Add documentation for the new Ecovacs (Deebot) component and vacuum (#5922)

* Add documentation for the new Ecovacs (Deebot) component and vacuum

* Copy paste error fix

* Typo fix and template improvements

From PR review
This commit is contained in:
Greg Laabs 2018-08-20 08:43:01 -07:00 committed by Paulus Schoutsen
parent cec178bdce
commit 03e53ea64b
3 changed files with 138 additions and 0 deletions

View File

@ -0,0 +1,69 @@
---
layout: page
title: "Ecovacs"
description: "Instructions on how to integrate Ecovacs vacuums within Home Assistant."
date: 2018-07-29 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ecovacs.png
ha_category: Hub
ha_iot_class: "Cloud Push"
ha_release: 0.75
---
The `ecovacs` component is the main component to integrate all [Ecovacs](https://www.ecovacs.com) (Deebot) vacuums. You will need your Ecovacs account information (username, password) to discover and control vacuums in your account.
Please see the [Ecovacs Vacuum](/components/vacuum.ecovacs/) documentation for more information about using the vacuum entity.
## {% linkable_title Configuration %}
To add your Ecovacs devices into your Home Assistant installation, add the following to your `configuration.yaml` file:
```yaml
ecovacs:
username: YOUR_ECOVACS_USERNAME
password: YOUR_ECOVACS_PASSWORD
country: YOUR_TWO_LETTER_COUNTRY_CODE
continent: YOUR_TWO_LETTER_CONTINENT_CODE
```
{% configuration %}
username:
description: Your username to login to your Ecovacs account.
required: true
type: string
password:
description: Your password to login to your Ecovacs account.
required: true
type: string
country:
description: Your two-letter country code (us, uk, etc).
required: true
type: string
continent:
description: Your two-letter continent code (na, eu, etc).
required: true
type: string
{% endconfiguration %}
Note: For some countries, you will need to set `continent` to `ww` (meaning worldwide.) There is unfortunately no way to know the correct settings other than guessing and checking. See the [sucks library protocol documentation](https://github.com/wpietri/sucks/blob/master/protocol.md) for more information about what has been figured out about the Ecovacs servers.
### {% linkable_title Stability and Reporting Bugs %}
The library that talks to the Ecovacs servers is in a very early state and still under development. As such, it is likely that not all regions and devices will work at the current time.
Please see the [sucks library documentation](https://github.com/wpietri/sucks) for some more information about what has been tested, and check out the GitHub issues to see if the issue you're having is known or being worked on.
If you have an issue with the Ecovacs component, please file a [GitHub Issue](https://github.com/home-assistant/home-assistant/issues) and include your Home Assistant logs in the report. To get full debug output from both the Ecovacs component and the underlying `sucks` library, place this in your `configuration.yaml` file:
```yaml
logger:
logs:
homeassistant.components.ecovacs: debug
homeassistant.components.vacuum.ecovacs: debug
sucks: debug
```
Warning: doing this will cause your authentication token to visible in your log files. Be sure to remove any tokens and other authentication details from your log before posting them in an issue.

View File

@ -0,0 +1,69 @@
---
layout: page
title: "Ecovacs Deebot Vacuum"
description: "Instructions on how to setup Ecovacs Deebot vacuums within Home Assistant."
date: 2018-07-27 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ecovacs.png
ha_category: Vacuum
ha_iot_class: "Cloud Push"
ha_release: 0.75
---
The `ecovacs` vacuum platform allows you to monitor and control your Ecovacs Deebot vacuums.
You have first to setup the [Ecovacs component](/components/ecovacs/)
### {% linkable_title Component Lifespans %}
The remaining lifespan of components on your Deebot vacuum will be reported as attributes on the vacuum entity. The value will be a whole number representing the percentage of life remaining.
Here's an example of how to extract the filter's lifespan to its own sensor using a [template sensor](/components/sensor.template/):
{% raw %}
```yaml
# Example configuration.yaml entry
sensor:
- platform: template
sensors:
vacuum_filter:
friendly_name: "Vacuum Filter Remaining Lifespan"
unit_of_measurement: '%'
value_template: "{{ state_attr('vacuum.my_vacuum_id', 'component_filter') }}"
```
{% endraw %}
Or, if you want a simple binary sensor that becomes `On` when the filter needs to be replaced (5% or less):
{% raw %}
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: template
sensors:
vacuum_filter_replace:
friendly_name: "Vacuum Filter"
device_class: problem
value_template: "{{ state_attr('vacuum.my_vacuum_id', 'component_filter') <= 5 }}"
```
{% endraw %}
### {% linkable_title Handling Errors %}
The vacuum entity has an `error` attribute that will contain the _most recent_ error message that came from the vacuum. There is not a comprehensive list of all error messages, so you may need to do some experimentation to determine the error messages that your vacuum can send.
If the vacuum fires a "no error" event, the `error` attribute will change back to `None`. Note, however, that this does not happen for all types of errors.
Alternatively, you can use the `ecovacs_error` event to watch for errors. This event will contain a data payload that looks like:
```json
{
"entity_id": "vacuum.deebot_m80",
"error": "an_error_name"
}
```
Finally, if a vacuum becomes unavailable (usually due to being idle and off its charger long enough for it to completely power off,) the vacuum's `status` attribute will change to `offline` until it is turned back on.

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB