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

Classes

class  StateDemoVacuum
 

Functions

None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 

Variables

string DEMO_VACUUM_BASIC = "2_Second_floor"
 
string DEMO_VACUUM_COMPLETE = "0_Ground_floor"
 
string DEMO_VACUUM_MINIMAL = "3_Third_floor"
 
string DEMO_VACUUM_MOST = "1_First_floor"
 
string DEMO_VACUUM_NONE = "4_Fourth_floor"
 
list FAN_SPEEDS = ["min", "medium", "high", "max"]
 
tuple SUPPORT_ALL_SERVICES
 
tuple SUPPORT_BASIC_SERVICES
 
 SUPPORT_MINIMAL_SERVICES = VacuumEntityFeature.TURN_ON | VacuumEntityFeature.TURN_OFF
 
tuple SUPPORT_MOST_SERVICES
 

Detailed Description

Demo platform for the vacuum component.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.demo.vacuum.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Set up the Demo config entry.

Definition at line 67 of file vacuum.py.

Variable Documentation

◆ DEMO_VACUUM_BASIC

string homeassistant.components.demo.vacuum.DEMO_VACUUM_BASIC = "2_Second_floor"

Definition at line 62 of file vacuum.py.

◆ DEMO_VACUUM_COMPLETE

string homeassistant.components.demo.vacuum.DEMO_VACUUM_COMPLETE = "0_Ground_floor"

Definition at line 60 of file vacuum.py.

◆ DEMO_VACUUM_MINIMAL

string homeassistant.components.demo.vacuum.DEMO_VACUUM_MINIMAL = "3_Third_floor"

Definition at line 63 of file vacuum.py.

◆ DEMO_VACUUM_MOST

string homeassistant.components.demo.vacuum.DEMO_VACUUM_MOST = "1_First_floor"

Definition at line 61 of file vacuum.py.

◆ DEMO_VACUUM_NONE

string homeassistant.components.demo.vacuum.DEMO_VACUUM_NONE = "4_Fourth_floor"

Definition at line 64 of file vacuum.py.

◆ FAN_SPEEDS

list homeassistant.components.demo.vacuum.FAN_SPEEDS = ["min", "medium", "high", "max"]

Definition at line 59 of file vacuum.py.

◆ SUPPORT_ALL_SERVICES

tuple homeassistant.components.demo.vacuum.SUPPORT_ALL_SERVICES
Initial value:
1 = (
2  VacuumEntityFeature.STATE
3  | VacuumEntityFeature.START
4  | VacuumEntityFeature.STOP
5  | VacuumEntityFeature.PAUSE
6  | VacuumEntityFeature.STOP
7  | VacuumEntityFeature.RETURN_HOME
8  | VacuumEntityFeature.FAN_SPEED
9  | VacuumEntityFeature.SEND_COMMAND
10  | VacuumEntityFeature.LOCATE
11  | VacuumEntityFeature.STATUS
12  | VacuumEntityFeature.BATTERY
13  | VacuumEntityFeature.LOCATE
14  | VacuumEntityFeature.MAP
15  | VacuumEntityFeature.CLEAN_SPOT
16 )

Definition at line 42 of file vacuum.py.

◆ SUPPORT_BASIC_SERVICES

tuple homeassistant.components.demo.vacuum.SUPPORT_BASIC_SERVICES
Initial value:
1 = (
2  VacuumEntityFeature.STATE
3  | VacuumEntityFeature.START
4  | VacuumEntityFeature.STOP
5  | VacuumEntityFeature.BATTERY
6 )

Definition at line 25 of file vacuum.py.

◆ SUPPORT_MINIMAL_SERVICES

homeassistant.components.demo.vacuum.SUPPORT_MINIMAL_SERVICES = VacuumEntityFeature.TURN_ON | VacuumEntityFeature.TURN_OFF

Definition at line 23 of file vacuum.py.

◆ SUPPORT_MOST_SERVICES

tuple homeassistant.components.demo.vacuum.SUPPORT_MOST_SERVICES
Initial value:
1 = (
2  VacuumEntityFeature.STATE
3  | VacuumEntityFeature.START
4  | VacuumEntityFeature.STOP
5  | VacuumEntityFeature.PAUSE
6  | VacuumEntityFeature.RETURN_HOME
7  | VacuumEntityFeature.BATTERY
8  | VacuumEntityFeature.FAN_SPEED
9 )

Definition at line 32 of file vacuum.py.