Merge branch 'master' into next

Conflicts:
	source/_components/binary_sensor.command_line.markdown
	source/_components/binary_sensor.mysensors.markdown
	source/_posts/2016-02-28-steam-d-link-smart-plugs-and-neurio-energy-sensors.markdown
	source/developers/credits.markdown
This commit is contained in:
Paulus Schoutsen 2016-03-12 09:50:18 -08:00
commit 6187938e63
40 changed files with 3724 additions and 3248 deletions

View file

@ -15,7 +15,7 @@ The `mqtt` alarm panel platform enables the possibility to control MQTT capable
The component will accept the following states from your Alarm Panel (in lower case):
- 'armed'
- 'disarmed'
- 'armed_home'
- 'armed_away'
- 'pending'

View file

@ -193,7 +193,7 @@ automation 3:
#### {% linkable_title Zone trigger %}
Zone triggers can trigger when an entity is entering or leaving the zone. For zone automation to work, you need to have setup a device tracker platform that supports reporting GPS coordinates. Currently this is limited to the [OwnTracks platform](/components/device_tracker.owntracks/).
Zone triggers can trigger when an entity is entering or leaving the zone. For zone automation to work, you need to have setup a device tracker platform that supports reporting GPS coordinates. Currently this is limited to the [OwnTracks platform](/components/device_tracker.owntracks/) as well as the [iCloud platform](/components/device_tracker.icloud/).
```yaml
automation:
@ -310,7 +310,7 @@ Valid values for `weekday` are (`sun`, `mon`, `tue`, `wed`, `thu`, `fri` & `sat`
#### {% linkable_title Zone condition %}
Zone conditions test if an entity is in a certain zone. For zone automation to work, you need to have setup a device tracker platform that supports reporting GPS coordinates. Currently this is limited to the [OwnTracks platform](/components/device_tracker.owntracks/).
Zone conditions test if an entity is in a certain zone. For zone automation to work, you need to have setup a device tracker platform that supports reporting GPS coordinates. Currently this is limited to the [OwnTracks platform](/components/device_tracker.owntracks/) as well as the [iCloud platform](/components/device_tracker.icloud/).
```yaml
automation:
@ -363,4 +363,4 @@ The Logbook component will show a line entry when an automation is triggered. Y
![Logbook example](/images/components/automation/logbook.png)
[template]: /getting-started/templating/
[template]: /getting-started/templating/

View file

@ -37,7 +37,6 @@ Accessing the URL http://IP_ADDRESS/digital/PIN_NUMBER should give you the state
```bash
$ curl -X GET http://10.100.0.157/digital/9
{"return_value": 0, "id": "office1", "name": "Office", "connected": true}
```
<p class='note'>

View file

@ -11,7 +11,7 @@ logo: bloomsky.png
ha_category: Binary Sensor
---
The `bloomsky` binary sensor platform allows you to get data from your BoomSky device.
The `bloomsky` binary sensor platform allows you to get data from your BloomSky device.
To get your BloomSky binary sensors working with Home Assistant, follow the instructions for the [BloomSky component](/components/bloomsky/) first.

View file

