homeassistant.components.unifiprotect.data Namespace Reference

Classes
class	ProtectData

Functions
str	_async_dispatch_id (UFPConfigEntry entry, str dispatch)
ProtectData|None	async_get_data_for_entry_id (HomeAssistant hass, str entry_id)
ProtectData|None	async_get_data_for_nvr_id (HomeAssistant hass, str nvr_id)
list[UFPConfigEntry]	async_get_ufp_entries (HomeAssistant hass)
bool	async_last_update_was_successful (HomeAssistant hass, UFPConfigEntry entry)
ProtectApiClient|None	async_ufp_instance_for_config_entry_ids (HomeAssistant hass, set[str] config_entry_ids)

Variables
	_LOGGER = logging.getLogger(__name__)
	ProtectDeviceType
	UFPConfigEntry

Detailed Description

Base class for protect data.

Function Documentation

_async_dispatch_id()

str homeassistant.components.unifiprotect.data._async_dispatch_id ( UFPConfigEntry  entry, str  dispatch  )

private

Generate entry specific dispatch ID.

Definition at line 62 of file data.py.

async_get_data_for_entry_id()

ProtectData | None homeassistant.components.unifiprotect.data.async_get_data_for_entry_id	(	HomeAssistant	hass,
		str	entry_id
	)

Find the ProtectData instance for a config entry id.

Definition at line 388 of file data.py.

async_get_data_for_nvr_id()

ProtectData | None homeassistant.components.unifiprotect.data.async_get_data_for_nvr_id	(	HomeAssistant	hass,
		str	nvr_id
	)

Find the ProtectData instance for the NVR id.

Definition at line 375 of file data.py.

async_get_ufp_entries()

list[UFPConfigEntry] homeassistant.components.unifiprotect.data.async_get_ufp_entries

(

HomeAssistant

hass

)

Get all the UFP entries.

Definition at line 360 of file data.py.

async_last_update_was_successful()

bool homeassistant.components.unifiprotect.data.async_last_update_was_successful	(	HomeAssistant	hass,
		UFPConfigEntry	entry
	)

Check if the last update was successful for a config entry.

Definition at line 54 of file data.py.

async_ufp_instance_for_config_entry_ids()

ProtectApiClient | None homeassistant.components.unifiprotect.data.async_ufp_instance_for_config_entry_ids	(	HomeAssistant	hass,
		set[str]	config_entry_ids
	)

Find the UFP instance for the config entry ids.

Definition at line 343 of file data.py.

Variable Documentation

_LOGGER

homeassistant.components.unifiprotect.data._LOGGER = logging.getLogger(__name__)

private

Definition at line 48 of file data.py.

ProtectDeviceType

homeassistant.components.unifiprotect.data.ProtectDeviceType

Definition at line 49 of file data.py.

UFPConfigEntry

homeassistant.components.unifiprotect.data.UFPConfigEntry

Definition at line 50 of file data.py.