Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.lifx.entity.LIFXEntity Class Reference
Inheritance diagram for homeassistant.components.lifx.entity.LIFXEntity:
[legend]
Collaboration diagram for homeassistant.components.lifx.entity.LIFXEntity:
[legend]

Public Member Functions

None __init__ (self, LIFXUpdateCoordinator coordinator)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.lifx.coordinator.LIFXUpdateCoordinator
None __init__ (self, HomeAssistant hass, LIFXConnection connection, str title)
 
None async_apply_theme (self, str theme_name)
 
Callable[[], None] async_enable_rssi_updates (self)
 
int async_get_active_effect (self)
 
None async_get_color (self)
 
None async_get_color_zones (self)
 
str|None async_get_entity_id (self, Platform platform, str key)
 
None async_get_extended_color_zones (self)
 
bool|None async_get_hev_cycle_state (self)
 
None async_identify_bulb (self)
 
None async_set_color (self, list[float|int|None] hsbk, int|None duration)
 
None async_set_color_zones (self, int start_index, int end_index, list[float|int|None] hsbk, int|None duration, int apply)
 
None async_set_extended_color_zones (self, list[tuple[int|float, int|float, int|float, int|float]] colors, int|None colors_count=None, int duration=0, int apply=1)
 
None async_set_hev_cycle_state (self, bool enable, int duration=0)
 
None async_set_infrared_brightness (self, str option)
 
None async_set_matrix_effect (self, str effect, list[tuple[int, int, int, int]]|None palette=None, float|None speed=None, bool power_on=True, str|None sky_type=None, int|None cloud_saturation_min=None, int|None cloud_saturation_max=None)
 
None async_set_multizone_effect (self, str effect, float speed=3.0, str direction="RIGHT", str|None theme_name=None, bool power_on=True)
 
None async_set_power (self, bool state, int|None duration)
 
None async_set_waveform_optional (self, dict[str, Any] value, bool rapid=False)
 
None async_setup (self)
 
str|None current_infrared_brightness (self)
 
dict[str, Any] diagnostics (self)
 
int get_number_of_zones (self)
 
bool is_extended_multizone (self)
 
bool is_legacy_multizone (self)
 
bool is_matrix (self)
 
str label (self)
 
str mac_address (self)
 
int rssi (self)
 
str rssi_uom (self)
 
str serial_number (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 Attributes

 bulb
 
- Public Attributes inherited from homeassistant.components.lifx.coordinator.LIFXUpdateCoordinator
 active_effect
 
 connection
 
 last_used_theme
 
 lock
 
- 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
 

Private Attributes

 _attr_device_info
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Detailed Description

Representation of a LIFX entity with a coordinator.

Definition at line 15 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.lifx.entity.LIFXEntity.__init__ (   self,
LIFXUpdateCoordinator  coordinator 
)
Initialise the light.

Reimplemented in homeassistant.components.lifx.button.LIFXButton.

Definition at line 20 of file entity.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.lifx.entity.LIFXEntity._attr_device_info
private

Definition at line 24 of file entity.py.

◆ _attr_has_entity_name

bool homeassistant.components.lifx.entity.LIFXEntity._attr_has_entity_name = True
staticprivate

Definition at line 18 of file entity.py.

◆ bulb

homeassistant.components.lifx.entity.LIFXEntity.bulb

Definition at line 23 of file entity.py.


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