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

Public Member Functions

None async_set_fan_mode (self, str fan_mode)
 
None async_set_humidity (self, float humidity)
 
None async_set_hvac_mode (self, HVACMode hvac_mode)
 
None async_set_preset_mode (self, str preset_mode)
 
None async_set_swing_mode (self, str swing_mode)
 
None async_set_temperature (self, **Any kwargs)
 
None async_turn_off (self)
 
None async_turn_on (self)
 
- Public Member Functions inherited from homeassistant.components.mqtt.climate.MqttTemperatureControlEntity
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)
 
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)
 
str|None suggested_object_id (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.climate.ClimateEntity
Any __getattribute__ (self, str name)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
None async_handle_set_fan_mode_service (self, str fan_mode)
 
None async_handle_set_hvac_mode_service (self, HVACMode hvac_mode)
 
None async_handle_set_preset_mode_service (self, str preset_mode)
 
None async_handle_set_swing_horizontal_mode_service (self, str swing_horizontal_mode)
 
None async_handle_set_swing_mode_service (self, str swing_mode)
 
None async_set_humidity (self, int humidity)
 
None async_set_swing_horizontal_mode (self, str swing_horizontal_mode)
 
None async_toggle (self)
 
None async_turn_aux_heat_off (self)
 
None async_turn_aux_heat_on (self)
 
dict[str, Any]|None capability_attributes (self)
 
float|None current_humidity (self)
 
float|None current_temperature (self)
 
str|None fan_mode (self)
 
list[str]|None fan_modes (self)
 
HVACAction|None hvac_action (self)
 
HVACMode|None hvac_mode (self)
 
list[HVACMode] hvac_modes (self)
 
bool|None is_aux_heat (self)
 
float max_humidity (self)
 
float max_temp (self)
 
float min_humidity (self)
 
float min_temp (self)
 
float precision (self)
 
str|None preset_mode (self)
 
list[str]|None preset_modes (self)
 
None set_fan_mode (self, str fan_mode)
 
None set_humidity (self, int humidity)
 
None set_hvac_mode (self, HVACMode hvac_mode)
 
None set_preset_mode (self, str preset_mode)
 
None set_swing_horizontal_mode (self, str swing_horizontal_mode)
 
None set_swing_mode (self, str swing_mode)
 
None set_temperature (self, **Any kwargs)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
ClimateEntityFeature supported_features (self)
 
str|None swing_horizontal_mode (self)
 
list[str]|None swing_horizontal_modes (self)
 
str|None swing_mode (self)
 
list[str]|None swing_modes (self)
 
float|None target_humidity (self)
 
float|None target_temperature (self)
 
float|None target_temperature_high (self)
 
float|None target_temperature_low (self)
 
float|None target_temperature_step (self)
 
str temperature_unit (self)
 
None toggle (self)
 
None turn_aux_heat_off (self)
 
None turn_aux_heat_on (self)
 
None turn_off (self)
 
None turn_on (self)
 

Static Public Member Functions

VolSchemaType config_schema ()
 

Static Public Attributes

 None
 
- Static Public Attributes inherited from homeassistant.components.mqtt.climate.MqttTemperatureControlEntity
 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
 
- Static Public Attributes inherited from homeassistant.components.climate.ClimateEntity
 bool
 
 ClimateEntityFeature
 
 float
 
 None
 

Private Member Functions

None _handle_action_received (self, ReceiveMessage msg)
 
None _handle_mode_received (self, str template_name, str attr, str mode_list, ReceiveMessage msg)
 
None _handle_preset_mode_received (self, ReceiveMessage msg)
 
None _prepare_subscribe_topics (self)
 
None _setup_from_config (self, ConfigType config)
 

Private Attributes

 _attr_fan_mode
 
 _attr_fan_modes
 
 _attr_hvac_action
 
 _attr_hvac_mode
 
 _attr_hvac_modes
 
 _attr_max_humidity
 
 _attr_max_temp
 
 _attr_min_humidity
 
 _attr_min_temp
 
 _attr_precision
 
 _attr_preset_mode
 
 _attr_preset_modes
 
 _attr_supported_features
 
 _attr_swing_mode
 
 _attr_swing_modes
 
 _attr_target_temperature
 
 _attr_target_temperature_high
 
 _attr_target_temperature_low
 
 _attr_target_temperature_step
 
 _attr_temperature_unit
 
 _command_templates
 
 _feature_preset_mode
 
 _optimistic
 
 _optimistic_preset_mode
 
 _topic
 
 _value_templates
 

Static Private Attributes

 _attributes_extra_blocked = MQTT_CLIMATE_ATTRIBUTES_BLOCKED
 
 _default_name = DEFAULT_NAME
 
bool _enable_turn_on_off_backwards_compatibility = False
 
 _entity_id_format = climate.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
 
- Public Attributes inherited from homeassistant.components.climate.ClimateEntity
 hvac_mode
 

Detailed Description

Representation of an MQTT climate device.

Definition at line 513 of file climate.py.

Member Function Documentation

◆ _handle_action_received()

None homeassistant.components.mqtt.climate.MqttClimate._handle_action_received (   self,
ReceiveMessage  msg 
)
private
Handle receiving action via MQTT.

Definition at line 644 of file climate.py.

◆ _handle_mode_received()

None homeassistant.components.mqtt.climate.MqttClimate._handle_mode_received (   self,
str  template_name,
str  attr,
str  mode_list,
ReceiveMessage   msg 
)
private
Handle receiving listed mode via MQTT.

Definition at line 668 of file climate.py.

◆ _handle_preset_mode_received()

None homeassistant.components.mqtt.climate.MqttClimate._handle_preset_mode_received (   self,
ReceiveMessage  msg 
)
private
Handle receiving preset mode via MQTT.

Definition at line 682 of file climate.py.

◆ _prepare_subscribe_topics()

None homeassistant.components.mqtt.climate.MqttClimate._prepare_subscribe_topics (   self)
private
(Re)Subscribe to topics.

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

Definition at line 702 of file climate.py.

◆ _setup_from_config()

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

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

Definition at line 531 of file climate.py.

◆ async_set_fan_mode()

None homeassistant.components.mqtt.climate.MqttClimate.async_set_fan_mode (   self,
str  fan_mode 
)
Set new target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 795 of file climate.py.

◆ async_set_humidity()

None homeassistant.components.mqtt.climate.MqttClimate.async_set_humidity (   self,
float  humidity 
)
Set new target humidity.

Definition at line 773 of file climate.py.

◆ async_set_hvac_mode()

None homeassistant.components.mqtt.climate.MqttClimate.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set new operation mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 804 of file climate.py.

◆ async_set_preset_mode()

None homeassistant.components.mqtt.climate.MqttClimate.async_set_preset_mode (   self,
str  preset_mode 
)
Set a preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 813 of file climate.py.

◆ async_set_swing_mode()

None homeassistant.components.mqtt.climate.MqttClimate.async_set_swing_mode (   self,
str  swing_mode 
)
Set new swing mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 786 of file climate.py.

◆ async_set_temperature()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 766 of file climate.py.

◆ async_turn_off()

None homeassistant.components.mqtt.climate.MqttClimate.async_turn_off (   self)
Turn the entity off.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 838 of file climate.py.

◆ async_turn_on()

None homeassistant.components.mqtt.climate.MqttClimate.async_turn_on (   self)
Turn the entity on.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 827 of file climate.py.

◆ config_schema()

VolSchemaType homeassistant.components.mqtt.climate.MqttClimate.config_schema ( )
static
Return the config schema.

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

Definition at line 527 of file climate.py.

Member Data Documentation

◆ _attr_fan_mode

homeassistant.components.mqtt.climate.MqttClimate._attr_fan_mode
private

Definition at line 571 of file climate.py.

◆ _attr_fan_modes

homeassistant.components.mqtt.climate.MqttClimate._attr_fan_modes
private

Definition at line 546 of file climate.py.

◆ _attr_hvac_action

homeassistant.components.mqtt.climate.MqttClimate._attr_hvac_action
private

Definition at line 655 of file climate.py.

◆ _attr_hvac_mode

homeassistant.components.mqtt.climate.MqttClimate._attr_hvac_mode
private

Definition at line 575 of file climate.py.

◆ _attr_hvac_modes

homeassistant.components.mqtt.climate.MqttClimate._attr_hvac_modes
private

Definition at line 533 of file climate.py.

◆ _attr_max_humidity

homeassistant.components.mqtt.climate.MqttClimate._attr_max_humidity
private

Definition at line 543 of file climate.py.

◆ _attr_max_temp

homeassistant.components.mqtt.climate.MqttClimate._attr_max_temp
private

Definition at line 541 of file climate.py.

◆ _attr_min_humidity

homeassistant.components.mqtt.climate.MqttClimate._attr_min_humidity
private

Definition at line 542 of file climate.py.

◆ _attr_min_temp

homeassistant.components.mqtt.climate.MqttClimate._attr_min_temp
private

Definition at line 539 of file climate.py.

◆ _attr_precision

homeassistant.components.mqtt.climate.MqttClimate._attr_precision
private

Definition at line 545 of file climate.py.

◆ _attr_preset_mode

homeassistant.components.mqtt.climate.MqttClimate._attr_preset_mode
private

Definition at line 583 of file climate.py.

◆ _attr_preset_modes

homeassistant.components.mqtt.climate.MqttClimate._attr_preset_modes
private

Definition at line 582 of file climate.py.

◆ _attr_supported_features

homeassistant.components.mqtt.climate.MqttClimate._attr_supported_features
private

Definition at line 641 of file climate.py.

◆ _attr_swing_mode

homeassistant.components.mqtt.climate.MqttClimate._attr_swing_mode
private

Definition at line 573 of file climate.py.

◆ _attr_swing_modes

homeassistant.components.mqtt.climate.MqttClimate._attr_swing_modes
private

Definition at line 547 of file climate.py.

◆ _attr_target_temperature

homeassistant.components.mqtt.climate.MqttClimate._attr_target_temperature
private

Definition at line 564 of file climate.py.

◆ _attr_target_temperature_high

homeassistant.components.mqtt.climate.MqttClimate._attr_target_temperature_high
private

Definition at line 568 of file climate.py.

◆ _attr_target_temperature_low

homeassistant.components.mqtt.climate.MqttClimate._attr_target_temperature_low
private

Definition at line 566 of file climate.py.

◆ _attr_target_temperature_step

homeassistant.components.mqtt.climate.MqttClimate._attr_target_temperature_step
private

Definition at line 548 of file climate.py.

◆ _attr_temperature_unit

homeassistant.components.mqtt.climate.MqttClimate._attr_temperature_unit
private

Definition at line 535 of file climate.py.

◆ _attributes_extra_blocked

homeassistant.components.mqtt.climate.MqttClimate._attributes_extra_blocked = MQTT_CLIMATE_ATTRIBUTES_BLOCKED
staticprivate

Definition at line 521 of file climate.py.

◆ _command_templates

homeassistant.components.mqtt.climate.MqttClimate._command_templates
private

Definition at line 604 of file climate.py.

◆ _default_name

homeassistant.components.mqtt.climate.MqttClimate._default_name = DEFAULT_NAME
staticprivate

Definition at line 519 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.mqtt.climate.MqttClimate._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 524 of file climate.py.

◆ _entity_id_format

homeassistant.components.mqtt.climate.MqttClimate._entity_id_format = climate.ENTITY_ID_FORMAT
staticprivate

Definition at line 520 of file climate.py.

◆ _feature_preset_mode

homeassistant.components.mqtt.climate.MqttClimate._feature_preset_mode
private

Definition at line 576 of file climate.py.

◆ _optimistic

homeassistant.components.mqtt.climate.MqttClimate._optimistic
private

Definition at line 552 of file climate.py.

◆ _optimistic_preset_mode

homeassistant.components.mqtt.climate.MqttClimate._optimistic_preset_mode
private

Definition at line 586 of file climate.py.

◆ _topic

homeassistant.components.mqtt.climate.MqttClimate._topic
private

Definition at line 550 of file climate.py.

◆ _value_templates

homeassistant.components.mqtt.climate.MqttClimate._value_templates
private

Definition at line 596 of file climate.py.

◆ None

homeassistant.components.mqtt.climate.MqttClimate.None
static

Definition at line 516 of file climate.py.


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