Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.smarttub.light.SmartTubLight Class Reference
Inheritance diagram for homeassistant.components.smarttub.light.SmartTubLight:
[legend]
Collaboration diagram for homeassistant.components.smarttub.light.SmartTubLight:
[legend]

Public Member Functions

def __init__ (self, coordinator, light)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
def brightness (self)
 
def effect (self)
 
def effect_list (self)
 
def is_on (self)
 
SpaLight light (self)
 
- Public Member Functions inherited from homeassistant.components.smarttub.entity.SmartTubEntity
None __init__ (self, DataUpdateCoordinator coordinator, smarttub.Spa spa, entity_name)
 
smarttub.SpaState spa_status (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.light.LightEntity
dict[str, Any] capability_attributes (self)
 
ColorMode|str|None color_mode (self)
 
int|None color_temp (self)
 
int|None color_temp_kelvin (self)
 
tuple[float, float]|None hs_color (self)
 
int max_color_temp_kelvin (self)
 
int max_mireds (self)
 
int min_color_temp_kelvin (self)
 
int min_mireds (self)
 
tuple[int, int, int]|None rgb_color (self)
 
tuple[int, int, int, int]|None rgbw_color (self)
 
tuple[int, int, int, int, int]|None rgbww_color (self)
 
dict[str, Any]|None state_attributes (self)
 
set[ColorMode]|set[str]|None supported_color_modes (self)
 
LightEntityFeature supported_features (self)
 
LightEntityFeature supported_features_compat (self)
 
tuple[float, float]|None xy_color (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
- 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 add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
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

 light_zone
 
- Public Attributes inherited from homeassistant.components.smarttub.entity.SmartTubEntity
 spa
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Static Private Member Functions

def _effect_to_light_mode (effect)
 
def _hass_to_smarttub_brightness (brightness)
 
def _light_mode_to_effect (SpaLight.LightMode light_mode)
 
def _smarttub_to_hass_brightness (intensity)
 

Private Attributes

 _attr_name
 
 _attr_unique_id
 

Static Private Attributes

 _attr_color_mode = ColorMode.BRIGHTNESS
 
dictionary _attr_supported_color_modes = {ColorMode.BRIGHTNESS}
 
 _attr_supported_features = LightEntityFeature.EFFECT
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.light.LightEntity
 int
 
 LightEntityFeature
 
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

A light on a spa.

Definition at line 46 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.smarttub.light.SmartTubLight.__init__ (   self,
  coordinator,
  light 
)
Initialize the entity.

Definition at line 53 of file light.py.

Member Function Documentation

◆ _effect_to_light_mode()

def homeassistant.components.smarttub.light.SmartTubLight._effect_to_light_mode (   effect)
staticprivate

Definition at line 115 of file light.py.

◆ _hass_to_smarttub_brightness()

def homeassistant.components.smarttub.light.SmartTubLight._hass_to_smarttub_brightness (   brightness)
staticprivate

Definition at line 80 of file light.py.

◆ _light_mode_to_effect()

def homeassistant.components.smarttub.light.SmartTubLight._light_mode_to_effect ( SpaLight.LightMode  light_mode)
staticprivate

Definition at line 106 of file light.py.

◆ _smarttub_to_hass_brightness()

def homeassistant.components.smarttub.light.SmartTubLight._smarttub_to_hass_brightness (   intensity)
staticprivate

Definition at line 74 of file light.py.

◆ async_turn_off()

None homeassistant.components.smarttub.light.SmartTubLight.async_turn_off (   self,
**Any  kwargs 
)
Turn the light off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 132 of file light.py.

◆ async_turn_on()

None homeassistant.components.smarttub.light.SmartTubLight.async_turn_on (   self,
**Any  kwargs 
)
Turn the light on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 121 of file light.py.

◆ brightness()

def homeassistant.components.smarttub.light.SmartTubLight.brightness (   self)
Return the brightness of this light between 0..255.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 67 of file light.py.

◆ effect()

def homeassistant.components.smarttub.light.SmartTubLight.effect (   self)
Return the current effect.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 89 of file light.py.

◆ effect_list()

def homeassistant.components.smarttub.light.SmartTubLight.effect_list (   self)
Return the list of supported effects.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 97 of file light.py.

◆ is_on()

def homeassistant.components.smarttub.light.SmartTubLight.is_on (   self)
Return true if the light is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 84 of file light.py.

◆ light()

SpaLight homeassistant.components.smarttub.light.SmartTubLight.light (   self)
Return the underlying SpaLight object for this entity.

Definition at line 62 of file light.py.

Member Data Documentation

◆ _attr_color_mode

homeassistant.components.smarttub.light.SmartTubLight._attr_color_mode = ColorMode.BRIGHTNESS
staticprivate

Definition at line 49 of file light.py.

◆ _attr_name

homeassistant.components.smarttub.light.SmartTubLight._attr_name
private

Definition at line 59 of file light.py.

◆ _attr_supported_color_modes

dictionary homeassistant.components.smarttub.light.SmartTubLight._attr_supported_color_modes = {ColorMode.BRIGHTNESS}
staticprivate

Definition at line 50 of file light.py.

◆ _attr_supported_features

homeassistant.components.smarttub.light.SmartTubLight._attr_supported_features = LightEntityFeature.EFFECT
staticprivate

Definition at line 51 of file light.py.

◆ _attr_unique_id

homeassistant.components.smarttub.light.SmartTubLight._attr_unique_id
private

Definition at line 57 of file light.py.

◆ light_zone

homeassistant.components.smarttub.light.SmartTubLight.light_zone

Definition at line 56 of file light.py.


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