Skip to content

Add ECOVACS GOAT mower documentation #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
monsivar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add ECOVACS GOAT mower documentation #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/goat/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# ECOVACS GOAT mowers

!!! attention "Important notice"

We do not provide support that is the same, equal, or similar to manufacturer support
because we are in no way affiliated with ECOVACS nor is it sponsored or endorsed by ECOVACS

`deebot-client` includes initial support for selected ECOVACS GOAT robotic lawn mowers. In the client, GOAT devices are represented as `DeviceType.MOWER`.

The project historically focuses on vacuum cleaners, so some shared Python and protocol APIs still use vacuum-oriented names such as `clean`. For GOAT devices, those shared APIs map to mower actions where the hardware profile exposes them. Integrations built on top of `deebot-client` may choose to present mower-specific wording to users, but the underlying Python and protocol names are not renamed in the documentation.

Model support means that `deebot-client` has a hardware profile and a conservative set of known capabilities for a device. It does not mean that every feature from the ECOVACS app is supported.

- [Supported models](supported-models.md)
- [Mowing control](mowing-control.md)
22 changes: 22 additions & 0 deletions docs/goat/mowing-control.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Mowing control

!!! attention "Important notice"

We do not provide support that is the same, equal, or similar to manufacturer support
because we are in no way affiliated with ECOVACS nor is it sponsored or endorsed by ECOVACS

GOAT mower control currently uses the shared `deebot-client` JSON command names. These names are inherited from the vacuum support in the library, so `clean` means the general work action exposed by the profile. For a mower, integrations may display this as mowing, but the Python and protocol APIs remain named `clean`.

| Model | General mowing | Selected-area mowing | Return to charging station |
| ----------------------------- | -------------- | -------------------- | -------------------------- |
| ECOVACS GOAT G1 | `CleanV2` | `CleanAreaV2` | `Charge` |
| ECOVACS GOAT A1600 RTK | `CleanV2` | `CleanAreaV2` | `Charge` |
| ECOVACS GOAT A3000 LiDAR Pro | `CleanV2` | `CleanAreaV2` | `Charge` |
| ECOVACS GOAT O500 Panorama | `CleanV2` | `CleanAreaV2` | `Charge` |
| ECOVACS GOAT O1200 LiDAR | `CleanV2` | Not exposed | `Charge` |

All five reviewed GOAT profiles expose general mowing through `CleanV2`, and use `Charge` to return the mower to the charging station.

The G1, A1600 RTK, A3000 LiDAR Pro and O500 Panorama profiles currently expose `CleanAreaV2`. The current upstream O1200 profile exposes `CleanV2`, but does not expose `CleanAreaV2`.

Absence of `CleanAreaV2` in a hardware profile only means that selected-area mowing is not exposed through that upstream `deebot-client` capability. It must not be interpreted as proof that the physical mower or the ECOVACS app lacks selected-area mowing.
18 changes: 18 additions & 0 deletions docs/goat/supported-models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Supported GOAT models

!!! attention "Important notice"

We do not provide support that is the same, equal, or similar to manufacturer support
because we are in no way affiliated with ECOVACS nor is it sponsored or endorsed by ECOVACS

The following ECOVACS GOAT models have dedicated hardware profiles in the current upstream `deebot-client` dev branch.

| Model | Hardware ID | Device type | Data type |
| ----------------------------- | ----------- | ------------------ | --------- |
| ECOVACS GOAT G1 | `5xu9h3` | `DeviceType.MOWER` | JSON |
| ECOVACS GOAT A1600 RTK | `xmp9ds` | `DeviceType.MOWER` | JSON |
| ECOVACS GOAT A3000 LiDAR Pro | `51rcxt` | `DeviceType.MOWER` | JSON |
| ECOVACS GOAT O500 Panorama | `300lc5` | `DeviceType.MOWER` | JSON |
| ECOVACS GOAT O1200 LiDAR | `2i0fns` | `DeviceType.MOWER` | JSON |

A dedicated hardware profile is not the same as complete feature support. This page only documents capabilities that are visible in those upstream profiles, and the supported control baseline is described on the [mowing control](mowing-control.md) page.
16 changes: 16 additions & 0 deletions docs/home/models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

Used by [Deebot for Home Assistant](https://github.com/DeebotUniverse/Deebot-4-Home-Assistant)

### Vacuum cleaners

| Model | status | Protocol | Data type |
| ----------------------- | :------------------------------: | --------- | --------- |
| Deebot OZMO 920 | :material-check: | REST/MQTT | JSON |
Expand All @@ -20,6 +22,20 @@ Used by [Deebot for Home Assistant](https://github.com/DeebotUniverse/Deebot-4-H
| Deebot U2 series | | REST/MQTT | JSON |
| Deebot X1 Omni | :material-progress-check: | REST/MQTT | JSON |

### ECOVACS GOAT mowers

The following mower entries have dedicated upstream `deebot-client` hardware profiles. They are listed without a status icon because the existing status legend does not describe mower feature coverage precisely. The hardware profiles verify JSON as the data type.

| Model | Hardware ID | Device type | Data type |
| ----------------------------- | ----------- | ------------------ | --------- |
| ECOVACS GOAT G1 | `5xu9h3` | `DeviceType.MOWER` | JSON |
| ECOVACS GOAT A1600 RTK | `xmp9ds` | `DeviceType.MOWER` | JSON |
| ECOVACS GOAT A3000 LiDAR Pro | `51rcxt` | `DeviceType.MOWER` | JSON |
| ECOVACS GOAT O500 Panorama | `300lc5` | `DeviceType.MOWER` | JSON |
| ECOVACS GOAT O1200 LiDAR | `2i0fns` | `DeviceType.MOWER` | JSON |

See [GOAT mower support](../goat/index.md) for the conservative mower capability notes.

## :material-language-javascript: ecovacs-deebot.js

Used by [Ecovacs Deebot adapter](https://github.com/mrbungle64/ioBroker.ecovacs-deebot) and [various others](projects.md#ecovacs-deebotjs)
Expand Down
4 changes: 4 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ nav:
- Simple: integrations/home-assistant/examples/ui/simple.md
- Advanced: integrations/home-assistant/examples/ui/advanced.md
- Migration: integrations/home-assistant/migration.md
- GOAT Mowers:
- goat/index.md
- Supported models: goat/supported-models.md
- Mowing control: goat/mowing-control.md
- Advanced:
- Protocols:
- MQTT: advanced/protocols/mqtt.md
Expand Down