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

Public Member Functions

None __init__ (self, *RiscoDataUpdateCoordinator coordinator, **Any kwargs)
 
- 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.risco.coordinator.RiscoDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, RiscoCloud risco, int scan_interval)
 
- 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 _get_data_from_coordinator (self)
 
None _handle_coordinator_update (self)
 
RiscoCloud _risco (self)
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.risco.coordinator.RiscoDataUpdateCoordinator
 risco
 
- 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

Risco cloud entity base class.

Definition at line 26 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.risco.entity.RiscoCloudEntity.__init__ (   self,
*RiscoDataUpdateCoordinator  coordinator,
**Any   kwargs 
)
Init the entity.

Definition at line 29 of file entity.py.

Member Function Documentation

◆ _get_data_from_coordinator()

None homeassistant.components.risco.entity.RiscoCloudEntity._get_data_from_coordinator (   self)
private

◆ _handle_coordinator_update()

None homeassistant.components.risco.entity.RiscoCloudEntity._handle_coordinator_update (   self)
private

Definition at line 38 of file entity.py.

◆ _risco()

RiscoCloud homeassistant.components.risco.entity.RiscoCloudEntity._risco (   self)
private
Return the Risco API object.

Definition at line 43 of file entity.py.


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