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

Public Member Functions

None __init__ (self, HomeAssistant hass, ModbusHub hub, dict[str, Any] config)
 
None async_added_to_hass (self)
 
None async_set_fan_mode (self, str fan_mode)
 
None async_set_hvac_mode (self, HVACMode hvac_mode)
 
None async_set_swing_mode (self, str swing_mode)
 
None async_set_temperature (self, **Any kwargs)
 
None async_update (self, datetime|None now=None)
 
- Public Member Functions inherited from homeassistant.components.modbus.entity.BaseStructPlatform
None __init__ (self, HomeAssistant hass, ModbusHub hub, dict config)
 
str|None unpack_structure_result (self, list[int] registers)
 
- Public Member Functions inherited from homeassistant.components.modbus.entity.BasePlatform
None async_base_added_to_hass (self)
 
None async_hold (self, bool update=True)
 
None async_run (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
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_removed_from_registry (self)
 
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_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (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.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)
 
- 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_preset_mode (self, str preset_mode)
 
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)
 
None async_turn_off (self)
 
None async_turn_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)
 

Private Member Functions

float|None _async_read_register (self, str register_type, int register, bool|None raw=False)
 

Private Attributes

 _attr_available
 
 _attr_current_temperature
 
 _attr_fan_mode
 
 _attr_fan_modes
 
 _attr_hvac_mode
 
 _attr_hvac_modes
 
 _attr_max_temp
 
 _attr_min_temp
 
 _attr_precision
 
 _attr_supported_features
 
 _attr_swing_mode
 
 _attr_swing_modes
 
 _attr_target_temperature
 
 _attr_target_temperature_step
 
 _attr_temperature_unit
 
 _fan_mode_register
 
 _hvac_mode_register
 
 _hvac_mode_write_registers
 
 _hvac_onoff_register
 
 _hvac_onoff_write_registers
 
 _swing_mode_register
 
 _target_temperature_register
 
 _target_temperature_write_registers
 
 _unit
 
 _value
 

Static Private Attributes

tuple _attr_supported_features
 
bool _enable_turn_on_off_backwards_compatibility = False
 

Additional Inherited Members

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

Detailed Description

Representation of a Modbus Thermostat.

Definition at line 125 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.modbus.climate.ModbusThermostat.__init__ (   self,
HomeAssistant  hass,
ModbusHub  hub,
dict[str, Any]  config 
)
Initialize the modbus thermostat.

Reimplemented from homeassistant.components.modbus.entity.BasePlatform.

Definition at line 135 of file climate.py.

Member Function Documentation

◆ _async_read_register()

float | None homeassistant.components.modbus.climate.ModbusThermostat._async_read_register (   self,
str  register_type,
int  register,
bool | None   raw = False 
)
private
Read register using the Modbus hub slave.

Definition at line 485 of file climate.py.

◆ async_added_to_hass()

None homeassistant.components.modbus.climate.ModbusThermostat.async_added_to_hass (   self)
Handle entity which will be added.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 260 of file climate.py.

◆ async_set_fan_mode()

None homeassistant.components.modbus.climate.ModbusThermostat.async_set_fan_mode (   self,
str  fan_mode 
)
Set new target fan mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 308 of file climate.py.

◆ async_set_hvac_mode()

None homeassistant.components.modbus.climate.ModbusThermostat.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set new target hvac mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 267 of file climate.py.

◆ async_set_swing_mode()

None homeassistant.components.modbus.climate.ModbusThermostat.async_set_swing_mode (   self,
str  swing_mode 
)
Set new target swing mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 330 of file climate.py.

◆ async_set_temperature()

None homeassistant.components.modbus.climate.ModbusThermostat.async_set_temperature (   self,
**Any  kwargs 
)
Set new target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 353 of file climate.py.

◆ async_update()

None homeassistant.components.modbus.climate.ModbusThermostat.async_update (   self,
datetime | None   now = None 
)
Update Target & Current Temperature.

Reimplemented from homeassistant.components.modbus.entity.BasePlatform.

Definition at line 408 of file climate.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.modbus.climate.ModbusThermostat._attr_available
private

Definition at line 405 of file climate.py.

◆ _attr_current_temperature

