jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-25 02:07:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up ecovacs documentation (#30872)

Browse Source
This commit is contained in:
Robert Resch 2024-01-19 16:52:49 +01:00 committed by GitHub
parent 6c031c3f96
commit de55fdc324
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
source/_integrations/ecovacs.markdown
View File

@ -9,6 +9,7 @@ ha_release: 0.77
ha_codeowners: ha_codeowners:
- '@OverloadUT' - '@OverloadUT'
- '@mib1185' - '@mib1185'
- '@edenhaus'
ha_domain: ecovacs ha_domain: ecovacs
ha_platforms: ha_platforms:
- vacuum - vacuum
@ -23,90 +24,15 @@ There is currently support for the following device types within Home Assistant:
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
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 [py-sucks library protocol documentation](https://github.com/mib1185/py-sucks/blob/master/protocol.md) for more information about what has been figured out about the Ecovacs servers. 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.
Additional note: There are some issues during the password encoding. Using some special characters (e.g., `-`) in your password does not work. Additional note: There are some issues during the password encoding. Using some special characters (e.g., `-`) in your password does not work.
### 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 [py-sucks library documentation](https://github.com/mib1185/py-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 integration, 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 integration 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 be visible in your log files. Be sure to remove any tokens and other authentication details from your log before posting them in an issue.
## Vacuum ## Vacuum
The `ecovacs` vacuum platform allows you to monitor and control your Ecovacs Deebot vacuums. The `ecovacs` vacuum platform allows you to monitor and control your Ecovacs Deebot vacuums.
### Service `vacuum.start`
Start a new cleaning task.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.stop`
Stop the current cleaning task and return to the dock.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.pause`
Pause a cleaning task.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.clean_spot`
Begin a spot cleaning operation.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.locate`
Locate the vacuum.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.set_fan_speed`
Pause a cleaning task.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
| `fan_speed` | no | Fan speed. Values are `normal` or `high`. |
### Service `vacuum.return_to_base`
Return to charging base/dock immediately.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Integration lifespan ### Integration lifespan
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. 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.