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

Public Member Functions

None __init__ (self, VenstarDataUpdateCoordinator venstar_data_coordinator, ConfigEntry config)
 
def current_humidity (self)
 
def current_temperature (self)
 
def extra_state_attributes (self)
 
def fan_mode (self)
 
HVACAction hvac_action (self)
 
HVACMode hvac_mode (self)
 
def max_humidity (self)
 
def min_humidity (self)
 
def preset_mode (self)
 
def 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)
 
def set_temperature (self, **kwargs)
 
ClimateEntityFeature supported_features (self)
 
def target_humidity (self)
 
def target_temperature (self)
 
def target_temperature_high (self)
 
def target_temperature_low (self)
 
str temperature_unit (self)
 
- Public Member Functions inherited from homeassistant.components.venstar.entity.VenstarEntity
DeviceInfo device_info (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.venstar.coordinator.VenstarDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, *VenstarColorTouch venstar_connection)
 
- 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)
 
list[str]|None fan_modes (self)
 
list[HVACMode] hvac_modes (self)
 
bool|None is_aux_heat (self)
 
float max_temp (self)
 
float min_temp (self)
 
float precision (self)
 
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)
 
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_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)
 
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

def _set_operation_mode (self, HVACMode operation_mode)
 

Private Attributes

 _attr_unique_id
 
 _mode_map
 

Static Private Attributes

list _attr_fan_modes = [FAN_ON, FAN_AUTO]
 
list _attr_hvac_modes = [HVACMode.HEAT, HVACMode.COOL, HVACMode.OFF, HVACMode.AUTO]
 
 _attr_name = None
 
 _attr_precision = PRECISION_HALVES
 
bool _enable_turn_on_off_backwards_compatibility = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.venstar.coordinator.VenstarDataUpdateCoordinator
 client
 
 runtimes
 
- 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 Venstar thermostat.

Definition at line 106 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.venstar.climate.VenstarThermostat.__init__ (   self,
VenstarDataUpdateCoordinator  venstar_data_coordinator,
ConfigEntry  config 
)
Initialize the thermostat.

Reimplemented from homeassistant.components.venstar.entity.VenstarEntity.

Definition at line 115 of file climate.py.

Member Function Documentation

◆ _set_operation_mode()

def homeassistant.components.venstar.climate.VenstarThermostat._set_operation_mode (   self,
HVACMode  operation_mode 
)
private
Change the operation mode (internal).

Definition at line 254 of file climate.py.

◆ current_humidity()

def homeassistant.components.venstar.climate.VenstarThermostat.current_humidity (   self)
Return the current humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 161 of file climate.py.

◆ current_temperature()

def homeassistant.components.venstar.climate.VenstarThermostat.current_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 156 of file climate.py.

◆ extra_state_attributes()

def homeassistant.components.venstar.climate.VenstarThermostat.extra_state_attributes (   self)
Return the optional state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 195 of file climate.py.

◆ fan_mode()

def homeassistant.components.venstar.climate.VenstarThermostat.fan_mode (   self)
Return the current fan mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 188 of file climate.py.

◆ hvac_action()

HVACAction homeassistant.components.venstar.climate.VenstarThermostat.hvac_action (   self)
Return current operation mode ie. heat, cool, auto.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 177 of file climate.py.

◆ hvac_mode()

HVACMode homeassistant.components.venstar.climate.VenstarThermostat.hvac_mode (   self)
Return current operation mode ie. heat, cool, auto.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 166 of file climate.py.

◆ max_humidity()

def homeassistant.components.venstar.climate.VenstarThermostat.max_humidity (   self)
Return the maximum humidity. Hardcoded to 60 in API.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 236 of file climate.py.

◆ min_humidity()

def homeassistant.components.venstar.climate.VenstarThermostat.min_humidity (   self)
Return the minimum humidity. Hardcoded to 0 in API.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 231 of file climate.py.

◆ preset_mode()

def homeassistant.components.venstar.climate.VenstarThermostat.preset_mode (   self)
Return current preset.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 241 of file climate.py.

◆ preset_modes()

def homeassistant.components.venstar.climate.VenstarThermostat.preset_modes (   self)
Return valid preset modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 250 of file climate.py.

◆ set_fan_mode()

None homeassistant.components.venstar.climate.VenstarThermostat.set_fan_mode (   self,
str  fan_mode 
)
Set new target fan mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 310 of file climate.py.

◆ set_humidity()

None homeassistant.components.venstar.climate.VenstarThermostat.set_humidity (   self,
int  humidity 
)
Set new target humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 326 of file climate.py.

◆ set_hvac_mode()

None homeassistant.components.venstar.climate.VenstarThermostat.set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set new target operation mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 321 of file climate.py.

◆ set_preset_mode()

None homeassistant.components.venstar.climate.VenstarThermostat.set_preset_mode (   self,
str  preset_mode 
)
Set the hold mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 334 of file climate.py.

◆ set_temperature()

def homeassistant.components.venstar.climate.VenstarThermostat.set_temperature (   self,
**  kwargs 
)
Set a new target temperature.

Definition at line 269 of file climate.py.

◆ supported_features()

ClimateEntityFeature homeassistant.components.venstar.climate.VenstarThermostat.supported_features (   self)
Return the list of supported features.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 130 of file climate.py.

◆ target_humidity()

def homeassistant.components.venstar.climate.VenstarThermostat.target_humidity (   self)
Return the humidity we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 226 of file climate.py.

◆ target_temperature()

def homeassistant.components.venstar.climate.VenstarThermostat.target_temperature (   self)
Return the target temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 203 of file climate.py.

◆ target_temperature_high()

def homeassistant.components.venstar.climate.VenstarThermostat.target_temperature_high (   self)
Return the upper bound temp if auto mode is on.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 219 of file climate.py.

◆ target_temperature_low()

def homeassistant.components.venstar.climate.VenstarThermostat.target_temperature_low (   self)
Return the lower bound temp if auto mode is on.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 212 of file climate.py.

◆ temperature_unit()

str homeassistant.components.venstar.climate.VenstarThermostat.temperature_unit (   self)
Return the unit of measurement, as defined by the API.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 149 of file climate.py.

Member Data Documentation

◆ _attr_fan_modes

list homeassistant.components.venstar.climate.VenstarThermostat._attr_fan_modes = [FAN_ON, FAN_AUTO]
staticprivate

Definition at line 109 of file climate.py.

◆ _attr_hvac_modes

list homeassistant.components.venstar.climate.VenstarThermostat._attr_hvac_modes = [HVACMode.HEAT, HVACMode.COOL, HVACMode.OFF, HVACMode.AUTO]
staticprivate

Definition at line 110 of file climate.py.

◆ _attr_name

homeassistant.components.venstar.climate.VenstarThermostat._attr_name = None
staticprivate

Definition at line 112 of file climate.py.

◆ _attr_precision

homeassistant.components.venstar.climate.VenstarThermostat._attr_precision = PRECISION_HALVES
staticprivate

Definition at line 111 of file climate.py.

◆ _attr_unique_id

homeassistant.components.venstar.climate.VenstarThermostat._attr_unique_id
private

Definition at line 127 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.venstar.climate.VenstarThermostat._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 113 of file climate.py.

◆ _mode_map

homeassistant.components.venstar.climate.VenstarThermostat._mode_map
private

Definition at line 122 of file climate.py.


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