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

Public Member Functions

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_temperature (self, **Any kwargs)
 
int|None current_humidity (self)
 
float|None current_temperature (self)
 
str|None fan_mode (self)
 
HVACAction|None hvac_action (self)
 
HVACMode|None hvac_mode (self)
 
list[HVACMode] hvac_modes (self)
 
float precision (self)
 
str|None preset_mode (self)
 
list[str]|None preset_modes (self)
 
ClimateEntityFeature supported_features (self)
 
int|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)
 
- Public Member Functions inherited from homeassistant.components.aprilaire.entity.BaseAprilaireEntity
None __init__ (self, AprilaireCoordinator coordinator, str|None unique_id)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.aprilaire.coordinator.AprilaireCoordinator
None __init__ (self, HomeAssistant hass, str|None unique_id, str host, int port)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_set_updated_data (self, Any data)
 
None async_update_listeners (self)
 
DeviceInfo|None create_device_info (self, dict[str, Any] data)
 
str create_device_name (self, dict[str, Any]|None data)
 
DeviceInfo|None device_info (self)
 
str device_name (self)
 
str get_hw_version (self, dict[str, Any] data)
 
def start_listen (self)
 
def stop_listen (self)
 
bool wait_for_ready (self, Callable[[bool], Awaitable[None]] ready_callback)
 
- 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_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)
 
None async_turn_on (self)
 
dict[str, Any]|None capability_attributes (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)
 
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)
 
str|None swing_horizontal_mode (self)
 
list[str]|None swing_horizontal_modes (self)
 
str|None swing_mode (self)
 
list[str]|None swing_modes (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_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 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)
 

Static Private Attributes

list _attr_fan_modes = [FAN_AUTO, FAN_ON, FAN_CIRCULATE]
 
int _attr_max_humidity = 50
 
int _attr_min_humidity = 10
 
 _attr_temperature_unit = UnitOfTemperature.CELSIUS
 
string _attr_translation_key = "thermostat"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.aprilaire.coordinator.AprilaireCoordinator
 client
 
 data
 
 hass
 
 unique_id
 
- 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

Climate entity for Aprilaire.

Definition at line 75 of file climate.py.

Member Function Documentation

◆ async_set_fan_mode()

None homeassistant.components.aprilaire.climate.AprilaireClimate.async_set_fan_mode (   self,
str  fan_mode 
)
Set the fan mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 258 of file climate.py.

◆ async_set_humidity()

None homeassistant.components.aprilaire.climate.AprilaireClimate.async_set_humidity (   self,
int  humidity 
)
Set the target humidification setpoint.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 253 of file climate.py.

◆ async_set_hvac_mode()

None homeassistant.components.aprilaire.climate.AprilaireClimate.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set the HVAC mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 272 of file climate.py.

◆ async_set_preset_mode()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 286 of file climate.py.

◆ async_set_temperature()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 229 of file climate.py.

◆ current_humidity()

int | None homeassistant.components.aprilaire.climate.AprilaireClimate.current_humidity (   self)
Get current humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 111 of file climate.py.

◆ current_temperature()

float | None homeassistant.components.aprilaire.climate.AprilaireClimate.current_temperature (   self)
Get current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 155 of file climate.py.

◆ fan_mode()

str | None homeassistant.components.aprilaire.climate.AprilaireClimate.fan_mode (   self)
Get fan mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 220 of file climate.py.

◆ hvac_action()

HVACAction | None homeassistant.components.aprilaire.climate.AprilaireClimate.hvac_action (   self)
Get the current HVAC action.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 143 of file climate.py.

◆ hvac_mode()

HVACMode | None homeassistant.components.aprilaire.climate.AprilaireClimate.hvac_mode (   self)
Get HVAC mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 123 of file climate.py.

◆ hvac_modes()

list[HVACMode] homeassistant.components.aprilaire.climate.AprilaireClimate.hvac_modes (   self)
Get supported HVAC modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 133 of file climate.py.

◆ precision()

float homeassistant.components.aprilaire.climate.AprilaireClimate.precision (   self)
Get the precision based on the unit.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 85 of file climate.py.

◆ preset_mode()

str | None homeassistant.components.aprilaire.climate.AprilaireClimate.preset_mode (   self)
Get the current preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 194 of file climate.py.

◆ preset_modes()

list[str] | None homeassistant.components.aprilaire.climate.AprilaireClimate.preset_modes (   self)
Get the supported preset modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 203 of file climate.py.

◆ supported_features()

ClimateEntityFeature homeassistant.components.aprilaire.climate.AprilaireClimate.supported_features (   self)
Get supported features.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 94 of file climate.py.

◆ target_humidity()

int | None homeassistant.components.aprilaire.climate.AprilaireClimate.target_humidity (   self)
Get current target humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 118 of file climate.py.

◆ target_temperature()

float | None homeassistant.components.aprilaire.climate.AprilaireClimate.target_temperature (   self)
Get the target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 162 of file climate.py.

◆ target_temperature_high()

float | None homeassistant.components.aprilaire.climate.AprilaireClimate.target_temperature_high (   self)
Get cool setpoint.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 184 of file climate.py.

◆ target_temperature_low()

float | None homeassistant.components.aprilaire.climate.AprilaireClimate.target_temperature_low (   self)
Get heat setpoint.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 189 of file climate.py.

◆ target_temperature_step()

float | None homeassistant.components.aprilaire.climate.AprilaireClimate.target_temperature_step (   self)
Get the step for the target temperature based on the unit.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 175 of file climate.py.

Member Data Documentation

◆ _attr_fan_modes

list homeassistant.components.aprilaire.climate.AprilaireClimate._attr_fan_modes = [FAN_AUTO, FAN_ON, FAN_CIRCULATE]
staticprivate

Definition at line 78 of file climate.py.

◆ _attr_max_humidity

int homeassistant.components.aprilaire.climate.AprilaireClimate._attr_max_humidity = 50
staticprivate

Definition at line 80 of file climate.py.

◆ _attr_min_humidity

int homeassistant.components.aprilaire.climate.AprilaireClimate._attr_min_humidity = 10
staticprivate

Definition at line 79 of file climate.py.

◆ _attr_temperature_unit

homeassistant.components.aprilaire.climate.AprilaireClimate._attr_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 81 of file climate.py.

◆ _attr_translation_key

string homeassistant.components.aprilaire.climate.AprilaireClimate._attr_translation_key = "thermostat"
staticprivate

Definition at line 82 of file climate.py.


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