Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.roomba.entity.IRobotVacuum Class Reference
Inheritance diagram for homeassistant.components.roomba.entity.IRobotVacuum:
[legend]
Collaboration diagram for homeassistant.components.roomba.entity.IRobotVacuum:
[legend]

Public Member Functions

def __init__ (self, roomba, blid)
 
def async_locate (self, **kwargs)
 
def async_pause (self)
 
def async_return_to_base (self, **kwargs)
 
def async_send_command (self, command, params=None, **kwargs)
 
def async_start (self)
 
def async_stop (self, **kwargs)
 
def extra_state_attributes (self)
 
tuple[int, int] get_cleaning_status (self, state)
 
def on_message (self, json_data)
 
def state (self)
 
- Public Member Functions inherited from homeassistant.components.roomba.entity.IRobotEntity
def async_added_to_hass (self)
 
def battery_level (self)
 
def battery_stats (self)
 
def last_mission (self)
 
def mission_stats (self)
 
def new_state_filter (self, new_state)
 
def robot_unique_id (self)
 
def run_stats (self)
 
def unique_id (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
str|None suggested_object_id (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.vacuum.StateVacuumEntity
None async_clean_spot (self, **Any kwargs)
 
None async_locate (self, **Any kwargs)
 
None async_return_to_base (self, **Any kwargs)
 
None async_send_command (self, str command, dict[str, Any]|list[Any]|None params=None, **Any kwargs)
 
None async_set_fan_speed (self, str fan_speed, **Any kwargs)
 
None async_stop (self, **Any kwargs)
 
str battery_icon (self)
 
int|None battery_level (self)
 
dict[str, Any]|None capability_attributes (self)
 
None clean_spot (self, **Any kwargs)
 
str|None fan_speed (self)
 
list[strfan_speed_list (self)
 
None locate (self, **Any kwargs)
 
None pause (self)
 
None return_to_base (self, **Any kwargs)
 
None send_command (self, str command, dict[str, Any]|list[Any]|None params=None, **Any kwargs)
 
None set_fan_speed (self, str fan_speed, **Any kwargs)
 
None start (self)
 
dict[str, Any] state_attributes (self)
 
None stop (self, **Any kwargs)
 
VacuumEntityFeature supported_features (self)
 
VacuumEntityFeature supported_features_compat (self)
 

Public Attributes

 state
 
- Public Attributes inherited from homeassistant.components.roomba.entity.IRobotEntity
 vacuum
 
 vacuum_state
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Public Attributes inherited from homeassistant.components.vacuum.StateVacuumEntity
 state
 

Private Attributes

 _cap_position
 

Static Private Attributes

bool _attr_available = True
 
 _attr_name = None
 
 _attr_supported_features = SUPPORT_IROBOT
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.vacuum.StateVacuumEntity
 None
 
 VacuumEntityFeature
 

Detailed Description

Base class for iRobot robots.

Definition at line 159 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.roomba.entity.IRobotVacuum.__init__ (   self,
  roomba,
  blid 
)
Initialize the iRobot handler.

Reimplemented from homeassistant.components.roomba.entity.IRobotEntity.

Reimplemented in homeassistant.components.roomba.braava.BraavaJet.

Definition at line 166 of file entity.py.

Member Function Documentation

◆ async_locate()

def homeassistant.components.roomba.entity.IRobotVacuum.async_locate (   self,
**  kwargs 
)
Located vacuum.

Definition at line 269 of file entity.py.

◆ async_pause()

def homeassistant.components.roomba.entity.IRobotVacuum.async_pause (   self)
Pause the cleaning cycle.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 255 of file entity.py.

◆ async_return_to_base()

def homeassistant.components.roomba.entity.IRobotVacuum.async_return_to_base (   self,
**  kwargs 
)
Set the vacuum cleaner to return to the dock.

Definition at line 259 of file entity.py.

◆ async_send_command()

def homeassistant.components.roomba.entity.IRobotVacuum.async_send_command (   self,
  command,
  params = None,
**  kwargs 
)
Send raw command.

Definition at line 273 of file entity.py.

◆ async_start()

def homeassistant.components.roomba.entity.IRobotVacuum.async_start (   self)
Start or resume the cleaning task.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 244 of file entity.py.

◆ async_stop()

def homeassistant.components.roomba.entity.IRobotVacuum.async_stop (   self,
**  kwargs 
)
Stop the vacuum cleaner.

Definition at line 251 of file entity.py.

◆ extra_state_attributes()

def homeassistant.components.roomba.entity.IRobotVacuum.extra_state_attributes (   self)
Return the state attributes of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.roomba.roomba.RoombaVacuum, and homeassistant.components.roomba.braava.BraavaJet.

Definition at line 177 of file entity.py.

◆ get_cleaning_status()

tuple[int, int] homeassistant.components.roomba.entity.IRobotVacuum.get_cleaning_status (   self,
  state 
)
Return the cleaning time and cleaned area from the device.

Definition at line 218 of file entity.py.

◆ on_message()

def homeassistant.components.roomba.entity.IRobotVacuum.on_message (   self,
  json_data 
)
Update state on message change.

Reimplemented from homeassistant.components.roomba.entity.IRobotEntity.

Definition at line 237 of file entity.py.

◆ state()

def homeassistant.components.roomba.entity.IRobotVacuum.state (   self)
Return the state of the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 172 of file entity.py.

Member Data Documentation

◆ _attr_available

bool homeassistant.components.roomba.entity.IRobotVacuum._attr_available = True
staticprivate

Definition at line 164 of file entity.py.

◆ _attr_name

homeassistant.components.roomba.entity.IRobotVacuum._attr_name = None
staticprivate

Definition at line 162 of file entity.py.

◆ _attr_supported_features

homeassistant.components.roomba.entity.IRobotVacuum._attr_supported_features = SUPPORT_IROBOT
staticprivate

Definition at line 163 of file entity.py.

◆ _cap_position

homeassistant.components.roomba.entity.IRobotVacuum._cap_position
private

Definition at line 169 of file entity.py.

◆ state

homeassistant.components.roomba.entity.IRobotVacuum.state

Definition at line 192 of file entity.py.


The documentation for this class was generated from the following file: