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

Public Member Functions

None __init__ (self, str unique_id, str device_name, bool state, bool available=False, int brightness=180, int|None ct=None, list[str]|None effect_list=None, str|None effect=None, tuple[int, int]|None hs_color=None, tuple[int, int, int, int]|None rgbw_color=None, tuple[int, int, int, int, int]|None rgbww_color=None, set[ColorMode]|None supported_color_modes=None)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
bool available (self)
 
int brightness (self)
 
str|None color_mode (self)
 
int color_temp (self)
 
str|None effect (self)
 
list[str]|None effect_list (self)
 
tuple[int, int]|None hs_color (self)
 
bool is_on (self)
 
tuple[int, int, int, int]|None rgbw_color (self)
 
tuple[int, int, int, int, int]|None rgbww_color (self)
 
set[ColorModesupported_color_modes (self)
 
str unique_id (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 max_mireds (self)
 
int min_color_temp_kelvin (self)
 
int min_mireds (self)
 
tuple[int, int, int]|None rgb_color (self)
 
dict[str, Any]|None state_attributes (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)
 
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)
 
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)
 
Mapping[str, Any]|None extra_state_attributes (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 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 Attributes

 _attr_device_info
 
 _available
 
 _brightness
 
 _color_mode
 
 _color_modes
 
 _ct
 
 _effect
 
 _effect_list
 
 _hs_color
 
 _rgbw_color
 
 _rgbww_color
 
 _state
 
 _unique_id
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 
bool _attr_should_poll = False
 

Additional Inherited Members

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

Definition at line 96 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.demo.light.DemoLight.__init__ (   self,
str  unique_id,
str  device_name,
bool  state,
bool   available = False,
int   brightness = 180,
int | None   ct = None,
list[str] | None   effect_list = None,
str | None   effect = None,
tuple[int, int] | None   hs_color = None,
tuple[int, int, int, int] | None   rgbw_color = None,
tuple[int, int, int, int, int] | None   rgbww_color = None,
set[ColorMode] | None   supported_color_modes = None 
)
Initialize the light.

Definition at line 103 of file light.py.

Member Function Documentation

◆ async_turn_off()

None homeassistant.components.demo.light.DemoLight.async_turn_off (   self,
**Any  kwargs 
)
Turn the light off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 246 of file light.py.

◆ async_turn_on()

None homeassistant.components.demo.light.DemoLight.async_turn_on (   self,
**Any  kwargs 
)
Turn the light on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 212 of file light.py.

◆ available()

bool homeassistant.components.demo.light.DemoLight.available (   self)
Return availability.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 156 of file light.py.

◆ brightness()

int homeassistant.components.demo.light.DemoLight.brightness (   self)
Return the brightness of this light between 0..255.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 163 of file light.py.

◆ color_mode()

str | None homeassistant.components.demo.light.DemoLight.color_mode (   self)
Return the color mode of the light.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 168 of file light.py.

◆ color_temp()

int homeassistant.components.demo.light.DemoLight.color_temp (   self)
Return the CT color temperature.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 188 of file light.py.

◆ effect()

str | None homeassistant.components.demo.light.DemoLight.effect (   self)
Return the current effect.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 198 of file light.py.

◆ effect_list()

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

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 193 of file light.py.

◆ hs_color()

tuple[int, int] | None homeassistant.components.demo.light.DemoLight.hs_color (   self)
Return the hs color value.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 173 of file light.py.

◆ is_on()

bool homeassistant.components.demo.light.DemoLight.is_on (   self)
Return true if light is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 203 of file light.py.

◆ rgbw_color()

tuple[int, int, int, int] | None homeassistant.components.demo.light.DemoLight.rgbw_color (   self)
Return the rgbw color value.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 178 of file light.py.

◆ rgbww_color()

tuple[int, int, int, int, int] | None homeassistant.components.demo.light.DemoLight.rgbww_color (   self)
Return the rgbww color value.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 183 of file light.py.

◆ supported_color_modes()

set[ColorMode] homeassistant.components.demo.light.DemoLight.supported_color_modes (   self)
Flag supported color modes.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 208 of file light.py.

◆ unique_id()

str homeassistant.components.demo.light.DemoLight.unique_id (   self)
Return unique ID for light.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 151 of file light.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.demo.light.DemoLight._attr_device_info
private

Definition at line 142 of file light.py.

◆ _attr_has_entity_name

bool homeassistant.components.demo.light.DemoLight._attr_has_entity_name = True
staticprivate

Definition at line 99 of file light.py.

◆ _attr_name

homeassistant.components.demo.light.DemoLight._attr_name = None
staticprivate

Definition at line 100 of file light.py.

◆ _attr_should_poll

bool homeassistant.components.demo.light.DemoLight._attr_should_poll = False
staticprivate

Definition at line 101 of file light.py.

◆ _available

homeassistant.components.demo.light.DemoLight._available
private

Definition at line 119 of file light.py.

◆ _brightness

homeassistant.components.demo.light.DemoLight._brightness
private

Definition at line 120 of file light.py.

◆ _color_mode

homeassistant.components.demo.light.DemoLight._color_mode
private

Definition at line 130 of file light.py.

◆ _color_modes

homeassistant.components.demo.light.DemoLight._color_modes
private

Definition at line 139 of file light.py.

◆ _ct

homeassistant.components.demo.light.DemoLight._ct
private

Definition at line 121 of file light.py.

◆ _effect

homeassistant.components.demo.light.DemoLight._effect
private

Definition at line 122 of file light.py.

◆ _effect_list

homeassistant.components.demo.light.DemoLight._effect_list
private

Definition at line 123 of file light.py.

◆ _hs_color

homeassistant.components.demo.light.DemoLight._hs_color
private

Definition at line 124 of file light.py.

◆ _rgbw_color

homeassistant.components.demo.light.DemoLight._rgbw_color
private

Definition at line 125 of file light.py.

◆ _rgbww_color

homeassistant.components.demo.light.DemoLight._rgbww_color
private

Definition at line 126 of file light.py.

◆ _state

homeassistant.components.demo.light.DemoLight._state
private

Definition at line 127 of file light.py.

◆ _unique_id

homeassistant.components.demo.light.DemoLight._unique_id
private

Definition at line 128 of file light.py.


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