jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Small cosmetic changes

Browse source
This commit is contained in:
Fabian Affolter 2017-01-27 11:13:56 +01:00
parent a16d62277c
commit 2f35de85f5
No known key found for this signature in database
GPG key ID: E23CD2DD36A4397F
4 changed files with 17 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
source/_components/microsoft_face.markdown
View file

@ -12,9 +12,9 @@ ha_category: Hub
ha_release: "0.37"
---
The `microsoft_face` component platform is the main component for Microsoft Azure Cognitive service [Face](https://www.microsoft.com/cognitive-services/en-us/face-api). All data are in a own private instance in the azure cloud.
The `microsoft_face` component platform is the main component for Microsoft Azure Cognitive service [Face](https://www.microsoft.com/cognitive-services/en-us/face-api). All data are in a own private instance in the Azure cloud.
You need an API key which is free but requires a [Azure registration](https://azure.microsoft.com/de-de/free/) with your microsoft ID. The free resource (*F0*) is limit to 30K request in a month and 20 per minute. If you don't want use a azure cloud, you can also get a API key with registration on [cognitive-services](https://www.microsoft.com/cognitive-services/en-us/subscriptions) but they need to recreate all 90 days.
You need an API key which is free but requires a [Azure registration](https://azure.microsoft.com/de-de/free/) with your microsoft ID. The free resource (*F0*) is limit to 30k requests in a month and 20 per minute. If you don't want use a the Azure cloud, you can also get a API key with registration on [cognitive-services](https://www.microsoft.com/cognitive-services/en-us/subscriptions) but they need to recreate all 90 days.
To enable the Microsoft Face component, add the following lines to your `configuration.yaml`:
@ -27,16 +27,17 @@ microsoft_face:
Configuration variables:
- **api_key** (*Required*): The API key for your Cognitive resource.
- **timeout** (*Optional)*: Set timeout for api connection (default 10sec).
- **timeout** (*Optional)*: Set timeout for the API connection. Defaults to 10s.
### {% linkable_title Person and Groups %}
For most of service you need set a group or a person. So it process and detect only stuff they will given with this group. Home-Assistent create for all group a entity and allow your to show the state, person and IDs inside UI.
For most of the services you need to set up a group or a person. This limits the processing and detection to elements provided by group. Home Assistent creates for all group a entity and allow you to show the state, person and IDs directly on the frontend.
For manage this feature you have following services they can call with UI, script or rest api.
For managing this feature, you have the following services. They can be called with the Frontend, a script, or the REST API.
- *microsoft_face.create_group*
- *microsoft_face.delete_group*
```yaml
service: microsoft_face.create_group
data:
@ -45,6 +46,7 @@ data:
- *microsoft_face.create_person*
- *microsoft_face.delete_person*
```yaml
service: microsoft_face.create_person
data:
@ -52,9 +54,10 @@ data:
name: 'Hans Maier'
```
We need add image to a person. We can add multiple image for every person to make the detection better. We can take a picture from a camera or send a local image to our azure resource.
You need to add an image of a person. You can add multiple images for every person to make the detection better. You can take a picture from a camera or send a local image to your Azure resource.
- *microsoft_face.face_person*
```yaml
service: microsoft_face.face_person
data:
@ -63,15 +66,18 @@ data:
camera_entity: camera.door
```
For the local image we need *curl*. The personId is present in group entity as attribute.
For the local image we need `curl`. The person ID is present in group entity as attribute.
```bash
curl -v -X POST "https://westus.api.cognitive.microsoft.com/face/v1.0/persongroups/{GroupName}/persons/{personId}/persistedFaces" -H "Ocp-Apim-Subscription-Key: {ApiKey}" -H "Content-Type: application/octet-stream" --data "@/tmp/image.jpg"
$ curl -v -X POST "https://westus.api.cognitive.microsoft.com/face/v1.0/persongroups/{GroupName}/persons/{personId}/persistedFaces" \
-H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
-H "Content-Type: application/octet-stream" --data "@/tmp/image.jpg"
```
After we done with changes on a group, we need train this group to make our AI fit to handle the new data.
- *microsoft_face.train_group*
```yaml
service: microsoft_face.train_group
data: