Skip to content

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

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
Feb 25, 2021
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebdb300
Adjust wording in Litter-Robot documentation and set ha_category to Pets
natekspencer Feb 24, 2021
e66b843
Add ha_platforms and put ha_category back to vacuum
natekspencer Feb 25, 2021
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
20 changes: 10 additions & 10 deletions source/_integrations/litterrobot.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,23 @@ ha_quality_scale: gold
ha_codeowners:
- '@natekspencer'
ha_domain: litterrobot
ha_platforms:
- sensor
- switch
- vacuum
Comment on lines +13 to +16
Copy link
Copy Markdown
Member

@frenck frenck Feb 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can leave this in, but you don't have to do this, it is synced data.

---

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.

There is currently support for the following device types within Home Assistant:

- Vacuum (this is the representation of your Litter-Robot litter box)
The Feeder-Robot is not currently supported by this integration.

{% include integrations/config_flow.md %}

## 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 |
| ---------------- | -------- | -------------------------------------------------------------------------------- |
Expand All @@ -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. |
| Waste Drawer | `sensor` | Displays the current waste level gauge. |

All of the entities above are grouped together and identified by a single device.

## Attributes
## 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 | 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. |
| is_sleeping | boolean | Whether or not the unit is currently in sleep mode. |
Expand All @@ -53,15 +53,15 @@ Some entities have attributes in addition to the default ones that are available

### Waste Drawer `sensor` entity

| Attribute | Type | Definition |
| Attribute | Type | Description |
| ------------------------ | ------- | ------------------------------------------------------------------------ |
| 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.
Commands are utilized for additional functionality that is available in the Litter-Robot companion app. The following are currently available:

### reset_waste_drawer

Expand Down