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

Public Member Functions

None __init__ (self, ConfigType config)
 
None async_added_to_hass (self)
 
None async_will_remove_from_hass (self)
 
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_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)
 
bool available (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)
 

Static Public Attributes

 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Member Functions

None _attributes_message_received (self, ReceiveMessage msg)
 
None _attributes_prepare_subscribe_topics (self)
 
None _attributes_subscribe_topics (self)
 

Private Attributes

 _attr_extra_state_attributes
 
 _attr_tpl
 
 _attributes_config
 
 _attributes_sub_state
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Detailed Description

Mixin used for platforms that support JSON attributes.

Definition at line 361 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.mqtt.entity.MqttAttributesMixin.__init__ (   self,
ConfigType  config 
)
Initialize the JSON attributes mixin.

Definition at line 367 of file entity.py.

Member Function Documentation

◆ _attributes_message_received()

None homeassistant.components.mqtt.entity.MqttAttributesMixin._attributes_message_received (   self,
ReceiveMessage  msg 
)
private
Update extra state attributes.

Definition at line 424 of file entity.py.

◆ _attributes_prepare_subscribe_topics()

None homeassistant.components.mqtt.entity.MqttAttributesMixin._attributes_prepare_subscribe_topics (   self)
private
(Re)Subscribe to topics.

Definition at line 387 of file entity.py.

◆ _attributes_subscribe_topics()

None homeassistant.components.mqtt.entity.MqttAttributesMixin._attributes_subscribe_topics (   self)
private
(Re)Subscribe to topics.

Definition at line 413 of file entity.py.

◆ async_added_to_hass()

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

Reimplemented from homeassistant.helpers.entity.Entity.

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

Definition at line 372 of file entity.py.

◆ async_will_remove_from_hass()

None homeassistant.components.mqtt.entity.MqttAttributesMixin.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 417 of file entity.py.

◆ attributes_discovery_update()

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

Definition at line 383 of file entity.py.

◆ attributes_prepare_discovery_update()

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

Definition at line 378 of file entity.py.

Member Data Documentation

◆ _attr_extra_state_attributes

homeassistant.components.mqtt.entity.MqttAttributesMixin._attr_extra_state_attributes
private

Definition at line 441 of file entity.py.

◆ _attr_tpl

homeassistant.components.mqtt.entity.MqttAttributesMixin._attr_tpl
private

Definition at line 390 of file entity.py.

◆ _attributes_config

homeassistant.components.mqtt.entity.MqttAttributesMixin._attributes_config
private

Definition at line 370 of file entity.py.

◆ _attributes_sub_state

homeassistant.components.mqtt.entity.MqttAttributesMixin._attributes_sub_state
private

Definition at line 393 of file entity.py.

◆ None

homeassistant.components.mqtt.entity.MqttAttributesMixin.None
static

Definition at line 365 of file entity.py.


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