Phil Hawthorne e3da848b1c Spelling fixes for Dyson component pages (#6814)
Some more fixes for the Dyson component
2018-10-15 18:52:09 +02:00

85 lines
2.2 KiB
Markdown

---
layout: page
title: "Dyson"
description: "Instructions on how to integrate Dyson into Home Assistant."
date: 2017-05-27 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: dyson.png
ha_category: Hub
ha_iot_class: "Cloud Polling"
ha_release: 0.47
---
The `dyson` component is the main component to integrate all [Dyson](https://dyson.com) related platforms: [Fans](/components/fan.dyson/) and [Robot vacuum cleaners](/components/vacuum.dyson/).
## {% linkable_title Configuration %}
To enable this component, add the following lines to your `configuration.yaml`:
```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 # eg. 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).
<p class='note warning'>
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.
</p>
To find a devices IP address, you can use your router or `nmap`:
```bash
$ 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:
```bash
$ nmap -p 1883 192.168.0.0/24 -- open
```