homeassistant.components.onvif.entity.ONVIFBaseEntity Class Reference

Inheritance diagram for homeassistant.components.onvif.entity.ONVIFBaseEntity:

Collaboration diagram for homeassistant.components.onvif.entity.ONVIFBaseEntity:

Public Member Functions
None	__init__ (self, ONVIFDevice device)
def	available (self)
DeviceInfo	device_info (self)
str	mac_or_serial (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_added_to_hass (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)
dict[str, Any]|None	capability_attributes (self)
str|None	device_class (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)

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Base class common to all ONVIF entities.

Definition at line 12 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.onvif.entity.ONVIFBaseEntity.__init__	(		self,
		ONVIFDevice	device
	)

Initialize the ONVIF entity.

Reimplemented in homeassistant.components.onvif.button.SetSystemDateAndTimeButton, and homeassistant.components.onvif.button.RebootButton.

Definition at line 15 of file entity.py.

Member Function Documentation

available()

def homeassistant.components.onvif.entity.ONVIFBaseEntity.available

(

self

)

Return True if device is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 20 of file entity.py.

device_info()

DeviceInfo homeassistant.components.onvif.entity.ONVIFBaseEntity.device_info

(

self

)

Return a device description for device registry.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 40 of file entity.py.

mac_or_serial()

str homeassistant.components.onvif.entity.ONVIFBaseEntity.mac_or_serial

(

self

)

Return MAC or serial, for unique_id generation.

MAC address is not always available, and given the number
of non-conformant ONVIF devices we have historically supported,
we cannot guarantee serial number either.  Due to this, we have
adopted an either/or approach in the config entry setup, and can
guarantee that one or the other will be populated.
See: https://github.com/home-assistant/core/issues/35883

Definition at line 25 of file entity.py.

---

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

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