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

Classes

class  TemplateVacuum
 

Functions

def _async_create_entities (hass, config)
 
None async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
list _VALID_STATES
 
string CONF_BATTERY_LEVEL_TEMPLATE = "battery_level_template"
 
string CONF_FAN_SPEED_LIST = "fan_speeds"
 
string CONF_FAN_SPEED_TEMPLATE = "fan_speed_template"
 
string CONF_VACUUMS = "vacuums"
 
string ENTITY_ID_FORMAT = VACUUM_DOMAIN + ".{}"
 
 PLATFORM_SCHEMA
 
 VACUUM_SCHEMA
 

Detailed Description

Support for Template vacuums.

Function Documentation

◆ _async_create_entities()

def homeassistant.components.template.vacuum._async_create_entities (   hass,
  config 
)
private 
Create the Template Vacuums.

Definition at line 98 of file vacuum.py.

◆ async_setup_platform()

None homeassistant.components.template.vacuum.async_setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  async_add_entities,
DiscoveryInfoType | None   discovery_info = None 
) 
Set up the template vacuums.

Definition at line 118 of file vacuum.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.template.vacuum._LOGGER = logging.getLogger(__name__)
private

Definition at line 52 of file vacuum.py.

◆ _VALID_STATES

list homeassistant.components.template.vacuum._VALID_STATES
private
Initial value:
1 = [
2  STATE_CLEANING,
3  STATE_DOCKED,
4  STATE_PAUSED,
5  STATE_IDLE,
6  STATE_RETURNING,
7  STATE_ERROR,
8 ]

Definition at line 60 of file vacuum.py.

◆ CONF_BATTERY_LEVEL_TEMPLATE

string homeassistant.components.template.vacuum.CONF_BATTERY_LEVEL_TEMPLATE = "battery_level_template"

Definition at line 55 of file vacuum.py.

◆ CONF_FAN_SPEED_LIST

string homeassistant.components.template.vacuum.CONF_FAN_SPEED_LIST = "fan_speeds"

Definition at line 56 of file vacuum.py.

◆ CONF_FAN_SPEED_TEMPLATE

string homeassistant.components.template.vacuum.CONF_FAN_SPEED_TEMPLATE = "fan_speed_template"

Definition at line 57 of file vacuum.py.

◆ CONF_VACUUMS

string homeassistant.components.template.vacuum.CONF_VACUUMS = "vacuums"

Definition at line 54 of file vacuum.py.

◆ ENTITY_ID_FORMAT

string homeassistant.components.template.vacuum.ENTITY_ID_FORMAT = VACUUM_DOMAIN + ".{}"

Definition at line 59 of file vacuum.py.

◆ PLATFORM_SCHEMA

homeassistant.components.template.vacuum.PLATFORM_SCHEMA
Initial value:
1 = cv.PLATFORM_SCHEMA.extend(
2  {vol.Required(CONF_VACUUMS): vol.Schema({cv.slug: VACUUM_SCHEMA})}
3 )

Definition at line 93 of file vacuum.py.

◆ VACUUM_SCHEMA

homeassistant.components.template.vacuum.VACUUM_SCHEMA
Initial value:
1 = vol.All(
2  cv.deprecated(CONF_ENTITY_ID),
3  vol.Schema(
4  {
5  vol.Optional(CONF_FRIENDLY_NAME): cv.string,
6  vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
7  vol.Optional(CONF_BATTERY_LEVEL_TEMPLATE): cv.template,
8  vol.Optional(CONF_FAN_SPEED_TEMPLATE): cv.template,
9  vol.Required(SERVICE_START): cv.SCRIPT_SCHEMA,
10  vol.Optional(SERVICE_PAUSE): cv.SCRIPT_SCHEMA,
11  vol.Optional(SERVICE_STOP): cv.SCRIPT_SCHEMA,
12  vol.Optional(SERVICE_RETURN_TO_BASE): cv.SCRIPT_SCHEMA,
13  vol.Optional(SERVICE_CLEAN_SPOT): cv.SCRIPT_SCHEMA,
14  vol.Optional(SERVICE_LOCATE): cv.SCRIPT_SCHEMA,
15  vol.Optional(SERVICE_SET_FAN_SPEED): cv.SCRIPT_SCHEMA,
16  vol.Optional(CONF_FAN_SPEED_LIST, default=[]): cv.ensure_list,
17  vol.Optional(CONF_ENTITY_ID): cv.entity_ids,
18  vol.Optional(CONF_UNIQUE_ID): cv.string,
19  }
20  )
21  .extend(TEMPLATE_ENTITY_ATTRIBUTES_SCHEMA_LEGACY.schema)
22  .extend(TEMPLATE_ENTITY_AVAILABILITY_SCHEMA_LEGACY.schema),
23 )

Definition at line 69 of file vacuum.py.