mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-12-10 00:30:02 -06:00
126 lines
8.8 KiB
Markdown
126 lines
8.8 KiB
Markdown
---
|
||
title: Litter-Robot
|
||
description: Instructions on how to integrate a Litter-Robot Wi-Fi-enabled, automatic, self-cleaning litter box to Home Assistant.
|
||
ha_category:
|
||
- Button
|
||
- Select
|
||
- Sensor
|
||
- Switch
|
||
- Update
|
||
- Vacuum
|
||
ha_iot_class: Cloud Push
|
||
ha_release: 2021.3
|
||
ha_config_flow: true
|
||
ha_codeowners:
|
||
- '@natekspencer'
|
||
- '@tkdrob'
|
||
ha_domain: litterrobot
|
||
ha_dhcp: true
|
||
ha_platforms:
|
||
- binary_sensor
|
||
- button
|
||
- select
|
||
- sensor
|
||
- switch
|
||
- time
|
||
- update
|
||
- vacuum
|
||
ha_integration_type: hub
|
||
ha_quality_scale: bronze
|
||
---
|
||
|
||
The Litter-Robot {% term integration %} allows you to monitor and control your Wi-Fi-enabled, automatic, self-cleaning litter box and pet feeders. If you have pet profiles set up, you can also track your pet's weight.
|
||
|
||
## Prerequisites
|
||
|
||
Before using this integration, you’ll need a Whisker account and a Wi-Fi-enabled Litter-Robot or Feeder-Robot linked to it. You can do this via the Whisker app.
|
||
|
||
{% include integrations/config_flow.md %}
|
||
|
||
{% configuration_basic %}
|
||
Username:
|
||
description: "The email address of your Whisker account."
|
||
Password:
|
||
description: "The password of your Whisker account."
|
||
{% endconfiguration_basic %}
|
||
|
||
## Entities
|
||
|
||
### Litter-Robot
|
||
|
||
| 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, only for Litter-Robot 3. |
|
||
| 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. |
|
||
| Litter level | `sensor` | Displays the litter level, only for Litter-Robot 4. |
|
||
| Pet weight | `sensor` | Displays the last measured pet weight, only for Litter-Robot 4. |
|
||
| 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.). |
|
||
| Total cycles | `sensor` | Displays the total cycles. |
|
||
| Waste drawer | `sensor` | Displays the current waste drawer level. |
|
||
| Power status | `binary_sensor` | Indicates whether power is currently connected. |
|
||
| Sleep mode | `binary_sensor` | Indicates whether sleep mode is enabled. |
|
||
| Sleeping | `binary_sensor` | Indicates whether sleep mode is currently active. |
|
||
| Clean cycle wait time minutes | `select` | View and select the clean cycle wait time. |
|
||
| Globe brightness | `select` | View and select the brightness level for the globe light, only for Litter-Robot 4. |
|
||
| Globe light | `select` | View and select the globe light setting, only for Litter-Robot 4. |
|
||
| Panel brightness | `select` | View and select the panel brightness, only for Litter-Robot 4. |
|
||
| Reset | `button` | Button to reset the robot, clearing any errors and potentially triggering a cycle, only for Litter-Robot 4. |
|
||
| Reset waste drawer | `button` | Button to reset the waste drawer level to 0%, only for Litter-Robot 3. |
|
||
| Firmware | `update` | View and update to the latest firmware, only for Litter-Robot 4. |
|
||
|
||
### Feeder-Robot
|
||
|
||
| Entity | Domain | Description |
|
||
| -------------------- | -------- | ------------------------------------------------------------------------------------------ |
|
||
| Give snack | `button` | Button to dispense a single snack portion. |
|
||
| Meal insert size | `select` | View and select the meal insert size. |
|
||
| Food dispensed today | `sensor` | Displays the amount of food, in cups, by the feeder. |
|
||
| Food level | `sensor` | Displays the approximate food level remaining in the hopper. |
|
||
| Last feeding | `sensor` | Displays the timestamp of the last dispensed meal or snack. |
|
||
| Next feeding | `sensor` | Displays the timestamp of the next scheduled meal. |
|
||
| Gravity mode | `switch` | When turned on, the unit will keep the bowl full by checking the food level every 6 hours. |
|
||
| 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. |
|
||
|
||
### Pet
|
||
|
||
| Entity | Domain | Description |
|
||
| ------------ | -------- | ------------------------------------------------- |
|
||
| Visits today | `sensor` | Pet's daily visits to the Litter-Robot. |
|
||
| Weight | `sensor` | Pet's weight. |
|
||
|
||
## Actions
|
||
|
||
Actions are utilized for additional functionality that is available in the Whisker (previously Litter-Robot) companion app. The following are currently available:
|
||
|
||
### set_sleep_mode
|
||
|
||
Enables (with `start_time` parameter) or disables sleep mode on the Litter-Robot. Currently, this is limited to only the Litter-Robot 3. To make changes to the sleep schedule on your Litter-Robot 4, please continue to use the Whisker app.
|
||
|
||
| Parameter | Type | Required | Description |
|
||
| ---------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| enabled | bool | yes | Set to true to enable and false to disable. |
|
||
| start_time | string | no | Time at which the unit will enter sleep mode and prevent an automatic clean cycle for 8 hours. This param uses the 24-hour format string `%H:%M:%S`, with seconds being optional, and is based on the timezone configured for your Home Assistant installation. As such, `10:30:00` would indicate 10:30 AM, whereas `22:30:00` would indicate 10:30 PM. |
|
||
|
||
Example of setting the sleep mode to begin at 10:30 PM.
|
||
|
||
```yaml
|
||
action: litterrobot.set_sleep_mode
|
||
target:
|
||
entity_id: vacuum.litter_robot_litter_box
|
||
data:
|
||
enabled: true
|
||
start_time: "22:30:00"
|
||
|
||
```
|
||
|
||
## Removing the integration
|
||
|
||
This integration follows standard integration removal. No extra steps are required.
|
||
|
||
{% include integrations/remove_device_service.md %}
|