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

Public Member Functions

None __init__ (self, WLEDDataUpdateCoordinator coordinator, int segment)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
bool available (self)
 
int|None brightness (self)
 
int|None color_temp_kelvin (self)
 
str|None effect (self)
 
list[streffect_list (self)
 
bool is_on (self)
 
tuple[int, int, int]|None rgb_color (self)
 
tuple[int, int, int, int]|None rgbw_color (self)
 
- Public Member Functions inherited from homeassistant.components.wled.entity.WLEDEntity
DeviceInfo device_info (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.wled.coordinator.WLEDDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, *ConfigEntry entry)
 
bool has_main_light (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- 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 (self)
 
tuple[float, float]|None hs_color (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, 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)
 
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 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)
 

Private Attributes

 _attr_color_mode
 
 _attr_name
 
 _attr_supported_color_modes
 
 _attr_translation_placeholders
 
 _attr_unique_id
 
 _segment
 

Static Private Attributes

 _attr_max_color_temp_kelvin = COLOR_TEMP_K_MAX
 
 _attr_min_color_temp_kelvin = COLOR_TEMP_K_MIN
 
 _attr_supported_features = LightEntityFeature.EFFECT | LightEntityFeature.TRANSITION
 
string _attr_translation_key = "segment"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.wled.coordinator.WLEDDataUpdateCoordinator
 keep_main_light
 
 last_update_success
 
 unsub
 
 wled
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- 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

Defines a WLED light based on a segment.

Definition at line 111 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.wled.light.WLEDSegmentLight.__init__ (   self,
WLEDDataUpdateCoordinator  coordinator,
int  segment 
)
Initialize WLED segment light.

Definition at line 119 of file light.py.

Member Function Documentation

◆ async_turn_off()

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

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 220 of file light.py.

◆ async_turn_on()

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

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 237 of file light.py.

◆ available()

bool homeassistant.components.wled.light.WLEDSegmentLight.available (   self)
Return True if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 152 of file light.py.

◆ brightness()

int | None homeassistant.components.wled.light.WLEDSegmentLight.brightness (   self)
Return the brightness of this light between 1..255.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 189 of file light.py.

◆ color_temp_kelvin()

int | None homeassistant.components.wled.light.WLEDSegmentLight.color_temp_kelvin (   self)
Return the CT color value in K.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 176 of file light.py.

◆ effect()

str | None homeassistant.components.wled.light.WLEDSegmentLight.effect (   self)
Return the current effect of the light.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 182 of file light.py.

◆ effect_list()

list[str] homeassistant.components.wled.light.WLEDSegmentLight.effect_list (   self)
Return the list of supported effects.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 203 of file light.py.

◆ is_on()

bool homeassistant.components.wled.light.WLEDSegmentLight.is_on (   self)
Return the state of the light.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 208 of file light.py.

◆ rgb_color()

tuple[int, int, int] | None homeassistant.components.wled.light.WLEDSegmentLight.rgb_color (   self)
Return the color value.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 162 of file light.py.

◆ rgbw_color()

tuple[int, int, int, int] | None homeassistant.components.wled.light.WLEDSegmentLight.rgbw_color (   self)
Return the color value.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 169 of file light.py.

Member Data Documentation

◆ _attr_color_mode

homeassistant.components.wled.light.WLEDSegmentLight._attr_color_mode
private

Definition at line 148 of file light.py.

◆ _attr_max_color_temp_kelvin

homeassistant.components.wled.light.WLEDSegmentLight._attr_max_color_temp_kelvin = COLOR_TEMP_K_MAX
staticprivate

Definition at line 117 of file light.py.

◆ _attr_min_color_temp_kelvin

homeassistant.components.wled.light.WLEDSegmentLight._attr_min_color_temp_kelvin = COLOR_TEMP_K_MIN
staticprivate

Definition at line 116 of file light.py.

◆ _attr_name

homeassistant.components.wled.light.WLEDSegmentLight._attr_name
private

Definition at line 131 of file light.py.

◆ _attr_supported_color_modes

homeassistant.components.wled.light.WLEDSegmentLight._attr_supported_color_modes
private

Definition at line 149 of file light.py.

◆ _attr_supported_features

homeassistant.components.wled.light.WLEDSegmentLight._attr_supported_features = LightEntityFeature.EFFECT | LightEntityFeature.TRANSITION
staticprivate

Definition at line 114 of file light.py.

◆ _attr_translation_key

string homeassistant.components.wled.light.WLEDSegmentLight._attr_translation_key = "segment"
staticprivate

Definition at line 115 of file light.py.

◆ _attr_translation_placeholders

homeassistant.components.wled.light.WLEDSegmentLight._attr_translation_placeholders
private

Definition at line 133 of file light.py.

◆ _attr_unique_id

homeassistant.components.wled.light.WLEDSegmentLight._attr_unique_id
private

Definition at line 135 of file light.py.

◆ _segment

homeassistant.components.wled.light.WLEDSegmentLight._segment
private

Definition at line 126 of file light.py.


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