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

Public Member Functions

None __init__ (self, NiceGOUpdateCoordinator coordinator, str device_id, str device_name)
 
bool available (self)
 
NiceGODevice data (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.nice_go.coordinator.NiceGOUpdateCoordinator
None __init__ (self, HomeAssistant hass)
 
None async_ha_stop (self, Event event)
 
None client_listen (self)
 
None on_connected (self)
 
None on_connection_lost (self, dict[str, Exception] data)
 
None on_data (self, dict[str, Any] data)
 
None unsubscribe (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)
 

Private Attributes

 _attr_device_info
 
 _attr_unique_id
 
 _device_id
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.nice_go.coordinator.NiceGOUpdateCoordinator
 api
 
 connected
 
 email
 
 organization_id
 
 password
 
 refresh_token
 
 refresh_token_creation_time
 
- 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

Common base for Nice G.O. entities.

Definition at line 10 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.nice_go.entity.NiceGOEntity.__init__ (   self,
NiceGOUpdateCoordinator  coordinator,
str  device_id,
str  device_name 
)
Initialize the entity.

Definition at line 15 of file entity.py.

Member Function Documentation

◆ available()

bool homeassistant.components.nice_go.entity.NiceGOEntity.available (   self)
Return if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 38 of file entity.py.

◆ data()

NiceGODevice homeassistant.components.nice_go.entity.NiceGOEntity.data (   self)
Return the Nice G.O. device.

Definition at line 33 of file entity.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.nice_go.entity.NiceGOEntity._attr_device_info
private

Definition at line 26 of file entity.py.

◆ _attr_has_entity_name

bool homeassistant.components.nice_go.entity.NiceGOEntity._attr_has_entity_name = True
staticprivate

Definition at line 13 of file entity.py.

◆ _attr_unique_id

homeassistant.components.nice_go.entity.NiceGOEntity._attr_unique_id
private

Definition at line 24 of file entity.py.

◆ _device_id

homeassistant.components.nice_go.entity.NiceGOEntity._device_id
private

Definition at line 25 of file entity.py.


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