homeassistant.components.unifiprotect.entity Namespace Reference

Classes
class	BaseProtectEntity
class	EventEntityMixin
class	PermRequired
class	ProtectDeviceEntity
class	ProtectEntityDescription
class	ProtectEventMixin
class	ProtectIsOnEntity
class	ProtectNVREntity
class	ProtectSetableKeysMixin

Functions
list[BaseProtectEntity]	_async_device_entities (ProtectData data, type[BaseProtectEntity] klass, ModelType model_type, Sequence[ProtectEntityDescription] descs, Sequence[ProtectEntityDescription]|None unadopted_descs=None, ProtectAdoptableDeviceModel|None ufp_device=None)
list[ProtectEntityDescription]	_combine_model_descs (ModelType model_type, dict[ModelType, Sequence[ProtectEntityDescription]]|None model_descriptions, Sequence[ProtectEntityDescription]|None all_descs)
list[BaseProtectEntity]	async_all_device_entities (ProtectData data, type[BaseProtectEntity] klass, dict[ModelType, Sequence[ProtectEntityDescription]]|None model_descriptions=None, Sequence[ProtectEntityDescription]|None all_descs=None, list[ProtectEntityDescription]|None unadopted_descs=None, ProtectAdoptableDeviceModel|None ufp_device=None)

Variables
tuple	_ALL_MODEL_TYPES
	_LOGGER = logging.getLogger(__name__)
	T = TypeVar("T", bound=ProtectAdoptableDeviceModel | NVR)

Detailed Description

Shared Entity definition for UniFi Protect Integration.

Function Documentation

_async_device_entities()

list[BaseProtectEntity] homeassistant.components.unifiprotect.entity._async_device_entities ( ProtectData  data, type[BaseProtectEntity]  klass, ModelType  model_type, Sequence[ProtectEntityDescription]  descs, Sequence[ProtectEntityDescription] | None   unadopted_descs = None, ProtectAdoptableDeviceModel | None   ufp_device = None  )

private

Definition at line 52 of file entity.py.

_combine_model_descs()

list[ProtectEntityDescription] homeassistant.components.unifiprotect.entity._combine_model_descs ( ModelType  model_type, dict[ModelType, Sequence[ProtectEntityDescription]] | None  model_descriptions, Sequence[ProtectEntityDescription] | None  all_descs  )

private

Combine all the descriptions with descriptions a model type.

Definition at line 132 of file entity.py.

async_all_device_entities()

list[BaseProtectEntity] homeassistant.components.unifiprotect.entity.async_all_device_entities	(	ProtectData	data,
		type[BaseProtectEntity]	klass,
		dict[ModelType, Sequence[ProtectEntityDescription]] | None	model_descriptions = None,
		Sequence[ProtectEntityDescription] | None	all_descs = None,
		list[ProtectEntityDescription] | None	unadopted_descs = None,
		ProtectAdoptableDeviceModel | None	ufp_device = None
	)

Generate a list of all the device entities.

Definition at line 145 of file entity.py.

Variable Documentation

_ALL_MODEL_TYPES

tuple homeassistant.components.unifiprotect.entity._ALL_MODEL_TYPES

private

Initial value:

=  (
    ModelType.CAMERA,
    ModelType.LIGHT,
    ModelType.SENSOR,
    ModelType.VIEWPORT,
    ModelType.DOORLOCK,
    ModelType.CHIME,
)

Definition at line 121 of file entity.py.

_LOGGER

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

private

Definition at line 38 of file entity.py.

T

homeassistant.components.unifiprotect.entity.T = TypeVar("T", bound=ProtectAdoptableDeviceModel | NVR)

Definition at line 40 of file entity.py.