homeassistant.components.yale.util Namespace Reference

Functions
Activity|None	_activity_time_based (Activity latest)
aiohttp.ClientSession	async_create_yale_clientsession (HomeAssistant hass)
Activity|None	retrieve_ding_activity (YaleData data, DoorbellDetail|LockDetail detail)
bool	retrieve_online_state (YaleData data, DoorbellDetail|LockDetail detail)
Activity|None	retrieve_time_based_activity (set[ActivityType] activities, YaleData data, DoorbellDetail|LockDetail detail)

Variables
dictionary	_RING_ACTIVITIES = {ActivityType.DOORBELL_DING}
	retrieve_doorbell_motion_activity
	TIME_TO_DECLARE_DETECTION = timedelta(seconds=ACTIVITY_UPDATE_INTERVAL.total_seconds())

Detailed Description

Yale util functions.

Function Documentation

_activity_time_based()

Activity | None homeassistant.components.yale.util._activity_time_based ( Activity  latest )

private

Get the latest state of the sensor.

Definition at line 62 of file util.py.

async_create_yale_clientsession()

aiohttp.ClientSession homeassistant.components.yale.util.async_create_yale_clientsession

(

HomeAssistant

hass

)

Create an aiohttp session for the yale integration.

Definition at line 23 of file util.py.

retrieve_ding_activity()

Activity | None homeassistant.components.yale.util.retrieve_ding_activity	(	YaleData	data,
		DoorbellDetail | LockDetail	detail
	)

Get the ring/ding state.

Definition at line 44 of file util.py.

retrieve_online_state()

bool homeassistant.components.yale.util.retrieve_online_state	(	YaleData	data,
		DoorbellDetail | LockDetail	detail
	)

Get the latest state of the sensor.

Definition at line 71 of file util.py.

retrieve_time_based_activity()

Activity | None homeassistant.components.yale.util.retrieve_time_based_activity	(	set[ActivityType]	activities,
		YaleData	data,
		DoorbellDetail | LockDetail	detail
	)

Get the latest state of the sensor.

Definition at line 31 of file util.py.

Variable Documentation

_RING_ACTIVITIES

dictionary homeassistant.components.yale.util._RING_ACTIVITIES = {ActivityType.DOORBELL_DING}

private

Definition at line 41 of file util.py.

retrieve_doorbell_motion_activity

homeassistant.components.yale.util.retrieve_doorbell_motion_activity

Initial value:

=  partial(
    retrieve_time_based_activity, {ActivityType.DOORBELL_MOTION}
)

Definition at line 57 of file util.py.

TIME_TO_DECLARE_DETECTION

homeassistant.components.yale.util.TIME_TO_DECLARE_DETECTION = timedelta(seconds=ACTIVITY_UPDATE_INTERVAL.total_seconds())

Definition at line 19 of file util.py.