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. |
| Sleep mode (per day) | switch |
Enable or disable each day of the week’s sleep schedule, only for Litter-Robot 5. |
| 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 and 5. |
| Next filter replacement | sensor |
Displays the next filter replacement date, only for Litter-Robot 5. |
| Pet weight | sensor |
Displays the last measured pet weight, only for Litter-Robot 4 and 5. |
| Scoops saved | sensor |
Displays the total number of scoops of litter saved, only for Litter-Robot 5. |
| 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 (such as Clean Cycle in Progress, Ready, or Drawer Full). |
| Total cycles | sensor |
Displays the total cycles. |
| Waste drawer | sensor |
Displays the current waste drawer level. |
| Bonnet removed | binary_sensor |
Indicates whether the bonnet is removed, only for Litter-Robot 5. |
| Drawer removed | binary_sensor |
Indicates whether the waste drawer is removed, only for Litter-Robot 5. |
| Hopper connected | binary_sensor |
Indicates whether a LitterHopper is connected, only for Litter-Robot 5. |
| Laser dirty | binary_sensor |
Indicates whether the cat detection laser is dirty, only for Litter-Robot 5. |
| Online | binary_sensor |
Indicates whether the unit is connected to the Whisker cloud, only for Litter-Robot 5. |
| 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 and 5. |
| Globe light | select |
View and select the globe light setting, only for Litter-Robot 4 and 5. |
| Panel brightness | select |
View and select the panel brightness, only for Litter-Robot 4 and 5. |
| Sleep mode start (per day) | time |
Set each day of the week’s sleep mode start time, only for Litter-Robot 5. |
| Sleep mode end (per day) | time |
Set each day of the week’s sleep mode end time, only for Litter-Robot 5. |
| Change filter | button |
Button to indicate the filter was changed and reset the replacement date, only for Litter-Robot 5. |
| Reset | button |
Button to reset the robot, clearing errors and potentially cycling, only for Litter-Robot 4 and 5. |
| Reset waste drawer | button |
Button to reset the waste drawer level to 0%, only for Litter-Robot 3 and 5. |
| Firmware | update |
View and update to the latest firmware, only for Litter-Robot 4. |
The per-day sleep schedule entities (Sleep mode (per day), Sleep mode start (per day), and Sleep mode end (per day)) are disabled by default. Enable the days you want to control in the entity settings.
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. |
List of actions
The Whisker integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides the following actions. Each link below opens a dedicated page with examples, parameters, and a step-by-step UI walkthrough.
-
Set sleep mode (
litterrobot.set_sleep_mode) Sets the sleep mode and start time on a Litter-Robot.
For an overview of every action across all integrations, see the actions reference.
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.