Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mqtt.vacuum.MqttStateVacuum Class Reference
Inheritance diagram for homeassistant.components.mqtt.vacuum.MqttStateVacuum:
[legend]
Collaboration diagram for homeassistant.components.mqtt.vacuum.MqttStateVacuum:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, ConfigType config, ConfigEntry config_entry, DiscoveryInfoType|None discovery_data)
 
None async_clean_spot (self, **Any kwargs)
 
None async_locate (self, **Any kwargs)
 
None async_pause (self)
 
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_start (self)
 
None async_stop (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttEntity
bool add_subscription (self, str state_topic_config_key, Callable[[ReceiveMessage], None] msg_callback, set[str]|None tracked_attributes, bool disable_encoding=False)
 
None async_added_to_hass (self)
 
None async_publish (self, str topic, PublishPayloadType payload, int qos=0, bool retain=False, str|None encoding=DEFAULT_ENCODING)
 
None async_publish_with_config (self, str topic, PublishPayloadType payload)
 
None async_will_remove_from_hass (self)
 
None discovery_update (self, MQTTDiscoveryPayload discovery_payload)
 
None mqtt_async_added_to_hass (self)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttAttributesMixin
None __init__ (self, ConfigType config)
 
None attributes_discovery_update (self, DiscoveryInfoType config)
 
None attributes_prepare_discovery_update (self, DiscoveryInfoType config)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (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_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_write_ha_state (self)
 
str|None attribution (self)
 
str|None device_class (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)
 
Mapping[str, Any]|None extra_state_attributes (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 unique_id (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.mqtt.entity.MqttAvailabilityMixin
None __init__ (self, ConfigType config)
 
None async_mqtt_connection_state_changed (self, bool state)
 
None availability_discovery_update (self, DiscoveryInfoType config)
 
None availability_prepare_discovery_update (self, DiscoveryInfoType config)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttDiscoveryUpdateMixin
None __init__ (self, HomeAssistant hass, DiscoveryInfoType|None discovery_data, Callable[[MQTTDiscoveryPayload], Coroutine[Any, Any, None]]|None discovery_update=None)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None async_removed_from_registry (self)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttEntityDeviceInfo
None __init__ (self, dict[str, Any]|None specifications, ConfigEntry config_entry)
 
DeviceInfo|None device_info (self)
 
None device_info_discovery_update (self, DiscoveryInfoType config)
 
- Public Member Functions inherited from homeassistant.components.vacuum.StateVacuumEntity
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)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
None stop (self, **Any kwargs)
 
VacuumEntityFeature supported_features (self)
 
VacuumEntityFeature supported_features_compat (self)
 

Static Public Member Functions

VolSchemaType config_schema ()
 

Private Member Functions

None _async_publish_command (self, VacuumEntityFeature feature)
 
None _prepare_subscribe_topics (self)
 
None _setup_from_config (self, ConfigType config)
 
None _state_message_received (self, ReceiveMessage msg)
 
None _subscribe_topics (self)
 
None _update_state_attributes (self, dict[str, Any] payload)
 

Private Attributes

 _attr_battery_level
 
 _attr_fan_speed
 
 _attr_fan_speed_list
 
 _attr_state
 
 _attr_supported_features
 
 _command_topic
 
 _payloads
 
 _send_command_topic
 
 _set_fan_speed_topic
 

Static Private Attributes

 _attributes_extra_blocked = MQTT_VACUUM_ATTRIBUTES_BLOCKED
 
 _default_name = DEFAULT_NAME
 
 _entity_id_format = ENTITY_ID_FORMAT
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.mqtt.entity.MqttEntity
 hass
 
- 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
 
- Static Public Attributes inherited from homeassistant.components.mqtt.entity.MqttAttributesMixin
 None
 
- 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

Representation of a MQTT-controlled state vacuum.

Definition at line 193 of file vacuum.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum.__init__ (   self,
HomeAssistant  hass,
ConfigType  config,
ConfigEntry  config_entry,
DiscoveryInfoType | None  discovery_data 
)
Initialize the vacuum.

Reimplemented from homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 205 of file vacuum.py.

Member Function Documentation

◆ _async_publish_command()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum._async_publish_command (   self,
VacuumEntityFeature  feature 
)
private
Publish a command.

Definition at line 287 of file vacuum.py.

◆ _prepare_subscribe_topics()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum._prepare_subscribe_topics (   self)
private
(Re)Subscribe to topics.

Reimplemented from homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 275 of file vacuum.py.

◆ _setup_from_config()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum._setup_from_config (   self,
ConfigType  config 
)
private
(Re)Setup the entity.

Reimplemented from homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 222 of file vacuum.py.

◆ _state_message_received()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum._state_message_received (   self,
ReceiveMessage  msg 
)
private
Handle state MQTT message.

Definition at line 262 of file vacuum.py.

◆ _subscribe_topics()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum._subscribe_topics (   self)
private
(Re)Subscribe to topics.

Reimplemented from homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 283 of file vacuum.py.

◆ _update_state_attributes()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum._update_state_attributes (   self,
dict[str, Any]  payload 
)
private
Update the entity state attributes.

Definition at line 255 of file vacuum.py.

◆ async_clean_spot()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum.async_clean_spot (   self,
**Any  kwargs 
)
Perform a spot clean-up.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 312 of file vacuum.py.

◆ async_locate()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum.async_locate (   self,
**Any  kwargs 
)
Locate the vacuum (usually by playing a song).

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 316 of file vacuum.py.

◆ async_pause()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum.async_pause (   self)
Pause the vacuum.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 300 of file vacuum.py.

◆ async_return_to_base()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum.async_return_to_base (   self,
**Any  kwargs 
)
Tell the vacuum to return to its dock.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 308 of file vacuum.py.

◆ async_send_command()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum.async_send_command (   self,
str  command,
dict[str, Any] | list[Any] | None   params = None,
**Any  kwargs 
)
Send a command to a vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 330 of file vacuum.py.

◆ async_set_fan_speed()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum.async_set_fan_speed (   self,
str  fan_speed,
**Any  kwargs 
)
Set fan speed.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 320 of file vacuum.py.

◆ async_start()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum.async_start (   self)
Start the vacuum.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 296 of file vacuum.py.

◆ async_stop()

None homeassistant.components.mqtt.vacuum.MqttStateVacuum.async_stop (   self,
**Any  kwargs 
)
Stop the vacuum.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 304 of file vacuum.py.

◆ config_schema()

VolSchemaType homeassistant.components.mqtt.vacuum.MqttStateVacuum.config_schema ( )
static
Return the config schema.

Reimplemented from homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 218 of file vacuum.py.

Member Data Documentation

◆ _attr_battery_level

homeassistant.components.mqtt.vacuum.MqttStateVacuum._attr_battery_level
private

Definition at line 259 of file vacuum.py.

◆ _attr_fan_speed

homeassistant.components.mqtt.vacuum.MqttStateVacuum._attr_fan_speed
private

Definition at line 258 of file vacuum.py.

◆ _attr_fan_speed_list

homeassistant.components.mqtt.vacuum.MqttStateVacuum._attr_fan_speed_list
private

Definition at line 238 of file vacuum.py.

◆ _attr_state

homeassistant.components.mqtt.vacuum.MqttStateVacuum._attr_state
private

Definition at line 268 of file vacuum.py.

◆ _attr_supported_features

homeassistant.components.mqtt.vacuum.MqttStateVacuum._attr_supported_features
private

Definition at line 235 of file vacuum.py.

◆ _attributes_extra_blocked

homeassistant.components.mqtt.vacuum.MqttStateVacuum._attributes_extra_blocked = MQTT_VACUUM_ATTRIBUTES_BLOCKED
staticprivate

Definition at line 198 of file vacuum.py.

◆ _command_topic

homeassistant.components.mqtt.vacuum.MqttStateVacuum._command_topic
private

Definition at line 239 of file vacuum.py.

◆ _default_name

homeassistant.components.mqtt.vacuum.MqttStateVacuum._default_name = DEFAULT_NAME
staticprivate

Definition at line 196 of file vacuum.py.

◆ _entity_id_format

homeassistant.components.mqtt.vacuum.MqttStateVacuum._entity_id_format = ENTITY_ID_FORMAT
staticprivate

Definition at line 197 of file vacuum.py.

◆ _payloads

homeassistant.components.mqtt.vacuum.MqttStateVacuum._payloads
private

Definition at line 243 of file vacuum.py.

◆ _send_command_topic

homeassistant.components.mqtt.vacuum.MqttStateVacuum._send_command_topic
private

Definition at line 241 of file vacuum.py.

◆ _set_fan_speed_topic

homeassistant.components.mqtt.vacuum.MqttStateVacuum._set_fan_speed_topic
private

Definition at line 240 of file vacuum.py.


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