mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-16 05:46:52 +00:00
Adds Facebox (#5355)
* Adds Machine box * Update image_processing.facebox.markdown
This commit is contained in:
parent
bc6a090ecc
commit
fa520535fd
60
source/_components/image_processing.facebox.markdown
Normal file
60
source/_components/image_processing.facebox.markdown
Normal file
@ -0,0 +1,60 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Facebox"
|
||||
description: "Detect and recognise faces with Facebox."
|
||||
date: 2018-05-03 00:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: machine-box.png
|
||||
ha_category: Image Processing
|
||||
featured: false
|
||||
ha_release: 0.70
|
||||
---
|
||||
|
||||
The `facebox` image processing platform allows you to detect and recognise faces in a camera image using [Facebox](https://machinebox.io/docs/facebox). The state of the entity is the number of faces detected, and recognised faces are listed in the `matched_faces` attribute. Facebox runs in a Docker container, and it is recommended that you run this container on a machine with a minimum of 2 GB RAM. On your machine with Docker, run the Facebox container with:
|
||||
```
|
||||
MB_KEY="INSERT-YOUR-KEY-HERE"
|
||||
|
||||
sudo docker run --name=facebox --restart=always 8080:8080 -e "MB_KEY=$MB_KEY" machinebox/facebox
|
||||
```
|
||||
|
||||
If you only require face detection (number of faces) you can disable face recognition by adding ```-e "MB_FACEBOX_DISABLE_RECOGNITION=true"``` to the `docker run` command.
|
||||
|
||||
To enable this platform in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
image_processing:
|
||||
- platform: facebox
|
||||
ip_address: 192.168.0.1
|
||||
port: 8080
|
||||
source:
|
||||
- entity_id: camera.local_file
|
||||
name: my_custom_name
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
ip_address:
|
||||
description: The IP address of your machine hosting Facebox.
|
||||
required: true
|
||||
type: string
|
||||
port:
|
||||
description: The port which Facebox is exposed on.
|
||||
required: true
|
||||
type: string
|
||||
source:
|
||||
description: The list of image sources.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
entity_id:
|
||||
description: A camera entity id to get picture from.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: This parameter allows you to override the name of your `image_processing` entity.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
BIN
source/images/supported_brands/machine-box.png
Normal file
BIN
source/images/supported_brands/machine-box.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 19 KiB |
Loading…
x
Reference in New Issue
Block a user