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

Public Member Functions

def play_effect (self, effect, transition)
 
def update_static_attributes (self)
 
- Public Member Functions inherited from homeassistant.components.osramlightify.light.Luminary
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)
 
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)
 
- 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)
 

Private Member Functions

def _get_effect_list (self)
 
LightEntityFeature _get_supported_features (self)
 
def _get_unique_id (self)
 

Private Attributes

 _device_attributes
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.osramlightify.light.Luminary
 update_func
 
- 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.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 an Osram Lightify Group.

Definition at line 427 of file light.py.

Member Function Documentation

◆ _get_effect_list()

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

Reimplemented from homeassistant.components.osramlightify.light.Luminary.

Definition at line 449 of file light.py.

◆ _get_supported_features()

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

Reimplemented from homeassistant.components.osramlightify.light.Luminary.

Definition at line 441 of file light.py.

◆ _get_unique_id()

def homeassistant.components.osramlightify.light.OsramLightifyGroup._get_unique_id (   self)
private
Get a unique ID for the group.

Reimplemented from homeassistant.components.osramlightify.light.Luminary.

Definition at line 430 of file light.py.

◆ play_effect()

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

Reimplemented from homeassistant.components.osramlightify.light.Luminary.

Definition at line 455 of file light.py.

◆ update_static_attributes()

def homeassistant.components.osramlightify.light.OsramLightifyGroup.update_static_attributes (   self)
Update static attributes of the luminary.

Reimplemented from homeassistant.components.osramlightify.light.Luminary.

Definition at line 466 of file light.py.

Member Data Documentation

◆ _device_attributes

homeassistant.components.osramlightify.light.OsramLightifyGroup._device_attributes
private

Definition at line 469 of file light.py.


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