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

Public Member Functions

None __init__ (self, Controller controller)
 
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_preset_mode (self, str preset_mode)
 
None async_set_temperature (self, **Any kwargs)
 
None async_turn_on (self)
 
def control_zone_name (self)
 
float|None control_zone_setpoint (self)
 
float|None current_temperature (self)
 
Mapping[str, Any] extra_state_attributes (self)
 
str|None fan_mode (self)
 
list[str]|None fan_modes (self)
 
HVACMode hvac_mode (self)
 
list[HVACMode] hvac_modes (self)
 
float max_temp (self)
 
float min_temp (self)
 
str preset_mode (self)
 
list[strpreset_modes (self)
 
None set_available (self, bool available, Exception|None ex=None)
 
float supply_temperature (self)
 
float|None target_temperature (self)
 
def wrap_and_catch (self, coro)
 
- 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_set_swing_mode (self, str swing_mode)
 
None async_toggle (self)
 
None async_turn_aux_heat_off (self)
 
None async_turn_aux_heat_on (self)
 
None async_turn_off (self)
 
dict[str, Any]|None capability_attributes (self)
 
float|None current_humidity (self)
 
HVACAction|None hvac_action (self)
 
bool|None is_aux_heat (self)
 
float max_humidity (self)
 
float min_humidity (self)
 
float precision (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_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)
 
- 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)
 
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)
 
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 Attributes

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

Private Attributes

 _attr_available
 
 _attr_device_info
 
 _attr_supported_features
 
 _attr_unique_id
 
 _controller
 
 _fan_to_pizone
 
 _state_to_pizone
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 
 _attr_precision = PRECISION_TENTHS
 
bool _attr_should_poll = False
 
float _attr_target_temperature_step = 0.5
 
 _attr_temperature_unit = UnitOfTemperature.CELSIUS
 
bool _enable_turn_on_off_backwards_compatibility = False
 

Additional Inherited Members

- 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 iZone Controller.

Definition at line 135 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.izone.climate.ControllerDevice.__init__ (   self,
Controller  controller 
)
Initialise ControllerDevice.

Definition at line 146 of file climate.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.izone.climate.ControllerDevice.async_added_to_hass (   self)
Call on adding to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 193 of file climate.py.

◆ async_set_fan_mode()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 407 of file climate.py.

◆ async_set_hvac_mode()

None homeassistant.components.izone.climate.ControllerDevice.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set new target operation mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 412 of file climate.py.

◆ async_set_preset_mode()

None homeassistant.components.izone.climate.ControllerDevice.async_set_preset_mode (   self,
str  preset_mode 
)
Set the preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 424 of file climate.py.

◆ async_set_temperature()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 399 of file climate.py.

◆ async_turn_on()

None homeassistant.components.izone.climate.ControllerDevice.async_turn_on (   self)
Turn the entity on.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 430 of file climate.py.

◆ control_zone_name()

def homeassistant.components.izone.climate.ControllerDevice.control_zone_name (   self)
Return the zone that currently controls the AC unit (if target temp not set by controller).

Definition at line 334 of file climate.py.

◆ control_zone_setpoint()

float | None homeassistant.components.izone.climate.ControllerDevice.control_zone_setpoint (   self)
Return the temperature setpoint of the zone that currently controls the AC unit (if target temp not set by controller).

Definition at line 345 of file climate.py.

◆ current_temperature()

float | None homeassistant.components.izone.climate.ControllerDevice.current_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 327 of file climate.py.

◆ extra_state_attributes()

Mapping[str, Any] homeassistant.components.izone.climate.ControllerDevice.extra_state_attributes (   self)
Return the optional state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 263 of file climate.py.

◆ fan_mode()

str | None homeassistant.components.izone.climate.ControllerDevice.fan_mode (   self)
Return the fan setting.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 369 of file climate.py.

◆ fan_modes()

list[str] | None homeassistant.components.izone.climate.ControllerDevice.fan_modes (   self)
Return the list of available fan modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 374 of file climate.py.

◆ hvac_mode()

