diff --git a/source/_components/image_processing.markdown b/source/_components/image_processing.markdown index 7bd4c48b188..aaf458d39e4 100644 --- a/source/_components/image_processing.markdown +++ b/source/_components/image_processing.markdown @@ -30,20 +30,20 @@ automation: - alias: Open garage door trigger: platform: event - event_type: found_plate + event_type: image_processing.found_plate event_data: entity_id: openalpr.camera_garage_1 plate: BE2183423 ... ``` -The following event attributes will be present: `entity_id`, `plate`, `confidence` +The following event attributes will be present (platform depents): `entity_id`, `plate`, `confidence` -## {% linkable_title Face identify %} +## {% linkable_title Face %} -Face entities attribute have a face counter `total_faces` and all validated person as `known_faces`. +Face entities attribute have a face counter `total_faces` and all face data as `faces`. -This event is trigger after Microsoft Face identify found a known faces. +This event is trigger after Microsoft Face found a faces. ```yaml # Example configuration.yaml automation entry @@ -51,11 +51,11 @@ automation: - alias: Known person in front of my door trigger: platform: event - event_type: identify_face + event_type: image_processing.detect_face event_data: entity_id: image_processing.door name: 'Hans Maier' ... ``` -The following event attributes will be present: `entity_id`, `name`, `confidence` +The following event attributes will be present (platform depends): `entity_id`, `name`, `confidence`, `age`, `gender`, `motion`, `glasses` diff --git a/source/_components/image_processing.microsoft_face_detect.markdown b/source/_components/image_processing.microsoft_face_detect.markdown new file mode 100644 index 00000000000..10ed16b8f48 --- /dev/null +++ b/source/_components/image_processing.microsoft_face_detect.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Microsoft Face detect" +description: "Instructions how to integrate microsoft face detect into Home Assistant." +date: 2017-01-25 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: microsoft.png +ha_category: Image Processing +featured: false +ha_release: 0.37 +--- + +The `microsoft_face_detect` image processing platform lets you use [Microsoft Face identify](https://www.microsoft.com/cognitive-services/en-us/) API through Home Assistant. This platform allow you do detect face on camera and fire a event with attributes. + +Please refer to the [component](/components/microsoft_face/) configuration on how to setup the API key. + +For using the result inside an automation rule, take a look at the [component](/components/image_processing/) page. + +### {% linkable_title Configuration Home Assistant %} + +```yaml +# Example configuration.yaml entry +image_processing: + - platform: microsoft_face_detect + source: + - entity_id: camera.door +``` +Configuration variables: + +- **group** (*Required*): Micrsoft face group to detect person from it. +- **confidence** (*Optional*): The minimum of confidence in percent to process with Home Assistant. Defaults to 80. +- **source** array (*Required*): List of image sources. + - **entity_id** (*Required*): A camera entity id to get picture from. + - **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity. +- **attributes** array (*Optional*): Default age,gender. Attributes for search on picture. Supported: age, gender, glasses diff --git a/source/_components/image_processing.microsoft_face_identify.markdown b/source/_components/image_processing.microsoft_face_identify.markdown index 9265a9e26b4..c134396c5c3 100644 --- a/source/_components/image_processing.microsoft_face_identify.markdown +++ b/source/_components/image_processing.microsoft_face_identify.markdown @@ -13,7 +13,7 @@ featured: false ha_release: 0.37 --- -The `microsoft_face_identify` image processing platform lets you use [Microsoft Face identify](https://www.microsoft.com/cognitive-services/en-us/) API through Home Assistant. +The `microsoft_face_identify` image processing platform lets you use [Microsoft Face identify](https://www.microsoft.com/cognitive-services/en-us/) API through Home Assistant. This platform allow you do identify persons on camera and fire a event with identify persons. Please refer to the [component](/components/microsoft_face/) configuration on how to setup the API key.