Skip to content

Adds image_processing.facebox_face_detect.markdown#5300

Closed
robmarkcole wants to merge 7 commits intonextfrom
robmarkcole-patch-1
Closed

Adds image_processing.facebox_face_detect.markdown#5300
robmarkcole wants to merge 7 commits intonextfrom
robmarkcole-patch-1

Conversation

@robmarkcole
Copy link
Copy Markdown
Contributor

@robmarkcole robmarkcole commented May 3, 2018

Description:
Adds docs for new facebox image processing platform.

Pull request in home-assistant (if applicable):
home-assistant/core#14356

Checklist:

  • Branch: Fixes, changes and adjustments should be created against current. New documentation for platforms/components and features should go to next.
  • The documentation follow the standards.

comments: false
sharing: true
footer: true
logo: home-assistant.png
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be we should use the Machinebox logo.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’ve approached to request permission. It’s a bad idea to use logos without express permission

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we had this discussion earlier. All logos as properties of the respective legal owners...and HA does not claim otherwise.

```
MB_KEY="INSERT-YOUR-KEY-HERE"

docker run -p 8080:8080 -e "MB_KEY=$MB_KEY" -e "MB_FACEBOX_DISABLE_RECOGNITION=true" machinebox/facebox
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add a name to the container and restart option. Here's the command that I use:
sudo docker run --name=facebox --restart=always -p 8080:8080 -e "MB_KEY=$MB_KEY" -d machinebox/facebox

We can still retain the -e "MB_FACEBOX_DISABLE_RECOGNITION=true" flag.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure theres no harm adding this info, thanks for the suggestion.

Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rename the file to the updated platform name.

description: The list of image sources.
required: true
type: array
entity_id:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These items should be nested under a map type key, under the key keys.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. BTW where are these instructions listed? Not in the standards?


To enable this component in your installation, add the following to your `configuration.yaml` file:

{% raw %}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need the raw tags? I don't believe so.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

ha_release: 0.70
---

The `facebox` image processing component 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. To minimise the time for Facebox to detect faces in an image using this component, on your machine with Docker run Facebox with:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a new platform (facebox) that has been created, not a new component. Facebox is now a platform under the image_processing component.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

@robmarkcole
Copy link
Copy Markdown
Contributor Author

@MartinHjelmare changes addressed, cheers

@MartinHjelmare
Copy link
Copy Markdown
Member

Good! Please rebase on next branch to let the build pass. There was a problem in the version of next that this PR is based on, which has been fixed now.

This was referenced May 12, 2018
@fabaff fabaff deleted the robmarkcole-patch-1 branch May 13, 2018 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants