Home Assistant Unofficial Reference 2024.12.1
Namespaces | Classes | Functions | Variables
homeassistant.components.vacuum Namespace Reference

Namespaces

 const
 
 device_action
 
 device_condition
 
 device_trigger
 
 intent
 
 reproduce_state
 
 significant_change
 

Classes

class  StateVacuumEntity
 
class  StateVacuumEntityDescription
 
class  VacuumEntityFeature
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
bool is_on (HomeAssistant hass, str entity_id)
 

Variables

 __all__
 
 __dir__
 
 __getattr__
 
 _DEPRECATED_SUPPORT_BATTERY
 
 _DEPRECATED_SUPPORT_CLEAN_SPOT
 
 _DEPRECATED_SUPPORT_FAN_SPEED
 
 _DEPRECATED_SUPPORT_LOCATE
 
 _DEPRECATED_SUPPORT_MAP
 
 _DEPRECATED_SUPPORT_PAUSE
 
 _DEPRECATED_SUPPORT_RETURN_HOME
 
 _DEPRECATED_SUPPORT_SEND_COMMAND
 
 _DEPRECATED_SUPPORT_START
 
 _DEPRECATED_SUPPORT_STATE
 
 _DEPRECATED_SUPPORT_STATUS
 
 _DEPRECATED_SUPPORT_STOP
 
 _DEPRECATED_SUPPORT_TURN_OFF
 
 _DEPRECATED_SUPPORT_TURN_ON
 
 _LOGGER
 
 ATTR_BATTERY_ICON
 
 ATTR_CLEANED_AREA
 
 ATTR_FAN_SPEED
 
 ATTR_FAN_SPEED_LIST
 
 ATTR_PARAMS
 
 ATTR_STATUS
 
 check_if_deprecated_constant
 
 DEFAULT_NAME
 
 dir_with_deprecated_constants
 
 ENTITY_ID_FORMAT
 
 module_globals
 
 module_globals_keys
 
 PLATFORM_SCHEMA
 
 PLATFORM_SCHEMA_BASE
 
 SCAN_INTERVAL
 
 seconds
 
 SERVICE_CLEAN_SPOT
 
 SERVICE_LOCATE
 
 SERVICE_PAUSE
 
 SERVICE_RETURN_TO_BASE
 
 SERVICE_SEND_COMMAND
 
 SERVICE_SET_FAN_SPEED
 
 SERVICE_START
 
 SERVICE_START_PAUSE
 
 SERVICE_STOP
 
 STATE_VACUUM_CACHED_PROPERTIES_WITH_ATTR_
 
 STATES
 

Detailed Description

Support for vacuum cleaner robots (botvacs).

Function Documentation

◆ async_setup()

bool homeassistant.components.vacuum.async_setup ( HomeAssistant  hass,
ConfigType  config 
) 
Set up the vacuum component.

Definition at line 136 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.vacuum.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
) 
Set up a config entry.

Definition at line 199 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.vacuum.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
) 
Unload a config entry.

Definition at line 204 of file __init__.py.

◆ is_on()

bool homeassistant.components.vacuum.is_on ( HomeAssistant  hass,
str  entity_id 
) 
Return if the vacuum is on based on the statemachine.

Definition at line 131 of file __init__.py.

Variable Documentation

◆ __all__

homeassistant.components.vacuum.__all__
private

Definition at line 418 of file __init__.py.

◆ __dir__

homeassistant.components.vacuum.__dir__
private

Definition at line 415 of file __init__.py.

◆ __getattr__

homeassistant.components.vacuum.__getattr__
private

Definition at line 414 of file __init__.py.

◆ _DEPRECATED_SUPPORT_BATTERY

homeassistant.components.vacuum._DEPRECATED_SUPPORT_BATTERY
private

Definition at line 108 of file __init__.py.

◆ _DEPRECATED_SUPPORT_CLEAN_SPOT

homeassistant.components.vacuum._DEPRECATED_SUPPORT_CLEAN_SPOT
private

Definition at line 120 of file __init__.py.

◆ _DEPRECATED_SUPPORT_FAN_SPEED

homeassistant.components.vacuum._DEPRECATED_SUPPORT_FAN_SPEED
private

Definition at line 105 of file __init__.py.

◆ _DEPRECATED_SUPPORT_LOCATE

homeassistant.components.vacuum._DEPRECATED_SUPPORT_LOCATE
private

Definition at line 117 of file __init__.py.

◆ _DEPRECATED_SUPPORT_MAP

homeassistant.components.vacuum._DEPRECATED_SUPPORT_MAP
private

Definition at line 123 of file __init__.py.

◆ _DEPRECATED_SUPPORT_PAUSE

homeassistant.components.vacuum._DEPRECATED_SUPPORT_PAUSE
private

Definition at line 100 of file __init__.py.

◆ _DEPRECATED_SUPPORT_RETURN_HOME

homeassistant.components.vacuum._DEPRECATED_SUPPORT_RETURN_HOME
private

Definition at line 102 of file __init__.py.

◆ _DEPRECATED_SUPPORT_SEND_COMMAND

homeassistant.components.vacuum._DEPRECATED_SUPPORT_SEND_COMMAND
private

Definition at line 114 of file __init__.py.

◆ _DEPRECATED_SUPPORT_START

homeassistant.components.vacuum._DEPRECATED_SUPPORT_START
private

Definition at line 125 of file __init__.py.

◆ _DEPRECATED_SUPPORT_STATE

homeassistant.components.vacuum._DEPRECATED_SUPPORT_STATE
private

Definition at line 124 of file __init__.py.

◆ _DEPRECATED_SUPPORT_STATUS

homeassistant.components.vacuum._DEPRECATED_SUPPORT_STATUS
private

Definition at line 111 of file __init__.py.

◆ _DEPRECATED_SUPPORT_STOP

homeassistant.components.vacuum._DEPRECATED_SUPPORT_STOP
private

Definition at line 101 of file __init__.py.

◆ _DEPRECATED_SUPPORT_TURN_OFF

homeassistant.components.vacuum._DEPRECATED_SUPPORT_TURN_OFF
private

Definition at line 97 of file __init__.py.

◆ _DEPRECATED_SUPPORT_TURN_ON

homeassistant.components.vacuum._DEPRECATED_SUPPORT_TURN_ON
private

Definition at line 94 of file __init__.py.

◆ _LOGGER

homeassistant.components.vacuum._LOGGER
private

Definition at line 42 of file __init__.py.

◆ ATTR_BATTERY_ICON

homeassistant.components.vacuum.ATTR_BATTERY_ICON

Definition at line 50 of file __init__.py.

◆ ATTR_CLEANED_AREA

homeassistant.components.vacuum.ATTR_CLEANED_AREA

Definition at line 51 of file __init__.py.

◆ ATTR_FAN_SPEED

homeassistant.components.vacuum.ATTR_FAN_SPEED

Definition at line 52 of file __init__.py.

◆ ATTR_FAN_SPEED_LIST

homeassistant.components.vacuum.ATTR_FAN_SPEED_LIST

Definition at line 53 of file __init__.py.

◆ ATTR_PARAMS

homeassistant.components.vacuum.ATTR_PARAMS

Definition at line 54 of file __init__.py.

◆ ATTR_STATUS

homeassistant.components.vacuum.ATTR_STATUS

Definition at line 55 of file __init__.py.

◆ check_if_deprecated_constant

homeassistant.components.vacuum.check_if_deprecated_constant

Definition at line 414 of file __init__.py.

◆ DEFAULT_NAME

homeassistant.components.vacuum.DEFAULT_NAME

Definition at line 70 of file __init__.py.

◆ dir_with_deprecated_constants

homeassistant.components.vacuum.dir_with_deprecated_constants

Definition at line 416 of file __init__.py.

◆ ENTITY_ID_FORMAT

homeassistant.components.vacuum.ENTITY_ID_FORMAT

Definition at line 45 of file __init__.py.

◆ module_globals

homeassistant.components.vacuum.module_globals

Definition at line 414 of file __init__.py.

◆ module_globals_keys

homeassistant.components.vacuum.module_globals_keys

Definition at line 416 of file __init__.py.

◆ PLATFORM_SCHEMA

homeassistant.components.vacuum.PLATFORM_SCHEMA

Definition at line 46 of file __init__.py.

◆ PLATFORM_SCHEMA_BASE

homeassistant.components.vacuum.PLATFORM_SCHEMA_BASE

Definition at line 47 of file __init__.py.

◆ SCAN_INTERVAL

homeassistant.components.vacuum.SCAN_INTERVAL

Definition at line 48 of file __init__.py.

◆ seconds

homeassistant.components.vacuum.seconds

Definition at line 48 of file __init__.py.

◆ SERVICE_CLEAN_SPOT

homeassistant.components.vacuum.SERVICE_CLEAN_SPOT

Definition at line 57 of file __init__.py.

◆ SERVICE_LOCATE

homeassistant.components.vacuum.SERVICE_LOCATE

Definition at line 58 of file __init__.py.

◆ SERVICE_PAUSE

homeassistant.components.vacuum.SERVICE_PAUSE

Definition at line 64 of file __init__.py.

◆ SERVICE_RETURN_TO_BASE

homeassistant.components.vacuum.SERVICE_RETURN_TO_BASE

Definition at line 59 of file __init__.py.

◆ SERVICE_SEND_COMMAND

homeassistant.components.vacuum.SERVICE_SEND_COMMAND

Definition at line 60 of file __init__.py.

◆ SERVICE_SET_FAN_SPEED

homeassistant.components.vacuum.SERVICE_SET_FAN_SPEED

Definition at line 61 of file __init__.py.

◆ SERVICE_START

homeassistant.components.vacuum.SERVICE_START

Definition at line 63 of file __init__.py.

◆ SERVICE_START_PAUSE

homeassistant.components.vacuum.SERVICE_START_PAUSE

Definition at line 62 of file __init__.py.

◆ SERVICE_STOP

homeassistant.components.vacuum.SERVICE_STOP

Definition at line 65 of file __init__.py.

◆ STATE_VACUUM_CACHED_PROPERTIES_WITH_ATTR_

homeassistant.components.vacuum.STATE_VACUUM_CACHED_PROPERTIES_WITH_ATTR_

Definition at line 213 of file __init__.py.

◆ STATES

homeassistant.components.vacuum.STATES

Definition at line 68 of file __init__.py.