Home Assistant Unofficial Reference 2024.12.1
vacuum.py File Reference

Go to the source code of this file.

Classes

class  homeassistant.components.mqtt.vacuum.MqttStateVacuum
 

Namespaces

 homeassistant.components.mqtt.vacuum
 

Functions

None homeassistant.components.mqtt.vacuum.async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 
list[str] homeassistant.components.mqtt.vacuum.services_to_strings (VacuumEntityFeature services, dict[VacuumEntityFeature, str] service_to_string)
 

Variables

dictionary homeassistant.components.mqtt.vacuum._FEATURE_PAYLOADS
 
 homeassistant.components.mqtt.vacuum._LOGGER = logging.getLogger(__name__)
 
tuple homeassistant.components.mqtt.vacuum.ALL_SERVICES
 
string homeassistant.components.mqtt.vacuum.BATTERY = "battery_level"
 
string homeassistant.components.mqtt.vacuum.CONF_FAN_SPEED_LIST = "fan_speed_list"
 
string homeassistant.components.mqtt.vacuum.CONF_PAYLOAD_CLEAN_SPOT = "payload_clean_spot"
 
string homeassistant.components.mqtt.vacuum.CONF_PAYLOAD_LOCATE = "payload_locate"
 
string homeassistant.components.mqtt.vacuum.CONF_PAYLOAD_PAUSE = "payload_pause"
 
string homeassistant.components.mqtt.vacuum.CONF_PAYLOAD_RETURN_TO_BASE = "payload_return_to_base"
 
string homeassistant.components.mqtt.vacuum.CONF_PAYLOAD_START = "payload_start"
 
string homeassistant.components.mqtt.vacuum.CONF_PAYLOAD_STOP = "payload_stop"
 
string homeassistant.components.mqtt.vacuum.CONF_PAYLOAD_TURN_OFF = "payload_turn_off"
 
string homeassistant.components.mqtt.vacuum.CONF_PAYLOAD_TURN_ON = "payload_turn_on"
 
string homeassistant.components.mqtt.vacuum.CONF_SEND_COMMAND_TOPIC = "send_command_topic"
 
string homeassistant.components.mqtt.vacuum.CONF_SET_FAN_SPEED_TOPIC = "set_fan_speed_topic"
 
 homeassistant.components.mqtt.vacuum.CONF_SUPPORTED_FEATURES = ATTR_SUPPORTED_FEATURES
 
string homeassistant.components.mqtt.vacuum.DEFAULT_NAME = "MQTT State Vacuum"
 
string homeassistant.components.mqtt.vacuum.DEFAULT_PAYLOAD_CLEAN_SPOT = "clean_spot"
 
string homeassistant.components.mqtt.vacuum.DEFAULT_PAYLOAD_LOCATE = "locate"
 
string homeassistant.components.mqtt.vacuum.DEFAULT_PAYLOAD_PAUSE = "pause"
 
string homeassistant.components.mqtt.vacuum.DEFAULT_PAYLOAD_RETURN_TO_BASE = "return_to_base"
 
string homeassistant.components.mqtt.vacuum.DEFAULT_PAYLOAD_START = "start"
 
string homeassistant.components.mqtt.vacuum.DEFAULT_PAYLOAD_STOP = "stop"
 
bool homeassistant.components.mqtt.vacuum.DEFAULT_RETAIN = False
 
list[str] homeassistant.components.mqtt.vacuum.DEFAULT_SERVICE_STRINGS = services_to_strings(DEFAULT_SERVICES, SERVICE_TO_STRING)
 
tuple homeassistant.components.mqtt.vacuum.DEFAULT_SERVICES
 
 homeassistant.components.mqtt.vacuum.DISCOVERY_SCHEMA = PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.ALLOW_EXTRA)
 
string homeassistant.components.mqtt.vacuum.FAN_SPEED = "fan_speed"
 
 homeassistant.components.mqtt.vacuum.MQTT_VACUUM_ATTRIBUTES_BLOCKED
 
string homeassistant.components.mqtt.vacuum.MQTT_VACUUM_DOCS_URL = "https://www.home-assistant.io/integrations/vacuum.mqtt/"
 
int homeassistant.components.mqtt.vacuum.PARALLEL_UPDATES = 0
 
 homeassistant.components.mqtt.vacuum.PLATFORM_SCHEMA_MODERN
 
string homeassistant.components.mqtt.vacuum.STATE = "state"
 
dictionary homeassistant.components.mqtt.vacuum.STRING_TO_SERVICE = {v: k for k, v in SERVICE_TO_STRING.items()}