@ -60,9 +60,19 @@ Check if [RasPlex](http://www.rasplex.com/) is `online`.
```yaml
binary_sensor:
platform: command_line
command: 'ping rasplex.local -c 1 | grep "1 received" | wc -l'
command: 'ping -c 1 rasplex.local | grep "1 received" | wc -l'
name: 'is_rasplex_online'
payload_on: 1
payload_off: 0
```
An alternative solution could look like this:
```yaml
binary_sensor:
platform: command_line
name: Printer
command: ping -c 1 192.168.1.10 &> /dev/null && echo success || echo fail
payload_on: "success"
payload_off: "fail"
```

View file

@ -13,4 +13,21 @@ Binary sensors are gathering information about state of switches, contacts, pins
Knowing that there are only two states allows Home Assistant to represent the sensor better in the frontend.
Most binary sensors support the `SENSOR_CLASSES` which let you specify the type of your sensor. The following types are supported:
- **None**: Generic on/off
- **opening**: Door, window, etc
- **motion**: Motion sensor
- **gas'**: CO, CO2, etc
- **smoke'**: Smoke detector
- **moisture**: Specifically a wetness sensor
- **light**: Lightness threshold
- **power**: Power, over-current, etc
- **safety**: Generic on=unsafe, off=safe
- **heat**: On means hot (or too hot)
- **cold**: On means cold (or too cold)
- **moving**: On means moving, Off means stopped
- **sound**: On means sound detected, Off means no sound
- **vibration**: On means vibration detected, Off means no vibration
For analog sensors please check the [component overview](https://home-assistant.io/components/#sensor).

View file

@ -2,7 +2,11 @@
layout: page
title: "MySensors Binary Sensor"
description: "Instructions how to integrate MySensors binary sensors into Home Assistant."
<<<<<<< HEAD
date: 2016-02-27 20:13 +0100
=======
date: 2016-02-28 01:20 +0100
>>>>>>> master
sidebar: true
comments: false
sharing: true
@ -30,9 +34,9 @@ S_TYPE | V_TYPE
---------------|----------------------------------
S_SPRINKLER | V_TRIPPED
S_WATER_LEAK | V_TRIPPED
S_SOUND | V_TRIPPED, V_LEVEL
S_VIBRATION | V_TRIPPED, V_LEVEL
S_MOISTURE | V_TRIPPED, V_LEVEL
S_SOUND | V_TRIPPED
S_VIBRATION | V_TRIPPED
S_MOISTURE | V_TRIPPED
For more information, visit the [serial api] of MySensors.

View file

@ -33,3 +33,6 @@ Configuration variables:
- **http_id** (*Required*): The value can be obtained by logging in to the Tomato admin interface and search for `http_id` in the page source code.
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
A description of the API s available in this [Tomato API](http://paulusschoutsen.nl/blog/2013/10/tomato-api-documentation/) blog post.

View file

@ -14,21 +14,14 @@ ha_iot_class: "Assumed State"
`limitlessled` can control your [LimitlessLED](http://www.limitlessled.com/) lights from within Home Assistant. The lights are also known as EasyBulb, AppLight, AppLamp, MiLight, LEDme, dekolight or iLight.
### Setup
### {% linkable_title Setup %}
Before configuring Home Assistant, make sure you can control your bulbs with the Milight mobile application. Discover your bridge(s) IP. You can do this via your router, or a mobile application like Fing ([android](https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en), [itunes](https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8)). Keep in mind that LimitlessLED bulbs are controlled via groups. You cannot control an individual bulb via the bridge, unless it is in a group by itself. Note that you can assign an `rgbw` and `white` group to the same group number, effectively allowing 8 groups (4 `rgbw` and 4 `white`) per bridge.
Before configuring Home Assistant, make sure you can control your bulbs or LEDs with the MiLight mobile application. Discover your bridge(s) IP address. You can do this via your router or a mobile application like Fing ([android](https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en) or [itunes](https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8)). Keep in mind that LimitlessLED bulbs are controlled via groups. You can not control an individual bulb via the bridge, unless it is in a group by itself. Note that you can assign an `rgbw` and `white` group to the same group number, effectively allowing 8 groups (4 `rgbw` and 4 `white`) per bridge.
To add `limitlessled` to your installation, add the following to your `configuration.yaml` file:
```yaml
light:
platform: limitlessled
bridges:
```
Next, list your bridges and groups. Here's an example. See the next section for a full explanaton of each configuration variable.
```yaml
# Example configuration.yaml entry
light:
platform: limitlessled
bridges:
@ -52,30 +45,31 @@ light:
name: Living Room & Hall
```
### Configuration variables
Configuration variables:
- **bridges** (*Required*): (list)
- **bridges** array (*Required*):
- **host** (*Required*): IP address of the device, eg. `192.168.1.32`
- **version**: Bridge version (default is `5`). Don't use if you aren't sure.
- **port**: Bridge port (default is `8899`). Normally not necessary to specify.
- **groups** (*Required*): (list)
- **version** (*Optional*): Bridge version (default is `5`). Don't use if you aren't sure.
- **port** (*Optional*): Bridge port. Defaults to 8899.
- **groups** array (*Required*): The list of available groups.
- **number** (*Required*): Group number (`1`-`4`). Corresponds to the group number on the remote.
- **name** (*Required*): Any name you'd like. Must be unique among all configured groups.
- **type**: Type of group. Choose either `rgbw` or `white`. `rgbw` is the default if you don't specify.
- **type** (*Optional*): Type of group. Choose either `rgbw` or `white`. `rgbw` is the default if you don't specify this entry.
### Properties
Refer to the [light]({{site_root}}/components/light) documentation for general property usage, but keep in mind the following notes specific to LimitlessLED.
### {% linkable_title Properties %}
Refer to the [light]({{site_root}}/components/light/) documentation for general property usage, but keep in mind the following notes specific to LimitlessLED.
- **RGBW**
- *Color*: There are 256 color possibilities along the LimitlessLED color spectrum. Color properties like saturation and lightness can't be used - only hue. The only exception is white (which may be warm or cold depending on the type of RGBW bulb). If you select a color with saturation or lightness, Home Assistant will calculate the nearest valid LimitlessLED color.
- *Color*: There are 256 color possibilities along the LimitlessLED color spectrum. Color properties like saturation and lightness can not be used - only Hue can. The only exception is white (which may be warm or cold depending on the type of RGBW bulb). If you select a color with saturation or lightness, Home Assistant will calculate the nearest valid LimitlessLED color.
- *Brightness*: There are 25 brightness steps.
- **White**
- As you can observe on the Milight mobile application, you cannot select a specific brightness or temperature - you can only step each property up or down. There is no indication of which step you are on. This restriction, combined with the unreliable nature of LimitlessLED transmissions, means that setting white bulb properties is done on a best-effort basis. The only very reliable settings are the minimum and maximum of each property.
- As you can observe on the MiLight mobile application, you can not select a specific brightness or temperature - you can only step each property up or down. There is no indication of which step you are on. This restriction, combined with the unreliable nature of LimitlessLED transmissions, means that setting white bulb properties is done on a best-effort basis. The only very reliable settings are the minimum and maximum of each property.
- *Temperature*: There are 10 temperature steps.
- *Brightness*: There are 10 brightness steps.
- **Transitions**
- If a transition time is set, the group will transition between the current settings and the target settings for the duration specified. Transitions from or to white are not possible - the color will change immediately.
- If a transition time is set, the group will transition between the current settings and the target settings for the duration specified. Transitions from or to white are not possible - the color will change immediately.
### Initialization & Synchronization
### {% linkable_title Initialization & Synchronization %}
When starting Home Assistant, your LimitlessLED bulbs will be set to known default values. This ensures a consistent user interface and uninterrupted turning on/off. If you control your LimitlessLED lights via the Milight mobile application or other means while Home Assistant is running, Home Assistant can not track those changes and you may observe unexpected behavior. This is due to a LimitlessLED limitation.
When starting Home Assistant, your LimitlessLED bulbs will be set to known default values. This ensures a consistent user interface and uninterrupted turning on/off. If you control your LimitlessLED lights via the MiLight mobile application or other means while Home Assistant is running, Home Assistant can not track those changes and you may observe unexpected behavior. This is due to a LimitlessLED limitation.

View file

@ -69,6 +69,7 @@ Configuration variables:
- **state_value_template** (*Optional*): Defines a [template](/getting-started/templating/) to extract the state value.
- **brightness_value_template** (*Optional*): Defines a [template](/getting-started/templating/) to extract the brightness value.
- **rgb_value_template** (*Optional*): Defines a [template](/getting-started/templating/) to extract the RGB value.
- **brightness_scale** (*Optional*): Defines the maximum brightness value (i.e. 100%) of the MQTT device (defaults to 255).
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
- **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON".
- **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF".

View file

@ -2,7 +2,7 @@
layout: page
title: "MySensors Light"
description: "Instructions how to integrate MySensors lights into Home Assistant."
date: 2016-02-15 17:37 +0100
date: 2016-03-02 18:20 +0100
sidebar: true
comments: false
sharing: true
@ -16,20 +16,20 @@ Integrates MySensors lights into Home Assistant. See the [main component] for co
The following actuator types are supported:
##### MySensors version 1.4 and higher
##### MySensors version 1.4
S_TYPE | V_TYPE
---------|--------------
S_LIGHT | V_LIGHT
S_DIMMER | V_DIMMER
S_DIMMER | V_DIMMER\*, V_LIGHT\*
##### MySensors version 1.5 and higher
S_TYPE | V_TYPE
------------|-------------
S_LIGHT | V_STATUS
S_DIMMER | V_PERCENTAGE
S_RGB_LIGHT | V_RGB
S_DIMMER | [V_DIMMER\* or V_PERCENTAGE\*], [V_LIGHT\* or V_STATUS\*]
S_RGB_LIGHT | V_RGB*, [V_LIGHT\* or V_STATUS\*], [V_DIMMER or V_PERCENTAGE]
V_TYPES with a star (\*) denotes required V_TYPES. Use either V_LIGHT or V_STATUS and either V_DIMMER or V_PERCENTAGE for an applicable actuator.
For more information, visit the [serial api] of MySensors.

View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: telldus_tellstick.png
ha_category: Light
ha_iot_class: "Assumed State"
---

View file

@ -26,6 +26,7 @@ Steps to configure your Amazon Fire TV stick with Home Assistant:
- From the main (Launcher) screen, select Settings.
- Select System > About > Network.
- `pip install firetv[firetv-server]` into a Python 2.x environment
- If installed on Debian Jessie then the libssl-dev package is needed. Install it with `apt-get install libssl-dev`
- `firetv-server -d <fire tv device IP>:5555`, background the process
- Configure Home Assistant as follows:

View file

@ -17,7 +17,7 @@ To enable command_rollershutter in your installation, add the following to your
```yaml
# Example configuration.yaml entry
rollershutter:
- platform: command_rollershutter
- platform: command_line
rollershutters:
Kitchen Rollershutter:
upcmd: move_command up kitchen

View file

@ -0,0 +1,32 @@
---
layout: page
title: "Deutsche Bahn"
description: "Instructions how to integrate timetable data for travelling in Germany within Home Assistant."
date: 2015-06-02 21:45
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_iot_class: "Local Polling"
---
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.
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
platform: deutsche_bahn
from: NAME_OF_START_STATION
to: NAME_OF_FINAL_STATION
```
Configuration variables:
- **from** (*Required*): The name of the start station.
- **to** (*Required*): The name of the end station.

View file

@ -2,7 +2,7 @@
layout: page
title: "MySensors Sensor"
description: "Instructions how to integrate MySensors sensors into Home Assistant."
date: 2016-02-18 20:13 +0100
date: 2016-02-28 01:20 +0100
sidebar: true
comments: false
sharing: true
@ -20,9 +20,6 @@ The following sensor types are supported:
S_TYPE | V_TYPE
-------------------|---------------------------------------
S_DOOR | V_TRIPPED
S_MOTION | V_TRIPPED
S_SMOKE | V_TRIPPED
S_TEMP | V_TEMP
S_HUM | V_HUM
S_BARO | V_PRESSURE, V_FORECAST
@ -46,11 +43,9 @@ S_TYPE | V_TYPE
---------------|----------------------------------
S_COLOR_SENSOR | V_RGB
S_MULTIMETER | V_VOLTAGE, V_CURRENT, V_IMPEDANCE
S_SPRINKLER | V_TRIPPED
S_WATER_LEAK | V_TRIPPED
S_SOUND | V_TRIPPED, V_LEVEL
S_VIBRATION | V_TRIPPED, V_LEVEL
S_MOISTURE | V_TRIPPED, V_LEVEL
S_SOUND | V_LEVEL
S_VIBRATION | V_LEVEL
S_MOISTURE | V_LEVEL
S_LIGHT_LEVEL | V_LEVEL
S_AIR_QUALITY | V_LEVEL (replaces V_DUST_LEVEL)
S_DUST | V_LEVEL (replaces V_DUST_LEVEL)

View file

@ -36,6 +36,10 @@ sensor:
- sum_rain_24
module_name2:
- temperature
rainmeter_name3:
- rain
- sum_rain_1
- sum_rain_24
```
Configuration variables:
@ -85,5 +89,5 @@ You have to provide these name in your Home Assistant configuration file.
</p>
<p class='note'>
The Home Assistant NetAtmo platform has only be tested with the classic indoor and outdoor module. There is no support for the rainmeter and windmeter module at this time because developers does not own these modules.
The Home Assistant NetAtmo platform has only be tested with the classic indoor, outdoor module and rainmeter. There is no support for the windmeter module at this time because developers does not own these modules.
</p>

View file

@ -13,7 +13,7 @@ ha_iot_class: "Cloud Polling"
---
Integrate your [Neurio](http://neur.io/) meter information into Home Assistant. To get an API key and secret, login to your Neurio account at https://my.neur.io/#settings/applications/register and register an application. Note the Homepage URL and Callback URL are optional.
Integrate your [Neurio](http://neur.io/) meter information into Home Assistant. To get an API key and secret, login to your [Neurio account](https://my.neur.io/#settings/applications/register) and register an application. Note the Homepage URL and Callback URL are optional.
To enable this sensor in your installation, add the following to your `configuration.yaml` file:

View file

@ -16,6 +16,25 @@ To enable RFXtrx sensors in your installation, add the following to your `config
```yaml
# Example configuration.yaml entry
sensor:
platform: rfxtrx
sensor:
platform: rfxtrx
automatic_add: True
devices:
sensor_0502:
name: Lving
packetid: 0a52080705020095220269
data_type: Temperature
sensor_0601:
name: Bath_Humidity
packetid: 0a520802060100ff0e0269
data_type: Humidity
sensor_0601 2:
name: Bath
packetid: 0a520802060100ff0e0269
```
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

View file

@ -62,7 +62,40 @@ sensor:
port: 8888
timeout: 5
payload: "r WaterPressure\n"
value_template: "{{ value.split(';')[0] }}"
value_template: "{% raw %}{{ value.split(';')[0] }}{% endraw %}"
unit: Bar
```
### {% linkable_title hddtemp %}
The tool `hddtemp` collects the temperatur of your harddisks.
```bash
$ hddtemp
/dev/sda: SAMSUNG MZMTE256HMHP-000L1: 39°C
```
With `hddtemp -d` you can run the tool in TCP/IP daemon mode on port 7634 which enables you to get the data across the network.
```bash
$ telnet localhost 7634
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
|/dev/sda|SAMSUNG MZMTE256HMHP-000L1|38|C|Connection closed by foreign host.
```
The entry for the `configuration.yaml` file for a `hddtemp` sensor could look like the example below.
```yaml
sensor:
# Example configuration.yaml entry
- platform: tcp
name: HDD temperature
host: 127.0.0.1
port: 7634
timeout: 5
payload: "\n"
value_template: "{% raw %}{{ value.split('|')[3] }}{% endraw %}"
unit: "°C"
```

View file

@ -19,7 +19,7 @@ When a state topic is not available, the switch will work in optimistic mode. In
Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect switch operation.
To enable this s in your installation, add the following to your `configuration.yaml` file:
To enable this switch in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yml entry
@ -28,10 +28,10 @@ switch:
name: "Bedroom Switch"
state_topic: "home/bedroom/switch1"
command_topic: "home/bedroom/switch1/set"
qos: 0
payload_on: "ON"
payload_off: "OFF"
optimistic: false
qos: 0
retain: true
value_template: '{% raw %}{{ value.x }}{% endraw %}'
```
@ -41,13 +41,13 @@ Configuration variables:
- **name** (*Optional*): The name of the switch. Default is 'MQTT Switch'.
- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
- **command_topic** (*Required*): The MQTT topic to publish commands to change the switch state.
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
- **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON".
- **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF".
- **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
- **retain** (*Optional*): If the published message should have the retain flag on or not.
- **value_template** (*Optional*): Defines a [template](/getting-started/templating/) to extract a value from the payload.
<p class='note warning'>
Make sure that your topics match exact. `some-topic/` and `some-topic` are different topics.
Make sure that your topic match exact. `some-topic/` and `some-topic` are different topics.
</p>

View file

@ -2,7 +2,7 @@
layout: page
title: "MySensors Switch"
description: "Instructions how to integrate MySensors switches into Home Assistant."
date: 2016-02-15 20:49 +0100
date: 2016-03-02 18:20 +0100
sidebar: true
comments: false
sharing: true
@ -23,13 +23,15 @@ S_TYPE | V_TYPE
S_DOOR | V_ARMED
S_MOTION | V_ARMED
S_SMOKE | V_ARMED
S_LIGHT | V_LIGHT
S_LOCK | V_LOCK_STATUS
##### MySensors version 1.5 and higher
S_TYPE | V_TYPE
-------------|------------------
S_BINARY | V_STATUS, V_LIGHT
S_LIGHT | V_STATUS
S_BINARY | [V_STATUS or V_LIGHT]
S_SPRINKLER | V_STATUS
S_WATER_LEAK | V_ARMED
S_SOUND | V_ARMED

View file

@ -9,6 +9,7 @@ sharing: true
footer: true
logo: telldus_tellstick.png
ha_category: Switch
ha_iot_class: "Assumed State"
---

View file

@ -14,6 +14,8 @@ ha_category: Thermostat
The `heatmiser` thermostat platform let you control [Heatmiser DT/DT-E/PRT/PRT-E](http://www.heatmisershop.co.uk/heatmiser-slimline-programmable-room-thermostat/) thermostats from Heatmiser. The module itself is currently setup to work over a RS232 -> RS485 converter, therefore it connects over IP.
Further work would be required to get this setup to connect over Wifi, but the HeatmiserV3 python module being used is a full implementation of the V3 protocol. If you would like to contribute to making this work over wifi, please contact @andylockran on github.
To set it up, add the following information to your `configuration.yaml` file:
```yaml