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

Public Member Functions

def __init__ (self, hass, camera_entity, name, doods, detector, config)
 
def camera_entity (self)
 
def extra_state_attributes (self)
 
def name (self)
 
def process_image (self, image)
 
def state (self)
 
- Public Member Functions inherited from homeassistant.components.image_processing.ImageProcessingEntity
None async_process_image (self, bytes image)
 
None async_update (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)
 
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)
 

Public Attributes

 hass
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

def _save_image (self, image, matches, paths)
 

Private Attributes

 _area
 
 _aspect
 
 _camera_entity
 
 _covers
 
 _dconfig
 
 _detector_name
 
 _doods
 
 _file_out
 
 _height
 
 _label_areas
 
 _label_covers
 
 _last_image
 
 _matches
 
 _name
 
 _process_time
 
 _total_matches
 
 _width
 

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

Doods image processing service client.

Definition at line 128 of file image_processing.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.doods.image_processing.Doods.__init__ (   self,
  hass,
  camera_entity,
  name,
  doods,
  detector,
  config 
)
Initialize the DOODS entity.

Definition at line 131 of file image_processing.py.

Member Function Documentation

◆ _save_image()

def homeassistant.components.doods.image_processing.Doods._save_image (   self,
  image,
  matches,
  paths 
)
private

Definition at line 243 of file image_processing.py.

◆ camera_entity()

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

Reimplemented from homeassistant.components.image_processing.ImageProcessingEntity.

Definition at line 217 of file image_processing.py.

◆ extra_state_attributes()

def homeassistant.components.doods.image_processing.Doods.extra_state_attributes (   self)
Return device specific state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 232 of file image_processing.py.

◆ name()

def homeassistant.components.doods.image_processing.Doods.name (   self)
Return the name of the image processor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 222 of file image_processing.py.

◆ process_image()

def homeassistant.components.doods.image_processing.Doods.process_image (   self,
  image 
)
Process the image.

Definition at line 285 of file image_processing.py.

◆ state()

def homeassistant.components.doods.image_processing.Doods.state (   self)
Return the state of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 227 of file image_processing.py.

Member Data Documentation

◆ _area

homeassistant.components.doods.image_processing.Doods._area
private

Definition at line 199 of file image_processing.py.

◆ _aspect

homeassistant.components.doods.image_processing.Doods._aspect
private

Definition at line 147 of file image_processing.py.

◆ _camera_entity

homeassistant.components.doods.image_processing.Doods._camera_entity
private

Definition at line 134 of file image_processing.py.

◆ _covers

homeassistant.components.doods.image_processing.Doods._covers
private

Definition at line 200 of file image_processing.py.

◆ _dconfig

homeassistant.components.doods.image_processing.Doods._dconfig
private

Definition at line 210 of file image_processing.py.

◆ _detector_name

homeassistant.components.doods.image_processing.Doods._detector_name
private

Definition at line 142 of file image_processing.py.

◆ _doods

homeassistant.components.doods.image_processing.Doods._doods
private

Definition at line 140 of file image_processing.py.

◆ _file_out

homeassistant.components.doods.image_processing.Doods._file_out
private

Definition at line 141 of file image_processing.py.

◆ _height

homeassistant.components.doods.image_processing.Doods._height
private

Definition at line 146 of file image_processing.py.

◆ _label_areas

homeassistant.components.doods.image_processing.Doods._label_areas
private

Definition at line 159 of file image_processing.py.

◆ _label_covers

homeassistant.components.doods.image_processing.Doods._label_covers
private

Definition at line 160 of file image_processing.py.

◆ _last_image

homeassistant.components.doods.image_processing.Doods._last_image
private

Definition at line 213 of file image_processing.py.

◆ _matches

homeassistant.components.doods.image_processing.Doods._matches
private

Definition at line 211 of file image_processing.py.

◆ _name

homeassistant.components.doods.image_processing.Doods._name
private

Definition at line 136 of file image_processing.py.

◆ _process_time

homeassistant.components.doods.image_processing.Doods._process_time
private

Definition at line 214 of file image_processing.py.

◆ _total_matches

homeassistant.components.doods.image_processing.Doods._total_matches
private

Definition at line 212 of file image_processing.py.

◆ _width

homeassistant.components.doods.image_processing.Doods._width
private

Definition at line 145 of file image_processing.py.

◆ hass

homeassistant.components.doods.image_processing.Doods.hass

Definition at line 133 of file image_processing.py.


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