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 10:17:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Litter-Robot documentation for switches and sensors (#16702)

Browse Source
This commit is contained in:
Nathan Spencer 2021-02-24 03:34:40 -07:00 committed by GitHub
parent fd9199ed88
commit 120460e7ef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
source/_integrations/litterrobot.markdown
View File

@ -26,23 +26,39 @@ There is currently support for the following device types within Home Assistant:
The following entities are created for this component:
| Entity | Domain |
| ---------- | -------- |
| Litter Box | `vacuum` |
| 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. |
| Waste Drawer | `sensor` | Displays the current waste level gauge. |
All of the entities above are grouped together and identified by a single device.
## Attributes
The following additional attributes are available on the `vacuum` component:
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 | Definition |
| ----------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 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_start_time | string | When sleep mode is enabled, displays the time the unit will enter sleep mode in the format `%H:%M:%S`, otherwise `None`. |
| sleep_mode_end_time | string | When sleep mode is enabled, displays the time the unit will exit sleep mode in the format `%H:%M:%S`, otherwise `None`. |
| 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. |
| unit_status_code | string | The [unit status code](https://github.com/natekspencer/pylitterbot/blob/main/pylitterbot/robot.py#L21) associated with the current status of the vacuum. |
| last_seen | string | UTC datetime the unit last reported its status. |
### Waste Drawer `sensor` entity
| Attribute | Type | Definition |
| ------------------------ | ------- | ------------------------------------------------------------------------ |
| cycle_count | integer | Number of clean cycles performed since last reset. |
| cycle_capacity | integer | Number of clean cycles before unit is full. |
| cycles_after_drawer_full | integer | Number of clean cycles performed since drawer full status was indicated. |
## Commands
In addition to the entities that are created above, some commands are utilized for additional functionality that is available in the Litter-Robot companion app.