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

Public Member Functions

None __init__ (self, BSBLanData data)
 
None async_set_data (self, **Any kwargs)
 
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)
 
HVACMode|None hvac_mode (self)
 
str|None preset_mode (self)
 
float|None target_temperature (self)
 
- Public Member Functions inherited from homeassistant.components.bsblan.entity.BSBLanEntity
None __init__ (self, BSBLanUpdateCoordinator coordinator, BSBLanData data)
 
- 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.bsblan.coordinator.BSBLanUpdateCoordinator
None __init__ (self, HomeAssistant hass, ConfigEntry config_entry, BSBLAN client)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- 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_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)
 
str|None fan_mode (self)
 
list[str]|None fan_modes (self)
 
HVACAction|None hvac_action (self)
 
list[HVACMode] hvac_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_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)
 
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)
 

Public Attributes

 hvac_mode
 
- Public Attributes inherited from homeassistant.components.bsblan.coordinator.BSBLanUpdateCoordinator
 client
 
 update_interval
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- 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
 

Private Attributes

 _attr_max_temp
 
 _attr_min_temp
 
 _attr_temperature_unit
 
 _attr_unique_id
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_hvac_modes = HVAC_MODES
 
 _attr_name = None
 
 _attr_preset_modes = PRESET_MODES
 
tuple _attr_supported_features
 
bool _enable_turn_on_off_backwards_compatibility = False
 

Additional Inherited Members

- 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

Defines a BSBLAN climate device.

Definition at line 53 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.bsblan.climate.BSBLANClimate.__init__ (   self,
BSBLanData  data 
)
Initialize BSBLAN climate device.

Definition at line 70 of file climate.py.

Member Function Documentation

◆ async_set_data()

None homeassistant.components.bsblan.climate.BSBLANClimate.async_set_data (   self,
**Any  kwargs 
)
Set device settings using BSBLAN.

Definition at line 128 of file climate.py.

◆ async_set_hvac_mode()

None homeassistant.components.bsblan.climate.BSBLANClimate.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set hvac mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 109 of file climate.py.

◆ async_set_preset_mode()

None homeassistant.components.bsblan.climate.BSBLANClimate.async_set_preset_mode (   self,
str  preset_mode 
)
Set preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 113 of file climate.py.

◆ async_set_temperature()

None homeassistant.components.bsblan.climate.BSBLANClimate.async_set_temperature (   self,
**Any  kwargs 
)
Set new target temperatures.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 124 of file climate.py.

◆ current_temperature()

float | None homeassistant.components.bsblan.climate.BSBLANClimate.current_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 83 of file climate.py.

◆ hvac_mode()

HVACMode | None homeassistant.components.bsblan.climate.BSBLANClimate.hvac_mode (   self)
Return hvac operation ie. heat, cool mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 93 of file climate.py.

◆ preset_mode()

str | None homeassistant.components.bsblan.climate.BSBLANClimate.preset_mode (   self)
Return the current preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 100 of file climate.py.

◆ target_temperature()

float | None homeassistant.components.bsblan.climate.BSBLANClimate.target_temperature (   self)
Return the temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 88 of file climate.py.

Member Data Documentation

◆ _attr_has_entity_name

bool homeassistant.components.bsblan.climate.BSBLANClimate._attr_has_entity_name = True
staticprivate

Definition at line 56 of file climate.py.

◆ _attr_hvac_modes

homeassistant.components.bsblan.climate.BSBLANClimate._attr_hvac_modes = HVAC_MODES
staticprivate

Definition at line 67 of file climate.py.

◆ _attr_max_temp

homeassistant.components.bsblan.climate.BSBLANClimate._attr_max_temp
private

Definition at line 79 of file climate.py.

◆ _attr_min_temp

homeassistant.components.bsblan.climate.BSBLANClimate._attr_min_temp
private

Definition at line 78 of file climate.py.

◆ _attr_name

homeassistant.components.bsblan.climate.BSBLANClimate._attr_name = None
staticprivate

Definition at line 57 of file climate.py.

◆ _attr_preset_modes

homeassistant.components.bsblan.climate.BSBLANClimate._attr_preset_modes = PRESET_MODES
staticprivate

Definition at line 66 of file climate.py.

◆ _attr_supported_features

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

Definition at line 59 of file climate.py.

◆ _attr_temperature_unit

homeassistant.components.bsblan.climate.BSBLANClimate._attr_temperature_unit
private

Definition at line 80 of file climate.py.

◆ _attr_unique_id

homeassistant.components.bsblan.climate.BSBLANClimate._attr_unique_id
private

Definition at line 76 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.bsblan.climate.BSBLANClimate._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 68 of file climate.py.

◆ hvac_mode

homeassistant.components.bsblan.climate.BSBLANClimate.hvac_mode

Definition at line 103 of file climate.py.


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