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

Public Member Functions

None __init__ (self, EntityData entity_data)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
int brightness (self)
 
ColorMode|None color_mode (self)
 
int|None color_temp (self)
 
str|None effect (self)
 
list[str]|None effect_list (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
bool is_on (self)
 
int max_mireds (self)
 
int min_mireds (self)
 
None restore_external_state_attributes (self, State state)
 
tuple[float, float]|None xy_color (self)
 
- Public Member Functions inherited from homeassistant.components.light.LightEntity
dict[str, Any] capability_attributes (self)
 
int|None color_temp_kelvin (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 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_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_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 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.zha.entity.ZHAEntity
None __init__ (self, EntityData entity_data, *args, **kwargs)
 
None async_added_to_hass (self)
 
None async_update (self)
 
None async_will_remove_from_hass (self)
 
bool available (self)
 
DeviceInfo device_info (self)
 
def log (self, int level, str msg, *args, **kwargs)
 
str|UndefinedType|None name (self)
 
- Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (self)
 

Private Attributes

 _attr_supported_color_modes
 
 _attr_supported_features
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Public Attributes inherited from homeassistant.components.zha.entity.ZHAEntity
 remove_future
 
- 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 ZHA or ZLL light.

Definition at line 77 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.zha.light.Light.__init__ (   self,
EntityData  entity_data 
)
Initialize the ZHA light.

Definition at line 80 of file light.py.

Member Function Documentation

◆ async_turn_off()

None homeassistant.components.zha.light.Light.async_turn_off (   self,
**Any  kwargs 
)
Turn the entity off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 181 of file light.py.

◆ async_turn_on()

None homeassistant.components.zha.light.Light.async_turn_on (   self,
**Any  kwargs 
)
Turn the entity on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 168 of file light.py.

◆ brightness()

int homeassistant.components.zha.light.Light.brightness (   self)
Return the brightness of this light.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 126 of file light.py.

◆ color_mode()

ColorMode | None homeassistant.components.zha.light.Light.color_mode (   self)
Return the color mode.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 151 of file light.py.

◆ color_temp()

int | None homeassistant.components.zha.light.Light.color_temp (   self)
Return the CT color value in mireds.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 146 of file light.py.

◆ effect()

str | None homeassistant.components.zha.light.Light.effect (   self)
Return the current effect.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 163 of file light.py.

◆ effect_list()

list[str] | None homeassistant.components.zha.light.Light.effect_list (   self)
Return the list of supported effects.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 158 of file light.py.

◆ extra_state_attributes()

Mapping[str, Any] | None homeassistant.components.zha.light.Light.extra_state_attributes (   self)
Return entity specific state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 112 of file light.py.

◆ is_on()

bool homeassistant.components.zha.light.Light.is_on (   self)
Return true if entity is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 121 of file light.py.

◆ max_mireds()

int homeassistant.components.zha.light.Light.max_mireds (   self)
Return the warmest color_temp that this light supports.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 136 of file light.py.

◆ min_mireds()

int homeassistant.components.zha.light.Light.min_mireds (   self)
Return the coldest color_temp that this light supports.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 131 of file light.py.

◆ restore_external_state_attributes()

None homeassistant.components.zha.light.Light.restore_external_state_attributes (   self,
State  state 
)
Restore entity state.

Reimplemented from homeassistant.components.zha.entity.ZHAEntity.

Definition at line 189 of file light.py.

◆ xy_color()

tuple[float, float] | None homeassistant.components.zha.light.Light.xy_color (   self)
Return the xy color value [float, float].

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 141 of file light.py.

Member Data Documentation

◆ _attr_supported_color_modes

homeassistant.components.zha.light.Light._attr_supported_color_modes
private

Definition at line 91 of file light.py.

◆ _attr_supported_features

homeassistant.components.zha.light.Light._attr_supported_features
private

Definition at line 109 of file light.py.


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