Merge branch 'next'

Conflicts:
	source/_components/binary_sensor.template.markdown
This commit is contained in:
Paulus Schoutsen 2016-06-07 19:31:21 -07:00
commit 0cc0369faa
18 changed files with 325 additions and 21 deletions

View File

@ -6,12 +6,6 @@ This is the source for the [Home-Assistant.io website](https://home-assistant.io
Setting up to contribute to documentation and the process for submitting pull requests is [explained here](https://home-assistant.io/developers/website/).
## Create a new blog post
```bash
$ rake new_post["title"]
```
## Site preview
```bash

View File

@ -0,0 +1,29 @@
---
layout: page
title: "EnOcean Binary Sensor"
description: "Instructions on how to set up EnOcean binary sensors within Home Assistant."
date: 2016-05-25 23:49
sidebar: true
comments: false
sharing: true
footer: true
logo: enocean.png
ha_category: Binary Sensor
---
This can typically be one of those batteryless wall switches. Currently only one type has been tested: Eltako FT55. Other devices will most likely not work without changing the Home-Asisstant code.
To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: enocean
id: [0x01,0x90,0x84,0x3C]
```
Configuration variables:
- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer.
- **platform** (*Required*): Set to `enocean`.

View File

@ -30,6 +30,7 @@ Configuration variables:
- **friendly_name** (*Optional*): Name to use in the Frontend.
- **sensor_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
- **warnings** (*Optional*): Turn off warnings (useful if the sensor is loaded before devices it depends on).
## {% linkable_title Examples %}

View File

@ -0,0 +1,42 @@
---
layout: page
title: "EnOcean"
description: "Connect EnOcean devices to home-assistant"
date: 2016-05-25 23:39
sidebar: true
comments: false
sharing: true
footer: true
logo: enocean.png
ha_category: Hub
---
The [EnOcean](https://en.wikipedia.org/wiki/EnOcean) standard is supported by many different vendors. There are switches and sensors of many different kinds, and typically they employ energy harvesting to get power such that no batteries are unnecessary.
The `enocean` component adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/en/enocean_modules/usb-300-oem/) in order for it to work.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](../binary_sensor.enocean) (wall switches)
- [Sensor](../sensor.enocean) (power meters)
- [Light](../light.enocean) (dimmers)
- [Switch](../switch.enocean)
However, only a few devices have been confirmed to work. These are:
- Eltako FUD61 dimmer
- Eltako FT55 battery-less wall switch
- Permundo PSC234 (switch and power monitor)
Other devices will most likely need some changes in the Home-Assistant code in order to work. Support for teaching of devices is also missing at this time.
# Configuration
```yaml
# Example configuration.yaml entry
enocean:
device: /dev/ttyUSB0
```
If no device is specified, the default will be **/dev/ttyUSB0**

View File

@ -0,0 +1,33 @@
---
layout: page
title: "EnOcean Light"
description: "Instructions on how to set up EnOcean lights within Home Assistant."
date: 2016-05-25 23:49
sidebar: true
comments: false
sharing: true
footer: true
logo: enocean.png
ha_category: Light
---
An EnOcean light can take many formes. Currently only one type has been tested: Eltako FUD61 dimmer.
To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
- name: Living_room
platform: enocean
id: [0x01,0x90,0x84,0x3C]
sender_id: [0xFF,0xC6,0xEA,0x04]
```
Configuration variables:
- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer.
- **sender_id** (*Required*): The Sender ID of the device. This is a 4 bytes long number.
- **platform** (*Required*): Set to `enocean`.
- **name** (*Required*): An identifier for the switch

View File

@ -0,0 +1,25 @@
---
layout: page
title: "Osram Lightify"
description: "Instructions how to integrate Osram Lightify into Home Assistant."
date: 2016-05-29 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: osramlightify.png
ha_category: Light
---
The `osramlightify` platform allows you to integrate your [Osram Lightify](http://www.osram.com/osram_com/products/led-technology/lightify/index.jsp) into Home Assistant.
```yaml
# Example configuration.yaml entry
light:
platform: osramlightify
host: 192.168.0.50
```
Configuration variables:
- **host** (*Required*): IP address of the Osram Lightify bridge, eg. `192.168.1.50`

View File

@ -16,7 +16,4 @@ ha_release: "0.20"
The `qwikswitch` light platform allows you to control your [QwikSwitch](http://www.qwikswitch.co.za/) relays and dimmers as lights from within Home Assistant.
They will be automatically discovered if the discovery component is enabled.
For more configuration information see the [QwikSwitch component](/components/qwikswitch/) documentation.
The platform is configured through the [QwikSwitch component](/components/qwikswitch/).

View File

@ -16,7 +16,7 @@ ha_release: "0.20"
The `qwikswitch` component is the main component to integrate various [QwikSwitch](http://www.qwikswitch.co.za/) devices with Home Assistant.
Loading the `qwikswitch` component will automatically adds all devices from the QS Mobile application. QS Mobile controls the QSUSB Modem device.
Loading the `qwikswitch` component automatically adds all devices from the QS Mobile application. QS Mobile controls the QSUSB Modem device.
Currently QwikSwitch relays and LED dimmers are supported (tested). QwikSwitch relay devices can be [switches](/components/switch.qwikswitch/) or [lights](/components/light.qwikswitch/) in Home-Assistant. If the device name in the QSUSB app ends with ` Switch` it will be created as a switch, otherwise as a light.
@ -31,6 +31,8 @@ qwikswitch:
Configuration variables:
- **url** (*Required*): The URL including the port of your QwikSwitch hub.
- **dimmer_adjust** (*Optional*): A decimal value to adjust the brightness of the dimmer exponentially. Increasing this value allows dimmers that reaches full brightness with low values in QS Mobile to appear more linear in Home Assistant. Recommended values between 1 and 2 and the default is 1.
- **button_events** (*Optional*): A comma separated list of button types that will generate events. Details below.
### {% linkable_title QwikSwitch Buttons %}
@ -44,11 +46,13 @@ automation:
event_type: qwikswitch.button.@12df34
```
`event_type` names should be in the format **qwikswitch.button.@__ID__**. where **@__ID__** will be captured in the Home Assistant log when pressing the button. Alternatively, you can also access the listen API call by going to 'http://127.0.0.1:2020/&listen' and then pressing the button.
`event_type` names should be in the format **qwikswitch.button.@__ID__**. where **@__ID__** will be captured in the Home Assistant log when pressing the button. Alternatively, you can also get the device ID from the QS Mobile application or using the listen API call by browsing to `http://127.0.0.1:2020/&listen` and then pressing the button.
Currently Event will be created for the following commands (cmd) value in the Listen packet:
By default events will be fired if the value in the command (cmd) field of the listen packet equals:
- `TOGGLE` - Normal QwikSwitch Transmitter button
- `SCENE EXE` - QwikSwitch Scene Transmitter buttons
- `LEVEL` - QwikSwitch OFF Transmitter buttons
Technically this could work for Keyfobs, door sensors, and PIR transmitters as well.
The list of recognized commands can be extended for Keyfobs, door sensors, and PIR transmitters with the **button_events** configuration option. **button_events** contain a comma separated list of commands that will fire Home Assistant events. By default it is: TOGGLE,SCENE EXE,LEVEL.
On some QS Mobile servers button events are only generated for switches added to the QS Mobile application, so it might be best to test button presses through the `/&listen` API

View File

@ -0,0 +1,59 @@
---
layout: page
title: "RFXtrx Rollershutter"
description: "Instructions how to integrate RFXtrx roller shutters into Home Assistant."
date: 2016-06-02 14:20
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Rollershutter
ha_release: 0.21
---
The `rfxtrx` platform support Siemens/LightwaveRF roller shutters that communicate in the frequency range of 433.92 MHz.
First you have to set up your [rfxtrx hub.](/components/rfxtrx/)
The easiest way to find your roller shutters is to add this to your `configuration.yaml`:
```yaml
rollershutter:
platform: rfxtrx
automatic_add: True
```
Launch your homeassistant and go the website.
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.
Then you should update your configuration to:
```yaml
rollershutter:
platform: rfxtrx
devices:
0b11000102ef9f210010f70:
name: device_name
```
Example configuration:
```yaml
# Example configuration.yaml entry
rollershutter:
platform: rfxtrx
automatic_add: False
signal_repetitions: 2
devices:
0b1100ce3213c7f210010f70:
name: Bedroom Shutter
0b11000a02ef2gf210010f50:
name: Bathroom Shutter
0b1111e003af16aa10000060:
name: Lounge Shutter
```
Configuration variables:
- **devices** (*Required*): A list of devices with their name to use in the frontend.
- **automatic_add** (*Optional*): To enable the automatic addition of new roller shutters.
- **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.

View File

@ -0,0 +1,32 @@
---
layout: page
title: "EnOcean Sensor"
description: "Instructions how to integrate TellStick sensors into Home Assistant."
date: 2016-05-26 01:00
sidebar: true
comments: false
sharing: true
footer: true
logo: enocean.png
ha_category: Sensor
---
The `enocean` sensor platform currently only allows reading out the power measured in a Permundo PSC234 switch.
To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- name: Television
platform: enocean
id: [0x01,0x90,0x84,0x3C]
```
Configuration variables:
- **id** (*Required*): The ID of the device. This is a 4 bytes long number.
- **platform** (*Required*): Set to `enocean`.
- **name** (*Required*): An identifier for the switch

View File

@ -34,6 +34,7 @@ Configuration variables:
- **friendly_name** (*Optional*): Name to use in the Frontend.
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
- **warnings** (*Optional*): Turn off warnings (useful if the sensor is loaded before devices it depends on).
## {% linkable_title Examples %}
@ -54,9 +55,9 @@ sensor:
unit_of_measurement: '°'
```
### {% linkable_title Multi line example with an if test %}
### {% linkable_title Multi line example with an if test (and warnings disabled)%}
This example shows a multiple line template with and is test. It looks at a sensing switch and shows on/off in the frontend.
This example shows a multiple line template with and if test. It looks at a sensing switch and shows on/off in the frontend. It disables warnings to avoid log messages where the switch it depends on isn't loaded yet.
```yaml
sensor:
@ -75,6 +76,7 @@ sensor:
failed
{%- endif %}{% endraw %}
warnings: Off
```
(please note the blank line to close the multi-line template)

View File

@ -35,7 +35,7 @@ Configuration variables:
### {% linkable_title Implementation Details %}
The suns event listener will call the service when the sun rises or sets with an offset.
The sun's event listener will call the service when the sun rises or sets with an offset.
The sun event need to have the type 'sun', which service to call, which event (sunset or sunrise) and the offset.
@ -62,3 +62,4 @@ The sun event need to have the type 'sun', which service to call, which event (s
| `next_rising` | Date and time of the next sun rising (in UTC).
| `next_setting` | Date and time of the next sun setting (in UTC).
| `elevation` | Solar elevation. This is the angle between the sun and the horizon. Negative values mean the sun is below the horizon.
| `azimuth` | Solar azimuth. The angle is shown clockwise from north.

View File

@ -0,0 +1,31 @@
---
layout: page
title: "EnOcean Switch"
description: "Instructions on how to set up EnOcean switches within Home Assistant."
date: 2016-05-25 23:49
sidebar: true
comments: false
sharing: true
footer: true
logo: enocean.png
ha_category: Switch
---
An EnOcean switch can take many forms. Currently only one type has been tested: Permundo PSC234
To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- name: Television
platform: enocean
id: [0x01,0x90,0x84,0x3C]
```
Configuration variables:
- **id** (*Required*): The ID of the device. This is a 4 bytes long number.
- **platform** (*Required*): Set to `enocean`.
- **name** (*Required*): An identifier for the switch

View File

@ -0,0 +1,47 @@
---
layout: page
title: "Flux Switch"
description: "Instructions how to have switches call command line commands."
date: 2016-06-01 17:41
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Switch
ha_release: 0.21
---
The Flux switch platform will change the temperature of your lights similar to
the way flux works on your computer, using circadian rhythm. They will be bright
during the day, and gradually fade to a red/orange at night.
The component will update your lights based on the the time of day. It will only
affect lights that are turned on and listed in the flux configuration.
During the day (in between `start time` and `sunset time`), it will fade the lights from
the `start_colortemp` to the `sunset_colortemp`. After sunset (between `sunset_time`
and `stop_time`), the lights will fade from the the `sunset_colortemp` to the
`stop_colortemp`. If the lights are still on after the `stop_time` it will continue
to change the light to the `stop_colortemp` until the light is turned off. The fade
effect is created by updating the lights every 30 seconds with a 30 second transition time.
If you don't wish to have flux update on 30 second intervals, you can leave the
switch turned off and use automation rules that call the service `switch.flux_update`
whenever you want the lights updated.
Example `configuration.yaml`:
```yaml
switch:
platform: flux
lights:
- light.desk
- light.lamp
name: Fluxer # optional, default Flux
start_time: 7:00 # optional, default sunrise
stop_time: 23:00 # optional, default 22:00
start_colortemp: 4000 # optional, default 4000
sunset_colortemp: 3000 # optional, default 3000
stop_colortemp: 1900 # optional, default 1900
brightness: 200 # optional, default calculated by RGB_to_xy
```

View File

@ -16,8 +16,6 @@ ha_release: "0.20"
The `qwikswitch` platform allows you to control your [QwikSwitch](http://www.qwikswitch.co.za/) relays as switches from within Home Assistant.
If the device name in the QSUSB app ends with `Switch` it will be created as a switch, otherwise as a [light](/components/light.qwikswitch/).
If the device name in the QS Mobile application ends with `Switch` it will be created as a switch, otherwise as a [light](/components/light.qwikswitch/).
They will be automatically discovered from the QSUSB API if the discovery component is enabled.
For more configuration information see the [QwikSwitch component](/components/qwikswitch/) documentation.
The platform is configured through the [QwikSwitch component](/components/qwikswitch/).

View File

@ -23,10 +23,12 @@ This page contains a list of people who have contributed in one way or another t
- [Alex Harvey](https://github.com/infamy)
- [Alexander Fortin](https://github.com/shaftoe)
- [Allan Glen](https://github.com/allanglen)
- [amorsillo](https://github.com/fignuts)
- [Andrew](https://github.com/aoakeson)
- [Andrew LeCody](https://github.com/aceat64)
- [Andy Loughran](https://github.com/andylockran)
- [andythigpen](https://github.com/andythigpen)
- [Ardi Mehist](https://github.com/omgapuppy)
- [Arthur Leonard Andersen](https://github.com/leoc)
- [Austin](https://github.com/trainman419)
- [Azelphur](https://github.com/Azelphur)
@ -54,6 +56,7 @@ This page contains a list of people who have contributed in one way or another t
- [Eric Rolf](https://github.com/xrolfex)
- [ettisan](https://github.com/ettisan)
- [Fabian Affolter](https://github.com/fabaff)
- [Felix](https://github.com/xifle)
- [Finbarr Brady](https://github.com/fbradyirl)
- [Flavio Castelli](https://github.com/flavio)
- [Florian Holzapfel](https://github.com/florianholzapfel)
@ -113,6 +116,7 @@ This page contains a list of people who have contributed in one way or another t
- [Moon Shot](https://github.com/moonshot)
- [Nick Touran](https://github.com/partofthething)
- [Nick Waring](https://github.com/nickwaring)
- [Nils Uliczka](https://github.com/darookee)
- [Nolan Gilley](https://github.com/nkgilley)
- [Oliver van Porten](https://github.com/mcdeck)
- [Øystein Hansen](https://github.com/oeysteinhansen)
@ -123,9 +127,12 @@ This page contains a list of people who have contributed in one way or another t
- [Rev Michael Greb](https://github.com/mikegrb)
- [rhooper](https://github.com/rhooper)
- [Richard Arends](https://github.com/Mosibi)
- [Richard Cox](https://github.com/khabi)
- [rkabadi](https://github.com/rkabadi)
- [Robbie Trencheny](https://github.com/robbiet480)
- [Rob Olimpiu](https://github.com/olimpiurob)
- [Rowan Hine](https://github.com/GreenTurtwig)
- [rubund](https://github.com/rubund)
- [Ryan Kraus](https://github.com/rmkraus)
- [Ryan Turner](https://github.com/ryanturner)
- [sander76](https://github.com/sander76)
@ -143,8 +150,10 @@ This page contains a list of people who have contributed in one way or another t
- [Tom Duijf](https://github.com/tomduijf)
- [trollkarlen](https://github.com/trollkarlen)
- [vitorespindola](https://github.com/vitorespindola)
- [Warren Konkel](https://github.com/wkonkel)
- [William Scanlon](https://github.com/w1ll1am23)
- [wind-rider](https://github.com/wind-rider)
- [wokar](https://github.com/wokar)
- [Zac Mrowicki](https://github.com/zmrow)
This page is irregularly updated. As a base we use the Github [contributors overview](https://github.com/home-assistant/home-assistant/graphs/contributors) of the Home Assistant git repository and the [overview](https://github.com/home-assistant/home-assistant.io/graphs/contributors) for [home-assistant.io](https://home-assistant.io). If you think that you are missing, please let us know or add yourself.

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB