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

Public Member Functions

None __init__ (self, FluxLedUpdateCoordinator coordinator, str base_unique_id, str|None key)
 
None async_added_to_hass (self)
 
dict[str, str] extra_state_attributes (self)
 
- 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.flux_led.coordinator.FluxLedUpdateCoordinator
None __init__ (self, HomeAssistant hass, AIOWifiLedBulb device, ConfigEntry entry)
 
- 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)
 

Private Member Functions

None _async_ensure_device_on (self)
 
None _handle_coordinator_update (self)
 

Private Attributes

 _attr_device_info
 
 _attr_unique_id
 
 _responding
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.flux_led.coordinator.FluxLedUpdateCoordinator
 device
 
 entry
 
 force_next_update
 
 title
 
- 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
 

Detailed Description

Representation of a Flux entity with a coordinator.

Definition at line 73 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.flux_led.entity.FluxEntity.__init__ (   self,
FluxLedUpdateCoordinator  coordinator,
str  base_unique_id,
str | None  key 
)
Initialize the light.

Reimplemented in homeassistant.components.flux_led.number.FluxConfigNumber.

Definition at line 78 of file entity.py.

Member Function Documentation

◆ _async_ensure_device_on()

None homeassistant.components.flux_led.entity.FluxEntity._async_ensure_device_on (   self)
private
Turn the device on if it needs to be turned on before a command.

Definition at line 94 of file entity.py.

◆ _handle_coordinator_update()

None homeassistant.components.flux_led.entity.FluxEntity._handle_coordinator_update (   self)
private
Handle updated data from the coordinator.

Definition at line 105 of file entity.py.

◆ async_added_to_hass()

None homeassistant.components.flux_led.entity.FluxEntity.async_added_to_hass (   self)
Handle entity which will be added.

Reimplemented in homeassistant.components.flux_led.number.FluxConfigNumber.

Definition at line 111 of file entity.py.

◆ extra_state_attributes()

dict[str, str] homeassistant.components.flux_led.entity.FluxEntity.extra_state_attributes (   self)
Return the attributes.

Definition at line 100 of file entity.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.flux_led.entity.FluxEntity._attr_device_info
private

Definition at line 92 of file entity.py.

◆ _attr_has_entity_name

bool homeassistant.components.flux_led.entity.FluxEntity._attr_has_entity_name = True
staticprivate

Definition at line 76 of file entity.py.

◆ _attr_unique_id

homeassistant.components.flux_led.entity.FluxEntity._attr_unique_id
private

Definition at line 89 of file entity.py.

◆ _responding

homeassistant.components.flux_led.entity.FluxEntity._responding
private

Definition at line 87 of file entity.py.


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