Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.image_processing Namespace Reference

Classes

class  FaceInformation
 
class  ImageProcessingDeviceClass
 
class  ImageProcessingEntity
 
class  ImageProcessingEntityDescription
 
class  ImageProcessingFaceEntity
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string ATTR_AGE = "age"
 
string ATTR_FACES = "faces"
 
string ATTR_GENDER = "gender"
 
string ATTR_GLASSES = "glasses"
 
string ATTR_TOTAL_FACES = "total_faces"
 
string CONF_CONFIDENCE = "confidence"
 
int DEFAULT_CONFIDENCE = 80
 
int DEFAULT_TIMEOUT = 10
 
string DOMAIN = "image_processing"
 
string EVENT_DETECT_FACE = "image_processing.detect_face"
 
 Final
 
 PLATFORM_SCHEMA
 
 PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE.extend(PLATFORM_SCHEMA.schema)
 
 SCAN_INTERVAL = timedelta(seconds=10)
 
string SERVICE_SCAN = "scan"
 
 SOURCE_SCHEMA
 

Detailed Description

Provides functionality to interact with image processing services.

Function Documentation

◆ async_setup()

bool homeassistant.components.image_processing.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the image processing.

Definition at line 95 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.image_processing._LOGGER = logging.getLogger(__name__)
private

Definition at line 29 of file __init__.py.

◆ ATTR_AGE

string homeassistant.components.image_processing.ATTR_AGE = "age"

Definition at line 52 of file __init__.py.

◆ ATTR_FACES

string homeassistant.components.image_processing.ATTR_FACES = "faces"

Definition at line 54 of file __init__.py.

◆ ATTR_GENDER

string homeassistant.components.image_processing.ATTR_GENDER = "gender"

Definition at line 55 of file __init__.py.

◆ ATTR_GLASSES

string homeassistant.components.image_processing.ATTR_GLASSES = "glasses"

Definition at line 56 of file __init__.py.

◆ ATTR_TOTAL_FACES

string homeassistant.components.image_processing.ATTR_TOTAL_FACES = "total_faces"

Definition at line 58 of file __init__.py.

◆ CONF_CONFIDENCE

string homeassistant.components.image_processing.CONF_CONFIDENCE = "confidence"

Definition at line 60 of file __init__.py.

◆ DEFAULT_CONFIDENCE

int homeassistant.components.image_processing.DEFAULT_CONFIDENCE = 80

Definition at line 63 of file __init__.py.

◆ DEFAULT_TIMEOUT

int homeassistant.components.image_processing.DEFAULT_TIMEOUT = 10

Definition at line 62 of file __init__.py.

◆ DOMAIN

string homeassistant.components.image_processing.DOMAIN = "image_processing"

Definition at line 31 of file __init__.py.

◆ EVENT_DETECT_FACE

string homeassistant.components.image_processing.EVENT_DETECT_FACE = "image_processing.detect_face"

Definition at line 50 of file __init__.py.

◆ Final

homeassistant.components.image_processing.Final

Definition at line 53 of file __init__.py.

◆ PLATFORM_SCHEMA

homeassistant.components.image_processing.PLATFORM_SCHEMA
Initial value:
1 = cv.PLATFORM_SCHEMA.extend(
2  {
3  vol.Optional(CONF_SOURCE): vol.All(cv.ensure_list, [SOURCE_SCHEMA]),
4  vol.Optional(CONF_CONFIDENCE, default=DEFAULT_CONFIDENCE): vol.All(
5  vol.Coerce(float), vol.Range(min=0, max=100)
6  ),
7  }
8 )

Definition at line 72 of file __init__.py.

◆ PLATFORM_SCHEMA_BASE

homeassistant.components.image_processing.PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE.extend(PLATFORM_SCHEMA.schema)

Definition at line 80 of file __init__.py.

◆ SCAN_INTERVAL

homeassistant.components.image_processing.SCAN_INTERVAL = timedelta(seconds=10)

Definition at line 32 of file __init__.py.

◆ SERVICE_SCAN

string homeassistant.components.image_processing.SERVICE_SCAN = "scan"

Definition at line 48 of file __init__.py.

◆ SOURCE_SCHEMA

homeassistant.components.image_processing.SOURCE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_ENTITY_ID): cv.entity_domain("camera"),
4  vol.Optional(CONF_NAME): cv.string,
5  }
6 )

Definition at line 65 of file __init__.py.