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

Public Member Functions

None __init__ (self, SpaClient client)
 
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)
 
float|None current_temperature (self)
 
str|None fan_mode (self)
 
HVACAction hvac_action (self)
 
HVACMode|None hvac_mode (self)
 
float max_temp (self)
 
float min_temp (self)
 
float precision (self)
 
str preset_mode (self)
 
float target_temperature (self)
 
str temperature_unit (self)
 
- Public Member Functions inherited from homeassistant.components.balboa.entity.BalboaEntity
None __init__ (self, SpaClient client, str key)
 
bool assumed_state (self)
 
None async_added_to_hass (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)
 
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)
 
- 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)
 
None async_turn_off (self)
 
None async_turn_on (self)
 
dict[str, Any]|None capability_attributes (self)
 
float|None current_humidity (self)
 
list[str]|None fan_modes (self)
 
list[HVACMode] hvac_modes (self)
 
bool|None is_aux_heat (self)
 
float max_humidity (self)
 
float min_humidity (self)
 
list[str]|None 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)
 
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_high (self)
 
float|None target_temperature_low (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 Attributes

 _attr_fan_modes
 
 _attr_preset_modes
 
 _blower
 
 _fan_mode_map
 

Static Private Attributes

list _attr_hvac_modes = [HVACMode.HEAT, HVACMode.OFF]
 
 _attr_name = None
 
tuple _attr_supported_features
 
 _attr_translation_key = DOMAIN
 
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
 
- 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 Balboa spa climate entity.

Definition at line 56 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.balboa.climate.BalboaClimateEntity.__init__ (   self,
SpaClient  client 
)
Initialize the climate entity.

Definition at line 70 of file climate.py.

Member Function Documentation

◆ async_set_fan_mode()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 144 of file climate.py.

◆ async_set_hvac_mode()

None homeassistant.components.balboa.climate.BalboaClimateEntity.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set new target hvac mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 149 of file climate.py.

◆ async_set_preset_mode()

None homeassistant.components.balboa.climate.BalboaClimateEntity.async_set_preset_mode (   self,
str  preset_mode 
)
Set new preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 140 of file climate.py.

◆ async_set_temperature()

None homeassistant.components.balboa.climate.BalboaClimateEntity.async_set_temperature (   self,
**Any  kwargs 
)
Set a new target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 136 of file climate.py.

◆ current_temperature()

float | None homeassistant.components.balboa.climate.BalboaClimateEntity.current_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 112 of file climate.py.

◆ fan_mode()

str | None homeassistant.components.balboa.climate.BalboaClimateEntity.fan_mode (   self)
Return the fan setting.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 93 of file climate.py.

◆ hvac_action()

HVACAction homeassistant.components.balboa.climate.BalboaClimateEntity.hvac_action (   self)
Return the current operation mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 88 of file climate.py.

◆ hvac_mode()

HVACMode | None homeassistant.components.balboa.climate.BalboaClimateEntity.hvac_mode (   self)
Return the current HVAC mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 83 of file climate.py.

◆ max_temp()

float homeassistant.components.balboa.climate.BalboaClimateEntity.max_temp (   self)
Return the minimum temperature supported by the spa.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 127 of file climate.py.

◆ min_temp()

float homeassistant.components.balboa.climate.BalboaClimateEntity.min_temp (   self)
Return the minimum temperature supported by the spa.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 122 of file climate.py.

◆ precision()

float homeassistant.components.balboa.climate.BalboaClimateEntity.precision (   self)
Return the precision of the system.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 100 of file climate.py.

◆ preset_mode()

str homeassistant.components.balboa.climate.BalboaClimateEntity.preset_mode (   self)
Return current preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 132 of file climate.py.

◆ target_temperature()

float homeassistant.components.balboa.climate.BalboaClimateEntity.target_temperature (   self)
Return the target temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 117 of file climate.py.

◆ temperature_unit()

str homeassistant.components.balboa.climate.BalboaClimateEntity.temperature_unit (   self)
Return the unit of measurement used by the platform.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 107 of file climate.py.

Member Data Documentation

◆ _attr_fan_modes

homeassistant.components.balboa.climate.BalboaClimateEntity._attr_fan_modes
private

Definition at line 80 of file climate.py.

◆ _attr_hvac_modes

list homeassistant.components.balboa.climate.BalboaClimateEntity._attr_hvac_modes = [HVACMode.HEAT, HVACMode.OFF]
staticprivate

Definition at line 59 of file climate.py.

◆ _attr_name

homeassistant.components.balboa.climate.BalboaClimateEntity._attr_name = None
staticprivate

Definition at line 67 of file climate.py.

◆ _attr_preset_modes

homeassistant.components.balboa.climate.BalboaClimateEntity._attr_preset_modes
private

Definition at line 73 of file climate.py.

◆ _attr_supported_features

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

Definition at line 60 of file climate.py.

◆ _attr_translation_key

homeassistant.components.balboa.climate.BalboaClimateEntity._attr_translation_key = DOMAIN
staticprivate

Definition at line 66 of file climate.py.

◆ _blower

homeassistant.components.balboa.climate.BalboaClimateEntity._blower
private

Definition at line 77 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.balboa.climate.BalboaClimateEntity._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 68 of file climate.py.

◆ _fan_mode_map

homeassistant.components.balboa.climate.BalboaClimateEntity._fan_mode_map
private

Definition at line 79 of file climate.py.


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