Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.hue.v1.light.HueLight Class Reference
Inheritance diagram for homeassistant.components.hue.v1.light.HueLight:
[legend]
Collaboration diagram for homeassistant.components.hue.v1.light.HueLight:
[legend]

Public Member Functions

def __init__ (self, coordinator, bridge, is_group, light, supported_color_modes, supported_features, rooms)
 
def async_turn_off (self, **kwargs)
 
def async_turn_on (self, **kwargs)
 
def available (self)
 
def brightness (self)
 
str color_mode (self)
 
def color_temp (self)
 
def device_id (self)
 
DeviceInfo|None device_info (self)
 
def effect (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 unique_id (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.light.LightEntity
dict[str, Any] capability_attributes (self)
 
int|None color_temp_kelvin (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)
 
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)
 
str|None device_class (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

 allow_unreachable
 
 bridge
 
 gamut
 
 gamut_typ
 
 is_ewelink
 
 is_group
 
 is_innr
 
 is_livarno
 
 is_osram
 
 is_philips
 
 is_s31litezb
 
 light
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

def _color_mode (self)
 

Private Attributes

 _attr_supported_color_modes
 
 _attr_supported_features
 
 _fixed_color_mode
 
 _rooms
 

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 a Hue light.

Definition at line 309 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.hue.v1.light.HueLight.__init__ (   self,
  coordinator,
  bridge,
  is_group,
  light,
  supported_color_modes,
  supported_features,
  rooms 
)
Initialize the light.

Definition at line 312 of file light.py.

Member Function Documentation

◆ _color_mode()

def homeassistant.components.hue.v1.light.HueLight._color_mode (   self)
private
Return the hue color mode.

Definition at line 417 of file light.py.

◆ async_turn_off()

def homeassistant.components.hue.v1.light.HueLight.async_turn_off (   self,
**  kwargs 
)
Turn the specified or all lights off.

Definition at line 586 of file light.py.

◆ async_turn_on()

def homeassistant.components.hue.v1.light.HueLight.async_turn_on (   self,
**  kwargs 
)
Turn the specified or all lights on.

Definition at line 529 of file light.py.

◆ available()

def homeassistant.components.hue.v1.light.HueLight.available (   self)
Return if light is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 482 of file light.py.

◆ brightness()

def homeassistant.components.hue.v1.light.HueLight.brightness (   self)
Return the brightness of this light between 0..255.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 391 of file light.py.

◆ color_mode()

str homeassistant.components.hue.v1.light.HueLight.color_mode (   self)
Return the color mode of the light.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 404 of file light.py.

◆ color_temp()

def homeassistant.components.hue.v1.light.HueLight.color_temp (   self)
Return the CT color value.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 435 of file light.py.

◆ device_id()

def homeassistant.components.hue.v1.light.HueLight.device_id (   self)
Return the ID of this Hue light.

Definition at line 381 of file light.py.

◆ device_info()

DeviceInfo | None homeassistant.components.hue.v1.light.HueLight.device_info (   self)
Return the device info.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 501 of file light.py.

◆ effect()

def homeassistant.components.hue.v1.light.HueLight.effect (   self)
Return the current effect.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 489 of file light.py.

◆ effect_list()

def homeassistant.components.hue.v1.light.HueLight.effect_list (   self)
Return the list of supported effects.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 494 of file light.py.

◆ extra_state_attributes()

def homeassistant.components.hue.v1.light.HueLight.extra_state_attributes (   self)
Return the device state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 612 of file light.py.

◆ hs_color()

def homeassistant.components.hue.v1.light.HueLight.hs_color (   self)
Return the hs color value.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 424 of file light.py.

◆ is_on()

def homeassistant.components.hue.v1.light.HueLight.is_on (   self)
Return true if device is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 475 of file light.py.

◆ max_mireds()

def homeassistant.components.hue.v1.light.HueLight.max_mireds (   self)
Return the warmest color_temp that this light supports.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 460 of file light.py.

◆ min_mireds()

def homeassistant.components.hue.v1.light.HueLight.min_mireds (   self)
Return the coldest color_temp that this light supports.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 446 of file light.py.

◆ name()

def homeassistant.components.hue.v1.light.HueLight.name (   self)
Return the name of the Hue light.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 386 of file light.py.

◆ unique_id()

def homeassistant.components.hue.v1.light.HueLight.unique_id (   self)
Return the unique ID of this Hue light.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 372 of file light.py.

Member Data Documentation

◆ _attr_supported_color_modes

homeassistant.components.hue.v1.light.HueLight._attr_supported_color_modes
private

Definition at line 324 of file light.py.

◆ _attr_supported_features

homeassistant.components.hue.v1.light.HueLight._attr_supported_features
private

Definition at line 325 of file light.py.

◆ _fixed_color_mode

homeassistant.components.hue.v1.light.HueLight._fixed_color_mode
private

Definition at line 334 of file light.py.

◆ _rooms

homeassistant.components.hue.v1.light.HueLight._rooms
private

Definition at line 329 of file light.py.

◆ allow_unreachable

homeassistant.components.hue.v1.light.HueLight.allow_unreachable

Definition at line 330 of file light.py.

◆ bridge

homeassistant.components.hue.v1.light.HueLight.bridge

Definition at line 327 of file light.py.

◆ gamut

homeassistant.components.hue.v1.light.HueLight.gamut

Definition at line 348 of file light.py.

◆ gamut_typ

homeassistant.components.hue.v1.light.HueLight.gamut_typ

Definition at line 347 of file light.py.

◆ is_ewelink

homeassistant.components.hue.v1.light.HueLight.is_ewelink

Definition at line 344 of file light.py.

◆ is_group

homeassistant.components.hue.v1.light.HueLight.is_group

Definition at line 328 of file light.py.

◆ is_innr

homeassistant.components.hue.v1.light.HueLight.is_innr

Definition at line 343 of file light.py.

◆ is_livarno

homeassistant.components.hue.v1.light.HueLight.is_livarno

Definition at line 345 of file light.py.

◆ is_osram

homeassistant.components.hue.v1.light.HueLight.is_osram

Definition at line 341 of file light.py.

◆ is_philips

homeassistant.components.hue.v1.light.HueLight.is_philips

Definition at line 342 of file light.py.

◆ is_s31litezb

homeassistant.components.hue.v1.light.HueLight.is_s31litezb

Definition at line 346 of file light.py.

◆ light

homeassistant.components.hue.v1.light.HueLight.light

Definition at line 326 of file light.py.


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