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

Public Member Functions

None __init__ (self, ConfigEntry config_entry, LivisiDataUpdateCoordinator coordinator, dict[str, Any] device, *bool use_room_as_device_name=False)
 
None async_added_to_hass (self)
 
None update_reachability (self, bool is_reachable)
 
- 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.livisi.coordinator.LivisiDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, ConfigEntry config_entry, AioLivisi aiolivisi)
 
Any|None async_get_device_state (self, str capability, str key)
 
list[dict[str, Any]] async_get_devices (self)
 
None async_set_all_rooms (self)
 
None async_setup (self)
 
None on_close (self)
 
None on_data (self, LivisiEvent event_data)
 
None ws_connect (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

 aio_livisi
 
- Public Attributes inherited from homeassistant.components.livisi.coordinator.LivisiDataUpdateCoordinator
 aiolivisi
 
 config_entry
 
 controller_type
 
 hass
 
 is_avatar
 
 port
 
 serial_number
 
 websocket
 
- 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_available
 
 _attr_device_info
 
 _attr_name
 
 _attr_unique_id
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Detailed Description

Represents a base livisi entity.

Definition at line 20 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.livisi.entity.LivisiEntity.__init__ (   self,
ConfigEntry  config_entry,
LivisiDataUpdateCoordinator  coordinator,
dict[str, Any]  device,
*bool   use_room_as_device_name = False 
)
Initialize the common properties of a Livisi device.

Definition at line 25 of file entity.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.livisi.entity.LivisiEntity.async_added_to_hass (   self)

◆ update_reachability()

None homeassistant.components.livisi.entity.LivisiEntity.update_reachability (   self,
bool  is_reachable 
)
Update the reachability of the device.

Definition at line 80 of file entity.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.livisi.entity.LivisiEntity._attr_available
private

Definition at line 45 of file entity.py.

◆ _attr_device_info

homeassistant.components.livisi.entity.LivisiEntity._attr_device_info
private

Definition at line 58 of file entity.py.

◆ _attr_has_entity_name

bool homeassistant.components.livisi.entity.LivisiEntity._attr_has_entity_name = True
staticprivate

Definition at line 23 of file entity.py.

◆ _attr_name

homeassistant.components.livisi.entity.LivisiEntity._attr_name
private

Definition at line 55 of file entity.py.

◆ _attr_unique_id

homeassistant.components.livisi.entity.LivisiEntity._attr_unique_id
private

Definition at line 46 of file entity.py.

◆ aio_livisi

homeassistant.components.livisi.entity.LivisiEntity.aio_livisi

Definition at line 34 of file entity.py.


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