Whisker
The Whisker integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] 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.
Supported devices
Any Wi-Fi connected Whisker device that can be onboarded via the Whisker app should work with this integration.
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.
Configuration
To add the Whisker hub to your Home Assistant instance, use this My button:
Whisker can be auto-discovered by Home Assistant. If an instance was found, it will be shown as Discovered. You can then set it up right away.
If it wasn’t discovered automatically, don’t worry! You can set up a manual integration entry:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the
Add Integration button. -
From the list, select Whisker.
-
Follow the instructions on screen to complete the setup.
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.
action: litterrobot.set_sleep_mode
target:
entity_id: vacuum.litter_robot_litter_box
data:
enabled: true
start_time: "22:30:00"
Data updates
This integration subscribes to updates from Feeder-Robot and Litter-Robot devices to receive new data as soon as it is available.
Additionally, this integration pollsData polling is the process of querying a device or service at regular intervals to check for updates or retrieve data. By defining a custom polling interval, you can control how frequently your system checks for new data, which can help optimize performance and reduce unnecessary network traffic. [Learn more] for updated device and pet data every 5 minutes.
Examples
Clean area(s) when a Litter-Robot cycles
Known limitations
The following features are not currently supported by the integration:
- Access to cameras on Litter-Robot 5 Pro models.
- Configuring sleep schedules on Litter-Robot 4 and newer models.
- Certain device settings, including renaming devices, filter replacement resets, and cycle count resets.
- Reassigning pet visits.
Troubleshooting
Device becomes unavailable or unresponsive
The device shows as unavailable when it cannot reach the Whisker cloud service. Check your internet connection first, then open the Whisker app and see if you can still control the device from there. If the app also cannot connect, the Whisker service may be down or your device may be offline.
Removing the integration
This integration follows standard integration removal. No extra steps are required.
To remove an integration instance from Home Assistant
- Go to Settings > Devices & services and select the integration card.
- From the list of devices, select the integration instance you want to remove.
- Next to the entry, select the three dots
menu. Then, select Delete.