home-assistant.io/source/_components/dyson.markdown

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_iot_class, ha_release, redirect_from

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_iot_class	ha_release	redirect_from
page	Dyson	Instructions on how to integrate Dyson into Home Assistant.	2017-05-27 10:00	true	false	true	true	dyson.png	Hub Climate Fan Sensor Vacuum	Cloud Polling	0.47	/components/vacuum.dyson/ /components/climate.dyson/ /components/fan.dyson/ /components/sensor.dyson/

The dyson integration is the main integration to integrate all Dyson related platforms.

There is currently support for the following device types within Home Assistant:

• Climate
• Fan
• Sensor
• Vacuum
• Air Quality

{% linkable_title Configuration %}

To enable this component, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
dyson:
  username: YOUR_DYSON_USERNAME
  password: YOUR_DYSON_PASSWORD
  language: YOUR_DYSON_ACCOUNT_LANGUAGE
  devices:
    - device_id: DEVICE_ID_1 # e.g., Serial number: XXX-XX-XXXXXXXX
      device_ip: DEVICE_IP_1
    - device_id: DEVICE_ID_2
      device_ip: DEVICE_IP_2

{% configuration %} username: description: Dyson account username (email address). required: true type: string password: description: Dyson account password. required: true type: string language: description: "Dyson account language country code. Known working codes: FR, NL, GB, AU. Other codes should be supported." required: true type: string devices: description: List of devices. required: false type: map keys: device_id: description: Device ID. The Serial Number of the device. Found in the smart phone app device settings page. required: true type: string device_ip: description: Device IP address. required: true type: string {% endconfiguration %}

The devices list is optional, but you'll have to provide them if discovery is not working (warnings in the logs and the devices are not available in Home Assistant web interface).

Discovery is not yet supported for any robot vacuum models (Dyson 360 Eye). For these devices, you will need to provide them in the `devices` list.

To find a devices IP address, you can use your router or nmap:

$ nmap -p 1883 XXX.XXX.XXX.XXX/YY -- open

Where:

• XXX.XXX.XXX.XXX is your network address
• YY is your network mask

For example:

$ nmap -p 1883 192.168.0.0/24 -- open

{% linkable_title Vacuum %}

The dyson vacuum platform allows you to control your Dyson 360 Eye robot vacuum.

{% linkable_title Component services %}

This integration support the following services (see Vacuum Cleaner Robots):

• turn_on
• turn_off
• start_pause
• stop
• return_to_home
• set_fan_speed. Fan speed values:
  • Quiet
  • Max

{% linkable_title Climate %}

The dyson climate platform allows you to control your Dyson Pure Hot+Cool Fan thermal control. For controlling the fan functionality, see the Dyson fan part on this page.

{% linkable_title Component services %}

This integration supports the following services (see Climate):

• turn_on
• turn_off
• set_temperature
• set_fan_mode
• set_operation_mode

{% linkable_title Fan %}

The dyson fan platform allows you to control your Dyson Purifier fans.

{% linkable_title Supported fan devices %}

• Pure Cool link (desk and tower)
• Pure Hot+cool link (see climate part) for thermal control
• Pure Cool 2018 (DP04 and TP04)

{% linkable_title Attributes %}

There are several attributes which can be used for automations and templates.

Attribute	Description
night_mode	A boolean that indicates if the night mode of the fan device is on.
auto_mode	A boolean that indicates if the auto mode of the fan device is on.
angle_low	Int (between 5 and 355) that indicates the low angle of oscillation (only for DP04 and TP04).
angle_high	Int (between 5 and 355) that indicates the high angle of oscillation (only for DP04 and TP04).
flow_direction_front	Boolean that indicates if the frontal flow direction is enabled (only for DP04 and TP04).
timer	Attribute that indicates the status of the auto power off timer, can be either 'OFF' or an integer representing the time remaining until shutdown in minutes (only for DP04 and TP04).
hepa filter	State of the fan's HEPA filter in % (only for DP04 and TP04).
carbon filter	State of the fan's carbon filter in % (only for DP04 and TP04).

{% linkable_title Sensor %}

The dyson sensor platform provides temperature and humidity sensors.

{% linkable_title Air Quality %}

The dyson air quality platform provides the following levels:

• Particulate matter 2.5 (<= 2.5 μm) level.
• Particulate matter 10 (<= 10 μm) level.
• Air Quality Index (AQI).
• NO2 (nitrogen dioxide) level.
• VOC (Volatile organic compounds) level.

Note: currently only the 2018 dyson fans are supported(TP04 and DP04).

{% linkable_title Supported fan devices %}

• Pure Cool link (desk and tower)
• Pure Hot+cool link (see climate part) for thermal control
• Pure Cool 2018 Models (TP04 and DP04)