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-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adjust wording and add ha_platforms in Litter-Robot documentation (#16737)

Browse Source
This commit is contained in:
Nathan Spencer 2021-02-24 18:03:49 -07:00 committed by Franck Nijhof
parent 80d60820c3
commit 01b4de9f5f
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
source/_integrations/litterrobot.markdown
View File

@ -10,21 +10,23 @@ ha_quality_scale: gold
ha_codeowners: ha_codeowners:
- '@natekspencer' - '@natekspencer'
ha_domain: litterrobot ha_domain: litterrobot
ha_platforms:
- sensor
- switch
- vacuum
--- ---
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 for cats.
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 unit that has already been associated with your account.
There is currently support for the following device types within Home Assistant: The Feeder-Robot is not currently supported by this integration.
- Vacuum (this is the representation of your Litter-Robot litter box)
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
## Entities ## Entities
The following entities are created for this component: The following entities are created for this component and identified by a single device per Litter-Robot unit:
| Entity | Domain | Description | | Entity | Domain | Description |
| ---------------- | -------- | -------------------------------------------------------------------------------- | | ---------------- | -------- | -------------------------------------------------------------------------------- |
@ -33,15 +35,13 @@ The following entities are created for this component:
| 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. |
| Waste Drawer | `sensor` | Displays the current waste level gauge. | | Waste Drawer | `sensor` | Displays the current waste level gauge. |
All of the entities above are grouped together and identified by a single device. ## Additional Attributes
## 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.
### Litter Box `vacuum` entity ### Litter Box `vacuum` entity
| Attribute | Type | Definition | | 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. | | 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. | | is_sleeping | boolean | Whether or not the unit is currently in sleep mode. |
@ -53,7 +53,7 @@ Some entities have attributes in addition to the default ones that are available
### Waste Drawer `sensor` entity ### Waste Drawer `sensor` entity
| Attribute | Type | Definition | | Attribute | Type | Description |
| ------------------------ | ------- | ------------------------------------------------------------------------ | | ------------------------ | ------- | ------------------------------------------------------------------------ |
| cycle_count | integer | Number of clean cycles performed since last reset. | | cycle_count | integer | Number of clean cycles performed since last reset. |
| cycle_capacity | integer | Number of clean cycles before unit is full. | | cycle_capacity | integer | Number of clean cycles before unit is full. |
@ -61,7 +61,7 @@ Some entities have attributes in addition to the default ones that are available
## Commands ## 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. Commands are utilized for additional functionality that is available in the Litter-Robot companion app. The following are currently available:
### reset_waste_drawer ### reset_waste_drawer