Skip to content

Update litterrobot documentation to match current implementation #23045

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

Merged
frenck merged 2 commits into from
Jul 18, 2022
Merged

Update litterrobot documentation to match current implementation #23045

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d157a83
Update litterrobot documentation to match current implementation
natekspencer Jun 8, 2022
78661f7
Adjust litterrobot documentation
natekspencer Jul 16, 2022
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
37 changes: 18 additions & 19 deletions source/_integrations/litterrobot.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,39 +26,38 @@ The Litter-Robot integration allows you to control and monitor your Wi-Fi-enable

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.

The Feeder-Robot is not currently supported by this integration.
The Feeder-Robot and Litter-Robot 4 are not currently supported by this integration.

{% include integrations/config_flow.md %}

## Entities

The following entities are created for this component and identified by a single device per Litter-Robot unit:

| Entity | Domain | Description |
| ----------------------------- | -------- | -------------------------------------------------------------------------------- |
| 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. |
| Panel Lockout | `switch` | When turned on, disables the buttons on the unit to prevent changes to settings. |
| 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. |
| Waste Drawer | `sensor` | Displays the current waste drawer level. |
| 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%. |
| Entity | Domain | Description |
| ----------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| 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. |
| 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. |
| 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. |
| Status Code | `sensor` | Displays the status code (Clean Cycle in Progress, Ready, Drawer Full, etc). |
| Waste Drawer | `sensor` | Displays the current waste drawer level. |
Comment thread
frenck marked this conversation as resolved.
| 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%. |

## Additional Attributes

Some entities have attributes in addition to the default ones that are available for that platform. They are listed below.

### Litter Box `vacuum` entity

| Attribute | Type | Description |
| ----------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| clean_cycle_wait_time_minutes | integer | Current wait time, in minutes, between when your cat uses the Litter-Robot and when the unit cycles automatically. |
| is_sleeping | boolean | Whether or not the unit is currently in sleep mode. |
| sleep_mode_enabled | boolean | Whether or not sleep mode is enabled. |
| power_status | string | Current power status of the unit. `AC` indicates normal power, `DC` indicates battery backup and `NC` indicates that the unit is not connected and/or powered off. |
| status_code | string | The [status code](https://github.com/natekspencer/pylitterbot/blob/884944b011f5fea9639b7d21d19fa3f7708e25a7/pylitterbot/enums.py#L44) associated with the current status of the vacuum. |
| last_seen | string | UTC datetime the unit last reported its status. |
| Attribute | Type | Description |
| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| is_sleeping | boolean | Whether or not the unit is currently in sleep mode. |
| sleep_mode_enabled | boolean | Whether or not sleep mode is enabled. |
| power_status | string | Current power status of the unit. `AC` indicates normal power, `DC` indicates battery backup and `NC` indicates that the unit is not connected and/or powered off. |

## Services

Expand Down