homeassistant.components.modbus.climate.ModbusThermostat._attr_current_temperature
private

Definition at line 148 of file climate.py.

◆ _attr_fan_mode

homeassistant.components.modbus.climate.ModbusThermostat._attr_fan_mode
private

Definition at line 200 of file climate.py.

◆ _attr_fan_modes

homeassistant.components.modbus.climate.ModbusThermostat._attr_fan_modes
private

Definition at line 199 of file climate.py.

◆ _attr_hvac_mode

homeassistant.components.modbus.climate.ModbusThermostat._attr_hvac_mode
private

Definition at line 166 of file climate.py.

◆ _attr_hvac_modes

homeassistant.components.modbus.climate.ModbusThermostat._attr_hvac_modes
private

Definition at line 165 of file climate.py.

◆ _attr_max_temp

homeassistant.components.modbus.climate.ModbusThermostat._attr_max_temp
private

Definition at line 159 of file climate.py.

◆ _attr_min_temp

homeassistant.components.modbus.climate.ModbusThermostat._attr_min_temp
private

Definition at line 158 of file climate.py.

◆ _attr_precision

homeassistant.components.modbus.climate.ModbusThermostat._attr_precision
private

Definition at line 155 of file climate.py.

◆ _attr_supported_features [1/2]

tuple homeassistant.components.modbus.climate.ModbusThermostat._attr_supported_features
staticprivate
Initial value:
= (
ClimateEntityFeature.TARGET_TEMPERATURE
| ClimateEntityFeature.TURN_OFF
| ClimateEntityFeature.TURN_ON
)

Definition at line 128 of file climate.py.

◆ _attr_supported_features [2/2]

homeassistant.components.modbus.climate.ModbusThermostat._attr_supported_features
private

Definition at line 194 of file climate.py.

◆ _attr_swing_mode

homeassistant.components.modbus.climate.ModbusThermostat._attr_swing_mode
private

Definition at line 237 of file climate.py.

◆ _attr_swing_modes

homeassistant.components.modbus.climate.ModbusThermostat._attr_swing_modes
private

Definition at line 236 of file climate.py.

◆ _attr_target_temperature

homeassistant.components.modbus.climate.ModbusThermostat._attr_target_temperature
private

Definition at line 149 of file climate.py.

◆ _attr_target_temperature_step

homeassistant.components.modbus.climate.ModbusThermostat._attr_target_temperature_step
private

Definition at line 160 of file climate.py.

◆ _attr_temperature_unit

homeassistant.components.modbus.climate.ModbusThermostat._attr_temperature_unit
private

Definition at line 150 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.modbus.climate.ModbusThermostat._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 133 of file climate.py.

◆ _fan_mode_register

homeassistant.components.modbus.climate.ModbusThermostat._fan_mode_register
private

Definition at line 198 of file climate.py.

◆ _hvac_mode_register

homeassistant.components.modbus.climate.ModbusThermostat._hvac_mode_register
private

Definition at line 164 of file climate.py.

◆ _hvac_mode_write_registers

homeassistant.components.modbus.climate.ModbusThermostat._hvac_mode_write_registers
private

Definition at line 168 of file climate.py.

◆ _hvac_onoff_register

homeassistant.components.modbus.climate.ModbusThermostat._hvac_onoff_register
private

Definition at line 253 of file climate.py.

◆ _hvac_onoff_write_registers

homeassistant.components.modbus.climate.ModbusThermostat._hvac_onoff_write_registers
private

Definition at line 254 of file climate.py.

◆ _swing_mode_register

homeassistant.components.modbus.climate.ModbusThermostat._swing_mode_register
private

Definition at line 229 of file climate.py.

◆ _target_temperature_register

homeassistant.components.modbus.climate.ModbusThermostat._target_temperature_register
private

Definition at line 143 of file climate.py.

◆ _target_temperature_write_registers

homeassistant.components.modbus.climate.ModbusThermostat._target_temperature_write_registers
private

Definition at line 144 of file climate.py.

◆ _unit

homeassistant.components.modbus.climate.ModbusThermostat._unit
private

Definition at line 147 of file climate.py.

◆ _value

homeassistant.components.modbus.climate.ModbusThermostat._value
private

Definition at line 503 of file climate.py.


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