homeassistant.helpers.update_coordinator Namespace Reference

Classes
class	BaseCoordinatorEntity
class	BaseDataUpdateCoordinatorProtocol
class	CoordinatorEntity
class	DataUpdateCoordinator
class	TimestampDataUpdateCoordinator
class	UpdateFailed

Functions
None	__init__ (self, _BaseDataUpdateCoordinatorT coordinator, Any context=None)
None	_handle_coordinator_update (self)
None	async_added_to_hass (self)
None	async_update (self)
bool	should_poll (self)

Variables
	_DataT = TypeVar("_DataT", default=dict[str, Any])
	_DataUpdateCoordinatorT
	coordinator
	coordinator_context
int	REQUEST_REFRESH_DEFAULT_COOLDOWN = 10
bool	REQUEST_REFRESH_DEFAULT_IMMEDIATE = True

Detailed Description

Helpers to help coordinate updates.

Function Documentation

__init__()

None homeassistant.helpers.update_coordinator.__init__	(		self,
		_BaseDataUpdateCoordinatorT	coordinator,
		Any	context = None
	)

Base class for all Coordinator entities.

Create the entity with a DataUpdateCoordinator.

Definition at line 534 of file update_coordinator.py.

_handle_coordinator_update()

None homeassistant.helpers.update_coordinator._handle_coordinator_update (   self )

private

Handle updated data from the coordinator.

Definition at line 556 of file update_coordinator.py.

async_added_to_hass()

None homeassistant.helpers.update_coordinator.async_added_to_hass

(

self

)

When entity is added to hass.

Definition at line 546 of file update_coordinator.py.

async_update()

None homeassistant.helpers.update_coordinator.async_update

(

self

)

Update the entity.

Only used by the generic entity update service.

Definition at line 561 of file update_coordinator.py.

should_poll()

bool homeassistant.helpers.update_coordinator.should_poll

(

self

)

No need to poll. Coordinator notifies entity of updates.

Definition at line 542 of file update_coordinator.py.

Variable Documentation

_DataT

homeassistant.helpers.update_coordinator._DataT = TypeVar("_DataT", default=dict[str, Any])

private

Definition at line 39 of file update_coordinator.py.

_DataUpdateCoordinatorT

homeassistant.helpers.update_coordinator._DataUpdateCoordinatorT

private

Initial value:

=  TypeVar(
    "_DataUpdateCoordinatorT",
    bound="DataUpdateCoordinator[Any]",
    default="DataUpdateCoordinator[dict[str, Any]]",
)

Definition at line 40 of file update_coordinator.py.

coordinator

homeassistant.helpers.update_coordinator.coordinator

Definition at line 538 of file update_coordinator.py.

coordinator_context

homeassistant.helpers.update_coordinator.coordinator_context

Definition at line 539 of file update_coordinator.py.

REQUEST_REFRESH_DEFAULT_COOLDOWN

int homeassistant.helpers.update_coordinator.REQUEST_REFRESH_DEFAULT_COOLDOWN = 10

Definition at line 36 of file update_coordinator.py.

REQUEST_REFRESH_DEFAULT_IMMEDIATE

bool homeassistant.helpers.update_coordinator.REQUEST_REFRESH_DEFAULT_IMMEDIATE = True

Definition at line 37 of file update_coordinator.py.