homeassistant.components.microsoft_face Namespace Reference

Classes
class	MicrosoftFace
class	MicrosoftFaceGroupEntity

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)

Variables
	_LOGGER = logging.getLogger(__name__)
string	ATTR_CAMERA_ENTITY = "camera_entity"
string	ATTR_GROUP = "group"
string	ATTR_PERSON = "person"
string	CONF_AZURE_REGION = "azure_region"
	CONFIG_SCHEMA
string	DATA_MICROSOFT_FACE = "microsoft_face"
int	DEFAULT_TIMEOUT = 10
string	DOMAIN = "microsoft_face"
string	FACE_API_URL = "api.cognitive.microsoft.com/face/v1.0/{0}"
	SCHEMA_FACE_SERVICE
	SCHEMA_GROUP_SERVICE = vol.Schema({vol.Required(ATTR_NAME): cv.string})
	SCHEMA_PERSON_SERVICE
	SCHEMA_TRAIN_SERVICE = vol.Schema({vol.Required(ATTR_GROUP): cv.slugify})
string	SERVICE_CREATE_GROUP = "create_group"
string	SERVICE_CREATE_PERSON = "create_person"
string	SERVICE_DELETE_GROUP = "delete_group"
string	SERVICE_DELETE_PERSON = "delete_person"
string	SERVICE_FACE_PERSON = "face_person"
string	SERVICE_TRAIN_GROUP = "train_group"

Detailed Description

Support for Microsoft face recognition.

Function Documentation

async_setup()

bool homeassistant.components.microsoft_face.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up Microsoft Face.

Definition at line 77 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.microsoft_face._LOGGER = logging.getLogger(__name__)

private

Definition at line 26 of file __init__.py.

ATTR_CAMERA_ENTITY

string homeassistant.components.microsoft_face.ATTR_CAMERA_ENTITY = "camera_entity"

Definition at line 28 of file __init__.py.

ATTR_GROUP

string homeassistant.components.microsoft_face.ATTR_GROUP = "group"

Definition at line 29 of file __init__.py.

ATTR_PERSON

string homeassistant.components.microsoft_face.ATTR_PERSON = "person"

Definition at line 30 of file __init__.py.

CONF_AZURE_REGION

string homeassistant.components.microsoft_face.CONF_AZURE_REGION = "azure_region"

Definition at line 32 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.microsoft_face.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: vol.Schema(
            {
                vol.Required(CONF_API_KEY): cv.string,
                vol.Optional(CONF_AZURE_REGION, default="westus"): cv.string,
                vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
            }
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 47 of file __init__.py.

DATA_MICROSOFT_FACE

string homeassistant.components.microsoft_face.DATA_MICROSOFT_FACE = "microsoft_face"

Definition at line 34 of file __init__.py.

DEFAULT_TIMEOUT

int homeassistant.components.microsoft_face.DEFAULT_TIMEOUT = 10

Definition at line 35 of file __init__.py.

DOMAIN

string homeassistant.components.microsoft_face.DOMAIN = "microsoft_face"

Definition at line 36 of file __init__.py.

FACE_API_URL

string homeassistant.components.microsoft_face.FACE_API_URL = "api.cognitive.microsoft.com/face/v1.0/{0}"

Definition at line 38 of file __init__.py.

SCHEMA_FACE_SERVICE

homeassistant.components.microsoft_face.SCHEMA_FACE_SERVICE

Initial value:

=  vol.Schema(
    {
        vol.Required(ATTR_PERSON): cv.string,
        vol.Required(ATTR_GROUP): cv.slugify,
        vol.Required(ATTR_CAMERA_ENTITY): cv.entity_id,
    }
)

Definition at line 66 of file __init__.py.

SCHEMA_GROUP_SERVICE

homeassistant.components.microsoft_face.SCHEMA_GROUP_SERVICE = vol.Schema({vol.Required(ATTR_NAME): cv.string})

Definition at line 60 of file __init__.py.

SCHEMA_PERSON_SERVICE

homeassistant.components.microsoft_face.SCHEMA_PERSON_SERVICE

Initial value:

=  SCHEMA_GROUP_SERVICE.extend(
    {vol.Required(ATTR_GROUP): cv.slugify}
)

Definition at line 62 of file __init__.py.

SCHEMA_TRAIN_SERVICE

homeassistant.components.microsoft_face.SCHEMA_TRAIN_SERVICE = vol.Schema({vol.Required(ATTR_GROUP): cv.slugify})

Definition at line 74 of file __init__.py.

SERVICE_CREATE_GROUP

string homeassistant.components.microsoft_face.SERVICE_CREATE_GROUP = "create_group"

Definition at line 40 of file __init__.py.

SERVICE_CREATE_PERSON

string homeassistant.components.microsoft_face.SERVICE_CREATE_PERSON = "create_person"

Definition at line 41 of file __init__.py.

SERVICE_DELETE_GROUP

string homeassistant.components.microsoft_face.SERVICE_DELETE_GROUP = "delete_group"

Definition at line 42 of file __init__.py.

SERVICE_DELETE_PERSON

string homeassistant.components.microsoft_face.SERVICE_DELETE_PERSON = "delete_person"

Definition at line 43 of file __init__.py.

SERVICE_FACE_PERSON

string homeassistant.components.microsoft_face.SERVICE_FACE_PERSON = "face_person"

Definition at line 44 of file __init__.py.

SERVICE_TRAIN_GROUP

string homeassistant.components.microsoft_face.SERVICE_TRAIN_GROUP = "train_group"

Definition at line 45 of file __init__.py.