Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.roomba.entity Namespace Reference

Classes

class  IRobotEntity
 
class  IRobotVacuum
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string ATTR_CLEANED_AREA = "cleaned_area"
 
string ATTR_CLEANING_TIME = "cleaning_time"
 
string ATTR_ERROR = "error"
 
string ATTR_ERROR_CODE = "error_code"
 
string ATTR_POSITION = "position"
 
string ATTR_SOFTWARE_VERSION = "software_version"
 
dictionary STATE_MAP
 
tuple SUPPORT_IROBOT
 

Detailed Description

Base class for iRobot devices.

Variable Documentation

◆ _LOGGER

homeassistant.components.roomba.entity._LOGGER = logging.getLogger(__name__)
private

Definition at line 27 of file entity.py.

◆ ATTR_CLEANED_AREA

string homeassistant.components.roomba.entity.ATTR_CLEANED_AREA = "cleaned_area"

Definition at line 30 of file entity.py.

◆ ATTR_CLEANING_TIME

string homeassistant.components.roomba.entity.ATTR_CLEANING_TIME = "cleaning_time"

Definition at line 29 of file entity.py.

◆ ATTR_ERROR

string homeassistant.components.roomba.entity.ATTR_ERROR = "error"

Definition at line 31 of file entity.py.

◆ ATTR_ERROR_CODE

string homeassistant.components.roomba.entity.ATTR_ERROR_CODE = "error_code"

Definition at line 32 of file entity.py.

◆ ATTR_POSITION

string homeassistant.components.roomba.entity.ATTR_POSITION = "position"

Definition at line 33 of file entity.py.

◆ ATTR_SOFTWARE_VERSION

string homeassistant.components.roomba.entity.ATTR_SOFTWARE_VERSION = "software_version"

Definition at line 34 of file entity.py.

◆ STATE_MAP

dictionary homeassistant.components.roomba.entity.STATE_MAP
Initial value:
1 = {
2  "": STATE_IDLE,
3  "charge": STATE_DOCKED,
4  "evac": STATE_RETURNING, # Emptying at cleanbase
5  "hmMidMsn": STATE_CLEANING, # Recharging at the middle of a cycle
6  "hmPostMsn": STATE_RETURNING, # Cycle finished
7  "hmUsrDock": STATE_RETURNING,
8  "pause": STATE_PAUSED,
9  "run": STATE_CLEANING,
10  "stop": STATE_IDLE,
11  "stuck": STATE_ERROR,
12 }

Definition at line 48 of file entity.py.

◆ SUPPORT_IROBOT

tuple homeassistant.components.roomba.entity.SUPPORT_IROBOT
Initial value:
1 = (
2  VacuumEntityFeature.BATTERY
3  | VacuumEntityFeature.PAUSE
4  | VacuumEntityFeature.RETURN_HOME
5  | VacuumEntityFeature.SEND_COMMAND
6  | VacuumEntityFeature.START
7  | VacuumEntityFeature.STATE
8  | VacuumEntityFeature.STOP
9  | VacuumEntityFeature.LOCATE
10 )

Definition at line 37 of file entity.py.