Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.litterrobot.vacuum Namespace Reference

Classes

class  LitterRobotCleaner
 

Functions

None async_setup_entry (HomeAssistant hass, LitterRobotConfigEntry entry, AddEntitiesCallback async_add_entities)
 

Variables

 LITTER_BOX_ENTITY
 
dictionary LITTER_BOX_STATUS_STATE_MAP
 
string SERVICE_SET_SLEEP_MODE = "set_sleep_mode"
 

Detailed Description

Support for Litter-Robot "Vacuum".

Function Documentation

◆ async_setup_entry()

None homeassistant.components.litterrobot.vacuum.async_setup_entry ( HomeAssistant  hass,
LitterRobotConfigEntry  entry,
AddEntitiesCallback  async_add_entities 
)
Set up Litter-Robot cleaner using config entry.

Definition at line 49 of file vacuum.py.

Variable Documentation

◆ LITTER_BOX_ENTITY

homeassistant.components.litterrobot.vacuum.LITTER_BOX_ENTITY
Initial value:
1 = StateVacuumEntityDescription(
2  key="litter_box", translation_key="litter_box"
3 )

Definition at line 44 of file vacuum.py.

◆ LITTER_BOX_STATUS_STATE_MAP

dictionary homeassistant.components.litterrobot.vacuum.LITTER_BOX_STATUS_STATE_MAP
Initial value:
1 = {
2  LitterBoxStatus.CLEAN_CYCLE: STATE_CLEANING,
3  LitterBoxStatus.EMPTY_CYCLE: STATE_CLEANING,
4  LitterBoxStatus.CLEAN_CYCLE_COMPLETE: STATE_DOCKED,
5  LitterBoxStatus.CAT_DETECTED: STATE_DOCKED,
6  LitterBoxStatus.CAT_SENSOR_TIMING: STATE_DOCKED,
7  LitterBoxStatus.DRAWER_FULL_1: STATE_DOCKED,
8  LitterBoxStatus.DRAWER_FULL_2: STATE_DOCKED,
9  LitterBoxStatus.READY: STATE_DOCKED,
10  LitterBoxStatus.CAT_SENSOR_INTERRUPTED: STATE_PAUSED,
11  LitterBoxStatus.OFF: STATE_DOCKED,
12 }

Definition at line 31 of file vacuum.py.

◆ SERVICE_SET_SLEEP_MODE

string homeassistant.components.litterrobot.vacuum.SERVICE_SET_SLEEP_MODE = "set_sleep_mode"

Definition at line 29 of file vacuum.py.