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

Public Member Functions

None __init__ (self, HueBridge bridge, LightsController controller, Light resource)
 
None async_set_flash (self, str flash)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
int|None brightness (self)
 
ColorMode color_mode (self)
 
int color_temp (self)
 
bool color_temp_active (self)
 
str|None effect (self)
 
dict[str, str]|None extra_state_attributes (self)
 
bool is_on (self)
 
int max_mireds (self)
 
int min_mireds (self)
 
tuple[float, float]|None xy_color (self)
 
- Public Member Functions inherited from homeassistant.components.hue.v2.entity.HueBaseEntity
None __init__ (self, HueBridge bridge, BaseResourcesController controller, HueResource resource)
 
None async_added_to_hass (self)
 
bool available (self)
 
None on_update (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)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (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)
 
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 Member Functions inherited from homeassistant.components.light.LightEntity
dict[str, Any] capability_attributes (self)
 
int|None color_temp_kelvin (self)
 
list[str]|None effect_list (self)
 
tuple[float, float]|None hs_color (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)
 
- 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 Attributes

 controller
 
 effect
 
 resource
 
- Public Attributes inherited from homeassistant.components.hue.v2.entity.HueBaseEntity
 bridge
 
 controller
 
 device
 
 logger
 
 resource
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Static Public Attributes

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

Private Attributes

 _attr_effect_list
 
 _attr_supported_color_modes
 
 _color_temp_active
 
 _fixed_color_mode
 
 _last_brightness
 

Detailed Description

Representation of a Hue light.

Definition at line 72 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.hue.v2.light.HueLight.__init__ (   self,
HueBridge  bridge,
LightsController  controller,
Light   resource 
)
Initialize the light.

Definition at line 80 of file light.py.

Member Function Documentation

◆ async_set_flash()

None homeassistant.components.hue.v2.light.HueLight.async_set_flash (   self,
str  flash 
)
Send flash command to light.

Definition at line 287 of file light.py.

◆ async_turn_off()

None homeassistant.components.hue.v2.light.HueLight.async_turn_off (   self,
**Any  kwargs 
)
Turn the light off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 266 of file light.py.

◆ async_turn_on()

None homeassistant.components.hue.v2.light.HueLight.async_turn_on (   self,
**Any  kwargs 
)
Turn the device on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 209 of file light.py.

◆ brightness()

int | None homeassistant.components.hue.v2.light.HueLight.brightness (   self)
Return the brightness of this light between 0..255.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 122 of file light.py.

◆ color_mode()

ColorMode homeassistant.components.hue.v2.light.HueLight.color_mode (   self)
Return the color mode of the light.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 135 of file light.py.

◆ color_temp()

int homeassistant.components.hue.v2.light.HueLight.color_temp (   self)
Return the color temperature.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 167 of file light.py.

◆ color_temp_active()

bool homeassistant.components.hue.v2.light.HueLight.color_temp_active (   self)
Return if the light is in Color Temperature mode.

Definition at line 148 of file light.py.

◆ effect()

str | None homeassistant.components.hue.v2.light.HueLight.effect (   self)
Return the current effect.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 199 of file light.py.

◆ extra_state_attributes()

dict[str, str] | None homeassistant.components.hue.v2.light.HueLight.extra_state_attributes (   self)
Return the optional state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 191 of file light.py.

◆ is_on()

bool homeassistant.components.hue.v2.light.HueLight.is_on (   self)
Return true if device is on (brightness above 0).

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 130 of file light.py.

◆ max_mireds()

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

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 183 of file light.py.

◆ min_mireds()

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

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 175 of file light.py.

◆ xy_color()

tuple[float, float] | None homeassistant.components.hue.v2.light.HueLight.xy_color (   self)
Return the xy color.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 160 of file light.py.

Member Data Documentation

◆ _attr_effect_list

homeassistant.components.hue.v2.light.HueLight._attr_effect_list
private

Definition at line 106 of file light.py.

◆ _attr_supported_color_modes

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

Definition at line 99 of file light.py.

◆ _color_temp_active

homeassistant.components.hue.v2.light.HueLight._color_temp_active
private

Definition at line 226 of file light.py.

◆ _fixed_color_mode

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

Definition at line 102 of file light.py.

◆ _last_brightness

homeassistant.components.hue.v2.light.HueLight._last_brightness
private

Definition at line 225 of file light.py.

◆ controller

homeassistant.components.hue.v2.light.HueLight.controller

Definition at line 88 of file light.py.

◆ effect

homeassistant.components.hue.v2.light.HueLight.effect

Definition at line 234 of file light.py.

◆ entity_description

homeassistant.components.hue.v2.light.HueLight.entity_description
static
Initial value:
= LightEntityDescription(
key="hue_light", has_entity_name=True, name=None
)

Definition at line 76 of file light.py.

◆ None

homeassistant.components.hue.v2.light.HueLight.None
static

Definition at line 75 of file light.py.

◆ resource

homeassistant.components.hue.v2.light.HueLight.resource

Definition at line 87 of file light.py.


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