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

Public Member Functions

def __init__ (self, coordinator, thermostat, temperature_unit)
 
None async_added_to_hass (self)
 
bool available (self)
 
def current_temperature (self)
 
DeviceInfo device_info (self)
 
HVACAction hvac_action (self)
 
HVACMode hvac_mode (self)
 
def max_temp (self)
 
def min_temp (self)
 
def preset_mode (self)
 
None set_hvac_mode (self, HVACMode hvac_mode)
 
None set_preset_mode (self, str preset_mode)
 
None set_temperature (self, **Any kwargs)
 
def target_temperature (self)
 
str temperature_unit (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (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_fan_mode (self, str fan_mode)
 
None async_set_humidity (self, int humidity)
 
None async_set_hvac_mode (self, HVACMode hvac_mode)
 
None async_set_preset_mode (self, str preset_mode)
 
None async_set_swing_horizontal_mode (self, str swing_horizontal_mode)
 
None async_set_swing_mode (self, str swing_mode)
 
None async_set_temperature (self, **Any kwargs)
 
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)
 
str|None fan_mode (self)
 
list[str]|None fan_modes (self)
 
list[HVACMode] hvac_modes (self)
 
bool|None is_aux_heat (self)
 
float max_humidity (self)
 
float min_humidity (self)
 
float precision (self)
 
list[str]|None preset_modes (self)
 
None set_fan_mode (self, str fan_mode)
 
None set_humidity (self, int humidity)
 
None set_swing_horizontal_mode (self, str swing_horizontal_mode)
 
None set_swing_mode (self, str swing_mode)
 
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_high (self)
 
float|None target_temperature_low (self)
 
float|None target_temperature_step (self)
 
None toggle (self)
 
None turn_aux_heat_off (self)
 
None turn_aux_heat_on (self)
 
None turn_off (self)
 
None turn_on (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_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_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)
 
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)
 

Private Member Functions

None _forced_refresh (self, *_)
 
def _handle_coordinator_update (self)
 
def _schedule_update (self)
 
def _set_schedule_mode (self, schedule_mode)
 
def _set_temperature_and_mode (self, temperature, hvac_mode=None, preset_mode=None)
 
def _update_internal_state (self)
 

Private Attributes

 _attr_unique_id
 
 _schedule_mode
 
 _target_temperature
 
 _temperature_unit
 
 _thermostat
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_hvac_modes = OPERATION_LIST
 
 _attr_name = None
 
 _attr_preset_modes = PRESET_MODES
 
tuple _attr_supported_features
 
bool _enable_turn_on_off_backwards_compatibility = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.climate.ClimateEntity
 hvac_mode
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.components.climate.ClimateEntity
 bool
 
 ClimateEntityFeature
 
 float
 
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a NuHeat Thermostat.

Definition at line 72 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.nuheat.climate.NuHeatThermostat.__init__ (   self,
  coordinator,
  thermostat,
  temperature_unit 
)
Initialize the thermostat.

Definition at line 84 of file climate.py.

Member Function Documentation

◆ _forced_refresh()

None homeassistant.components.nuheat.climate.NuHeatThermostat._forced_refresh (   self,
_ 
)
private
Force a refresh.

Definition at line 230 of file climate.py.

◆ _handle_coordinator_update()

def homeassistant.components.nuheat.climate.NuHeatThermostat._handle_coordinator_update (   self)
private
Get the latest state from the thermostat.

Definition at line 246 of file climate.py.

◆ _schedule_update()

def homeassistant.components.nuheat.climate.NuHeatThermostat._schedule_update (   self)
private

Definition at line 215 of file climate.py.

◆ _set_schedule_mode()

def homeassistant.components.nuheat.climate.NuHeatThermostat._set_schedule_mode (   self,
  schedule_mode 
)
private
Set a schedule mode.

Definition at line 168 of file climate.py.

◆ _set_temperature_and_mode()

def homeassistant.components.nuheat.climate.NuHeatThermostat._set_temperature_and_mode (   self,
  temperature,
  hvac_mode = None,
  preset_mode = None 
)
private
Set temperature and hvac mode at the same time.

Definition at line 181 of file climate.py.

◆ _update_internal_state()

def homeassistant.components.nuheat.climate.NuHeatThermostat._update_internal_state (   self)
private
Update our internal state from the last api response.

Definition at line 240 of file climate.py.

