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

Public Member Functions

def __init__ (self, luminary, update_func, changed)
 
def available (self)
 
def brightness (self)
 
def color_temp (self)
 
def effect_list (self)
 
def extra_state_attributes (self)
 
def hs_color (self)
 
def is_on (self)
 
def max_mireds (self)
 
def min_mireds (self)
 
def name (self)
 
def play_effect (self, effect, transition)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
def unique_id (self)
 
None update (self)
 
def update_dynamic_attributes (self)
 
def update_luminary (self, luminary)
 
None update_static_attributes (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_kelvin (self)
 
str|None effect (self)
 
int max_color_temp_kelvin (self)
 
int min_color_temp_kelvin (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)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
Literal["on", "off"]|None state (self)
 
None toggle (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)
 
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)
 
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 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

 update_func
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

def _get_effect_list (self)
 
set[ColorMode_get_supported_color_modes (self)
 
LightEntityFeature _get_supported_features (self)
 
def _get_unique_id (self)
 

Private Attributes

 _attr_color_mode
 
 _attr_supported_color_modes
 
 _attr_supported_features
 
 _available
 
 _brightness
 
 _changed
 
 _color_temp
 
 _device_attributes
 
 _effect_list
 
 _is_on
 
 _luminary
 
 _max_mireds
 
 _min_mireds
 
 _rgb_color
 
 _unique_id
 

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

Representation of Luminary Lights and Groups.

Definition at line 181 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.osramlightify.light.Luminary.__init__ (   self,
  luminary,
  update_func,
  changed 
)
Initialize a Luminary Light.

Definition at line 184 of file light.py.

Member Function Documentation

◆ _get_effect_list()

def homeassistant.components.osramlightify.light.Luminary._get_effect_list (   self)
private
Get list of supported effects.

Reimplemented in homeassistant.components.osramlightify.light.OsramLightifyGroup.

Definition at line 241 of file light.py.

◆ _get_supported_color_modes()

set[ColorMode] homeassistant.components.osramlightify.light.Luminary._get_supported_color_modes (   self)
private
Get supported color modes.

Definition at line 208 of file light.py.

◆ _get_supported_features()

LightEntityFeature homeassistant.components.osramlightify.light.Luminary._get_supported_features (   self)
private
Get list of supported features.

Reimplemented in homeassistant.components.osramlightify.light.OsramLightifyGroup.

Definition at line 225 of file light.py.

◆ _get_unique_id()

def homeassistant.components.osramlightify.light.Luminary._get_unique_id (   self)
private

◆ available()

def homeassistant.components.osramlightify.light.Luminary.available (   self)
Return True if entity is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 300 of file light.py.

◆ brightness()

def homeassistant.components.osramlightify.light.Luminary.brightness (   self)
Return brightness of the luminary (0..255).

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 265 of file light.py.

◆ color_temp()

def homeassistant.components.osramlightify.light.Luminary.color_temp (   self)
Return the color temperature.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 260 of file light.py.

◆ effect_list()

def homeassistant.components.osramlightify.light.Luminary.effect_list (   self)
List of supported effects.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 275 of file light.py.

◆ extra_state_attributes()

def homeassistant.components.osramlightify.light.Luminary.extra_state_attributes (   self)
Return device specific state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 295 of file light.py.

◆ hs_color()

def homeassistant.components.osramlightify.light.Luminary.hs_color (   self)
Return last hs color value set.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 255 of file light.py.

◆ is_on()

def homeassistant.components.osramlightify.light.Luminary.is_on (   self)
Return True if the device is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 270 of file light.py.

◆ max_mireds()

def homeassistant.components.osramlightify.light.Luminary.max_mireds (   self)
Return the warmest color_temp that this light supports.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 285 of file light.py.

◆ min_mireds()

def homeassistant.components.osramlightify.light.Luminary.min_mireds (   self)
Return the coldest color_temp that this light supports.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 280 of file light.py.

◆ name()

def homeassistant.components.osramlightify.light.Luminary.name (   self)
Return the name of the luminary.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 250 of file light.py.

◆ play_effect()

def homeassistant.components.osramlightify.light.Luminary.play_effect (   self,
  effect,
  transition 
)
Play selected effect.

Reimplemented in homeassistant.components.osramlightify.light.OsramLightifyGroup.

Definition at line 304 of file light.py.

◆ turn_off()

None homeassistant.components.osramlightify.light.Luminary.turn_off (   self,
**Any  kwargs 
)
Turn the device off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 343 of file light.py.

◆ turn_on()

None homeassistant.components.osramlightify.light.Luminary.turn_on (   self,
**Any  kwargs 
)
Turn the device on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 318 of file light.py.

◆ unique_id()

def homeassistant.components.osramlightify.light.Luminary.unique_id (   self)
Return a unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 290 of file light.py.

◆ update()

None homeassistant.components.osramlightify.light.Luminary.update (   self)
Synchronize state with bridge.

Definition at line 397 of file light.py.

◆ update_dynamic_attributes()

def homeassistant.components.osramlightify.light.Luminary.update_dynamic_attributes (   self)
Update dynamic attributes of the luminary.

Definition at line 375 of file light.py.

◆ update_luminary()

def homeassistant.components.osramlightify.light.Luminary.update_luminary (   self,
  luminary 
)
Update internal luminary object.

Definition at line 353 of file light.py.

◆ update_static_attributes()

None homeassistant.components.osramlightify.light.Luminary.update_static_attributes (   self)
Update static attributes of the luminary.

Reimplemented in homeassistant.components.osramlightify.light.OsramLightifyGroup, and homeassistant.components.osramlightify.light.OsramLightifyLight.

Definition at line 358 of file light.py.

Member Data Documentation

◆ _attr_color_mode

homeassistant.components.osramlightify.light.Luminary._attr_color_mode
private

Definition at line 373 of file light.py.

◆ _attr_supported_color_modes

homeassistant.components.osramlightify.light.Luminary._attr_supported_color_modes
private

Definition at line 361 of file light.py.

◆ _attr_supported_features

homeassistant.components.osramlightify.light.Luminary._attr_supported_features
private

Definition at line 362 of file light.py.

◆ _available

homeassistant.components.osramlightify.light.Luminary._available
private

Definition at line 193 of file light.py.

◆ _brightness

homeassistant.components.osramlightify.light.Luminary._brightness
private

Definition at line 196 of file light.py.

◆ _changed

homeassistant.components.osramlightify.light.Luminary._changed
private

Definition at line 188 of file light.py.

◆ _color_temp

homeassistant.components.osramlightify.light.Luminary._color_temp
private

Definition at line 197 of file light.py.

◆ _device_attributes

homeassistant.components.osramlightify.light.Luminary._device_attributes
private

Definition at line 199 of file light.py.

◆ _effect_list

homeassistant.components.osramlightify.light.Luminary._effect_list
private

Definition at line 191 of file light.py.

◆ _is_on

homeassistant.components.osramlightify.light.Luminary._is_on
private

Definition at line 192 of file light.py.

◆ _luminary

homeassistant.components.osramlightify.light.Luminary._luminary
private

Definition at line 187 of file light.py.

◆ _max_mireds

homeassistant.components.osramlightify.light.Luminary._max_mireds
private

Definition at line 195 of file light.py.

◆ _min_mireds

homeassistant.components.osramlightify.light.Luminary._min_mireds
private

Definition at line 194 of file light.py.

◆ _rgb_color

homeassistant.components.osramlightify.light.Luminary._rgb_color
private

Definition at line 198 of file light.py.

◆ _unique_id

homeassistant.components.osramlightify.light.Luminary._unique_id
private

Definition at line 190 of file light.py.

◆ update_func

homeassistant.components.osramlightify.light.Luminary.update_func

Definition at line 186 of file light.py.


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