homeassistant.components.ring.entity Namespace Reference

Classes
class	DeprecatedInfo
class	RingBaseEntity
class	RingEntity
class	RingEntityDescription

Functions
def	_RingBaseEntityT
def	_RingEntityT
bool	async_check_create_deprecated (HomeAssistant hass, Platform platform, str unique_id, RingEntityDescription entity_description)

Variables
	_RingCoordinatorT
	RingDeviceT = TypeVar("RingDeviceT", bound=RingGeneric, default=RingGeneric)

Detailed Description

Base class for Ring entity.

Function Documentation

_RingBaseEntityT()

def homeassistant.components.ring.entity._RingBaseEntityT

private

Definition at line 56 of file entity.py.

_RingEntityT()

def homeassistant.components.ring.entity._RingEntityT

private

Definition at line 79 of file entity.py.

async_check_create_deprecated()

bool homeassistant.components.ring.entity.async_check_create_deprecated	(	HomeAssistant	hass,
		Platform	platform,
		str	unique_id,
		RingEntityDescription	entity_description
	)

Return true if the entitty should be created based on the deprecated_info.

If deprecated_info is not defined will return true.
If entity not yet created will return false.
If entity disabled will delete it and return false.
Otherwise will return true and create issues for scripts or automations.

Definition at line 92 of file entity.py.

Variable Documentation

_RingCoordinatorT

homeassistant.components.ring.entity._RingCoordinatorT

private

Initial value:

=  TypeVar(
    "_RingCoordinatorT",
    bound=(RingDataCoordinator | RingListenCoordinator),
)

Definition at line 35 of file entity.py.

RingDeviceT

homeassistant.components.ring.entity.RingDeviceT = TypeVar("RingDeviceT", bound=RingGeneric, default=RingGeneric)

Definition at line 33 of file entity.py.