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

Public Member Functions

None mqtt_async_added_to_hass (self)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttEntity
None __init__ (self, HomeAssistant hass, ConfigType config, ConfigEntry config_entry, DiscoveryInfoType|None discovery_data)
 
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)
 
- 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)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
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)
 
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)
 
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)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (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.sensor.RestoreSensor
SensorExtraStoredData|None async_get_last_sensor_data (self)
 
SensorExtraStoredData extra_restore_state_data (self)
 
- Public Member Functions inherited from homeassistant.components.sensor.SensorEntity
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
None async_internal_added_to_hass (self)
 
None async_registry_entry_updated (self)
 
dict[str, Any]|None capability_attributes (self)
 
SensorDeviceClass|None device_class (self)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
datetime|None last_reset (self)
 
str|None native_unit_of_measurement (self)
 
StateType|date|datetime|Decimal native_value (self)
 
list[str]|None options (self)
 
Any state (self)
 
dict[str, Any]|None state_attributes (self)
 
SensorStateClass|str|None state_class (self)
 
int|None suggested_display_precision (self)
 
str|None suggested_unit_of_measurement (self)
 
str|None unit_of_measurement (self)
 

Public Attributes

 device_class
 
- 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.sensor.SensorEntity
 entity_category
 
 registry_entry
 
 unit_of_measurement
 

Static Public Attributes

 None
 
- 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.sensor.SensorEntity
 Decimal
 
 None
 
 UndefinedType
 

Private Attributes

 _attr_device_class
 
 _attr_force_update
 
 _attr_last_reset
 
 _attr_native_unit_of_measurement
 
 _attr_native_value
 
 _attr_options
 
 _attr_state_class
 
 _attr_suggested_display_precision
 
 _expiration_trigger
 
 _expire_after
 
 _expired
 
 _last_reset_template
 
 _template
 

Static Private Attributes

 _attributes_extra_blocked = MQTT_SENSOR_ATTRIBUTES_BLOCKED
 
 _default_name = DEFAULT_NAME
 
 _entity_id_format = ENTITY_ID_FORMAT
 

Additional Inherited Members

- Static Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttEntity
VolSchemaType config_schema ()
 

Detailed Description

Representation of a sensor that can be updated using MQTT.

Definition at line 141 of file sensor.py.

Member Function Documentation

◆ mqtt_async_added_to_hass()

None homeassistant.components.mqtt.sensor.MqttSensor.mqtt_async_added_to_hass (   self)
Restore state for entities with expire_after set.

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

Definition at line 158 of file sensor.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.mqtt.sensor.MqttSensor._attr_device_class
private

Definition at line 211 of file sensor.py.

◆ _attr_force_update

homeassistant.components.mqtt.sensor.MqttSensor._attr_force_update
private

Definition at line 212 of file sensor.py.

◆ _attr_last_reset

homeassistant.components.mqtt.sensor.MqttSensor._attr_last_reset
private

Definition at line 315 of file sensor.py.

◆ _attr_native_unit_of_measurement

homeassistant.components.mqtt.sensor.MqttSensor._attr_native_unit_of_measurement
private

Definition at line 216 of file sensor.py.

◆ _attr_native_value

homeassistant.components.mqtt.sensor.MqttSensor._attr_native_value
private

Definition at line 181 of file sensor.py.

◆ _attr_options

homeassistant.components.mqtt.sensor.MqttSensor._attr_options
private

Definition at line 217 of file sensor.py.

◆ _attr_state_class

homeassistant.components.mqtt.sensor.MqttSensor._attr_state_class
private

Definition at line 218 of file sensor.py.

◆ _attr_suggested_display_precision

homeassistant.components.mqtt.sensor.MqttSensor._attr_suggested_display_precision
private

Definition at line 213 of file sensor.py.

◆ _attributes_extra_blocked

homeassistant.components.mqtt.sensor.MqttSensor._attributes_extra_blocked = MQTT_SENSOR_ATTRIBUTES_BLOCKED
staticprivate

Definition at line 147 of file sensor.py.

◆ _default_name

homeassistant.components.mqtt.sensor.MqttSensor._default_name = DEFAULT_NAME
staticprivate

Definition at line 144 of file sensor.py.

◆ _entity_id_format

homeassistant.components.mqtt.sensor.MqttSensor._entity_id_format = ENTITY_ID_FORMAT
staticprivate

Definition at line 145 of file sensor.py.

◆ _expiration_trigger

homeassistant.components.mqtt.sensor.MqttSensor._expiration_trigger
private

Definition at line 183 of file sensor.py.

◆ _expire_after

homeassistant.components.mqtt.sensor.MqttSensor._expire_after
private

Definition at line 220 of file sensor.py.

◆ _expired

homeassistant.components.mqtt.sensor.MqttSensor._expired
private

Definition at line 180 of file sensor.py.

◆ _last_reset_template

homeassistant.components.mqtt.sensor.MqttSensor._last_reset_template
private

Definition at line 231 of file sensor.py.

◆ _template

homeassistant.components.mqtt.sensor.MqttSensor._template
private

Definition at line 227 of file sensor.py.

◆ device_class

homeassistant.components.mqtt.sensor.MqttSensor.device_class

Definition at line 299 of file sensor.py.

◆ None

homeassistant.components.mqtt.sensor.MqttSensor.None
static

Definition at line 146 of file sensor.py.


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