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

Public Member Functions

None async_set_value (self, str value)
 
- 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)
 
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)
 
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.text.TextEntity
dict[str, Any] capability_attributes (self)
 
int max (self)
 
int min (self)
 
TextMode mode (self)
 
int native_max (self)
 
int native_min (self)
 
str|None native_value (self)
 
str|None pattern (self)
 
re.Pattern|None pattern_cmp (self)
 
None set_value (self, str value)
 
str|None state (self)
 

Static Public Member Functions

VolSchemaType config_schema ()
 

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.text.TextEntity
 None
 

Private Member Functions

None _handle_state_message_received (self, ReceiveMessage msg)
 
None _prepare_subscribe_topics (self)
 
None _setup_from_config (self, ConfigType config)
 
None _subscribe_topics (self)
 

Private Attributes

 _attr_assumed_state
 
 _attr_mode
 
 _attr_native_max
 
 _attr_native_min
 
 _attr_native_value
 
 _attr_pattern
 
 _command_template
 
 _compiled_pattern
 
 _optimistic
 
 _value_template
 

Static Private Attributes

 _attributes_extra_blocked = MQTT_TEXT_ATTRIBUTES_BLOCKED
 
 _default_name = DEFAULT_NAME
 
 _entity_id_format = text.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
 

Detailed Description

Representation of the MQTT text entity.

Definition at line 112 of file text.py.

Member Function Documentation

◆ _handle_state_message_received()

None homeassistant.components.mqtt.text.MqttTextEntity._handle_state_message_received (   self,
ReceiveMessage  msg 
)
private
Handle receiving state message via MQTT.

Definition at line 153 of file text.py.

◆ _prepare_subscribe_topics()

None homeassistant.components.mqtt.text.MqttTextEntity._prepare_subscribe_topics (   self)
private
(Re)Subscribe to topics.

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

Definition at line 161 of file text.py.

◆ _setup_from_config()

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

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

Definition at line 130 of file text.py.

◆ _subscribe_topics()

None homeassistant.components.mqtt.text.MqttTextEntity._subscribe_topics (   self)
private
(Re)Subscribe to topics.

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

Definition at line 169 of file text.py.

◆ async_set_value()

None homeassistant.components.mqtt.text.MqttTextEntity.async_set_value (   self,
str  value 
)
Change the text.

Reimplemented from homeassistant.components.text.TextEntity.

Definition at line 173 of file text.py.

◆ config_schema()

VolSchemaType homeassistant.components.mqtt.text.MqttTextEntity.config_schema ( )
static
Return the config schema.

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

Definition at line 126 of file text.py.

Member Data Documentation

◆ _attr_assumed_state

homeassistant.components.mqtt.text.MqttTextEntity._attr_assumed_state
private

Definition at line 150 of file text.py.

◆ _attr_mode

homeassistant.components.mqtt.text.MqttTextEntity._attr_mode
private

Definition at line 134 of file text.py.

◆ _attr_native_max

homeassistant.components.mqtt.text.MqttTextEntity._attr_native_max
private

Definition at line 132 of file text.py.

◆ _attr_native_min

homeassistant.components.mqtt.text.MqttTextEntity._attr_native_min
private

Definition at line 133 of file text.py.

◆ _attr_native_value

homeassistant.components.mqtt.text.MqttTextEntity._attr_native_value
private

Definition at line 158 of file text.py.

◆ _attr_pattern

homeassistant.components.mqtt.text.MqttTextEntity._attr_pattern
private

Definition at line 136 of file text.py.

◆ _attributes_extra_blocked

homeassistant.components.mqtt.text.MqttTextEntity._attributes_extra_blocked = MQTT_TEXT_ATTRIBUTES_BLOCKED
staticprivate

Definition at line 116 of file text.py.

◆ _command_template

homeassistant.components.mqtt.text.MqttTextEntity._command_template
private

Definition at line 140 of file text.py.

◆ _compiled_pattern

homeassistant.components.mqtt.text.MqttTextEntity._compiled_pattern
private

Definition at line 135 of file text.py.

◆ _default_name

homeassistant.components.mqtt.text.MqttTextEntity._default_name = DEFAULT_NAME
staticprivate

Definition at line 117 of file text.py.

◆ _entity_id_format

homeassistant.components.mqtt.text.MqttTextEntity._entity_id_format = text.ENTITY_ID_FORMAT
staticprivate

Definition at line 118 of file text.py.

◆ _optimistic

homeassistant.components.mqtt.text.MqttTextEntity._optimistic
private

Definition at line 149 of file text.py.

◆ _value_template

homeassistant.components.mqtt.text.MqttTextEntity._value_template
private

Definition at line 144 of file text.py.

◆ None

homeassistant.components.mqtt.text.MqttTextEntity.None
static

Definition at line 115 of file text.py.


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