Set sleep mode

The Set sleep mode action turns sleep mode on or off for a Litter-Robot. When sleep mode is enabled, the Litter-Robot does not run an automatic clean cycle for 8 hours starting from the time you choose.

This is handy for keeping the unit quiet overnight or while you are nearby, without changing settings in the Whisker app.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To set sleep mode from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. From the search box, search for and select Litter-Robot: Set sleep mode.
6. Under Targets, choose the Litter-Robot entities to control.
7. Turn Enabled on or off, and optionally set a Start time.
8. Select Save.

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching vacuum entity behind that target.

• Entity: one specific vacuum entity, such as vacuum.living_room.
• Device: every vacuum entity that belongs to a device.
• Area: every vacuum entity in a room or area.
• Floor: every vacuum entity on a floor.
• Label: every vacuum entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as litterrobot.set_sleep_mode. A basic example looks like this:

action: litterrobot.set_sleep_mode
target:
  entity_id: vacuum.litter_robot_litter_box
data:
  enabled: true
  start_time: "22:30:00"

This enables sleep mode starting at 10:30 PM.

Options in YAML

Good to know

• Sleep mode scheduling through this action is currently limited to the Litter-Robot 3. To change the sleep schedule on a Litter-Robot 4, use the Whisker app.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.