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

Public Member Functions

None __init__ (self, str unique_id, str device_name, float|None target_temperature, str unit_of_measurement, str|None preset, float current_temperature, str|None fan_mode, float|None target_humidity, float|None current_humidity, str|None swing_mode, str|None swing_horizontal_mode, HVACMode hvac_mode, HVACAction|None hvac_action, float|None target_temp_high, float|None target_temp_low, list[HVACMode] hvac_modes, list[str]|None preset_modes=None)
 
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)
 
float|None current_humidity (self)
 
float current_temperature (self)
 
str|None fan_mode (self)
 
list[strfan_modes (self)
 
HVACAction|None hvac_action (self)
 
HVACMode hvac_mode (self)
 
list[HVACMode] hvac_modes (self)
 
str|None preset_mode (self)
 
list[str]|None preset_modes (self)
 
str|None swing_horizontal_mode (self)
 
list[strswing_horizontal_modes (self)
 
str|None swing_mode (self)
 
list[strswing_modes (self)
 
float|None target_humidity (self)
 
float|None target_temperature (self)
 
float|None target_temperature_high (self)
 
float|None target_temperature_low (self)
 
str temperature_unit (self)
 
str unique_id (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_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)
 
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)
 
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)
 
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_added_to_hass (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)
 
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 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 Attributes

 _attr_device_info
 
 _attr_supported_features
 
 _current_fan_mode
 
 _current_humidity
 
 _current_swing_horizontal_mode
 
 _current_swing_mode
 
 _current_temperature
 
 _fan_modes
 
 _hvac_action
 
 _hvac_mode
 
 _hvac_modes
 
 _preset
 
 _preset_modes
 
 _swing_horizontal_modes
 
 _swing_modes
 
 _target_humidity
 
 _target_temperature
 
 _target_temperature_high
 
 _target_temperature_low
 
 _unique_id
 
 _unit_of_measurement
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 
bool _attr_should_poll = False
 
string _attr_translation_key = "ubercool"
 
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 demo climate device.

Definition at line 94 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.demo.climate.DemoClimate.__init__ (   self,
str  unique_id,
str  device_name,
float | None  target_temperature,
str  unit_of_measurement,
str | None  preset,
float  current_temperature,
str | None  fan_mode,
float | None  target_humidity,
float | None  current_humidity,
str | None  swing_mode,
str | None  swing_horizontal_mode,
HVACMode  hvac_mode,
HVACAction | None  hvac_action,
float | None  target_temp_high,
float | None  target_temp_low,
list[HVACMode]  hvac_modes,
list[str] | None   preset_modes = None 
)
Initialize the climate device.

Definition at line 103 of file climate.py.

Member Function Documentation

◆ async_set_fan_mode()

None homeassistant.components.demo.climate.DemoClimate.async_set_fan_mode (   self,
str  fan_mode 
)
Set new fan mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 292 of file climate.py.

◆ async_set_humidity()

None homeassistant.components.demo.climate.DemoClimate.async_set_humidity (   self,
int  humidity 
)
Set new humidity level.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 277 of file climate.py.

◆ async_set_hvac_mode()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 297 of file climate.py.

◆ async_set_preset_mode()

None homeassistant.components.demo.climate.DemoClimate.async_set_preset_mode (   self,
str  preset_mode 
)
Update preset_mode on.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 302 of file climate.py.

◆ async_set_swing_horizontal_mode()

None homeassistant.components.demo.climate.DemoClimate.async_set_swing_horizontal_mode (   self,
str  swing_horizontal_mode 
)
Set new swing mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 287 of file climate.py.

◆ async_set_swing_mode()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 282 of file climate.py.

◆ async_set_temperature()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 263 of file climate.py.

◆ current_humidity()

float | None homeassistant.components.demo.climate.DemoClimate.current_humidity (   self)
Return the current humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 199 of file climate.py.

◆ current_temperature()

float homeassistant.components.demo.climate.DemoClimate.current_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 179 of file climate.py.

◆ fan_mode()

str | None homeassistant.components.demo.climate.DemoClimate.fan_mode (   self)
Return the fan setting.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 234 of file climate.py.

◆ fan_modes()

list[str] homeassistant.components.demo.climate.DemoClimate.fan_modes (   self)
Return the list of available fan modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 239 of file climate.py.

◆ hvac_action()

HVACAction | None homeassistant.components.demo.climate.DemoClimate.hvac_action (   self)
Return current operation ie. heat, cool, idle.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 209 of file climate.py.

◆ hvac_mode()

HVACMode homeassistant.components.demo.climate.DemoClimate.hvac_mode (   self)
Return hvac target hvac state.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 214 of file climate.py.

◆ hvac_modes()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 219 of file climate.py.

◆ preset_mode()

str | None homeassistant.components.demo.climate.DemoClimate.preset_mode (   self)
Return preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 224 of file climate.py.

◆ preset_modes()

list[str] | None homeassistant.components.demo.climate.DemoClimate.preset_modes (   self)
Return preset modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 229 of file climate.py.

◆ swing_horizontal_mode()

str | None homeassistant.components.demo.climate.DemoClimate.swing_horizontal_mode (   self)
Return the swing setting.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 254 of file climate.py.

◆ swing_horizontal_modes()

list[str] homeassistant.components.demo.climate.DemoClimate.swing_horizontal_modes (   self)
List of available swing modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 259 of file climate.py.

◆ swing_mode()

str | None homeassistant.components.demo.climate.DemoClimate.swing_mode (   self)
Return the swing setting.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 244 of file climate.py.

◆ swing_modes()

list[str] homeassistant.components.demo.climate.DemoClimate.swing_modes (   self)
List of available swing modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 249 of file climate.py.

◆ target_humidity()

float | None homeassistant.components.demo.climate.DemoClimate.target_humidity (   self)
Return the humidity we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 204 of file climate.py.

◆ target_temperature()

float | None homeassistant.components.demo.climate.DemoClimate.target_temperature (   self)
Return the temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 184 of file climate.py.

◆ target_temperature_high()

float | None homeassistant.components.demo.climate.DemoClimate.target_temperature_high (   self)
Return the highbound target temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 189 of file climate.py.

◆ target_temperature_low()

float | None homeassistant.components.demo.climate.DemoClimate.target_temperature_low (   self)
Return the lowbound target temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 194 of file climate.py.

◆ temperature_unit()

str homeassistant.components.demo.climate.DemoClimate.temperature_unit (   self)
Return the unit of measurement.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 174 of file climate.py.

◆ unique_id()

str homeassistant.components.demo.climate.DemoClimate.unique_id (   self)
Return the unique id.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 169 of file climate.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.demo.climate.DemoClimate._attr_device_info
private

Definition at line 163 of file climate.py.

◆ _attr_has_entity_name

bool homeassistant.components.demo.climate.DemoClimate._attr_has_entity_name = True
staticprivate

Definition at line 97 of file climate.py.

◆ _attr_name

homeassistant.components.demo.climate.DemoClimate._attr_name = None
staticprivate

Definition at line 98 of file climate.py.

◆ _attr_should_poll

bool homeassistant.components.demo.climate.DemoClimate._attr_should_poll = False
staticprivate

Definition at line 99 of file climate.py.

◆ _attr_supported_features

homeassistant.components.demo.climate.DemoClimate._attr_supported_features
private

Definition at line 125 of file climate.py.

◆ _attr_translation_key

string homeassistant.components.demo.climate.DemoClimate._attr_translation_key = "ubercool"
staticprivate

Definition at line 100 of file climate.py.

◆ _current_fan_mode

homeassistant.components.demo.climate.DemoClimate._current_fan_mode
private

Definition at line 152 of file climate.py.

◆ _current_humidity

homeassistant.components.demo.climate.DemoClimate._current_humidity
private

Definition at line 151 of file climate.py.

◆ _current_swing_horizontal_mode

homeassistant.components.demo.climate.DemoClimate._current_swing_horizontal_mode
private

Definition at line 156 of file climate.py.

◆ _current_swing_mode

homeassistant.components.demo.climate.DemoClimate._current_swing_mode
private

Definition at line 155 of file climate.py.

◆ _current_temperature

homeassistant.components.demo.climate.DemoClimate._current_temperature
private

Definition at line 150 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.demo.climate.DemoClimate._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 101 of file climate.py.

◆ _fan_modes

homeassistant.components.demo.climate.DemoClimate._fan_modes
private

Definition at line 157 of file climate.py.

◆ _hvac_action

homeassistant.components.demo.climate.DemoClimate._hvac_action
private

Definition at line 153 of file climate.py.

◆ _hvac_mode

homeassistant.components.demo.climate.DemoClimate._hvac_mode
private

Definition at line 154 of file climate.py.

◆ _hvac_modes

homeassistant.components.demo.climate.DemoClimate._hvac_modes
private

Definition at line 158 of file climate.py.

◆ _preset

homeassistant.components.demo.climate.DemoClimate._preset
private

Definition at line 148 of file climate.py.

◆ _preset_modes

homeassistant.components.demo.climate.DemoClimate._preset_modes
private

Definition at line 149 of file climate.py.

◆ _swing_horizontal_modes

homeassistant.components.demo.climate.DemoClimate._swing_horizontal_modes
private

Definition at line 160 of file climate.py.

◆ _swing_modes

homeassistant.components.demo.climate.DemoClimate._swing_modes
private

Definition at line 159 of file climate.py.

◆ _target_humidity

homeassistant.components.demo.climate.DemoClimate._target_humidity
private

Definition at line 146 of file climate.py.

◆ _target_temperature

homeassistant.components.demo.climate.DemoClimate._target_temperature
private

Definition at line 145 of file climate.py.

◆ _target_temperature_high

homeassistant.components.demo.climate.DemoClimate._target_temperature_high
private

Definition at line 161 of file climate.py.

◆ _target_temperature_low

homeassistant.components.demo.climate.DemoClimate._target_temperature_low
private

Definition at line 162 of file climate.py.

◆ _unique_id

homeassistant.components.demo.climate.DemoClimate._unique_id
private

Definition at line 124 of file climate.py.

◆ _unit_of_measurement

homeassistant.components.demo.climate.DemoClimate._unit_of_measurement
private

Definition at line 147 of file climate.py.


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