homeassistant.components.zwave_js.climate.ZWaveClimate Class Reference

Inheritance diagram for homeassistant.components.zwave_js.climate.ZWaveClimate:

Collaboration diagram for homeassistant.components.zwave_js.climate.ZWaveClimate:

Public Member Functions
None	__init__ (self, ConfigEntry config_entry, Driver driver, ZwaveDiscoveryInfo info)
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_off (self)
None	async_turn_on (self)
int|None	current_humidity (self)
float|None	current_temperature (self)
dict[str, str]|None	extra_state_attributes (self)
str|None	fan_mode (self)
list[str]|None	fan_modes (self)
HVACAction|None	hvac_action (self)
HVACMode	hvac_mode (self)
list[HVACMode]	hvac_modes (self)
float	max_temp (self)
float	min_temp (self)
str|None	preset_mode (self)
list[str]|None	preset_modes (self)
float|None	target_temperature (self)
float|None	target_temperature_high (self)
float|None	target_temperature_low (self)
str	temperature_unit (self)
Public Member Functions inherited from homeassistant.components.zwave_js.entity.ZWaveBaseEntity
None	async_added_to_hass (self)
None	async_poll_value (self, bool refresh_all_values)
bool	available (self)
str	generate_name (self, bool include_value_name=False, str|None alternate_value_name=None, Sequence[str|None]|None additional_info=None, str|None name_prefix=None)
ZwaveValue|None	get_zwave_value (self, str|int value_property, int|None command_class=None, int|None endpoint=None, int|str|None value_property_key=None, bool add_to_watched_value_ids=True, bool check_all_endpoints=False)
None	on_value_update (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)
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, str]	translation_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.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)
dict[str, Any]|None	capability_attributes (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_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)

Private Member Functions
list[ThermostatSetpointType]	_current_mode_setpoint_enums (self)
None	_set_modes_and_presets (self)
float|None	_setpoint_temperature (self, ThermostatSetpointType setpoint_type)
ZwaveValue	_setpoint_value_or_raise (self, ThermostatSetpointType setpoint_type)

Private Attributes
	_current_humidity
	_current_mode
	_current_temp
	_fan_mode
	_fan_state
	_hvac_modes
	_hvac_presets
	_last_hvac_mode_id_before_off
	_operating_state
	_unit_value

Static Private Attributes
	_attr_precision = PRECISION_TENTHS
bool	_enable_turn_on_off_backwards_compatibility = False

Additional Inherited Members
Public Attributes inherited from homeassistant.components.zwave_js.entity.ZWaveBaseEntity
	config_entry
	driver
	info
	watched_value_ids
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 Z-Wave climate.

Definition at line 127 of file climate.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.zwave_js.climate.ZWaveClimate.__init__	(		self,
		ConfigEntry	config_entry,
		Driver	driver,
		ZwaveDiscoveryInfo	info
	)

Initialize thermostat.

Reimplemented from homeassistant.components.zwave_js.entity.ZWaveBaseEntity.

Reimplemented in homeassistant.components.zwave_js.climate.DynamicCurrentTempClimate.

Definition at line 133 of file climate.py.

Member Function Documentation

_current_mode_setpoint_enums()

list[ThermostatSetpointType] homeassistant.components.zwave_js.climate.ZWaveClimate._current_mode_setpoint_enums (   self )

private

Return the list of enums that are relevant to the current thermostat mode.

Definition at line 268 of file climate.py.

_set_modes_and_presets()

None homeassistant.components.zwave_js.climate.ZWaveClimate._set_modes_and_presets (   self )

private

Convert Z-Wave Thermostat modes into Home Assistant modes and presets.

Definition at line 241 of file climate.py.

_setpoint_temperature()

float | None homeassistant.components.zwave_js.climate.ZWaveClimate._setpoint_temperature (   self, ThermostatSetpointType   setpoint_type  )

private

Optionally return the temperature value of a setpoint.

Definition at line 231 of file climate.py.

_setpoint_value_or_raise()

ZwaveValue homeassistant.components.zwave_js.climate.ZWaveClimate._setpoint_value_or_raise (   self, ThermostatSetpointType   setpoint_type  )

private

Return a ZwaveValue for a setpoint or raise if not available.

Definition at line 222 of file climate.py.

async_set_fan_mode()

None homeassistant.components.zwave_js.climate.ZWaveClimate.async_set_fan_mode	(		self,
		str	fan_mode
	)

Set new target fan mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 451 of file climate.py.

async_set_hvac_mode()

None homeassistant.components.zwave_js.climate.ZWaveClimate.async_set_hvac_mode	(		self,
		HVACMode	hvac_mode
	)

Set new target hvac mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 494 of file climate.py.

async_set_preset_mode()

None homeassistant.components.zwave_js.climate.ZWaveClimate.async_set_preset_mode	(		self,
		str	preset_mode
	)

Set new target preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 551 of file climate.py.

async_set_temperature()

None homeassistant.components.zwave_js.climate.ZWaveClimate.async_set_temperature	(		self,
		**Any	kwargs
	)

Set new target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 467 of file climate.py.

async_turn_off()

None homeassistant.components.zwave_js.climate.ZWaveClimate.async_turn_off

