Add Documentation for Netatmo Welcome (#542)

* Reorganize  documentation for Netatmo

As Netatmo is now a Hub component, documentations has been splitted in several
parts betweent the hub, the sensors and the camera

Signed-off-by: Hugo D. (jabesq) <jabesq@gmail.com>

* Add configuration variables for Netatmo Welcome cameras

* Add ha_release information on new documentation pages

* Netatmo Weather Station is a weather sensor
This commit is contained in:
Hugo Dupras 2016-06-18 21:20:37 +02:00 committed by Paulus Schoutsen
parent 2e0193ea0d
commit 2328f20caa
3 changed files with 98 additions and 31 deletions

View File

@ -0,0 +1,37 @@
---
layout: page
title: "Netatmo Camera"
description: "Instructions how to integrate Netatmo camera into Home Assistant."
date: 2016-06-02 08:10
sidebar: true
comments: false
sharing: true
footer: true
logo: netatmo.png
ha_category: Camera
ha_release: "0.2x"
---
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, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
camera:
platform: netatmo
home: home_name
cameras:
- camera_name1
- camera_name2
```
Configuration variables:
- **home** (*Optionnal*): Will display the cameras of this home only.
- **cameras** array (*Optionnal*): Cameras to use. Multiple enties allowed.
- **camera_name**: Name of the camera to display.
If **home** and **cameras** is not provided, all cameras will be displayed.

View File

@ -0,0 +1,58 @@
---
layout: page
title: "Netatmo"
description: "Instructions how to integrate Netatmo component into Home Assistant."
date: 2016-06-02 08:10
sidebar: true
comments: false
sharing: true
footer: true
logo: netatmo.png
ha_category: Hub
ha_release: "0.2x"
---
The `netatmo` component platform is the main component to integrate all Netatmo related platforms. Besides this component you will have to setup any connected sensors separately.
To enable the Netatmo component, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
netatmo:
api_key: YOUR_API_KEY
secret_key: YOUR_SECRET_KEY
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
Configuration variables:
- **api_key** (*Required*): The API key for your netatmo account.
- **secret_key** (*Required*): Your netatmo secret key
- **username** (*Required*): Username for the netatmo account.
- **password** (*Required*): Password for the netatmo account.
### {% linkable_title Get API and Secret Key %}
To get your API credentials, you have to declare a new application in the [NetAtmo Developer Page](https://dev.netatmo.com/). Sign in using your username and password from your regular NetAtmo account.
Click on 'Create an App' at the top of the page.
<p class='img'>
<img src='/images/screenshots/netatmo_create.png' />
</p>
You have to fill the form, but only two fields are required : Name and Description. It doesn't really matter what you put into those. Just write something that make sense to you. To submit your new app, click on create at the bottom of the form.
<p class='img'>
<img src='/images/screenshots/netatmo_app.png' />
</p>
That's it. You can copy and paste your new API and secret keys in your Home Assistant configuration file just as said above.
<p class='img'>
<img src='/images/screenshots/netatmo_api.png' />
</p>
<p class='note'>
The Home Assistant NetAtmo platform has only be tested with the classic indoor, outdoor module and rainmeter. There is no support for the windmeter module at this time because developers does not own these modules.
</p>

View File

@ -2,13 +2,13 @@
layout: page layout: page
title: "Netatmo Sensor" title: "Netatmo Sensor"
description: "Instructions how to integrate Netatmo sensors into Home Assistant." description: "Instructions how to integrate Netatmo sensors into Home Assistant."
date: 2016-01-14 08:10 date: 2016-06-02 08:10
sidebar: true sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
logo: netatmo.png logo: netatmo.png
ha_category: Sensor ha_category: Weather
--- ---
@ -20,10 +20,6 @@ To enable the Netatmo sensor, add the following lines to your `configuration.yam
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
platform: netatmo platform: netatmo
api_key: YOUR_API_KEY
secret_key: YOUR_SECRET_KEY
username: YOUR_USERNAME
password: YOUR_PASSWORD
station: STATION_NAME station: STATION_NAME
modules: modules:
module_name1: module_name1:
@ -45,11 +41,7 @@ sensor:
Configuration variables: Configuration variables:
- **api_key** (*Required*): The API key for your netatmo account. - **station** (*Optionnal*): The name of the weather station. Needed if several stations are associated with the account.
- **secret_key** (*Required*): Your netatmo secret key
- **username** (*Required*): Username for the netatmo account.
- **password** (*Required*): Password for the netatmo account.
- **station**: The name of the weather station. Needed if several stations are associated with the account.
- **modules** (*Required*): Modules to use. Multiple entries allowed. - **modules** (*Required*): Modules to use. Multiple entries allowed.
- **module_name** array (*Required*): Name of the module. - **module_name** array (*Required*): Name of the module.
- **temperature**: Current temperature. - **temperature**: Current temperature.
@ -61,26 +53,6 @@ Configuration variables:
- **sum_rain_1**: Rainfall in the last hour in mm. - **sum_rain_1**: Rainfall in the last hour in mm.
- **sum_rain_24**: Rainfall in mm from 00:00am - 23:59pm. - **sum_rain_24**: Rainfall in mm from 00:00am - 23:59pm.
### {% linkable_title Get API and Secret Key %}
To get your API credentials, you have to declare a new application in the [NetAtmo Developer Page](https://dev.netatmo.com/). Sign in using your username and password from your regular NetAtmo account.
Click on 'Create an App' at the top of the page.
<p class='img'>
<img src='/images/screenshots/netatmo_create.png' />
</p>
You have to fill the form, but only two fields are required : Name and Description. It doesn't really matter what you put into those. Just write something that make sense to you. To submit your new app, click on create at the bottom of the form.
<p class='img'>
<img src='/images/screenshots/netatmo_app.png' />
</p>
That's it. You can copy and paste your new API and secret keys in your Home Assistant configuration file just as said above.
<p class='img'>
<img src='/images/screenshots/netatmo_api.png' />
</p>
### {% linkable_title Find your modules name %} ### {% linkable_title Find your modules name %}
You can find your modules name in your [online NetAtmo account](https://my.netatmo.com/app/station). These names can be found and changed in parameters (See screenshot) You can find your modules name in your [online NetAtmo account](https://my.netatmo.com/app/station). These names can be found and changed in parameters (See screenshot)