Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity Class Reference
Inheritance diagram for homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity:
[legend]
Collaboration diagram for homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity:
[legend]

Public Member Functions

def __init__ (self, camera_entity, params, confidence, name=None)
 
def async_process_image (self, image)
 
def camera_entity (self)
 
def confidence (self)
 
def name (self)
 
- Public Member Functions inherited from homeassistant.components.openalpr_cloud.image_processing.ImageProcessingAlprEntity
None __init__ (self)
 
None async_process_plates (self, dict[str, float] plates, int vehicles)
 
def extra_state_attributes (self)
 
None process_plates (self, dict[str, float] plates, int vehicles)
 
def state (self)
 
- Public Member Functions inherited from homeassistant.components.image_processing.ImageProcessingEntity
None async_process_image (self, bytes image)
 
None async_update (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)
 
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)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (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, strtranslation_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)
 

Private Attributes

 _camera
 
 _confidence
 
 _name
 
 _params
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.openalpr_cloud.image_processing.ImageProcessingAlprEntity
 plates
 
 vehicles
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- 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

Representation of an OpenALPR cloud entity.

Definition at line 156 of file image_processing.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity.__init__ (   self,
  camera_entity,
  params,
  confidence,
  name = None 
)
Initialize OpenALPR cloud API.

Definition at line 159 of file image_processing.py.

Member Function Documentation

◆ async_process_image()

def homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity.async_process_image (   self,
  image 
)
Process image.

This method is a coroutine.

Definition at line 187 of file image_processing.py.

◆ camera_entity()

def homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity.camera_entity (   self)
Return camera entity id from process pictures.

Reimplemented from homeassistant.components.image_processing.ImageProcessingEntity.

Definition at line 178 of file image_processing.py.

◆ confidence()

def homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity.confidence (   self)
Return minimum confidence for send events.

Reimplemented from homeassistant.components.image_processing.ImageProcessingEntity.

Definition at line 173 of file image_processing.py.

◆ name()

def homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity.name (   self)
Return the name of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 183 of file image_processing.py.

Member Data Documentation

◆ _camera

homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity._camera
private

Definition at line 164 of file image_processing.py.

◆ _confidence

homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity._confidence
private

Definition at line 165 of file image_processing.py.

◆ _name

homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity._name
private

Definition at line 168 of file image_processing.py.

◆ _params

homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity._params
private

Definition at line 163 of file image_processing.py.


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