Merge branch 'next'

This commit is contained in:
Fabian Affolter 2016-07-01 20:43:51 +02:00
commit 5f51e3bbe2
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
37 changed files with 1021 additions and 47 deletions

View File

@ -0,0 +1,20 @@
---
layout: page
title: "Envisalink Alarm"
description: "Instructions how to setup the Envisalink Alarm control panel within Home Assistant."
date: 2016-07-01 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: eyezon.png
ha_category: Alarm
ha_release: 0.23
ha_iot_class: "Local Push"
---
The `envisalink` alarm control panel platform allows you to control your [Envisalink](http://www.eyezon.com) alarms.
The requirement is that you have setup your [Envisalink hub](/components/envisalink/).

View File

@ -0,0 +1,18 @@
---
layout: page
title: "Envisalink Binary Sensor"
description: "Instructions how to integrate Envisalink binary sensors into Home Assistant."
date: 2016-07-01 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: eyezon.png
ha_release: 0.23
ha_category: Binary Sensor
ha_iot_class: "Local Push"
---
The `envisalink` platform allows you to get data from your [Envisalink](http://www.eyezon.com/) binary sensors from within Home Assistant.
The requirement is that you have setup your [Envisalink hub](/components/envisalink/).

View File

@ -0,0 +1,19 @@
---
layout: page
title: "Homematic Binary Sensor"
description: "Instructions how to integrate binary Homematic sensors within Home Assistant."
date: 2016-06-28 08:30
sidebar: true
comments: false
sharing: true
footer: true
logo: homematic.png
ha_category: Binary Sensor
ha_release: 0.23
ha_iot_class: "Local Push"
---
The `homematic` binary sensor platform lets you observe the state changes of binary [Homematic](http://www.homematic.com/) sensors through Home Assistant.
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.

View File

@ -0,0 +1,76 @@
---
layout: page
title: "Envisalink Alarm Control Panel"
description: "Instructions on how to integrate a DSC/Honeywell alarm panel with Home Assistant using an envisalink evl3/evl4 board."
date: 2016-06-19 22:10
sidebar: true
comments: false
sharing: true
footer: true
logo: eyezon.png
ha_category: Alarm
ha_release: 0.23
---
This component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and it's sensors to provide Home Assistant with rich information about their homes.
Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Eyez On, known as the Envisalink. The Envisalink evl3 and evl4 boards provide a TCP/IP interface to the alarm panel, where it emulates an alarm keypad. This board also exposes a raw TCP/IP based API, upon which this component is built. Currently, the Envisalink version 4 is the latest model. This component supports both the evl3 and the evl4.
Please visit the [eyezon website](http://www.eyezon.com/) for further information about the evl3 and evl4 boards.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](/components/binary_sensor.envisalink/): Reports on zone status
- [Sensor](/components/sensor.envisalink/): Emulates an alpha-numeric keypad attached to the alarm panel
- [Alarm Control Panel](/components/alarm_control_panel.envisalink/): Reports on partition status, and can be used to arm/disarm the system
This is a fully event-based component- any event sent by the Envisalink device will be immediately reflected within Home Assistant.
## Configuration
An `envisalink` section must be present in the `configuration.yaml` file and contain the following options as required:
### Required Parameters
- **host**: The IP address of the Envisalink device on your home network.
- **panel_type**: `HONEYWELL` or `DSC`, depending upon which alarm system you have.
- **user_name**: Which username to authenticate with when connecting to the device. On a Honeywell alarm panel, the username/password are the same.
- **password**: Which password to authenticate with when connecting to the device.
- **code**: Your alarm panel's code, for authenticating user input during arm/disarm.
### Optional Parameters
- **port**: Which network port to connect with. Default: `4025`
- **evl_version**: 3 for evl3, or 4 for evl4. Default: `3`
- **keepalive_interval**: This is a periodic heartbeat signal (measured in seconds) sent to your Envisalink board to keep it from restarting. This is required for DSC and Honeywell systems. Default: `60` seconds
- **zonedump_interval**: This is an interval (measured in seconds) where the evl will dump out all zone statuses. This is required for Honeywell systems, which do not properly send zone closure events. DSC boards do not technically need this. Default: `30`
- **zones**: Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. *Note- if no zones are specified, Home Assistant will not load any binary_sensor components.*
- **partitions**: Again, Envisalink boards do not tell us what is in use, and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor components are loaded.
#### Example
```yaml
envisalink:
#optional
port: 4025
evl_version: 3
keepalive_interval: 60
zonedump_interval: 30
#required
host: <envisalink IP address>
panel_type: HONEYWELL or DSC
user_name: <pass>
password: <pass>
code: '1234'
zones:
11:
name: 'Back Door'
type: 'opening'
21:
name: 'First Floor Motion'
type: 'motion'
partitions:
1:
name: 'Home Alarm'
```

View File

@ -0,0 +1,26 @@
---
layout: page
title: "Raspberry Pi Garage door"
description: "Instructions how to setup the Raspberry Pi garage doors within Home Assistant."
date: 2016-02-12 07:00
sidebar: true
comments: false
sharing: true
footer: true
logo: wink.png
ha_category: Garage Door
ha_release: 0.23
---
```yaml
# Example configuration.yaml entry
garage_door:
platform: rpi_gpio
doors:
- relay_pin: 10
state_pin: 11
name: 'Left door'
- relay_pin: 12
state_pin: 13
name: 'Right door'
```

View File

@ -0,0 +1,15 @@
---
layout: page
title: "Z-Wave Garage Door"
description: "Instructions how to setup the Z-Wave garage doors within Home Assistant."
date: 2015-11-15 13:00
sidebar: true
comments: false
sharing: true
footer: true
logo: z-wave.png
ha_category: Garage Door
ha_release: 0.23
---
To get your Z-Wave garage doors working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).

View File

@ -0,0 +1,64 @@
---
layout: page
title: "HDMI CEC"
description: "Instructions how to interact with HDMI CEC via Home Assistant."
date: 2016-06-24 19:59
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Automation
featured: false
ha_release: 0.23
ha_iot_class: "Local Push"
---
The CEC component provides services that allow selecting the active device, powering on all devices, and setting all devices to standby. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as Soundbars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers.
## {% linkable_title CEC Setup %}
### {% linkable_title Adapter %}
The computer running Home Assistant must support CEC, and of course be connected via HDMI to a device also supporting CEC. You can purchase a [USB CEC adapter](https://www.pulse-eight.com/p/104/usb-hdmi-cec-adapter) to add support if necessary. Note that all Raspberry Pi models support CEC natively.
### {% linkable_title libcec %}
[libcec](https://github.com/Pulse-Eight/libcec) must be installed for this component to work. Follow the installation instructions for your environment, provided at the link. `libcec` installs Python 3 bindings, by default as a system Python module. If you are running Home Assistant in a Python virtual environment, make sure it can access the system module, by either symlinking it or using the `--system-site-packages` flag.
## {% linkable_title Configuration Example %}
In the following example, a Pi Zero running Home Assistant is on a TV's HDMI port 1. HDMI port 2 is attached to a AV receiver. Three devices are attached to the AV receiver on HDMI ports 1 through 3.
```yaml
hdmi_cec:
devices:
1: Pi Zero
2:
1: Fire TV Stick
2: Chromecast
3: Another Device
```
## {% linkable_title Services %}
### {% linkable_title Select Device %}
Call the `hdmi_cec/select_device` service with the name of the device to select, for example:
```json
{
"device": "Chromecast"
}
```
### {% linkable_title Power On %}
Call the `hdmi_cec/power_on` service (no arguments) to power on any devices that support this function.
### {% linkable_title Standby %}
Call the `hdmi_cec/standby` service (no arguments) to place in standby any devices that support this function.
## {% linkable_title Useful References %}
* [CEC overview](http://wiki.kwikwai.com/index.php?title=The_HDMI-CEC_bus)
* [CEC-o-matic](http://www.cec-o-matic.com/)

View File

@ -0,0 +1,85 @@
---
layout: page
title: "Homematic"
description: "Instructions for integrating Homematic into Home Assistant."
date: 2016-06-28 23:25
sidebar: true
comments: false
sharing: true
footer: true
logo: homematic.png
ha_category: Hub
ha_iot_class: "Local Push"
featured: true
---
The [Homematic](http://www.homematic.com/) component provides bi-directional communication of Homematic platforms with their real world counterparts. This implementation does in no way modify your existing setup. Instead it queries your setup for its devices and subscribes to them to send and receive events.
Device support is currently available for most of:
- Switch/Dimmer-actors
- Thermostats
- Rollershutters
- Sensors (shutter contacts, motion detectors, power meters and more)
- Simple remote controls
If you want to see if a specific device you have is supported, head over to the [pyhomematic](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) repository and browse through the sourcecode. A dictionary with the device identifiers (e.g. HM-Sec-SC-2) can be found within the relevant modules near the bottom.
We automatically detect all devices we currently support and try to generate useful names. If you enable name-resolving, we try to fetch names from Metadata (Homegear), via JSON-RPC or the XML-API you may have installed on your CCU. Since this may fail this is disabled by default.
You can manually override the created entities be using Home Assistants [Customizing](https://home-assistant.io/getting-started/customizing-devices/) feature. With it you are able to hide entities you don't need to see within the UI.
To set up the component, add the following information to your `configuration.yaml` file:
```yaml
homematic:
local_ip: 127.0.0.1
local_port: 8943
remote_ip: 127.0.0.1
remote_port: 2001
```
Configuration variables:
- **local_ip** (*Required*): IP of device running Home Assistant
- **local_port** (*Optional*): Port for connection with Home Assistant. Defaults to 8943.
- **remote_ip** (*Required*): IP of CCU/Homegear
- **remote_port** (*Required*): Port of Homegear/CCU XML-RPC Server (usually 2001)
- **resolvenames** (*Optional*): <metadata, json, xml> Try to fetch device names. Defaults to `False` if not specified.
- **username** (*Optional*): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU.
- **password** (*Optional*): When fetching names via JSON-RPC, you need to specify the password of the user you have configured above.
- **delay** (*Optional*): <Float> Delay fetching of current state per deivce on startup. Used to prevent overloading of the CCU. Defaults to 0.5.
To further explain the `resolvenames` option:
We use three approaches to fetch the names of devices. Each assumes you have properly named your devices in your existing Homematic setup. As a general advice: Use ASCII for your devices names. Home Assistant won't include non-ASCII characters in entity-names.
1. The CCU allows to fetch details of the paired devices via JSON-RPC. For this to work you need to add valid credentials to your component-configuration. Guest-access is sufficient to query for device names.
2. If you use a regular CCU, there is an add-on called the "XML-API". With it installed, you are able to fetch all kinds of information from you CCU using XML-RPC. We can leverage this and fetch the names of devices set within the CCU. We don't support authentication with this method.
3. Homegear provides device-names through the metadata devices internally have. When using an HM-CFG-LAN interface, you typically use a configuration software ("HomeMatic-Komponenten konfigurieren" is the name of the shortcut on your desktop by default) to pair and configure your devices. If you have paired devices, you'll see them listed in a table. The leftmost column (Name) is prefilled with default names. You can click such a name and enter whatever you like.
Resolving names can take some time. So when you start Home Assistant you won't see you devices at first. For a setup with 20+ devices it can take up to a minute until all devices show up in the UI.
**Devices with buttons**
Devices with buttons (e.g. HM-Sen-MDIR-WM55, remote controls) may not be fully visible in the UI. This is intended, as buttons don't serve any value here and all they do is trigger events.
As an example:
The HM-Sen-MDIR-WM55 motion detector will be displayed as 2 entities. A motion sensor and a brightness sensor. On top of that we have 2 sets (one set per button) of 4 events: PRESS_SHORT, PRESS_LONG, PRESS_CONT, PRESS_LONG_RELEASE. Be aware, that there are devices which don't provide all of these events. But in general: if you can press it, it at least has PRESS_SHORT.
Here's an example of how to use these events for automations:
```yaml
automation:
trigger:
platform: event
event_type: homematic.keypress
event_data:
name: Kitchen Switch
channel: 1
param: PRESS_SHORT
action:
service: switch.turn_on
entity_id: switch.Kitchen_Ambience
```
The channel parameter is equal to the channel of the button you are configuring the automation for. You can view the available channels in the UI you use to pair your devices.
The name depends on if you chose to resolve names or not. If not, it will be the device ID (e.g. LEQ1234657). If you chose to resolve names (and that is successful), it will be the name you have set in your CCU or in the metadata (e.g. "Kitchen Switch").

View File

@ -0,0 +1,19 @@
---
layout: page
title: "Homematic Light"
description: "Instructions how to integrate Homematic lights within Home Assistant."
date: 2016-06-28 08:30
sidebar: true
comments: false
sharing: true
footer: true
logo: homematic.png
ha_category: Light
ha_release: 0.23
ha_iot_class: "Local Push"
---
The `homematic` light platform lets you control [Homematic](http://www.homematic.com/) lights through Home Assistant.
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.

View File

@ -0,0 +1,19 @@
---
layout: page
title: "Vera Lock"
description: "Instructions how to integrate Vera locks into Home Assistant."
date: 2016-06-29 15:00
sidebar: true
comments: false
sharing: true
footer: true
logo: vera.png
ha_category: Lock
ha_iot_class: "Local Push"
---
The `vera` platform allows you to control your [Vera](http://getvera.com/) locks from within Home Assistant.
They will be automatically discovered if the vera component is loaded.
For more configuration information see the [Vera component](/components/vera/) documentation.

View File

@ -0,0 +1,35 @@
---
layout: page
title: "Sony Bravia TV"
description: "Instructions on how to integrate a Sony Bravia TV into Home Assistant."
date: 2016-07-01 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: bravia.png
ha_category: Media Player
ha_release: 0.23
---
The `braviatv` platform allows you to control a [Sony Bravia TV](http://www.sony.com).
Almost all [Sony Bravia TV 2013 and newer](http://info.tvsideview.sony.net/en_ww/home_device.html#bravia) are supported.
You will need to configure your TV to allow the Home Assistant for remote usage. To do that, ensure that your TV is turned on. Open the configuration popup on Home Assistant and enter a random PIN (for example 0000). After that, the TV will show you a PIN and Home Assistant will allow you to re-enter that PIN. Enter the PIN shown on your TV and Home Assistant will be able to control your Sony Bravia TV.
To add a TV to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
media_player:
platform: braviatv
host: 192.168.0.10
name: Living Room TV
```
Configuration variables:
- **host** (*Required*): The IP of the Sony Bravia TV, eg. 192.168.0.10
- **name** (*Optional*): The name to use on the frontend.

View File

@ -0,0 +1,43 @@
---
layout: page
title: "cmus"
description: "Instructions how to integrate cmus Music Player into Home
Assistant."
date: 2016-06-17 18:45
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Media Player
---
The `cmus` platform allows you to control a [cmus](https://cmus.github.io/) music player on a remote or local machine from Home Assistant.
To add cmus to your installation, add the following to your `configuration.yaml` file if cmus is running on a remote server:
```yaml
# Example configuration.yaml entry
media_player:
platform: cmus
host: IP_ADDRESS
port: 3000
password: PASSWORD
name: Desktop Computer Music Player
```
if running locally it will look like:
```yaml
# Example configuration.yaml entry
media_player:
platform: cmus
name: Local Music Player
```
Configuration variables:
- **host** Hostname or IP address of the machine running cmus. Note if a remote
cmus is configured that instance must be configured to listen to remote connections, which also requires a password to be set.
- **password** (*Required if host is set*): Password for your cmus player.
- **port** (*Optional*): Port of the cmus socket, defaults to 3000.
- **name** (*Optional*): The name you'd like to give the cmus player in Home Assistant

View File

@ -0,0 +1,54 @@
---
layout: page
title: "Persistent notification"
description: "Instructions on how to integrate persistant notifications into Home Assistant."
date: 2016-06-25 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Other
ha_release: 0.23
---
The `persistant_notification` can be used to show a message on the frontend that has to be dismissed by the user.
<p class='img'>
<img src='/images/screenshots/persistant-notification.png' />
</p>
### {% linkable_title Service %}
The service `persistent_notification/create` takes in `message`, `title`, and `notification_id`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `message` | no | Body of the notification.
| `title` | yes | Title of the notification.
| `notification_id` | yes | If `notification_id` is given, it will overwrite the notification if there already was a notification with that ID.
The `persistant_notification` component supports specifying [templates](/topics/templating/) for both the `message` and the `title`. This will allow you to use the current state of Home Assistant in your notifications.
In an [action](https://home-assistant.io/getting-started/automation-action/) of your [automation setup](/getting-started/automation/) it could look like this with a customized subject.
```yaml
action:
service: persistant_notification.create
data:
message: "Your message goes here"
title: "Custom subject"
```
### {% linkable_title Create a persistant notification %}
Choose <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools** to call the `persistant_notification` service. Select `persistant_notification/create` from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**.
```json
{
"notification_id": "1234",
"title": "Sample notification",
"message": "This is a sample text"
}
```
This will create the notification entry shown above.

View File

@ -0,0 +1,19 @@
---
layout: page
title: "Homematic Rollershutter"
description: "Instructions how to integrate Homematic rollershutters within Home Assistant."
date: 2016-06-28 08:30
sidebar: true
comments: false
sharing: true
footer: true
logo: homematic.png
ha_category: Rollershutter
ha_release: 0.23
ha_iot_class: "Local Push"
---
The `homematic` rollershutter platform lets you control [Homematic](http://www.homematic.com/) rollershutters through Home Assistant.
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.

View File

@ -0,0 +1,15 @@
---
layout: page
title: "Z-Wave Rollershutter"
description: "Instructions how to setup the Z-Wave rollershutters within Home Assistant."
date: 2015-11-15 13:00
sidebar: true
comments: false
sharing: true
footer: true
logo: z-wave.png
ha_category: Rollershutter
ha_release: 0.23
---
To get your Z-Wave rollershutters working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).

View File

@ -10,11 +10,11 @@ footer: true
ha_category: Sensor
logo: db.png
ha_iot_class: "Local Polling"
ha_release: 0.14
---
The `deutsche_bahn` sensor will give you the departure time of the next train for the given connection. In case of a delay, the delay is also shown. Additional `ATTRIBUTES` are used to inform about eg. the type of the train, price and if it is ontime. The data are coming from the [bahn.de](http://www.bahn.de/p/view/index.shtml) website.
The `deutsche_bahn` sensor will give you the departure time of the next train for the given connection. In case of a delay, the delay is also shown. Additional details are used to inform about eg. the type of the train, price, and if it is ontime.
To enable this sensor, add the following lines to your `configuration.yaml` file:
@ -29,5 +29,18 @@ sensor:
Configuration variables:
- **from** (*Required*): The name of the start station.
- **to** (*Required*): The name of the end station.
- **to** (*Required*): The name of the end/destination station.
As already mentioned this sensor contains a lot of information to access those a [template senosr](/components/sensor.template/) can come handy.
```yaml
# Example configuration.yaml entry
sensor:
platform: template
sensors:
next_departure:
value_template: '{% raw %}{{ states.sensor.munich_to_ulm.attributes.next }}{% endraw %}'
friendly_name: 'Next departure'
```
The data is coming from the [bahn.de](http://www.bahn.de/p/view/index.shtml) website.

View File

@ -0,0 +1,19 @@
---
layout: page
title: "Vera Sensor"
description: "Instructions how to integrate Vera sensors into Home Assistant."
date: 2016-07-01 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: eyezon.png
ha_release: 0.23
ha_category: Sensor
ha_iot_class: "Local Push"
---
The `envisalink` platform allows you to get data from your [Envisalink](http://www.eyezon.com/) sensors from within Home Assistant.
The requirement is that you have setup your [Envisalink hub](/components/envisalink/).

View File

@ -0,0 +1,37 @@
---
layout: page
title: "Fixer.io"
description: "Instructions how to integrate exchange rates from Fixer.io within Home Assistant."
date: 2016-06-20 10:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
logo: fixer-io.png
ha_iot_class: "Local Polling"
ha_release: 0.23
---
The `fixer` sensor will show you the current exchange rate from [Fixer.io](http://fixer.io/) which is using data from the [European Central Bank (ECB)](https://www.ecb.europa.eu).
To get an owerview about the available [currencies](http://api.fixer.io/latest).
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
platform: fixer
name: EUR
base: EUR
target: CHF
```
Configuration variables:
- **name** (*Optional*): Name to use in the frontend.
- **base** (*Optional*): The symbol of the base currency. Default to USD
- **target** (*Required*): The symbol of the target currency.

View File

@ -0,0 +1,19 @@
---
layout: page
title: "Homematic Sensor"
description: "Instructions how to integrate Homematic sensors within Home Assistant."
date: 2016-06-28 08:30
sidebar: true
comments: false
sharing: true
footer: true
logo: homematic.png
ha_category: Sensor
ha_release: 0.23
ha_iot_class: "Local Push"
---
The `homematic` sensor platform lets you observe the state of [Homematic](http://www.homematic.com/) sensors through Home Assistant.
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.

View File

@ -16,6 +16,12 @@ The `onewire` platform supports sensors which are using the One wire (1-wire) bu
Supported devices:
- [DS18B20](https://datasheets.maximintegrated.com/en/ds/DS18B20.pdf)
- DS18S20
- DS1822
- DS1825
- DS28EA00 temperature sensors
There is also support for bus masters which use fuse to mount device tree.
To enable One wire sensors in your installation, add the following to your `configuration.yaml` file:

View File

@ -0,0 +1,37 @@
---
layout: page
title: "Open Exchange Rates"
description: "Instructions on how to integrate exchange rates from https://openexchangerates.org within Home Assistant."
date: 2016-06-23 10:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
logo: openexchangerates.png
ha_iot_class: "Local Polling"
ha_release: 0.23
---
The `openexchangerates` sensor will show you the current exchange rate from [Open Exchange Rates](https://openexchangerates.org) that provides realtime exchange rates for [170 currencies](https://openexchangerates.org/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour.
Obtain your API key [here](https://openexchangerates.org/signup)
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
platform: openexchangerates
api_key: your_api_key
base: USD #optional
quote: EUR
name: USDEUR #optional
```
Configuration variables:
- **name** (*Optional*): Name to use in the frontend.
- **base** (*Optional*): The symbol of the base currency. Defaults to USD
- **quote** (*Required*): The symbol of the quote or target currency.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: network-snmp.png
ha_category: Sensor
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_release: "0.22"
---

View File

@ -0,0 +1,48 @@
---
layout: page
title: "Swiss Hydrological Data"
description: "Instructions how to integrate hydrological data of Swiss waters within Home Assistant."
date: 2016-06-17 17:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_release: 0.22
---
The `swiss_hydrological_data` sensor will show you details (temperature, level, and discharge) of rivers and lakes in Switzerland.
The [station overview](http://www.hydrodaten.admin.ch/en/danger-levels-table.html) contains a list of all available measuring points and will help to determine the ID of station which is needed for the configuration.
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
platform: swiss_hydrological_data
name: Aare
station: STATION_ID
```
Configuration variables:
- **name** (*Optional*): Name to use in the frontend.
- **station** (*Required*): The ID of the measurement point.
The hydrological measurings are coming from the [Swiss Federal Office for the Environment (Bundesamt für Umwelt - Abt. Hydrologie)](http://www.hydrodaten.admin.ch) and are updated almost in real-time.
This sensor contains additional information which an easily accessed by a [template sensor](/components/sensor.template/).
```yaml
# Example configuration.yaml entry
sensor:
platform: template
sensors:
discharge:
value_template: '{% raw %}{{ states.sensor.aare.attributes.Discharge }}{% endraw %}'
friendly_name: 'Discharge'
```

View File

@ -0,0 +1,19 @@
---
layout: page
title: "Homematic Switch"
description: "Instructions how to integrate Homematic switches within Home Assistant."
date: 2016-06-28 08:30
sidebar: true
comments: false
sharing: true
footer: true
logo: homematic.png
ha_category: Switch
ha_release: 0.23
ha_iot_class: "Local Push"
---
The `homematic` switch platform lets you control [Homematic](http://www.homematic.com/) switches through Home Assistant.
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.

View File

@ -1,37 +0,0 @@
---
layout: page
title: "Homematic Thermostat"
description: "Instructions how to integrate Homematic thermostats within Home Assistant."
date: 2015-11-25 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: homematic.png
ha_category: Thermostat
ha_release: 0.9
---
The `homematic` thermostat platform let you control [Homematic](http://www.homematic.com/) thermostat from Home Assistant. Currently there is support for Homematic (HM-TC-IT-WM-W-EU, HM-CC-RT-DN) thermostats using Homegear or Homematic central (CCU1/CCU2).
To set it up, add the following information to your `configuration.yaml` file:
```yaml
thermostat:
platform: homematic
address: HOMEGEAR/CCU_ADDRESS
devices:
Livingroom 1:
id: DEVICE_SERIAL_NO
Livingroom 2:
id: DEVICE_SERIAL_NO
```
Configuration variables:
- **address** (*Required*: Adress of your Homegear or Homeatic central, eg. http://localhost:2001
- **devices** array (*Required*): List of all your Homeatic devices.
- **name** (*Required*): Name to identify the device.
- **id** (*Required*): The serial number of the device, eg. MEQ0791521

View File

@ -13,7 +13,7 @@ ha_category: Hub
The [Vera](http://getvera.com) hub is a controller mainly connecting to Z-Wave devices.
Switches, Lights (inc Dimmers), Sensors and Binary sensors are supported - and will be automaticaly added when HA connects to your Vera controller.
Switches, Lights (inc Dimmers), Locks, Sensors and Binary sensors are supported - and will be automaticaly added when HA connects to your Vera controller.
To use Vera devices in your installation, add the following to your configuration.yaml file using the IP and port number of your Vera controller:

View File

@ -0,0 +1,96 @@
---
layout: post
title: "0.23: Envisalink, Homematic, HDMI-CEC and CherryPi"
description: "This new release of Home Assistant contains support for Envisalink, Homematic and HDMI-CEC. Additionaly was the Wink support improved and CherryPi is the new WSGI server."
date: 2016-07-01 00:31:00 +0000
date_formatted: "July 1, 2016"
author: Paulus Schoutsen
author_twitter: balloob
comments: true
categories: Release-Notes
---
It's time for Home Assistant 0.23 and it's full of goodies. It's also the release that bumps us over a 1000 tests and to 94% test coverage! Also our install issues on the Raspberry Pi and Synology have been resolved.
This release brings support for two new ecosystems: [Envisalink] and [Homematic]. We can now also control your TV via HDMI using [HDMI-CEC] (which works on the Pi!) and another cool feature is the [persistent notifications] which allow you to add a notification to the frontend till dismissed.
[Wink] support has been dramatically improved by migrating to the PubNub API. This allows Wink to push changes from their system to Home Assistant. This change came just in time as somehow our Wink integration was causing a lot of requests to their servers. Thanks to Wink for letting us know so we could solve it instead of blocking us.
On the config side, you can now [store your passwords][secrets] in your OS keyring or just in a standalone file. We also got a new service to reload the core config so no reboots needed anymore after changing customize settings!
<img src='/images/supported_brands/bravia.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='150' /><img src='/images/supported_brands/eyezon.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='150' /><img src='/images/supported_brands/homematic.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='150' /><img src='/images/supported_brands/fixer-io.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='150' /><img src='/images/supported_brands/openexchangerates.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='150' />
- Support for [Envisalink] added ([alarm control panel][envi-alarm], [binary sensor][envi-binary-sensor], [sensor][envi-sensor]) ([@cinntax])
- Support for [Homematic] added ([binary sensor][hm-binary-sensor], [light][hm-light], [rollershutter][hm-rollershutter], [sensor][hm-sensor], [switch][hm-switch]) ([@pvizeli], [@danielperna84])
- New [HDMI-CEC] component ([@happyleavesaoc], [@lukas-hetzenecker])
- Major rewrite of [Wink] which now pushes changes to Home Assistant ([@w1ll1am23])
- Core: new add [reload core config service] ([@balloob])
- Support for [persistent notifications] added ([@fabaff], [@balloob])
- Garage door: [Z-Wave][zwave-garage-door] support added ([@turbokongen])
- Rollershutter: [Z-Wave][zwave-rollershutter] support added ([@turbokongen])
- Media Player: [Sony Bravia TV] now supported ([@aparraga])
- Sensor: [Fixer.io] now supported ([@fabaff])
- Garage door: Control any garage door using [Raspberry Pi GPIO pins] ([@kellerza])
- Sensor: [OpenExchangeRates] support added ([@arsaboo])
- Notify: [Pushover] now supports target device, sound, url and priority ([@dale3h])
- Sensor: [Netatmo] now supports wind, battery and radio signals ([@Jypy])
- Log successful and failed login attemps ([@fabaff])
- Config: allow [extracting account info][secrets] into OS keyring or separate YAML file ([@kellerza])
- Core: add option to not filter out duplicate states per entity ([@philipbl])
- HTTP: Follow Mozilla SSL recommendations ([@danieljkemp], [@AlucardZero])
- Light: [Z-Wave colorbulb][zwave-light] support added ([@armills])
- Core: new elevation config option added ([@balloob])
- Sensor: [OneWire] support extended with support for DS18S20, DS1822, DS1825 and DS28EA00 temperature sensors + support for bus masters which use fuse to mount device tree. ([@Ardetus])
- Lock: [Vera] now supported ([@rhooper])
- HTTP: Migrate to CherryPy WSGI server to fix install and runtime problems ([@balloob])
Breaking changes:
- Homematic thermostat configuration has changed and now depends on the new [Homematic] component.
[@AlucardZero]: https://github.com/AlucardZero/
[@aparraga]: https://github.com/aparraga/
[@Ardetus]: https://github.com/Ardetus/
[@armills]: https://github.com/armills/
[@arsaboo]: https://github.com/arsaboo/
[@balloob]: https://github.com/balloob/
[@cinntax]: https://github.com/cinntax/
[@dale3h]: https://github.com/dale3h/
[@danieljkemp]: https://github.com/danieljkemp/
[@danielperna84]: https://github.com/danielperna84/
[@fabaff]: https://github.com/fabaff/
[@happyleavesaoc]: https://github.com/happyleavesaoc/
[@Jypy]: https://github.com/Jypy/
[@kellerza]: https://github.com/kellerza/
[@lukas-hetzenecker]: https://github.com/lukas-hetzenecker/
[@philipbl]: https://github.com/philipbl/
[@pvizeli]: https://github.com/pvizeli/
[@rhooper]: https://github.com/rhooper/
[@turbokongen]: https://github.com/turbokongen/
[@w1ll1am23]: https://github.com/w1ll1am23/
[envi-alarm]: /components/alarm_control_panel.envisalink/
[envi-binary-sensor]: /components/binary_sensor.envisalink/
[envi-sensor]: /components/sensor.envisalink/
[Envisalink]: /components/envisalink/
[HDMI-CEC]: /components/hdmi_cec/
[hm-binary-sensor]: /components/binary_sensor.homematic/
[hm-light]: /components/light.homematic/
[hm-rollershutter]: /components/rollershutter.homematic/
[hm-sensor]: /components/sensor.homematic/
[hm-switch]: /components/switch.homematic/
[Homematic]: /components/homematic/
[Netatmo]: /components/sensor.netatmo/
[OneWire]: /components/sensor.onewire/
[OpenExchangeRates]: /components/sensor.openexchangerates/
[Pushover]: /components/notify.pushover/
[secrets]: /topics/secrets/
[Vera]: /components/lock.vera/
[Wink]: /components/wink/
[zwave-garage-door]: /components/garage_door.zwave/
[zwave-light]: /components/light.zwave/
[zwave-rollershutter]: /components/rollershutter.zwave/
[Fixer.io]: /components/sensor.fixer/
[persistent notifications]: /components/persistent_notification/
[reload core config service]: /getting-started/customizing-devices/#reloading-customize
[Sony Bravia TV]: /components/media_player.braviatv/
[Raspberry Pi GPIO pins]: /components/garage_door.rpi_gpio/

View File

@ -0,0 +1,96 @@
---
layout: post
title: "0.23: TBD (rename file too)."
description: ""
date: 2016-07-01 00:31:00 +0000
date_formatted: "July 1, 2016"
author: Paulus Schoutsen
author_twitter: balloob
comments: true
categories: Release-Notes
---
It's time for Home Assistant 0.23 and it's full of goodies. It's also the release that bumps us over a 1000 tests and to 94% test coverage! Also our install issues on the Raspberry Pi and Synology have been resolved.
This release brings support for two new ecosystems: [Envisalink] and [Homematic]. We can now also control your TV via HDMI using [HDMI-CEC] (which works on the Pi!) and another cool feature is the [persistent notifications] which allow you to add a notification to the frontend till dismissed.
[Wink] support has been dramatically improved by migrating to the PubNub API. This allows Wink to push changes from their system to Home Assistant. This change came just in time as somehow our Wink integration was causing a lot of requests to their servers. Thanks to Wink for letting us know so we could solve it instead of blocking us.
On the config side, you can now [store your passwords][secrets] in your OS keyring or just in a standalone file. We also got a new service to reload the core config so no reboots needed anymore after changing customize settings!
<img src='/images/supported_brands/bravia.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='150' /><img src='/images/supported_brands/eyezon.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='150' /><img src='/images/supported_brands/homematic.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='150' /><img src='/images/supported_brands/fixer-io.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='150' /><img src='/images/supported_brands/openexchangerates.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='150' />
- Support for [Envisalink] added ([alarm control panel][envi-alarm], [binary sensor][envi-binary-sensor], [sensor][envi-sensor]) ([@cinntax])
- Support for [Homematic] added ([binary sensor][hm-binary-sensor], [light][hm-light], [rollershutter][hm-rollershutter], [sensor][hm-sensor], [switch][hm-switch]) ([@pvizeli], [@danielperna84])
- New [HDMI-CEC] component ([@happyleavesaoc], [@lukas-hetzenecker])
- Major rewrite of [Wink] which now pushes changes to Home Assistant ([@w1ll1am23])
- Core: new add [reload core config service] ([@balloob])
- Support for [persistent notifications] added ([@fabaff], [@balloob])
- Garage door: [Z-Wave][zwave-garage-door] support added ([@turbokongen])
- Rollershutter: [Z-Wave][zwave-rollershutter] support added ([@turbokongen])
- Media Player: [Sony Bravia TV] now supported ([@aparraga])
- Sensor: [Fixer.io] now supported ([@fabaff])
- Garage door: Control any garage door using [Raspberry Pi GPIO pins] ([@kellerza])
- Sensor: [OpenExchangeRates] support added ([@arsaboo])
- Notify: [Pushover] now supports target device, sound, url and priority ([@dale3h])
- Sensor: [Netatmo] now supports wind, battery and radio signals ([@Jypy])
- Log successful and failed login attemps ([@fabaff])
- Config: allow [extracting account info][secrets] into OS keyring or separate YAML file ([@kellerza])
- Core: add option to not filter out duplicate states per entity ([@philipbl])
- HTTP: Follow Mozilla SSL recommendations ([@danieljkemp], [@AlucardZero])
- Light: [Z-Wave colorbulb][zwave-light] support added ([@armills])
- Core: new elevation config option added ([@balloob])
- Sensor: [OneWire] support extended with support for DS18S20, DS1822, DS1825 and DS28EA00 temperature sensors + support for bus masters which use fuse to mount device tree. ([@Ardetus])
- Lock: [Vera] now supported ([@rhooper])
- HTTP: Migrate to CherryPy WSGI server to fix install and runtime problems ([@balloob])
Breaking changes:
- Homematic thermostat configuration has changed and now depends on the new [Homematic] component.
[@AlucardZero]: https://github.com/AlucardZero/
[@aparraga]: https://github.com/aparraga/
[@Ardetus]: https://github.com/Ardetus/
[@armills]: https://github.com/armills/
[@arsaboo]: https://github.com/arsaboo/
[@balloob]: https://github.com/balloob/
[@cinntax]: https://github.com/cinntax/
[@dale3h]: https://github.com/dale3h/
[@danieljkemp]: https://github.com/danieljkemp/
[@danielperna84]: https://github.com/danielperna84/
[@fabaff]: https://github.com/fabaff/
[@happyleavesaoc]: https://github.com/happyleavesaoc/
[@Jypy]: https://github.com/Jypy/
[@kellerza]: https://github.com/kellerza/
[@lukas-hetzenecker]: https://github.com/lukas-hetzenecker/
[@philipbl]: https://github.com/philipbl/
[@pvizeli]: https://github.com/pvizeli/
[@rhooper]: https://github.com/rhooper/
[@turbokongen]: https://github.com/turbokongen/
[@w1ll1am23]: https://github.com/w1ll1am23/
[envi-alarm]: /components/alarm_control_panel.envisalink/
[envi-binary-sensor]: /components/binary_sensor.envisalink/
[envi-sensor]: /components/sensor.envisalink/
[Envisalink]: /components/envisalink/
[HDMI-CEC]: /components/hdmi_cec/
[hm-binary-sensor]: /components/binary_sensor.homematic/
[hm-light]: /components/light.homematic/
[hm-rollershutter]: /components/rollershutter.homematic/
[hm-sensor]: /components/sensor.homematic/
[hm-switch]: /components/switch.homematic/
[Homematic]: /components/homematic/
[Netatmo]: /components/sensor.netatmo/
[OneWire]: /components/sensor.onewire/
[OpenExchangeRates]: /components/sensor.openexchangerates/
[Pushover]: /components/notify.pushover/
[secrets]: /topics/secrets/
[Vera]: /components/lock.vera/
[Wink]: /components/wink/
[zwave-garage-door]: /components/garage_door.zwave/
[zwave-light]: /components/light.zwave/
[zwave-rollershutter]: /components/rollershutter.zwave/
[Fixer.io]: /components/sensor.fixer/
[persistent notifications]: /components/persistent_notification/
[reload core config service]: /getting-started/customizing-devices/#reloading-customize
[Sony Bravia TV]: /components/media_player.braviatv/
[Raspberry Pi GPIO pins]: /components/garage_door.rpi_gpio/

View File

@ -0,0 +1,87 @@
---
layout: page
title: "Storing secrets"
description: "Storing secrets outside of your configuration.yaml."
date: 2016-07-01 08:30
sidebar: false
comments: false
sharing: true
footer: true
---
The `configuration.yaml` file a plain-text file thus it is readable for everyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. This separation can also help you to keep easier track of your passwords and API keys (as they are all stored at one place and no longer spread across the `configuration.yaml` file) if you don't want to [split up your configuration](topics/splitting_configuration/).
### {% linkable_title Using secrets.yaml %}
The workflow for the outsourcing in the `secrets.yaml` are very similar to the [splitting of the configuration](topics/splitting_configuration/). Create a `secrets.yaml` file in your Home assistant configuration directory (The location of the folder differs between operating systems: on OS X and Linux it's `~/.homeassistant` and on Windows it's `%APPDATA%/.homeassistant`).
The entries for password and API keys in the `configuration.yaml` file usally looks like the example below.
```yaml
http:
api_password: YOUR_PASSWORD
```
Those entries need to be replaced with `!secret` and a identifier.
```yaml
http:
api_password: !secret http_password
```
The `secrets.yaml` files stored the corresponding password assigned to the identifier.
```yaml
debug: 0
http_password: YOUR_PASSWORD
```
### {% linkable_title Python Keyring %}
Using [Keyring](http://pythonhosted.org/keyring/) is an alternative way to `secrets.yaml` but requires that `keyring` is installed (incl. its command-line tools). This can be done with:
```bash
$ pip3 install keyring
```
Replaced your password or API key with `!secret` and an identifier in `configuration.yaml` file.
```yaml
http:
api_password: !secret http_password
```
Create an entry in your keyring. The service (SERVICE) is `homeassistant` and the identifier is the USERNAME in the keyring context.
```bash
$ keyring set homeassistant http_password
Password for 'http_password' in 'homeassistant':
Please set a password for your new keyring:
Please confirm the password:
```
If the command-line tool `keyring` is not available, launch `python3` and do the process manually.
```python
>>> import keyring
>>> keyring.set_password("homeassistant", "http_password", "12345")
Please set a password for your new keyring:
Please confirm the password:
>>> keyring.get_password("homeassistant", "http_password")
'12345'
>>> keyring.get_keyring()
<EncryptedKeyring at /home/your_user/.local/share/python_keyring/crypted_pass.cfg>
```
If you launch home Assistant now, you will be prompted for the keyring password to unlock your keyring.
```bash
$ hass
Config directory: /home/fab/.homeassistant
Please enter password for encrypted keyring:
```
<p class='note warning'>
With this configuration [autostart](/getting-started/autostart/) will no longer work.
</p>

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
---
By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by adding the following configuration inside the `homeassistant:` section.
Devices that you don't want to have visible can be hidden with `hidden`.
@ -42,4 +42,12 @@ homeassistant:
assumed_state: false
```
### {% linkable_title Reloading customize %}
Home Assistant offers a service to reload the core configuration while Home Assistant is running called `homeassistant/reload_core_config`. This allows you to change your customize section and see it being applied without having to restart Home Assistant. To call this service, go to the <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> service developer tools, select the service `homeassistant/reload_core_config` and click "Call Service".
<p class='note warning'>
New customize information will be applied the next time the state of the entity gets updated.
</p>
### [Next step: Setting up presence detection &raquo;](/getting-started/presence-detection/)

View File

@ -16,7 +16,6 @@ See the [components overview page](/components/) to find installation instructio
Usually every entity needs its own entry in the `configuration.yaml` file. There are two styles for multiple entries:
#### {% linkable_title Style 1: Collect every entity under the "parent" %}
```yaml
sensor:

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.6 KiB

View File

@ -15,11 +15,11 @@ 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 Version: 0.22.1</h1>
Released: <span class='release-date'>June 20, 2016</span>
<h1>Current Version: 0.23</h1>
Released: <span class='release-date'>July 1, 2016</span>
<div class='links'>
<a href='/blog/2016/06/18/pandora-bt-home-hub-5-and-local-file-camera/'>Release notes</a>
<a href='/blog/2016/07/01/envisalink-homematic-hdmi-cec-and-cherrypi/'>Release notes</a>
</div>
</div>
<div class='join-community material-card text'>