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

Public Member Functions

None __init__ (self, str|None device_serial, PyViCareDeviceConfig device_config, PyViCareDevice device, PyViCareHeatingCircuit circuit)
 
dict[str, Any] extra_state_attributes (self)
 
HVACAction hvac_action (self)
 
HVACMode|None hvac_mode (self)
 
list[HVACMode] hvac_modes (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)
 
None set_vicare_mode (self, vicare_mode)
 
None update (self)
 
str|None vicare_mode_from_hvac_mode (self, hvac_mode)
 
- Public Member Functions inherited from homeassistant.components.vicare.entity.ViCareEntity
None __init__ (self, str unique_id_suffix, str|None device_serial, PyViCareDeviceConfig device_config, PyViCareDevice device, PyViCareHeatingDeviceComponent|None component=None)
 
- 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)
 
- 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)
 
float|None current_temperature (self)
 
str|None fan_mode (self)
 
list[str]|None fan_modes (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)
 
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 (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)
 

Static Public Attributes

 None
 
- 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
 

Private Attributes

 _attr_current_temperature
 
 _attr_preset_modes
 
 _attr_target_temperature
 
 _current_action
 
 _current_mode
 
 _current_program
 
 _device
 

Static Private Attributes

 _attr_max_temp = VICARE_TEMP_HEATING_MAX
 
 _attr_min_temp = VICARE_TEMP_HEATING_MIN
 
 _attr_precision = PRECISION_TENTHS
 
tuple _attr_supported_features
 
 _attr_target_temperature_step = PRECISION_WHOLE
 
 _attr_temperature_unit = UnitOfTemperature.CELSIUS
 
string _attr_translation_key = "heating"
 
bool _enable_turn_on_off_backwards_compatibility = False
 

Additional Inherited Members

- 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
 

Detailed Description

Representation of the ViCare heating climate device.

Definition at line 125 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.vicare.climate.ViCareClimate.__init__ (   self,
str | None  device_serial,
PyViCareDeviceConfig  device_config,
PyViCareDevice  device,
PyViCareHeatingCircuit  circuit 
)
Initialize the climate device.

Definition at line 145 of file climate.py.

Member Function Documentation

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.vicare.climate.ViCareClimate.extra_state_attributes (   self)
Show Device Attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 341 of file climate.py.

◆ hvac_action()

HVACAction homeassistant.components.vicare.climate.ViCareClimate.hvac_action (   self)
Return the current hvac action.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 278 of file climate.py.

◆ hvac_mode()

HVACMode | None homeassistant.components.vicare.climate.ViCareClimate.hvac_mode (   self)
Return current hvac mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 233 of file climate.py.

◆ hvac_modes()

list[HVACMode] homeassistant.components.vicare.climate.ViCareClimate.hvac_modes (   self)
Return the list of available hvac modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 263 of file climate.py.

◆ preset_mode()

def homeassistant.components.vicare.climate.ViCareClimate.preset_mode (   self)
Return the current preset mode, e.g., home, away, temp.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 291 of file climate.py.

◆ set_hvac_mode()

None homeassistant.components.vicare.climate.ViCareClimate.set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set a new hvac mode on the ViCare API.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 239 of file climate.py.

◆ set_preset_mode()

None homeassistant.components.vicare.climate.ViCareClimate.set_preset_mode (   self,
str  preset_mode 
)
Set new preset mode and deactivate any existing programs.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 295 of file climate.py.

◆ set_temperature()

None homeassistant.components.vicare.climate.ViCareClimate.set_temperature (   self,
**Any  kwargs 
)
Set new target temperatures.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 284 of file climate.py.

◆ set_vicare_mode()

None homeassistant.components.vicare.climate.ViCareClimate.set_vicare_mode (   self,
  vicare_mode 
)
Service function to set vicare modes directly.

Definition at line 345 of file climate.py.

◆ update()

None homeassistant.components.vicare.climate.ViCareClimate.update (   self)
Let HA know there has been an update from the ViCare API.

Definition at line 165 of file climate.py.

◆ vicare_mode_from_hvac_mode()

str | None homeassistant.components.vicare.climate.ViCareClimate.vicare_mode_from_hvac_mode (   self,
  hvac_mode 
)
Return the corresponding vicare mode for an hvac_mode.

Definition at line 251 of file climate.py.

Member Data Documentation

◆ _attr_current_temperature

homeassistant.components.vicare.climate.ViCareClimate._attr_current_temperature
private

Definition at line 179 of file climate.py.

◆ _attr_max_temp

homeassistant.components.vicare.climate.ViCareClimate._attr_max_temp = VICARE_TEMP_HEATING_MAX
staticprivate

Definition at line 137 of file climate.py.

◆ _attr_min_temp

homeassistant.components.vicare.climate.ViCareClimate._attr_min_temp = VICARE_TEMP_HEATING_MIN
staticprivate

Definition at line 136 of file climate.py.

◆ _attr_precision

homeassistant.components.vicare.climate.ViCareClimate._attr_precision = PRECISION_TENTHS
staticprivate

Definition at line 128 of file climate.py.

◆ _attr_preset_modes

homeassistant.components.vicare.climate.ViCareClimate._attr_preset_modes
private

Definition at line 159 of file climate.py.

◆ _attr_supported_features

tuple homeassistant.components.vicare.climate.ViCareClimate._attr_supported_features
staticprivate
Initial value:
= (
ClimateEntityFeature.TARGET_TEMPERATURE
| ClimateEntityFeature.PRESET_MODE
| ClimateEntityFeature.TURN_OFF
| ClimateEntityFeature.TURN_ON
)

Definition at line 129 of file climate.py.

◆ _attr_target_temperature

homeassistant.components.vicare.climate.ViCareClimate._attr_target_temperature
private

Definition at line 191 of file climate.py.

◆ _attr_target_temperature_step

homeassistant.components.vicare.climate.ViCareClimate._attr_target_temperature_step = PRECISION_WHOLE
staticprivate

Definition at line 138 of file climate.py.

◆ _attr_temperature_unit

homeassistant.components.vicare.climate.ViCareClimate._attr_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 135 of file climate.py.

◆ _attr_translation_key

string homeassistant.components.vicare.climate.ViCareClimate._attr_translation_key = "heating"
staticprivate

Definition at line 139 of file climate.py.

◆ _current_action

homeassistant.components.vicare.climate.ViCareClimate._current_action
private

Definition at line 211 of file climate.py.

◆ _current_mode

homeassistant.components.vicare.climate.ViCareClimate._current_mode
private

Definition at line 194 of file climate.py.

◆ _current_program

homeassistant.components.vicare.climate.ViCareClimate._current_program
private

Definition at line 186 of file climate.py.

◆ _device

homeassistant.components.vicare.climate.ViCareClimate._device
private

Definition at line 156 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.vicare.climate.ViCareClimate._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 143 of file climate.py.

◆ None

homeassistant.components.vicare.climate.ViCareClimate.None
static

Definition at line 140 of file climate.py.


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