HVACMode homeassistant.components.izone.climate.ControllerDevice.hvac_mode (   self)
Return current operation ie. heat, cool, idle.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 292 of file climate.py.

◆ hvac_modes()

list[HVACMode] homeassistant.components.izone.climate.ControllerDevice.hvac_modes (   self)
Return the list of available operation modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 305 of file climate.py.

◆ max_temp()

float homeassistant.components.izone.climate.ControllerDevice.max_temp (   self)
Return the maximum temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 386 of file climate.py.

◆ min_temp()

float homeassistant.components.izone.climate.ControllerDevice.min_temp (   self)
Return the minimum temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 380 of file climate.py.

◆ preset_mode()

str homeassistant.components.izone.climate.ControllerDevice.preset_mode (   self)
Eco mode is external air.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 313 of file climate.py.

◆ preset_modes()

list[str] homeassistant.components.izone.climate.ControllerDevice.preset_modes (   self)
Available preset modes, normal or eco.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 319 of file climate.py.

◆ set_available()

None homeassistant.components.izone.climate.ControllerDevice.set_available (   self,
bool  available,
Exception | None   ex = None 
)
Set availability for the controller.

Also sets zone availability as they follow the same availability.

Definition at line 239 of file climate.py.

◆ supply_temperature()

float homeassistant.components.izone.climate.ControllerDevice.supply_temperature (   self)
Return the current supply, or in duct, temperature.

Definition at line 364 of file climate.py.

◆ target_temperature()

float | None homeassistant.components.izone.climate.ControllerDevice.target_temperature (   self)
Return the temperature we try to reach (either from control zone or master unit).

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 357 of file climate.py.

◆ wrap_and_catch()

def homeassistant.components.izone.climate.ControllerDevice.wrap_and_catch (   self,
  coro 
)
Catch any connection errors and set unavailable.

Definition at line 390 of file climate.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.izone.climate.ControllerDevice._attr_available
private

Definition at line 256 of file climate.py.

◆ _attr_device_info

homeassistant.components.izone.climate.ControllerDevice._attr_device_info
private

Definition at line 181 of file climate.py.

◆ _attr_has_entity_name

bool homeassistant.components.izone.climate.ControllerDevice._attr_has_entity_name = True
staticprivate

Definition at line 141 of file climate.py.

◆ _attr_name

homeassistant.components.izone.climate.ControllerDevice._attr_name = None
staticprivate

Definition at line 142 of file climate.py.

◆ _attr_precision

homeassistant.components.izone.climate.ControllerDevice._attr_precision = PRECISION_TENTHS
staticprivate

Definition at line 138 of file climate.py.

◆ _attr_should_poll

bool homeassistant.components.izone.climate.ControllerDevice._attr_should_poll = False
staticprivate

Definition at line 139 of file climate.py.

◆ _attr_supported_features

homeassistant.components.izone.climate.ControllerDevice._attr_supported_features
private

Definition at line 150 of file climate.py.

◆ _attr_target_temperature_step

float homeassistant.components.izone.climate.ControllerDevice._attr_target_temperature_step = 0.5
staticprivate

Definition at line 143 of file climate.py.

◆ _attr_temperature_unit

homeassistant.components.izone.climate.ControllerDevice._attr_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 140 of file climate.py.

◆ _attr_unique_id

homeassistant.components.izone.climate.ControllerDevice._attr_unique_id
private

Definition at line 180 of file climate.py.

◆ _controller

homeassistant.components.izone.climate.ControllerDevice._controller
private

Definition at line 148 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.izone.climate.ControllerDevice._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 144 of file climate.py.

◆ _fan_to_pizone

homeassistant.components.izone.climate.ControllerDevice._fan_to_pizone
private

Definition at line 176 of file climate.py.

◆ _state_to_pizone

homeassistant.components.izone.climate.ControllerDevice._state_to_pizone
private

Definition at line 166 of file climate.py.

◆ available

homeassistant.components.izone.climate.ControllerDevice.available

Definition at line 244 of file climate.py.

◆ zones

homeassistant.components.izone.climate.ControllerDevice.zones

Definition at line 189 of file climate.py.


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