Add Documentation for Netatmo binary sensor (#964)

* Add Documentation for Netatmo binary sensor

* Explicit Basic and Advanced configuration for Netatmo devices

Signed-off-by: Hugo D. (jabesq) <jabesq@gmail.com>
This commit is contained in:
Hugo Dupras 2016-10-21 09:33:03 +02:00 committed by Fabian Affolter
parent b5c7c6822d
commit 5ec96be809
3 changed files with 59 additions and 1 deletions

View File

@ -0,0 +1,52 @@
---
layout: page
title: "Netatmo Binary Sensor"
description: "Instructions how to integrate Netatmo binary sensor into Home Assistant."
date: 2016-09-19 15:10
sidebar: true
comments: false
sharing: true
footer: true
logo: netatmo.png
ha_category: Binary Sensor
ha_release: 0.31
---
### {% linkable_title Basic Configuration %}
The `netatmo` binary sensor platform is consuming the information provided by a [Netatmo Welcome](https://www.netatmo.com) camera. This component allows you to get the latest event seen by the camera.
To enable the Netatmo binary sensor, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your binary sensor.
### {% linkable_title Advanced configuration %}
If you want to select a specific sensor, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
binary_sensor:
platform: netatmo
home: home_name
cameras:
- camera_name1
monitored_conditions:
- Someone known
- Someone unknown
- Motion
```
Configuration variables:
- **home** (*Optional*): Will use the cameras of this home only.
- **cameras** array (*Optional*): Cameras to use. Multiple enties allowed.
- 'camera_name': Name of the camera to display.
- **monitored_conditions** array (*Optional*): List of monitored conditions.
- 'Someone known'
- 'Someone unknown'
- 'Motion'
If **home** and **cameras** is not provided, all cameras will be used. If multiple cameras are available then each monitored conditions will create a specific sensor for each camera
<p class='note'>
[Welcome tags](https://www.netatmo.com/product/security/welcome/tags) are not yet supported, but will be in a next update.
</p>

View File

@ -12,10 +12,15 @@ ha_category: Camera
ha_release: 0.22
---
### {% linkable_title Basic Configuration %}
The `netatmo` camera platform is consuming the information provided by a [Netatmo Welcome](https://www.netatmo.com) camera. This component allows you to view the current photo created by the Camera.
To enable the Netatmo camera, you first have to set up [netatmo](/components/netatmo/), and add the following lines to your `configuration.yaml`:
To enable the Netatmo camera, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your camera.
### {% linkable_title Advanced configuration %}
If you want to select a specific camera, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry

View File

@ -32,6 +32,7 @@ Configuration variables:
- **secret_key** (*Required*): Your netatmo secret key
- **username** (*Required*): Username for the netatmo account.
- **password** (*Required*): Password for the netatmo account.
- **discovery** (*Optional)*: Whether to discover Netatmo devices. Set it to False, if you want to choose which Netatmo device you want to add (default True).
### {% linkable_title Get API and Secret Key %}