homeassistant.components.image_processing.ImageProcessingFaceEntity Class Reference

Inheritance diagram for homeassistant.components.image_processing.ImageProcessingFaceEntity:

Collaboration diagram for homeassistant.components.image_processing.ImageProcessingFaceEntity:

Public Member Functions
None	__init__ (self)
None	async_process_faces (self, list[FaceInformation] faces, int total)
None	process_faces (self, list[FaceInformation] faces, int total)
str|int|None	state (self)
dict[str, Any]	state_attributes (self)
Public Member Functions inherited from homeassistant.components.image_processing.ImageProcessingEntity
None	async_process_image (self, bytes image)
None	async_update (self)
str|None	camera_entity (self)
float|None	confidence (self)
ImageProcessingDeviceClass|None	device_class (self)
None	process_image (self, bytes image)
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)
bool	available (self)
dict[str, Any]|None	capability_attributes (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)
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
	faces
	total_faces
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Static Private Attributes
	_attr_device_class = ImageProcessingDeviceClass.FACE

Additional Inherited Members
Static Public Attributes inherited from homeassistant.components.image_processing.ImageProcessingEntity
	timeout = DEFAULT_TIMEOUT
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Base entity class for face image processing.

Definition at line 197 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.image_processing.ImageProcessingFaceEntity.__init__

(

self

)

Initialize base face identify/verify entity.

Definition at line 202 of file __init__.py.

Member Function Documentation

async_process_faces()

None homeassistant.components.image_processing.ImageProcessingFaceEntity.async_process_faces	(		self,
		list[FaceInformation]	faces,
		int	total
	)

Send event with detected faces and store data.

known are a dict in follow format:
 [
   {
      ATTR_CONFIDENCE: 80,
      ATTR_NAME: 'Name',
      ATTR_AGE: 12.0,
      ATTR_GENDER: 'man',
      ATTR_MOTION: 'smile',
      ATTR_GLASSES: 'sunglasses'
   },
 ]

This method must be run in the event loop.

Definition at line 242 of file __init__.py.

process_faces()

None homeassistant.components.image_processing.ImageProcessingFaceEntity.process_faces	(		self,
		list[FaceInformation]	faces,
		int	total
	)

Send event with detected faces and store data.

Definition at line 237 of file __init__.py.

state()

str | int | None homeassistant.components.image_processing.ImageProcessingFaceEntity.state

(

self

)

Return the state of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 208 of file __init__.py.

state_attributes()

dict[str, Any] homeassistant.components.image_processing.ImageProcessingFaceEntity.state_attributes

(

self

)

Return device specific state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 233 of file __init__.py.

Member Data Documentation

_attr_device_class

homeassistant.components.image_processing.ImageProcessingFaceEntity._attr_device_class = ImageProcessingDeviceClass.FACE

staticprivate

Definition at line 200 of file __init__.py.

faces

homeassistant.components.image_processing.ImageProcessingFaceEntity.faces

Definition at line 272 of file __init__.py.

total_faces

homeassistant.components.image_processing.ImageProcessingFaceEntity.total_faces

Definition at line 205 of file __init__.py.

---

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

• core/homeassistant/components/image_processing/__init__.py