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

Public Member Functions

None async_set_temperature (self, **Any kwargs)
 
None handle_climate_attribute_received (self, str template_name, str attr, ReceiveMessage msg)
 
None prepare_subscribe_topics (self)
 
ReceivePayloadType render_template (self, ReceiveMessage msg, str template_name)
 
- 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)
 
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)
 

Static Public Attributes

 bool
 
- 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
 

Private Member Functions

None _publish (self, str topic, PublishPayloadType payload)
 
bool _set_climate_attribute (self, float|None temp, str cmnd_topic, str cmnd_template, str state_topic, str attr)
 
None _subscribe_topics (self)
 

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
 

Detailed Description

Helper entity class to control temperature.

MqttTemperatureControlEntity supports shared methods for
climate and water_heater platforms.

Definition at line 367 of file climate.py.

Member Function Documentation

◆ _publish()

None homeassistant.components.mqtt.climate.MqttTemperatureControlEntity._publish (   self,
str  topic,
PublishPayloadType  payload 
)
private

Definition at line 457 of file climate.py.

◆ _set_climate_attribute()

bool homeassistant.components.mqtt.climate.MqttTemperatureControlEntity._set_climate_attribute (   self,
float | None  temp,
str  cmnd_topic,
str  cmnd_template,
str  state_topic,
str  attr 
)
private

Definition at line 461 of file climate.py.

◆ _subscribe_topics()

None homeassistant.components.mqtt.climate.MqttTemperatureControlEntity._subscribe_topics (   self)
private
(Re)Subscribe to topics.

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

Definition at line 453 of file climate.py.

◆ async_set_temperature()

None homeassistant.components.mqtt.climate.MqttTemperatureControlEntity.async_set_temperature (   self,
**Any  kwargs 
)
Set new target temperatures.

Reimplemented in homeassistant.components.mqtt.water_heater.MqttWaterHeater, and homeassistant.components.mqtt.climate.MqttClimate.

Definition at line 482 of file climate.py.

◆ handle_climate_attribute_received()

None homeassistant.components.mqtt.climate.MqttTemperatureControlEntity.handle_climate_attribute_received (   self,
str  template_name,
str  attr,
ReceiveMessage   msg 
)
Handle climate attributes coming via MQTT.

Definition at line 392 of file climate.py.

◆ prepare_subscribe_topics()

None homeassistant.components.mqtt.climate.MqttTemperatureControlEntity.prepare_subscribe_topics (   self)
(Re)Subscribe to topics.

Definition at line 412 of file climate.py.

◆ render_template()

ReceivePayloadType homeassistant.components.mqtt.climate.MqttTemperatureControlEntity.render_template (   self,
ReceiveMessage  msg,
str   template_name 
)
Render a template by name.

Definition at line 384 of file climate.py.

Member Data Documentation

◆ bool

homeassistant.components.mqtt.climate.MqttTemperatureControlEntity.bool
static

Definition at line 377 of file climate.py.


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