Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mqtt.binary_sensor.MqttBinarySensor Class Reference
Inheritance diagram for homeassistant.components.mqtt.binary_sensor.MqttBinarySensor:
[legend]
Collaboration diagram for homeassistant.components.mqtt.binary_sensor.MqttBinarySensor:
[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)
 
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_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)
 
dict[str, Any]|None capability_attributes (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)
 
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)
 
- 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.binary_sensor.BinarySensorEntity
None async_internal_added_to_hass (self)
 
- Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (self)
 

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.binary_sensor.BinarySensorEntity
 None
 

Private Attributes

 _attr_device_class
 
 _attr_force_update
 
 _attr_is_on
 
 _delay_listener
 
 _expiration_trigger
 
 _expire_after
 
 _expired
 
 _value_template
 

Static Private Attributes

 _default_name = DEFAULT_NAME
 
 _entity_id_format = binary_sensor.ENTITY_ID_FORMAT
 

Additional Inherited Members

- Static Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttEntity
VolSchemaType config_schema ()
 
- 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.binary_sensor.BinarySensorEntity
 entity_category
 

Detailed Description

Representation a binary sensor that is updated by MQTT.

Definition at line 87 of file binary_sensor.py.

Member Function Documentation

◆ mqtt_async_added_to_hass()

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

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

Definition at line 97 of file binary_sensor.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.mqtt.binary_sensor.MqttBinarySensor._attr_device_class
private

Definition at line 154 of file binary_sensor.py.

◆ _attr_force_update

homeassistant.components.mqtt.binary_sensor.MqttBinarySensor._attr_force_update
private

Definition at line 153 of file binary_sensor.py.

◆ _attr_is_on

homeassistant.components.mqtt.binary_sensor.MqttBinarySensor._attr_is_on
private

Definition at line 117 of file binary_sensor.py.

◆ _default_name

homeassistant.components.mqtt.binary_sensor.MqttBinarySensor._default_name = DEFAULT_NAME
staticprivate

Definition at line 90 of file binary_sensor.py.

◆ _delay_listener

homeassistant.components.mqtt.binary_sensor.MqttBinarySensor._delay_listener
private

Definition at line 164 of file binary_sensor.py.

◆ _entity_id_format

homeassistant.components.mqtt.binary_sensor.MqttBinarySensor._entity_id_format = binary_sensor.ENTITY_ID_FORMAT
staticprivate

Definition at line 92 of file binary_sensor.py.

◆ _expiration_trigger

homeassistant.components.mqtt.binary_sensor.MqttBinarySensor._expiration_trigger
private

Definition at line 119 of file binary_sensor.py.

◆ _expire_after

homeassistant.components.mqtt.binary_sensor.MqttBinarySensor._expire_after
private

Definition at line 148 of file binary_sensor.py.

◆ _expired

homeassistant.components.mqtt.binary_sensor.MqttBinarySensor._expired
private

Definition at line 116 of file binary_sensor.py.

◆ _value_template

homeassistant.components.mqtt.binary_sensor.MqttBinarySensor._value_template
private

Definition at line 156 of file binary_sensor.py.

◆ None

homeassistant.components.mqtt.binary_sensor.MqttBinarySensor.None
static

Definition at line 91 of file binary_sensor.py.


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