Skip to content

Commit baccb84

Browse files
balloobballoob
authored
Merge pull request home-assistant#1138 from home-assistant/next
0.30
2 parents 3561993 + c953c3a commit baccb84

File tree

310 files changed

+2454
-1600
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

310 files changed

+2454
-1600
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
3+
***DELETE EVERYTHING BEFORE SUBMITTING YOUR PULL REQUEST!***
4+
5+
If you are submitting docs that depend on a pull request to be merged in Home Assistant please reference the PR like so:
6+
7+
`home-assistant/home-assistant#<home-assistant PR number goes here>`
8+
9+
Thanks for submitting!
10+
11+
---

‎README.markdown

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
# Home Assistant website
22

3-
This is the source for the [Home-Assistant.io website](https://home-assistant.io) for the [Home Assistant project](https://github.com/home-assistant/home-assistant)
3+
This is the source for the [Home-Assistant.io website](https://home-assistant.io).
44

55
## Setup
66

77
Setting up to contribute to documentation and the process for submitting pull requests is [explained here](https://home-assistant.io/developers/website/).
88

99
## Site preview
1010

11+
In order to make the preview available on [http://127.0.0.1:4000](http://127.0.0.1:4000), use the command as follows:
12+
1113
```bash
1214
$ rake preview
1315
```
1416

15-
This makes the preview available on [http://127.0.0.1:4000](http://127.0.0.1:4000).
16-
17-
1817
### Setup on Fedora and CentOS
19-
On Fedora > 22 or CentOS 7.1.1503 Ruby is not available by default. Please take the notes here as a little guide for the Ruby installation process.
18+
On Fedora 22 and later or CentOS 7.1.1503, Ruby is not available by default. Please take the notes here as a little guide for the Ruby installation process.
2019

2120
```bash
2221
$ curl -sSL https://rvm.io/mpapis.asc | gpg2 --import -

‎source/_components/alarm_control_panel.alarmdotcom.markdown

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ To enable this, add the following lines to your `configuration.yaml`:
2020
# Example configuration.yaml entry
2121
alarm_control_panel:
2222
platform: alarmdotcom
23-
name: "HA Alarm"
24-
code: PASSCODE
2523
username: YOUR_USERNAME
2624
password: YOUR_PASSWORD
2725
```

‎source/_components/alarm_control_panel.manual.markdown

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,11 @@ This platform enables you to set manual alarms in Home Assistant.
1818
# Example configuration.yaml entry
1919
alarm_control_panel:
2020
platform: manual
21-
name: "HA Alarm"
22-
code: PASSCODE
23-
pending_time: 60
24-
trigger_time: 120
25-
disarm_after_trigger: true
2621
```
2722
2823
Configuration variables:
2924
30-
- **name** (*Optional*): The name of the alarm. Default is 'HA Alarm'.
25+
- **name** (*Optional*): The name of the alarm. Default is "HA Alarm".
3126
- **code** (*Optional*): If defined, specifies a code to enable or disable the alarm in the frontend.
3227
- **pending_time** (*Optional*): The time in seconds of the pending time before arming the alarm. Default is 60 seconds.
3328
- **trigger_time** (*Optional*): The time in seconds of the trigger time in which the alarm is firing. Default is 120 seconds.

‎source/_components/alarm_control_panel.mqtt.markdown

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,6 @@ alarm_control_panel:
3232
platform: mqtt
3333
state_topic: "home/alarm"
3434
command_topic: "home/alarm/set"
35-
name: "MQTT Alarm"
36-
qos: 0
37-
payload_disarm: "DISARM"
38-
payload_arm_home: "ARM_HOME"
39-
payload_arm_away: "ARM_AWAY"
40-
code: "mySecretCode"
4135
```
4236
4337
Configuration variables:

‎source/_components/alarm_control_panel.nx584.markdown

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ To enable this, add the following lines to your `configuration.yaml`:
2020
# Example configuration.yaml entry
2121
alarm_control_panel:
2222
platform: nx584
23-
host: IP_ADDRESS
24-
port: 5007
2523
```
2624
2725
Configuration variables:

‎source/_components/alarm_control_panel.simplisafe.markdown

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ To enable this, add the following lines to your `configuration.yaml`:
2020
# Example configuration.yaml entry
2121
alarm_control_panel:
2222
platform: simplisafe
23-
name: "HA Alarm"
24-
code: PASSCODE
2523
username: YOUR_USERNAME
2624
password: YOUR_PASSWORD
2725
```

‎source/_components/apcupsd.markdown

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ To enable this sensor, add the following lines to your `configuration.yaml`:
1919
```yaml
2020
# Example configuration.yaml entry
2121
apcupsd:
22-
host: IP_ADDRESS
23-
port: PORT
2422
```
2523
2624
Configuration variables:

‎source/_components/binary_sensor.apcupsd.markdown

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: apcupsd.png
1111
ha_category: Binary Sensor
1212
ha_release: 0.13
13+
ha_iot_class: "Local Polling"
1314
---
1415

1516
In addition to the [APCUPSd Sensor](/components/sensor.apcupsd/) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times.
@@ -20,10 +21,8 @@ To enable this sensor, you first have to set up [apcupsd](/components/apcupsd/),
2021
# Example configuration.yaml entry
2122
binary_sensor:
2223
- platform: apcupsd
23-
name: UPS Online
2424
```
2525
2626
Configuration variables:
2727
28-
2928
- **name** (*Optional*): Name to use in the front end.

‎source/_components/binary_sensor.arest.markdown

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,25 +21,35 @@ To use your aREST binary sensor in your installation, add the following to your
2121
```yaml
2222
# Example configuration.yaml entry
2323
binary_sensor:
24-
platform: arest
25-
resource: http://IP_ADDRESS
26-
name: Office Switch
27-
pin: 8
24+
- platform: arest
25+
resource: http://IP_ADDRESS
26+
pin: 8
2827
```
2928
3029
Configuration variables:
3130
3231
- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, e.g. http://192.168.1.10.
33-
- **name** (*Optional*): Let you overwrite the the name of the device. By default *name* from the device is used.
3432
- **pin** (*Required*): Number of the pin to monitor.
33+
- **name** (*Optional*): Let you overwrite the the name of the device. By default *name* from the device is used.
3534
3635
Accessing the URL http://IP_ADDRESS/digital/PIN_NUMBER should give you the state of the pin inside a JSON response as `return_value`.
3736

3837
```bash
39-
$ curl -X GET http://10.100.0.157/digital/9
38+
$ curl -X GET http://192.168.0.5/digital/9
4039
{"return_value": 0, "id": "office1", "name": "Office", "connected": true}
4140
```
4241

42+
An example for Pin 9 inspired by the command above could look like this:
43+
44+
```yaml
45+
# Example configuration.yaml entry
46+
binary_sensor:
47+
- platform: arest
48+
resource: http://192.168.0.5/digital/9
49+
pin: 9
50+
name: Office
51+
```
52+
4353
<p class='note'>
4454
This sensor is not suitable for fast state changes because there is a high possibility that the change took place between two update cycle.
4555
</p>

‎source/_components/binary_sensor.command_line.markdown

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,8 @@ To use your Command binary sensor in your installation, add the following to you
2121
```yaml
2222
# Example configuration.yaml entry
2323
binary_sensor:
24-
platform: command_line
25-
command: cat /proc/sys/net/ipv4/ip_forward
26-
name: 'IP4 forwarding'
27-
sensor_class: opening
28-
payload_on: "1"
29-
payload_off: "0"
30-
value_template: '{% raw %}{{ value.x }}{% endraw %}'
24+
- platform: command_line
25+
command: cat /proc/sys/net/ipv4/ip_forward
3126
```
3227
3328
Configuration variables:
@@ -50,11 +45,12 @@ Check the state of an [SickRage](https://github.com/sickragetv/sickrage) instanc
5045
```yaml
5146
# Example configuration.yaml entry
5247
binary_sensor:
53-
platform: command_line
54-
command: netstat -na | find "33322" | find /c "LISTENING" > nul && (echo "Running") || (echo "Not running")
55-
name: 'sickragerunning'
56-
payload_on: "Running"
57-
payload_off: "Not running"
48+
- platform: command_line
49+
command: netstat -na | find "33322" | find /c "LISTENING" > nul && (echo "Running") || (echo "Not running")
50+
name: 'sickragerunning'
51+
sensor_class: moving
52+
payload_on: "Running"
53+
payload_off: "Not running"
5854
```
5955
6056
### {% linkable_title Check RasPlex %}
@@ -63,11 +59,12 @@ Check if [RasPlex](http://www.rasplex.com/) is `online`.
6359

6460
```yaml
6561
binary_sensor:
66-
platform: command_line
67-
command: 'ping -c 1 rasplex.local | grep "1 received" | wc -l'
68-
name: 'is_rasplex_online'
69-
payload_on: 1
70-
payload_off: 0
62+
- platform: command_line
63+
command: 'ping -c 1 rasplex.local | grep "1 received" | wc -l'
64+
name: 'is_rasplex_online'
65+
sensor_class: connectivity
66+
payload_on: 1
67+
payload_off: 0
7168
```
7269

7370
An alternative solution could look like this:
@@ -77,6 +74,7 @@ binary_sensor:
7774
platform: command_line
7875
name: Printer
7976
command: ping -c 1 192.168.1.10 &> /dev/null && echo success || echo fail
77+
sensor_class: connectivity
8078
payload_on: "success"
8179
payload_off: "fail"
8280
```

‎source/_components/binary_sensor.digital_ocean.markdown

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
layout: page
3+
title: "Digital Ocean Binary Sensor"
4+
description: "Instructions on how to set up Digital Ocean binary sensors within Home Assistant."
5+
date: 2016-09-24 08:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
ha_category: System Monitor
11+
logo: digital_ocean.png
12+
ha_release: "0.30"
13+
ha_iot_class: "Local Polling"
14+
---
15+
16+
The `digital_ocean` binary sensor platform allows you to monitor your Digital Ocean droplets.
17+
18+
To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/components/digital_ocean/) and then add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
binary_sensor:
23+
- platform: digital_ocean
24+
droplets:
25+
- 'fedora-512mb-nyc3-01'
26+
- 'coreos-512mb-nyc3-01'
27+
```
28+
29+
Configuration variables:
30+
31+
- **droplets** (*Required*): List of droplets you want to control.
32+

‎source/_components/binary_sensor.ecobee.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ comments: false
88
sharing: true
99
footer: true
1010
logo: ecobee.png
11-
ha_category: Sensor
11+
ha_category: Binary Sensor
12+
ha_release: 0.9
13+
ha_iot_class: "Local Push"
1214
---
1315

1416
To get your Ecobee binary sensors working with Home Assistant, follow the instructions for the general [Ecobee component](/components/ecobee/).

‎source/_components/binary_sensor.enocean.markdown

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ ha_release: 0.21
1313
ha_iot_class: "Local Push"
1414
---
1515

16-
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.
17-
16+
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.
1817

1918
To use your EnOcean device, you first have to set up your [EnOcean hub](/components/enocean/) and then add the following to your `configuration.yaml` file:
2019

@@ -23,8 +22,6 @@ To use your EnOcean device, you first have to set up your [EnOcean hub](/compone
2322
binary_sensor:
2423
- platform: enocean
2524
id: [0x01,0x90,0x84,0x3C]
26-
name: Door
27-
sensor_class: opening
2825
```
2926
3027
Configuration variables:

‎source/_components/binary_sensor.ffmpeg.markdown

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ To add FFmpeg with noise detection to your installation, add the following to yo
2929
binary_sensor:
3030
- platform: ffmpeg
3131
tool: noise
32-
input: FFMPEG_SUPPORTED_INPUT
33-
name: FFmpeg Noise
34-
peak: -30
35-
duration: 1
36-
reset: 20
3732
```
3833
3934
Configuration variables:
@@ -65,13 +60,6 @@ binary_sensor:
6560
- platform: ffmpeg
6661
tool: motion
6762
input: FFMPEG_SUPPORTED_INPUT
68-
name: FFmpeg Motion
69-
changes: 10
70-
reset: 20
71-
# group feature / default not in use
72-
repeat: 0
73-
repeat_time: 0
74-
7563
```
7664

7765
Configuration variables:

‎source/_components/binary_sensor.isy994.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: universal_devices.png
1111
ha_category: Binary Sensor
1212
ha_iot_class: "Local Push"
13+
ha_release: pre 0.7
1314
---
1415

1516
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) binary sensors from within Home Assistant.

‎source/_components/binary_sensor.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ sharing: true
99
footer: true
1010
---
1111

12-
Binary sensors are gathering information about state of switches, contacts, pins, and alike. The return value of those sensors is usually digital (1/0). This means that those sensors knows only two states: **off/low/open** and **on/high/closed**.
12+
Binary sensors are gathering information about state of switches, contacts, pins, and alike. The return value of those sensors is usually digital (1/0). This means that those sensors knows only two states: **0/off/low/open/false** and **1/on/high/closed/true**.
1313

1414
Knowing that there are only two states allows Home Assistant to represent the sensor better in the frontend.
1515

16-
Most binary sensors support the `SENSOR_CLASSES` which let you specify the type of your sensor. The following types are supported:
16+
Most binary sensors support the `sensor_class:` which let you specify the type of your sensor. The following types are supported:
1717

1818
- **None**: Generic on/off
1919
- **cold**: On means cold (or too cold)

‎source/_components/binary_sensor.modbus.markdown

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: modbus.png
1111
ha_category: Binary Sensor
1212
ha_release: 0.28
13+
ha_iot_class: "Local Push"
1314
---
1415

1516
The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils.
@@ -19,14 +20,14 @@ To use your Modbus binary sensors in your installation, add the following to you
1920
```yaml
2021
# Example configuration.yml entry
2122
binary_sensor:
22-
platform: modbus
23-
coils:
24-
- name: Sensor1
25-
slave: 1
26-
coil: 100
27-
- name: Sensor2
28-
slave: 1
29-
coil: 110
23+
- platform: modbus
24+
coils:
25+
- name: Sensor1
26+
slave: 1
27+
coil: 100
28+
- name: Sensor2
29+
slave: 1
30+
coil: 110
3031
```
3132
3233
Configuration variables:

0 commit comments

Comments
 (0)