◆ async_added_to_hass()

None homeassistant.components.nuheat.climate.NuHeatThermostat.async_added_to_hass (   self)
When entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 234 of file climate.py.

◆ available()

bool homeassistant.components.nuheat.climate.NuHeatThermostat.available (   self)
Return the unique id.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 110 of file climate.py.

◆ current_temperature()

def homeassistant.components.nuheat.climate.NuHeatThermostat.current_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 102 of file climate.py.

◆ device_info()

DeviceInfo homeassistant.components.nuheat.climate.NuHeatThermostat.device_info (   self)
Return the device_info of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 252 of file climate.py.

◆ hvac_action()

HVACAction homeassistant.components.nuheat.climate.NuHeatThermostat.hvac_action (   self)
Return current operation heat or idle.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 129 of file climate.py.

◆ hvac_mode()

HVACMode homeassistant.components.nuheat.climate.NuHeatThermostat.hvac_mode (   self)
Return current setting heat or auto.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 122 of file climate.py.

◆ max_temp()

def homeassistant.components.nuheat.climate.NuHeatThermostat.max_temp (   self)
Return the maximum supported temperature for the thermostat.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 142 of file climate.py.

◆ min_temp()

def homeassistant.components.nuheat.climate.NuHeatThermostat.min_temp (   self)
Return the minimum supported temperature for the thermostat.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 134 of file climate.py.

◆ preset_mode()

def homeassistant.components.nuheat.climate.NuHeatThermostat.preset_mode (   self)
Return current preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 158 of file climate.py.

◆ set_hvac_mode()

None homeassistant.components.nuheat.climate.NuHeatThermostat.set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set the system mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 114 of file climate.py.

◆ set_preset_mode()

None homeassistant.components.nuheat.climate.NuHeatThermostat.set_preset_mode (   self,
str  preset_mode 
)
Update the hold mode of the thermostat.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 162 of file climate.py.

◆ set_temperature()

None homeassistant.components.nuheat.climate.NuHeatThermostat.set_temperature (   self,
**Any  kwargs 
)
Set a new target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 175 of file climate.py.

◆ target_temperature()

def homeassistant.components.nuheat.climate.NuHeatThermostat.target_temperature (   self)
Return the currently programmed temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 150 of file climate.py.

◆ temperature_unit()

str homeassistant.components.nuheat.climate.NuHeatThermostat.temperature_unit (   self)
Return the unit of measurement.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 94 of file climate.py.

Member Data Documentation

◆ _attr_has_entity_name

bool homeassistant.components.nuheat.climate.NuHeatThermostat._attr_has_entity_name = True
staticprivate

Definition at line 79 of file climate.py.

◆ _attr_hvac_modes

homeassistant.components.nuheat.climate.NuHeatThermostat._attr_hvac_modes = OPERATION_LIST
staticprivate

Definition at line 75 of file climate.py.

◆ _attr_name

homeassistant.components.nuheat.climate.NuHeatThermostat._attr_name = None
staticprivate

Definition at line 80 of file climate.py.

◆ _attr_preset_modes

homeassistant.components.nuheat.climate.NuHeatThermostat._attr_preset_modes = PRESET_MODES
staticprivate

Definition at line 81 of file climate.py.

◆ _attr_supported_features

tuple homeassistant.components.nuheat.climate.NuHeatThermostat._attr_supported_features
staticprivate
Initial value:
= (
ClimateEntityFeature.TARGET_TEMPERATURE | ClimateEntityFeature.PRESET_MODE
)

Definition at line 76 of file climate.py.

◆ _attr_unique_id

homeassistant.components.nuheat.climate.NuHeatThermostat._attr_unique_id
private

Definition at line 91 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.nuheat.climate.NuHeatThermostat._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 82 of file climate.py.

◆ _schedule_mode

homeassistant.components.nuheat.climate.NuHeatThermostat._schedule_mode
private

Definition at line 89 of file climate.py.

◆ _target_temperature

homeassistant.components.nuheat.climate.NuHeatThermostat._target_temperature
private

Definition at line 90 of file climate.py.

◆ _temperature_unit

homeassistant.components.nuheat.climate.NuHeatThermostat._temperature_unit
private

Definition at line 88 of file climate.py.

◆ _thermostat

homeassistant.components.nuheat.climate.NuHeatThermostat._thermostat
private

Definition at line 87 of file climate.py.


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