(

self

)

Turn the entity off.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 509 of file climate.py.

async_turn_on()

None homeassistant.components.zwave_js.climate.ZWaveClimate.async_turn_on

(

self

)

Turn the entity on.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 513 of file climate.py.

current_humidity()

int | None homeassistant.components.zwave_js.climate.ZWaveClimate.current_humidity

(

self

)

Return the current humidity level.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 315 of file climate.py.

current_temperature()

float | None homeassistant.components.zwave_js.climate.ZWaveClimate.current_temperature

(

self

)

Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Reimplemented in homeassistant.components.zwave_js.climate.DynamicCurrentTempClimate.

Definition at line 320 of file climate.py.

extra_state_attributes()

dict[str, str] | None homeassistant.components.zwave_js.climate.ZWaveClimate.extra_state_attributes

(

self

)

Return the optional state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 404 of file climate.py.

fan_mode()

str | None homeassistant.components.zwave_js.climate.ZWaveClimate.fan_mode

(

self

)

Return the fan setting.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 386 of file climate.py.

fan_modes()

list[str] | None homeassistant.components.zwave_js.climate.ZWaveClimate.fan_modes

(

self

)

Return the list of available fan modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 397 of file climate.py.

hvac_action()

HVACAction | None homeassistant.components.zwave_js.climate.ZWaveClimate.hvac_action

(

self

)

Return the current running hvac operation if supported.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 305 of file climate.py.

hvac_mode()

HVACMode homeassistant.components.zwave_js.climate.ZWaveClimate.hvac_mode

(

self

)

Return hvac operation ie. heat, cool mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 288 of file climate.py.

hvac_modes()

list[HVACMode] homeassistant.components.zwave_js.climate.ZWaveClimate.hvac_modes

(

self

)

Return the list of available hvac operation modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 300 of file climate.py.

max_temp()

float homeassistant.components.zwave_js.climate.ZWaveClimate.max_temp

(

self

)

Return the maximum temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 436 of file climate.py.

min_temp()

float homeassistant.components.zwave_js.climate.ZWaveClimate.min_temp

(

self

)

Return the minimum temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 420 of file climate.py.

preset_mode()

str | None homeassistant.components.zwave_js.climate.ZWaveClimate.preset_mode

(

self

)

Return the current preset mode, e.g., home, away, temp.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 367 of file climate.py.

preset_modes()

list[str] | None homeassistant.components.zwave_js.climate.ZWaveClimate.preset_modes

(

self

)

Return a list of available preset modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 381 of file climate.py.

target_temperature()

float | None homeassistant.components.zwave_js.climate.ZWaveClimate.target_temperature

(

self

)

Return the temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 325 of file climate.py.

target_temperature_high()

float | None homeassistant.components.zwave_js.climate.ZWaveClimate.target_temperature_high

(

self

)

Return the highbound target temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 339 of file climate.py.

target_temperature_low()

float | None homeassistant.components.zwave_js.climate.ZWaveClimate.target_temperature_low

(

self

)

Return the lowbound target temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 353 of file climate.py.

temperature_unit()

str homeassistant.components.zwave_js.climate.ZWaveClimate.temperature_unit

(

self

)

Return the unit of measurement used by the platform.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 277 of file climate.py.

Member Data Documentation

_attr_precision

homeassistant.components.zwave_js.climate.ZWaveClimate._attr_precision = PRECISION_TENTHS

staticprivate

Definition at line 130 of file climate.py.

_current_humidity

homeassistant.components.zwave_js.climate.ZWaveClimate._current_humidity

private

Definition at line 184 of file climate.py.

_current_mode

homeassistant.components.zwave_js.climate.ZWaveClimate._current_mode

private

Definition at line 143 of file climate.py.

_current_temp

homeassistant.components.zwave_js.climate.ZWaveClimate._current_temp

private

Definition at line 176 of file climate.py.

_enable_turn_on_off_backwards_compatibility

bool homeassistant.components.zwave_js.climate.ZWaveClimate._enable_turn_on_off_backwards_compatibility = False

staticprivate

Definition at line 131 of file climate.py.

_fan_mode

homeassistant.components.zwave_js.climate.ZWaveClimate._fan_mode

private

Definition at line 190 of file climate.py.

_fan_state

homeassistant.components.zwave_js.climate.ZWaveClimate._fan_state

private

Definition at line 196 of file climate.py.

_hvac_modes

homeassistant.components.zwave_js.climate.ZWaveClimate._hvac_modes

private

Definition at line 250 of file climate.py.

_hvac_presets

homeassistant.components.zwave_js.climate.ZWaveClimate._hvac_presets

private

Definition at line 265 of file climate.py.

_last_hvac_mode_id_before_off

homeassistant.components.zwave_js.climate.ZWaveClimate._last_hvac_mode_id_before_off

private

Definition at line 506 of file climate.py.

_operating_state

homeassistant.components.zwave_js.climate.ZWaveClimate._operating_state

private

Definition at line 170 of file climate.py.

_unit_value

homeassistant.components.zwave_js.climate.ZWaveClimate._unit_value

private

Definition at line 169 of file climate.py.

---

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

• core/homeassistant/components/zwave_js/climate.py