jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

0.22 (#570)

Browse Source 
* Initial snmp sensor docs (#538)

* Fixed markdown and added logo (#551)

* Added documentation for router operating mode for asuswrt (#545)

* local_file camera component documenatation (#554)

* Documenation for local_file camera component

* Update camera.local_file.markdown

* Added information about voltage sensor

* Instructions for Pandora media player (#552)

* Add release

* Add pub_key

* Add BT Home Hub docs

* Markdown tweaks (#553)

* Add docs about MySensors IR switch (#556)

* Update sensor.mysensors docs, about moving V_IR_SEND type to switch
  platform.
* Update switch.mysensors docs. Add section about the new service and
  additional example sketch for the IR switch device.

* Update index.html

* plex sensor (#526)

* Add var descriptions

* Adds documentation for the Local File Camera (#482)

* Revert "Adds documentation for the Local File Camera" (#563)

* Minor changes

* Add Wink Rollershutter (#559)

* Added example of using template in shell_command. (#547)

* 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

* Add blog post 0.22
This commit is contained in:
Paulus Schoutsen 2016-06-18 13:24:52 -07:00 committed by GitHub
parent 7ecb13a8b8
commit 1f40fdb09d
29 changed files with 650 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
source/_components/alexa.markdown
View File

@ -270,8 +270,8 @@ First create a file called `alexa_confirm.yaml` with something like the followin
{% raw %}
>
{{ [
"OK",
"Sure",
"OK",
"Sure",
"If you insist",
"Done",
"No worries",

38
source/_components/camera.local_file.markdown Normal file
View File

@ -0,0 +1,38 @@
---
layout: page
title: "Local File"
description: "Instructions how to use Local File as a Camera within Home Assistant."
date: 2016-06-12 17:00
sidebar: true
comments: false
sharing: true
footer: true
logo: file.png
ha_category: Camera
ha_iot_class: "Local Polling"
ha_release: 0.22
---
The `local_file` camera platform allows you to integrate any readable image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated.
This can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodacally and will then be displayed in Home Assistant.
To enable this camera in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
platform: local_file
name: Local File
file_path: /tmp/image.jpg
```
Configuration variables:
- **name** (*Optional*): Name of the camera
- **file_path** (*Required*): File to serve as the camera.
<p class='note'>
The given `file_path` must be an existing file because the camera platform setup make a readable check on it.
</p>

37
source/_components/camera.netatmo.markdown Normal file
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.

5
source/_components/device_tracker.asuswrt.markdown
View File

@ -23,6 +23,7 @@ device_tracker:
platform: asuswrt
host: YOUR_ROUTER_IP
protocol: telnet
mode: router
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
```
@ -31,8 +32,10 @@ Configuration variables:
- **host** (*Required*): The IP address of your router, eg. 192.168.1.1.
- **protocol** (*Optional*): The protocol (`ssh` or `telnet`) to use. Defaults to `ssh`.
- **mode** (*Optional*): The operating mode of the router (`router` or `ap`). Defaults to `router`.
- **username** (*Required*: The username of an user with administrative privileges, usually *admin*.
- **password** (*Required*): The password for your given admin account.
- **password** (*Optional*): The password for your given admin account (use this if no public key is given).
- **pub_key** (*Optional*): The public key for your given admin account (instead of password).
<p class='note warning'>
You need to enable telnet on your router if you choose to use `protocol: telnet`.

33
source/_components/device_tracker.bt_home_hub_5.markdown Normal file
View File

@ -0,0 +1,33 @@
---
layout: page
title: "BT Home Hub 5"
description: "Instructions how to integrate BT Home Hub 5 router into Home Assistant."
date: 2016-06-13 13:00
sidebar: true
comments: false
sharing: true
footer: true
logo: bt.png
ha_category: Presence Detection
---
This platform offers presence detection by looking at connected devices to a [BT Home Hub 5](https://en.wikipedia.org/wiki/BT_Home_Hub) based router.
To use a BT Home Hub 5 router in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
device_tracker:
platform: bt_home_hub_5
host: 192.168.1.254
interval_seconds: 10
consider_home: 180
track_new_devices: yes
```
Configuration variables:
- **host** (*Required*): The IP address of your router, e.g. 192.168.1.254.
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

2
source/_components/device_tracker.ddwrt.markdown
View File

@ -14,7 +14,7 @@ ha_release: pre 0.7
This platform offers presence detection by looking at connected devices to a [DD-WRT](http://www.dd-wrt.com/site/index) based router.
To use a DD-WRRT router in your installation, add the following to your `configuration.yaml` file:
To use a DD-WRT router in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

29
source/_components/light.rfxtrx.markdown
View File

@ -7,19 +7,20 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: rfxtrx.png
ha_category: Light
ha_release: 0.7.5
---
The `rfxtrx` platform support lights that communicate in the frequency range of 433.92 MHz.
First you have to set up your [rfxtrx hub.](/components/rfxtrx/)
First you have to set up your [rfxtrx hub](/components/rfxtrx/).
The easiest way to find your lights is to add this to your `configuration.yaml`:
```yaml
light:
platform: rfxtrx
automatic_add: True
platform: rfxtrx
automatic_add: True
```
Launch your homeassistant and go the website.
@ -29,15 +30,15 @@ Push your remote and your device should be added:
<img src='/images/components/rfxtrx/switch.png' />
</p>
Here the name is 0b11000102ef9f210010f70 and you can verify that it works from the frontend.
Here the name is `0b11000102ef9f210010f70` and you can verify that it works from the frontend.
Then you should update your configuration to:
```yaml
light:
platform: rfxtrx
devices:
0b11000102ef9f210010f70:
name: device_name
platform: rfxtrx
devices:
0b11000102ef9f210010f70:
name: device_name
```
Example configuration:
@ -45,12 +46,12 @@ Example configuration:
```yaml
# Example configuration.yaml entry
light:
platform: rfxtrx
devices:
0b11000f10e9e5660b010f70:
name: Light1
0b1100100f29e5660c010f70:
name: Light_TV
platform: rfxtrx
devices:
0b11000f10e9e5660b010f70:
name: Light1
0b1100100f29e5660c010f70:
name: Light_TV
```
Configuration variables:

64
source/_components/media_player.pandora.markdown Normal file
View File

@ -0,0 +1,64 @@
---
layout: page
title: "Pandora"
description: "Instructions how to integrate Pandora radio into Home Assistant."
date: 2016-06-10 19:59
sidebar: true
comments: false
sharing: true
footer: true
logo: pandora.png
ha_category: Media Player
featured: false
ha_release: 0.22
---
If you have a Pandora account, you can control it from Home Assistant with this media player.
### {% linkable_title Installation of Pianobar %}
This media player uses the [Pianobar command-line Pandora client](https://github.com/PromyLOPh/pianobar), which you have to install separately. This can be done on a Raspberry Pi 2 with Raspbian Jesse as follows . _(Note: Other platforms may have different installation processes)_
Install the following dependencies:
```bash
$ sudo apt-get install git libao-dev libgcrypt11-dev libfaad-dev libmad0-dev libjson0-dev make pkg-config libav-tools libavcodec-extra libavcodec-dev libcurl4-openssl-dev libavfilter-dev libavformat-dev
```
Now clone the Pianobar repo and build pianobar:
```bash
$ git clone https://github.com/PromyLOPh/pianobar.git
$ cd pianobar
$ make clean && make
$ sudo make install
```
Configure Pianobar to auto-login and start playing a station (optional, see `man pianobar`) by creating and editing the `~/.config/pianobar/config` file:
```bash
password = Password
user = you@youraccount.com
```
Test it out by running `pianobar` in the command line. You should be able to listen to your Pandora stations.
### {% linkable_title Configuration in Home Assistant %}
The Pandora player can be loaded by adding the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
media_player:
platform: pandora
```
That's it! Now you will find a media player. If you click it you will find all your stations listed as different sources. If you switch to one, the station will begin playing.
<p class='img'>
<img src='/images/screenshots/pandora_player.png' />
</p>
<p class='note warning'>This is a new component and it has some issues. </p>

6
source/_components/media_player.sonos.markdown
View File

@ -13,7 +13,6 @@ featured: true
ha_release: 0.7.3
---
The `sonos` platform allows you to control your [Sonos](http://www.sonos.com) HiFi wireless speakers and audio components from Home Assistant.
To add your Sonos components to your installation, add the following to your `configuration.yaml` file. It will perform auto-discovery of your connected speakers.
@ -33,3 +32,8 @@ media_player:
hosts: IP
```
### {% linkable_title Service %}
There are two extra services exposed that will allow you to take a snapshot of what is currently playing and restore it afterwards. This is useful if you want to play a doorbell or notification sound and resume playback afterwards.
The services are called `sonos_snapshot` and `snapshot_restore`.

58
source/_components/netatmo.markdown Normal file
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>

2
source/_components/rfxtrx.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: rfxtrx.png
ha_category: Hub
ha_release: pre 0.7
---
@ -23,7 +24,6 @@ rfxtrx:
dummy: False
```
Configuration variables:
- **device** (*Required*): The path to your device, e.g. `/dev/serial/by-id/usb-RFXCOM_RFXtrx433_A1Y0NJGR-if00-port0`

24
source/_components/rollershutter.rfxtrx.markdown
View File

@ -2,34 +2,36 @@
layout: page
title: "RFXtrx Rollershutter"
description: "Instructions how to integrate RFXtrx roller shutters into Home Assistant."
date: 2016-06-02 22:10
date: 2016-06-12 12:40
sidebar: true
comments: false
sharing: true
footer: true
logo: rfxtrx.png
ha_category: Rollershutter
ha_release: 0.21
---
The `rfxtrx` platform supports Siemens/LightwaveRF and RFY roller shutters that communicate in the frequency range of 433.92 MHz.
First you have to set up your [rfxtrx hub.](/components/rfxtrx/)
First you have to set up your [rfxtrx hub](/components/rfxtrx/).
### {% linkable_title Configuration %}
#####Siemens/LightwaveRF
##### Siemens/LightwaveRF
The easiest way to find your roller shutters is to add this to your `configuration.yaml`:
```yaml
rollershutter:
platform: rfxtrx
automatic_add: True
platform: rfxtrx
automatic_add: True
```
Launch your homeassistant and go the website.
Launch your homeassistant and go the website (e.g http://localhost:8123).
Push your remote and your device should be added.
Once added it will show an id (e.g `0b11000102ef9f210010f70`) and you can verify that it works from the frontend.
Once added it will show an ID (e.g `0b11000102ef9f210010f70`) and you can verify that it works from the frontend.
Then you should update your configuration to:
```yaml
rollershutter:
platform: rfxtrx
@ -38,11 +40,10 @@ rollershutter:
name: device_name
```
#####RFY
The RFXtrx433e is required for RFY support, however it does not support receive for the RFY protocol - as such devices cannot be automatically added. Instead, configure the device in the [rfxmngr](http://www.rfxcom.com/downloads.htm) tool. Make a note of the assigned ID and Unit Code and then add a device to the configuration with the following id `071a0000[id][unit_code]`. Eg, if the id was `a` (`0a`) `00` `01`, and the unit code was `1` (`01`) then the fully qualified id would be `071a00000a000101`.
##### RFY
The [RFXtrx433e](http://www.rfxcom.com/RFXtrx433E-USB-43392MHz-Transceiver/en) is required for RFY support, however it does not support receive for the RFY protocol - as such devices cannot be automatically added. Instead, configure the device in the [rfxmngr](http://www.rfxcom.com/downloads.htm) tool. Make a note of the assigned ID and Unit Code and then add a device to the configuration with the following id `071a0000[id][unit_code]`. Eg, if the id was `0a` `00` `01`, and the unit code was `01` then the fully qualified id would be `071a00000a000101`.
#####Common
##### Common
Example configuration:
```yaml
@ -64,4 +65,3 @@ Configuration variables:
- **automatic_add** (*Optional*): To enable the automatic addition of new roller shutters (Siemens/LightwaveRF only).
- **signal_repetitions** *Optional*: Because the rxftrx device sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the roller shutter to try to send each signal repeatedly.
- **fire_event** *Optional*: Fires an event even if the state is the same as before. Can be used for automations.

20
source/_components/rollershutter.wink.markdown Normal file
View File

@ -0,0 +1,20 @@
---
layout: page
title: "Wink Rollershutter"
description: "Instructions how to setup the Wink rollershutter (shade) within Home Assistant."
date: 2016-02-12 07:00
sidebar: true
comments: false
sharing: true
footer: true
logo: wink.png
ha_category: Rollershutter
ha_release: 0.22
---
The Wink rollershutter platform allows you to control your [Wink](http://www.wink.com/) enabled rollershutters. It supports Wink shades / blinds / rollershutters such as the Bali Somfy or Lutron Serena blinds.
The Wink API currently doesn't provide status for shades.
The requirement is that you have setup your [Wink hub](/components/wink/).

2
source/_components/sensor.bloomsky.markdown
View File

@ -28,6 +28,7 @@ sensor:
- UVIndex
- Luminance
- Night
- Voltage
```
Configuration variables:
@ -40,3 +41,4 @@ Configuration variables:
- Rain
- Temperature
- UVIndex
- Voltage

4
source/_components/sensor.mysensors.markdown
View File

@ -2,7 +2,7 @@
layout: page
title: "MySensors Sensor"
description: "Instructions how to integrate MySensors sensors into Home Assistant."
date: 2016-04-13 14:20 +0100
date: 2016-06-12 15:00 +0200
sidebar: true
comments: false
sharing: true
@ -30,7 +30,7 @@ S_WEIGHT | V_WEIGHT, V_IMPEDANCE
S_POWER | V_WATT, V_KWH
S_DISTANCE | V_DISTANCE
S_LIGHT_LEVEL | V_LIGHT_LEVEL
S_IR | V_IR_SEND, V_IR_RECEIVE
S_IR | V_IR_RECEIVE
S_WATER | V_FLOW, V_VOLUME
S_AIR_QUALITY | V_DUST_LEVEL
S_CUSTOM | V_VAR1, V_VAR2, V_VAR3, V_VAR4, V_VAR5

34
source/_components/sensor.netatmo.markdown
View File

@ -2,13 +2,13 @@
layout: page
title: "Netatmo Sensor"
description: "Instructions how to integrate Netatmo sensors into Home Assistant."
date: 2016-01-14 08:10
date: 2016-06-02 08:10
sidebar: true
comments: false
sharing: true
footer: true
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
sensor:
platform: netatmo
api_key: YOUR_API_KEY
secret_key: YOUR_SECRET_KEY
username: YOUR_USERNAME
password: YOUR_PASSWORD
station: STATION_NAME
modules:
module_name1:
@ -45,11 +41,7 @@ sensor:
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.
- **station**: The name of the weather station. Needed if several stations are associated with the account.
- **station** (*Optionnal*): The name of the weather station. Needed if several stations are associated with the account.
- **modules** (*Required*): Modules to use. Multiple entries allowed.
- **module_name** array (*Required*): Name of the module.
- **temperature**: Current temperature.
@ -61,26 +53,6 @@ Configuration variables:
- **sum_rain_1**: Rainfall in the last hour in mm.
- **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 %}
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)

41
source/_components/sensor.plex.markdown Normal file
View File

@ -0,0 +1,41 @@
---
layout: page
title: "Plex Sensor"
description: "How to add a Plex sensor to Home Assistant."
date: 2016-06-3 08:19
sidebar: true
comments: false
sharing: true
footer: true
logo: plex.png
ha_category: Sensor
ha_release: 0.22
---
The `plex` sensor platform will monitor activity on a given [Plex Media Server](https://plex.tv/). It will create a sensor that shows the number of currently watching users as the state. If you click the sensor for more details it will show you who is watching what.
If your Plex server is on the same local network as Home Assistant, all you need to provide in the `configuration.yaml` is the host or IP address. If you want to access a remote Plex server, you must provide the Plex username, password, and optionally the server name of the remote Plex server. If no server name is given it will use the first server listed.
If you want to enable the plex sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
sensor:
platform: plex
name: Plex Spy
host: 192.168.1.100
port: 32400
username: plexuser
password: plexpw
server: MyPlexServer
```
Configuration variables:
- **host** (*Optional*): The IP address of your Plex server. Defaults to `localhost`.
- **port** (*Optional*): The port of your Plex Server. Defaults to 32400.
- **name** (*Optional*): Name of the Plex server. Defaults to Plex.
- **username** (*Optional*): The username for the remote Plex server.
- **password** (*Optional*): The password for your given account on the remote Plex server.
- **server** (*Optional*): The name of your remote Plex server.

61
source/_components/sensor.rfxtrx.markdown
View File

@ -7,18 +7,19 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: rfxtrx.png
ha_category: Sensor
---
The `rfxtrx` platform support sensors that communicate in the frequency range of 433.92 MHz.
First you have to set up your [rfxtrx hub.](/components/rfxtrx/)
First you have to set up your [rfxtrx hub](/components/rfxtrx/).
The easiest way to find your sensors is to add this to your `configuration.yaml`:
```yaml
sensor:
platform: rfxtrx
automatic_add: True
sensor:
platform: rfxtrx
automatic_add: True
```
Then when the sensor emits a signal it will be automatically added:
@ -27,47 +28,45 @@ Then when the sensor emits a signal it will be automatically added:
<img src='/images/components/rfxtrx/sensor.png' />
</p>
Here the name is 0a52080000301004d240259 and you can verify that it works from the frontend.
Here the name is `0a52080000301004d240259` and you can verify that it works from the frontend.
Then you should update your configuration to:
```yaml
sensor:
platform: rfxtrx
devices:
0a52080000301004d240259:
name: device_name
platform: rfxtrx
devices:
0a52080000301004d240259:
name: device_name
```
If you want to display several data types from one sensor:
```yaml
sensor:
platform: rfxtrx
devices:
0a520802060100ff0e0269:
name: Bath
data_type:
- Humidity
- Temperature
sensor:
platform: rfxtrx
devices:
0a520802060100ff0e0269:
name: Bath
data_type:
- Humidity
- Temperature
```
Example configuration:
```yaml
# Example configuration.yaml entry
sensor:
platform: rfxtrx
automatic_add: True
devices:
0a52080705020095220269:
name: Lving
0a520802060100ff0e0269:
name: Bath
data_type:
- Humidity
- Temperature
sensor:
platform: rfxtrx
automatic_add: True
devices:
0a52080705020095220269:
name: Lving
0a520802060100ff0e0269:
name: Bath
data_type:
- Humidity
- Temperature
```
Configuration variables:
@ -75,4 +74,4 @@ Configuration variables:
- **devices** (*Optional*): A list of devices with their name to use in the frontend.
- **automatic_add** (*Optional*): To enable the automatic addition of new lights.
- **data_type** (*Optional*): Which data type the sensor should show
- **fire_event** *Optional*: Fires an event even if the state is the same as before. Can be used for automations.

54
source/_components/sensor.snmp.markdown Normal file
View File

@ -0,0 +1,54 @@
---
layout: page
title: "SNMP"
description: "Instructions how to integrate SNMP sensors within Home Assistant."
date: 2016-06-05 20:00
sidebar: true
comments: false
sharing: true
footer: true
logo: network-snmp.png
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_release: "0.21"
---
The `snmp` sensor platform simple displays the information which are available through the [Simple Network Management Protocol (SNMP)](https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol). SNMP uses a tree-like hierarchy where each node is an object.
To enable this sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
platform: snmp
name: Load
host: 192.168.1.32
port: 161
community: public
baseoid: 1.3.6.1.4.1.2021.10.1.3.1
unit_of_measurement: "%"
```
Configuration variables:
- **host** (*Required*): The IP address of your host, eg. 192.168.1.32.
- **port** (*Option*): The SNMP port of your host. Defaults to 161.
- **name** (*Optional*): Name of the SNMP sensor.
- **community** (*Optional*): The SNMP community which is set for the device. Most devices have a default community set to to `public` with read-only permission (which is sufficient).
- **baseoid** (*Required*): The OID where the information is located. It's advised to use the numerical notation.
- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any.
The OIDs may vary on different system because they are vendor-specific. Beside the device's manual is the [OID Repository](http://www.oid-info.com/) a good place to start if you are looking for OIDs. The following OIDs are for the load of a Linux systems.
- 1 minute Load: 1.3.6.1.4.1.2021.10.1.3.1
- 5 minute Load: 1.3.6.1.4.1.2021.10.1.3.2
- 15 minute Load: 1.3.6.1.4.1.2021.10.1.3.3
There is a large amount of tools available to work with SNMP. `snmpwalk` let you easily retrieve the value of a OID.
```bash
$ snmpwalk -Os -c public -v 2c 192.168.1.32 1.3.6.1.4.1.2021.10.1.3.1
laLoad.1 = STRING: 0.19
```

19
source/_components/shell_command.markdown
View File

@ -26,3 +26,22 @@ Configuration variables:
- Alias for the command
- Command itself.
The commands can be dynamic, using templates to insert values of other entities. When using templates you are limited to only template the arguments. You are also no longer allowed to use pipe symbols when using templates.
Any service data passed into the service call to activate the shell command will be available as a variable within the template.
```yaml
# Apply value of a GUI slider to the shell_command
input_slider:
ac_temperature:
name: A/C Setting
initial: 24
min: 18
max: 32
step: 1
{% raw %}
shell_command:
set_ac_to_slider: 'irsend SEND_ONCE DELONGHI AC_{{ states.input_slider.ac_temperature.state}}_AUTO'
{% endraw %}
```

113
source/_components/switch.mysensors.markdown
View File

@ -2,7 +2,7 @@
layout: page
title: "MySensors Switch"
description: "Instructions how to integrate MySensors switches into Home Assistant."
date: 2016-04-21 13:30 +0100
date: 2016-06-12 15:00 +0200
sidebar: true
comments: false
sharing: true
@ -25,6 +25,7 @@ S_MOTION | V_ARMED
S_SMOKE | V_ARMED
S_LIGHT | V_LIGHT
S_LOCK | V_LOCK_STATUS
S_IR | V_IR_SEND, V_LIGHT
##### MySensors version 1.5 and higher
@ -38,10 +39,47 @@ S_SOUND | V_ARMED
S_VIBRATION | V_ARMED
S_MOISTURE | V_ARMED
All V_TYPES for each S_TYPE above are required to activate the actuator for the platform. Use either V_LIGHT or V_STATUS depending on library version for cases where that V_TYPE is required.
For more information, visit the [serial api] of MySensors.
### {% linkable_title Example sketch %}
### {% linkable_title Services %}
The MySensors switch platform exposes a service to change an IR code attribute for an IR switch device and turn the switch on. The IR switch will automatically be turned off after being turned on, if `optimistic` is set to `true` in the [config](/components/mysensors/#configuration) for the MySensors component. This will simulate a push button on a remote. If `optimistic` is `false`, the MySensors device will have to report its updated state to reset the switch. See the [example sketch](#ir-switch-sketch) for the IR switch below.
| Service | Description |
| ------- | ----------- |
| mysensors_send_ir_code | Set an IR code as a state attribute for a MySensors IR device switch and turn the switch on.|
The service can be used as part of an automation script. For example:
```yaml
# Example configuration.yaml automation entry
automation:
- alias: turn hvac on
trigger:
platform: time
after: '5:30:00'
action:
service: switch.mysensors_send_ir_code
entity_id: switch.hvac_1_1
data:
V_IR_SEND: '0xC284' # the IR code to send
- alias: turn hvac off
trigger:
platform: time
after: '0:30:00'
action:
service: switch.mysensors_send_ir_code
entity_id: switch.hvac_1_1
data:
V_IR_SEND: '0xC288' # the IR code to send
```
### {% linkable_title Example sketches %}
#### {% linkable_title Switch sketch %}
```cpp
/*
* Documentation: http://www.mysensors.org
@ -86,5 +124,76 @@ void incomingMessage(const MyMessage &message)
}
```
#### {% linkable_title IR switch sketch %}
```cpp
/*
* Documentation: http://www.mysensors.org
* Support Forum: http://forum.mysensors.org
*
* http://www.mysensors.org/build/ir
*/
#include <MySensor.h>
#include <SPI.h>
#include <IRLib.h>
#define SN "IR Sensor"
#define SV "1.0"
#define CHILD_ID 1
MySensor gw;
char code[10] = "abcd01234";
char oldCode[10] = "abcd01234";
MyMessage msgCodeRec(CHILD_ID, V_IR_RECEIVE);
MyMessage msgCode(CHILD_ID, V_IR_SEND);
MyMessage msgSendCode(CHILD_ID, V_LIGHT);
void setup()
{
gw.begin(incomingMessage);
gw.sendSketchInfo(SN, SV);
gw.present(CHILD_ID, S_IR);
// Send initial values.
gw.send(msgCodeRec.set(code));
gw.send(msgCode.set(code));
gw.send(msgSendCode.set(0));
}
void loop()
{
gw.process();
// IR receiver not implemented, just a dummy report of code when it changes
if (String(code) != String(oldCode)) {
Serial.print("Code received ");
Serial.println(code);
gw.send(msgCodeRec.set(code));
strcpy(oldCode, code);
}
}
void incomingMessage(const MyMessage &message) {
if (message.type==V_LIGHT) {
// IR sender not implemented, just a dummy print.
if (message.getBool()) {
Serial.print("Sending code ");
Serial.println(code);
}
gw.send(msgSendCode.set(message.getBool() ? 1 : 0));
// Always turn off device
gw.wait(100);
gw.send(msgSendCode.set(0));
}
if (message.type == V_IR_SEND) {
// Retrieve the IR code value from the incoming message.
String codestring = message.getString();
codestring.toCharArray(code, sizeof(code));
Serial.print("Changing code to ");
Serial.println(code);
gw.send(msgCode.set(code));
}
}
```
[main component]: /components/mysensors/
[serial api]: https://www.mysensors.org/download/serial_api_15

39
source/_components/switch.rfxtrx.markdown
View File

@ -7,19 +7,20 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: rfxtrx.png
ha_category: Switch
ha_release: 0.7.5
---
The `rfxtrx` platform support switches that communicate in the frequency range of 433.92 MHz.
First you have to set up your [rfxtrx hub.](/components/rfxtrx/)
First you have to set up your [rfxtrx hub](/components/rfxtrx/).
The easiest way to find your switches is to add this to your `configuration.yaml`:
```yaml
switch:
platform: rfxtrx
automatic_add: True
platform: rfxtrx
automatic_add: True
```
Launch your homeassistant and go the website.
@ -29,32 +30,32 @@ Push your remote and your device should be added:
<img src='/images/components/rfxtrx/switch.png' />
</p>
Here the name is 0b11000102ef9f210010f70 and you can verify that it works from the frontend.
Here the name is `0b11000102ef9f210010f70` and you can verify that it works from the frontend.
Then you should update your configuration to:
```yaml
switch:
platform: rfxtrx
devices:
0b11000102ef9f210010f70:
name: device_name
platform: rfxtrx
devices:
0b11000102ef9f210010f70:
name: device_name
```
Example configuration:
```yaml
# Example configuration.yaml entry
switch:
platform: rfxtrx
automatic_add: False
signal_repetitions: 2
devices:
0b1100ce3213c7f210010f70:
name: Movment1
0b11000a02ef2gf210010f50:
name: Movment2
0b1111e003af16aa10000060:
name: Door
switch:
platform: rfxtrx
automatic_add: False
signal_repetitions: 2
devices:
0b1100ce3213c7f210010f70:
name: Movment1
0b11000a02ef2gf210010f50:
name: Movment2
0b1111e003af16aa10000060:
name: Door
```
Configuration variables:

2
source/_includes/site/head.html
View File

@ -1,6 +1,6 @@
{% capture fb_description %}{% if page.description %}{{ page.description }}{% endif %}{% endcapture %}
{% capture description %}{% if page.description %}{{ page.description }}{% else site.description %}{{ site.description }}{% endif %}{% endcapture %}
{% capture social_image %}{% if page.og_image %}{{ page.og_image | prepend: site.url }}{% else %}https://home-assistant.io/images/home-assistant-logo-2164x2164.png{% endif %}{% endcapture %}
{% capture social_image %}{% if page.og_image %}{{ page.og_image | prepend: site.url }}{% else %}https://home-assistant.io/images/default-social.png{% endif %}{% endcapture %}
<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->

74
source/_posts/2016-06-18-pandora-bt-home-hub-5-and-local-file-camera.markdown Normal file
View File

@ -0,0 +1,74 @@
---
layout: post
title: "0.22: Pandora, BT Home Hub 5 and local file camera."
description: "This new release of Home Assistant has been mainly about stabilizing our last release which included a lot of core improvements. We're all stable now and set for a bright future."
date: 2016-06-18 18:06:00 +0000
date_formatted: "June 18, 2016"
author: Paulus Schoutsen
author_twitter: balloob
comments: true
categories: Release-Notes
---
It's time for the 0.22 release. This was a pretty rough release cycle and we had to issue two hot fixes for our core improvements. But it seems now that all is good and a lot of people have reported that their installs are faster than ever and the occasional quirks no longer occur.
We are aware that our new web stack has caused issues installing Home Assistant on ARM-based platforms. This sadly includes the Raspberry Pi and Synology NAS systems. We're working on getting to a better solution. For Raspberry Pi, the [All-in-One installer] will take care of everything for you. We're working on updating our [standalone Raspberry Pi installation guide].
There are two cool things that I want to highlight in this release. The first is Pandora support. This is based on the CLI player called pianobar. This means that your machine running Home Assistant can be connected to the speakers and provide your house with tunes.
<p class='img'>
<img src='/images/screenshots/pandora_player.png' />
</p>
Another cool addition is the local file camera. This seems very basic at first but will allow you to generate a graph with your favorite 3rd party graphing tool and display it on your Home Assistant dashboard. We're looking forward to see what you can do with this!
<img src='/images/supported_brands/pandora.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='150' /><img src='/images/supported_brands/bt.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='150' />
- Media Player: [Pandora] media player now supported ([@partofthething])
- Device Tracker: [BT Home Hub 5] now supported ([@lwis])
- Camera: New [local file] platform shows any image as camera ([@Landrash])
- Add [Sonos] snapshot and restore services ([@dansullivan86])
- Device Tracker: [AsusWRT] in Access Point mode now supported ([@linjef])
- Device Tracker: [AsusWRT] login using public key now supported ([@mtreinish])
- Device Tracker: [AsusWRT] protocol to use is now auto detected ([@persandstrom])
- Camera: [Netatmo] now supported ([@jabesq])
- API documentation added in [Swagger.yaml format] ([@wind-rider])
- Media Player: [Cast] devices can now be stopped ([@michaelarnauts])
- MySensors: [IR switch device] and service now supported ([@MartinHjelmare])
- Bloomsky: [Voltage sensor] now supported ([@arsaboo])
- Sensor: New [Plex sensor] monitors friends streaming from your Plex server ([@nkgilley])
- Component [shell command] can now use templates to render arguments ([@partofthething])
- Rollershutter: [Wink] is now supported ([@philk])
- Alexa: Updated [documentation][alexa] to show how to call scripts and scenes (@acockburn)
[@acockburn]: https://github.com/acockburn/
[@arsaboo]: https://github.com/arsaboo/
[@dansullivan86]: https://github.com/dansullivan86/
[@jabesq]: https://github.com/jabesq/
[@Landrash]: https://github.com/Landrash/
[@linjef]: https://github.com/linjef/
[@lwis]: https://github.com/lwis/
[@MartinHjelmare]: https://github.com/MartinHjelmare/
[@michaelarnauts]: https://github.com/michaelarnauts/
[@mtreinish]: https://github.com/mtreinish/
[@nkgilley]: https://github.com/nkgilley/
[@partofthething]: https://github.com/partofthething/
[@persandstrom]: https://github.com/persandstrom/
[@philk]: https://github.com/philk/
[@wind-rider]: https://github.com/wind/
[AsusWRT]: /components/device_tracker.asuswrt/
[BT Home Hub 5]: /components/device_tracker.bt_home_hub_5/
[Cast]: /components/media_player.cast/
[IR switch device]: /components/mysensors/
[local file]: /components/camera.local_file/
[Netatmo]: /components/netatmo/
[Pandora]: /components/media_player.pandora/
[shell command]: /components/shell_command/
[Sonos]: /components/media_player.sonos/
[Wink]: /components/rollershutter.wink/
[alexa]: /components/alexa/#working-with-scenes
[Plex sensor]: /components/sensor.plex/
[Swagger.yaml format]: https://github.com/home-assistant/home-assistant/blob/dev/docs/swagger.yaml
[All-in-One installer]: /getting-started/installation-raspberry-pi-all-in-one/
[standalone Raspberry Pi installation guide]: /getting-started/installation-raspberry-pi/
[Voltage sensor]: /components/sensor.bloomsky/

BIN
source/images/default-social.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 49 KiB

BIN
source/images/screenshots/pandora_player.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 29 KiB

BIN
source/images/supported_brands/bt.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.1 KiB

BIN
source/images/supported_brands/pandora.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 29 KiB

6
source/index.html
View File

@ -15,9 +15,9 @@ hide_github_edit: true
<div class="grid">
<div class="grid__item one-third lap-one-third palm-one-whole">
<div class='current-version material-card text'>
<h1>Current: 0.21.2</h1>
Released: <span class='release-date'>June 15, 2016</span><br>
<a href='/blog/2016/06/08/super-fast-web-enocean-lirc/'>Release notes</a>
<h1>Current: 0.22</h1>
Released: <span class='release-date'>June 18, 2016</span><br>
<a href='/blog/2016/06/18/pandora-bt-home-hub-5-and-local-file-camera/'>Release notes</a>
</div>
</div>
<div class="grid__item two-thirds lap-two-thirds palm-one-whole">