Update litterrobot documentation for Feeder-Robot model (#23940)

This commit is contained in:
Nathan Spencer 2022-08-30 12:36:32 -06:00 committed by GitHub
parent d81120505b
commit 9c68e7fabe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -24,33 +24,37 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
The Litter-Robot integration allows you to control and monitor your Wi-Fi-enabled, automatic, self-cleaning litter box for cats. The Litter-Robot integration allows you to control and monitor your Wi-Fi-enabled, automatic, self-cleaning litter box and pet feeders.
You will need a Litter-Robot account as well as a Wi-Fi-enabled Litter-Robot unit that has already been associated with your account. You will need a Litter-Robot account as well as a Wi-Fi-enabled Litter-Robot or Feeder-Robot unit that has already been associated with your account.
The Feeder-Robot is not currently supported by this integration.
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
## Entities ## Entities
The following entities are created for this component and identified by a single device per Litter-Robot unit: ### Litter-Robot
| Entity | Domain | Description | | Entity | Domain | Description |
| ----------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------- | -------- | -------------------------------------------------------------------------------- |
| Litter Box | `vacuum` | Main entity that represents a Litter-Robot unit. | | Litter Box | `vacuum` | Main entity that represents a Litter-Robot unit. |
| Night Light Mode | `switch` | When turned on, automatically turns on the night light in darker settings. | | Night Light Mode | `switch` | When turned on, automatically turns on the night light in darker settings. |
| Panel Lockout | `switch` | When turned on, disables the buttons on the unit to prevent changes to settings. | | Panel Lockout | `switch` | When turned on, disables the buttons on the unit to prevent changes to settings. |
| Last Seen | `sensor` | Displays the time the unit was last seen / reported an update. | | Last Seen | `sensor` | Displays the time the unit was last seen / reported an update. |
| Sleep Mode Start Time | `sensor` | When sleep mode is enabled, displays the current or next sleep mode start time. | | Sleep Mode Start Time | `sensor` | When sleep mode is enabled, displays the current or next sleep mode start time. |
| Sleep Mode End Time | `sensor` | When sleep mode is enabled, displays the current or last sleep mode end time. | | Sleep Mode End Time | `sensor` | When sleep mode is enabled, displays the current or last sleep mode end time. |
| Status Code | `sensor` | Displays the status code (Clean Cycle in Progress, Ready, Drawer Full, etc). | | Status Code | `sensor` | Displays the status code (Clean Cycle in Progress, Ready, Drawer Full, etc). |
| Waste Drawer | `sensor` | Displays the current waste drawer level. | | Waste Drawer | `sensor` | Displays the current waste drawer level. |
| Clean Cycle Wait Time Minutes | `select` | View and select the clean cycle wait time. | | Clean Cycle Wait Time Minutes | `select` | View and select the clean cycle wait time. |
| Reset Waste Drawer* | `button` | Button to reset the waste drawer level to 0%. | | Reset Waste Drawer* | `button` | Button to reset the waste drawer level to 0%. |
\* Litter-Robot 3 only \* Litter-Robot 3 only
### Feeder-Robot
| Entity | Domain | Description |
| ---------- | -------- | ------------------------------------------------------------ |
| Food level | `sensor` | Displays the approximate food level remaining in the hopper. |
## Additional Attributes ## Additional Attributes
Some entities have attributes in addition to the default ones that are available for that platform. They are listed below. Some entities have attributes in addition to the default ones that are available for that platform. They are listed below.