homeassistant.components.unifiprotect.entity.EventEntityMixin Class Reference

Inheritance diagram for homeassistant.components.unifiprotect.entity.EventEntityMixin:

Collaboration diagram for homeassistant.components.unifiprotect.entity.EventEntityMixin:

Static Public Attributes
	None
Static Public Attributes inherited from homeassistant.components.unifiprotect.entity.BaseProtectEntity
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Private Member Functions
None	_async_event_with_immediate_end (self)
bool	_event_already_ended (self, Event|None prev_event, datetime|None prev_event_end)
None	_set_event_attrs (self, Event event)
None	_set_event_done (self)

Private Attributes
	_attr_extra_state_attributes

Static Private Attributes
	_unrecorded_attributes = frozenset({ATTR_EVENT_ID, ATTR_EVENT_SCORE})

Additional Inherited Members
Public Member Functions inherited from homeassistant.components.unifiprotect.entity.BaseProtectEntity
None	__init__ (self, ProtectData data, ProtectDeviceType device, EntityDescription|None description=None)
None	async_added_to_hass (self)
None	async_update (self)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_device_update (self, bool warning=True)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
dict[str, Any]|None	capability_attributes (self)
str|None	device_class (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
str|None	entity_picture (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
Mapping[str, Any]|None	extra_state_attributes (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
str|UndefinedType|None	name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
StateType	state (self)
dict[str, Any]|None	state_attributes (self)
str|None	suggested_object_id (self)
int|None	supported_features (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
Public Attributes inherited from homeassistant.components.unifiprotect.entity.BaseProtectEntity
	data
	device
	entity_description
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Detailed Description

Adds motion event attributes to sensor.

Definition at line 327 of file entity.py.

Member Function Documentation

_async_event_with_immediate_end()

None homeassistant.components.unifiprotect.entity.EventEntityMixin._async_event_with_immediate_end (   self )

private

Definition at line 348 of file entity.py.

_event_already_ended()

bool homeassistant.components.unifiprotect.entity.EventEntityMixin._event_already_ended (   self, Event | None  prev_event, datetime | None   prev_event_end  )

private

Determine if the event has already ended.

The event_end time is passed because the prev_event and event object
may be the same object, and the uiprotect code will mutate the
event object so we need to check the datetime object that was
saved from the last time the entity was updated.

Definition at line 357 of file entity.py.

_set_event_attrs()

None homeassistant.components.unifiprotect.entity.EventEntityMixin._set_event_attrs (   self, Event  event  )

private

Set event attrs.

Definition at line 340 of file entity.py.

_set_event_done()

None homeassistant.components.unifiprotect.entity.EventEntityMixin._set_event_done (   self )

private

Clear the event and state.

Reimplemented in homeassistant.components.unifiprotect.sensor.ProtectLicensePlateEventSensor, and homeassistant.components.unifiprotect.binary_sensor.ProtectEventBinarySensor.

Definition at line 336 of file entity.py.

Member Data Documentation

_attr_extra_state_attributes

homeassistant.components.unifiprotect.entity.EventEntityMixin._attr_extra_state_attributes

private

Definition at line 342 of file entity.py.

_unrecorded_attributes

homeassistant.components.unifiprotect.entity.EventEntityMixin._unrecorded_attributes = frozenset({ATTR_EVENT_ID, ATTR_EVENT_SCORE})

staticprivate

Definition at line 331 of file entity.py.

None

homeassistant.components.unifiprotect.entity.EventEntityMixin.None

static

Definition at line 332 of file entity.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/unifiprotect/entity.py