Litter-Robot


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.

The Feeder-Robot is not currently supported by this integration.

Configuration

Adding Litter-Robot to your Home Assistant instance can be done via the user interface, by taking the following steps:

  • Browse to your Home Assistant instance.

  • In the sidebar click on Configuration.

  • From the configuration menu select: Integrations.

  • In the bottom right, click on the Add Integration button.

  • From the list, search and select “Litter-Robot”.

  • Follow the instruction on screen to complete the set up.

After completing, the Litter-Robot integration will be immediately available for use.

Entities

The following entities are created for this component and identified by a single device per Litter-Robot unit:

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.
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.

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 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.
sleep_mode_start_time string When sleep mode is enabled, displays the time the unit will enter sleep mode in the format %H:%M:%S, otherwise None.
sleep_mode_end_time string When sleep mode is enabled, displays the time the unit will exit sleep mode in the format %H:%M:%S, otherwise None.
power_status string Current power status of the unit. AC indicates normal power, DC indicates battery backup and NC indicates that the unit is not connected and/or powered off.
unit_status_code string The unit status code associated with the current status of the vacuum.
last_seen string UTC datetime the unit last reported its status.

Waste Drawer sensor entity

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

Commands are utilized for additional functionality that is available in the Litter-Robot companion app. The following are currently available:

reset_waste_drawer

Resets the waste drawer gauge on the Litter-Robot. This will reset the cycle count returned by the Litter-Robot API to 0.

service: vacuum.send_command
target:
  entity_id: vacuum.litter_robot_litter_box
data:
  command: reset_waste_drawer

set_sleep_mode

Enables (with sleep_time param) or disables sleep mode on the Litter-Robot.

Param Type Required Description
enabled bool yes Set to true to enable and false to disable.
sleep_time string Required if the param enabled is set to true. 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.

service: vacuum.send_command
target:
  entity_id: vacuum.litter_robot_litter_box
data:
  command: set_sleep_mode
  params:
    enabled: true
    sleep_time: "22:30:00"