Inheritance diagram for homeassistant.components.image_processing.ImageProcessingEntity:

Collaboration diagram for homeassistant.components.image_processing.ImageProcessingEntity:

Public Member Functions
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)

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)

Static Public Attributes
	timeout = DEFAULT_TIMEOUT

Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Detailed Description

Base entity class for image processing.

Definition at line 130 of file __init__.py.

Member Function Documentation

◆ async_process_image()

None homeassistant.components.image_processing.ImageProcessingEntity.async_process_image	(		self,
		bytes	image
	)

Process image.

Definition at line 170 of file __init__.py.

◆ async_update()

None homeassistant.components.image_processing.ImageProcessingEntity.async_update ( self )

Update image and process it.

This method is a coroutine.

Definition at line 174 of file __init__.py.

◆ camera_entity()

str | None homeassistant.components.image_processing.ImageProcessingEntity.camera_entity ( self )

Return camera entity id from process pictures.

Definition at line 140 of file __init__.py.

◆ confidence()

float | None homeassistant.components.image_processing.ImageProcessingEntity.confidence ( self )

Return minimum confidence to do some things.

Reimplemented in homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity, homeassistant.components.microsoft_face_identify.image_processing.MicrosoftFaceIdentifyEntity, and homeassistant.components.demo.image_processing.DemoImageProcessingFace.

Definition at line 149 of file __init__.py.

◆ device_class()

ImageProcessingDeviceClass | None homeassistant.components.image_processing.ImageProcessingEntity.device_class ( self )

Return the class of this entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 158 of file __init__.py.

◆ process_image()

None homeassistant.components.image_processing.ImageProcessingEntity.process_image	(		self,
		bytes	image
	)

Process image.

Reimplemented in homeassistant.components.demo.image_processing.DemoImageProcessingFace.

Definition at line 166 of file __init__.py.

Member Data Documentation

◆ timeout

homeassistant.components.image_processing.ImageProcessingEntity.timeout = DEFAULT_TIMEOUT

static

Definition at line 137 of file __init__.py.

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

core/homeassistant/components/image_processing/__init__.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Static Public Attributes

Additional Inherited Members