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

Public Member Functions

None __init__ (self, ConfigType config)
 
None async_added_to_hass (self)
 
None async_mqtt_connection_state_changed (self, bool state)
 
None async_will_remove_from_hass (self)
 
None availability_discovery_update (self, DiscoveryInfoType config)
 
None availability_prepare_discovery_update (self, DiscoveryInfoType config)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (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_removed_from_registry (self)
 
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)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (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)
 
StateType state (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (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)
 

Private Member Functions

None _availability_message_received (self, ReceiveMessage msg)
 
None _availability_prepare_subscribe_topics (self)
 
None _availability_setup_from_config (self, ConfigType config)
 
None _availability_subscribe_topics (self)
 

Private Attributes

 _avail_config
 
 _availability_sub_state
 
 _available
 
 _available_latest
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Mixin used for platforms that report availability.

Definition at line 446 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.mqtt.entity.MqttAvailabilityMixin.__init__ (   self,
ConfigType  config 
)
Initialize the availability mixin.

Definition at line 449 of file entity.py.

Member Function Documentation

◆ _availability_message_received()

None homeassistant.components.mqtt.entity.MqttAvailabilityMixin._availability_message_received (   self,
ReceiveMessage  msg 
)
private
Handle a new received MQTT availability message.

Definition at line 533 of file entity.py.

◆ _availability_prepare_subscribe_topics()

None homeassistant.components.mqtt.entity.MqttAvailabilityMixin._availability_prepare_subscribe_topics (   self)
private
(Re)Subscribe to topics.

Definition at line 505 of file entity.py.

◆ _availability_setup_from_config()

None homeassistant.components.mqtt.entity.MqttAvailabilityMixin._availability_setup_from_config (   self,
ConfigType  config 
)
private
(Re)Setup.

Definition at line 478 of file entity.py.

◆ _availability_subscribe_topics()

None homeassistant.components.mqtt.entity.MqttAvailabilityMixin._availability_subscribe_topics (   self)
private
(Re)Subscribe to topics.

Definition at line 548 of file entity.py.

◆ async_added_to_hass()

None homeassistant.components.mqtt.entity.MqttAvailabilityMixin.async_added_to_hass (   self)
Subscribe MQTT events.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 456 of file entity.py.

◆ async_mqtt_connection_state_changed()

None homeassistant.components.mqtt.entity.MqttAvailabilityMixin.async_mqtt_connection_state_changed (   self,
bool  state 
)
Update state on connection/disconnection to MQTT broker.

Definition at line 553 of file entity.py.

◆ async_will_remove_from_hass()

None homeassistant.components.mqtt.entity.MqttAvailabilityMixin.async_will_remove_from_hass (   self)
Unsubscribe when removed.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 558 of file entity.py.

◆ availability_discovery_update()

None homeassistant.components.mqtt.entity.MqttAvailabilityMixin.availability_discovery_update (   self,
DiscoveryInfoType  config 
)
Handle updated discovery message.

Definition at line 474 of file entity.py.

◆ availability_prepare_discovery_update()

None homeassistant.components.mqtt.entity.MqttAvailabilityMixin.availability_prepare_discovery_update (   self,
DiscoveryInfoType  config 
)
Handle updated discovery message.

Definition at line 469 of file entity.py.

◆ available()

bool homeassistant.components.mqtt.entity.MqttAvailabilityMixin.available (   self)
Return if the device is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 565 of file entity.py.

Member Data Documentation

◆ _avail_config

homeassistant.components.mqtt.entity.MqttAvailabilityMixin._avail_config
private

Definition at line 503 of file entity.py.

◆ _availability_sub_state

homeassistant.components.mqtt.entity.MqttAvailabilityMixin._availability_sub_state
private

Definition at line 526 of file entity.py.

◆ _available

homeassistant.components.mqtt.entity.MqttAvailabilityMixin._available
private

Definition at line 507 of file entity.py.

◆ _available_latest

homeassistant.components.mqtt.entity.MqttAvailabilityMixin._available_latest
private

Definition at line 542 of file entity.py.


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