Skip to content

Commit 80570a2

Browse files
balloobballoob
committed
Merge pull request #176 from balloob/next
Release 0.12
2 parents b2b82d8 + 65a3711 commit 80570a2

Some content is hidden

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

46 files changed

+1601
-463
lines changed

‎sass/custom/_paulus.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ p.note {
160160
box-shadow: rgba(0,0,0,0.06) 0 0 10px;
161161

162162
&::before {
163-
font-family: "FontAwesome";
163+
font-family: "FontAwesome", sans-serif;
164164
content: "\f05a" " Note " attr(data-title);
165165
background-color: #6ab0de;
166166
color: white;

‎source/_components/automation.markdown

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -161,23 +161,31 @@ automation:
161161

162162
#### {% linkable_title Time trigger %}
163163

164-
Time can be triggered in many ways. The most common is to specify `after` and trigger at a specific point in time each day. Alternatively, you can also match if the hour, minute or second of the current time has a specific value. For example, by only setting minutes in the config to 5 it will trigger every hour when it is 5 minutes past whole. You cannot use `after` together with hour, minute or second.
164+
Time can be triggered in many ways. The most common is to specify `after` and trigger at a specific point in time each day. Alternatively, you can also match if the hour, minute or second of the current time has a specific value. You can prefix the value with a `/` to match whenever the value is divisible by that number. You cannot use `after` together with hour, minute or second.
165165

166166
```yaml
167167
automation:
168168
trigger:
169169
platform: time
170-
# All following are optional.
170+
# Matches every hour at 5 minutes past whole
171+
minutes: 5
172+
seconds: 0
173+
174+
automation 2:
175+
trigger:
176+
platform: time
171177
# When 'after' is used, you cannot also match on hour, minute, seconds.
172178
# Military time format.
173-
# after: '15:32:00'
174-
hours: 0
175-
minutes: 5
179+
after: '15:32:00'
180+
181+
automation 3:
182+
trigger:
183+
platform: time
184+
# You can also match on interval. This will match every 5 minutes
185+
minutes: '/5'
176186
seconds: 0
177187
```
178188

179-
The above example will trigger every hour on the 5 (2:05, 3:05, 4:05, etc).
180-
181189
#### {% linkable_title Zone trigger %}
182190

183191
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/).

‎source/_components/binary_sensor.command.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: component
3-
title: "Command binary sensor"
3+
title: "Command line binary sensor"
44
description: "Instructions how to integrate Command binary sensors within Home Assistant."
55
date: 2016-01-13 12:15
66
sidebar: true

‎source/_components/binary_sensor.nest.markdown

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
layout: component
3+
title: "Nest binary sensor"
4+
description: "Instructions how to integrate Nest binary sensors within Home Assistant."
5+
date: 2016-01-26 08:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: nest_thermostat.png
11+
ha_category: Binary Sensor
12+
---
13+
14+
15+
The Nest binary sensor platform let you monitor various states of a thermostat from [Nest](https://nest.com).
16+
17+
To set it up, add the following information to your `configuration.yaml` file:
18+
19+
```yaml
20+
sensor:
21+
platform: nest
22+
monitored_conditions:
23+
- 'fan'
24+
- 'hvac_ac_state',
25+
- 'hvac_aux_heater_state',
26+
- 'hvac_heat_x2_state',
27+
- 'hvac_heat_x3_state',
28+
- 'hvac_alt_heat_state',
29+
- 'hvac_alt_heat_x2_state',
30+
- 'hvac_emer_heat_state',
31+
- 'online'
32+
```
33+
34+
Configuration variables:
35+
36+
- **monitored_conditions** array (*Required*): States to monitor.
37+
38+
<p class='note'>You must have the [Nest component](https://home-assistant.io/components/nest/) configured to use this sensor.</p>

‎source/_components/binary_sensor.zigbee.markdown

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: component
3+
title: ZigBee Binary Sensor
4+
description: "Instructions on how to set up ZigBee binary sensors within Home Assistant."
5+
date: 2016-01-28 12:38
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: zigbee.png
11+
ha_category: Binary Sensor
12+
---
13+
14+
A ZigBee binary sensor in this context is a device connected to one of the digital input pins on a ZigBee module. The states reported by such a device are limited to 'on' or 'off'. By default, a binary sensor is considered 'on' when the ZigBee device's digital input pin is held 'high' and considered 'off' when it is held 'low'. This behaviour can be inverted by setting the `on_state` configuration variable to `low`.
15+
16+
To configure a digital input as a binary sensor, use the following variables:
17+
18+
- **name** (*Required*): The name you'd like to give the binary sensor in Home Assistant.
19+
- **platform** (*Required*): Set to `zigbee`.
20+
- **pin** (*Required*): The number identifying which pin to use.
21+
- **address**: The long 64bit address of the remote ZigBee device whose digital input pin you'd like to sample. Do not include this variable if you want to sample the local ZigBee device's pins.
22+
- **on_state**: Either `high` (default) or `low`, depicting whether the binary sensor is considered 'on' when the pin is 'high' or 'low'.
23+
24+
#### Example
25+
26+
```yaml
27+
binary_sensor:
28+
- name: Hallway PIR Sensor
29+
platform: zigbee
30+
pin: 0
31+
address: 0013A20040892FA2
32+
on_state: low
33+
```

‎source/_components/device_tracker.asuswrt.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ha_category: Presence Detection
1212
---
1313

1414

15-
This platform offers presence detection by looking at connected devices to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router.
15+
The `asuswrt` platform offers presence detection by looking at connected devices to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router.
1616

1717
<p class='note warning'>
1818
This device tracker needs telnet to be enabled on the router.

‎source/_components/device_tracker.owntracks.markdown

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,36 @@ device_tracker:
2727
2828
There is no further configuration needed for tracking Owntracks devices.
2929
30+
### {% linkable_title Using Owntracks with other device trackers %}
3031
Owntracks can also be used with other device trackers, such as [Nmap](/components/device_tracker.nmap_scanner/) or [Netgear](/components/device_tracker.netgear/). To do this, fill in the `mac` field to the Owntracks entry in `known_devices.yaml` with the MAC address of the device you want to track. This way the state of the device will be determined by the source that reported last.
32+
33+
### {% linkable_title Using Owntracks regions %}
34+
Owntracks can track regions, and send region entry and exit information to Home Assistant(HA). You set up a region in the Owntracks app which you should name the same as your HA Zone, and then make sure to turn on the `share` option for the region in the owntracks app. Please see the [owntracks documentation](http://owntracks.org/booklet/guide/waypoints/)
35+
36+
Home Assistant will use the enter and leave messages to set your zone location. Your location will be set to the center of zone when you enter. Location updates from OwnTracks will be ignored while you are inside a zone.
37+
38+
When you exit a zone, Home Assistant will start using location updates to track you again. To make sure that Home Assistant correctly exits a zone (which it calculates based on your GPS co-ordinates), you may want to set your Zone radius in HA to be slightly smaller that the Owntracks region radius.
39+
40+
### {% linkable_title Using Owntracks regions - forcing Owntracks to update using %}iBeacons
41+
When run in the usual `significant changes mode` (which is kind to your phone battery), Owntracks sometimes doesn't update your location as quickly as you'd like when you arrive at a zone. This can be annoying if you want to trigger an automation when you get home. You can improve the situation using iBeacons.
42+
43+
iBeacons are simple bluetooth devices that send out an "I'm here" message. They are supported by IOS and some Android devices. Owntracks explain more [here](http://owntracks.org/booklet/guide/beacons/)
44+
45+
When you enter an iBeacon region, Owntracks will send a `region enter` message to HA as described above. So if you want to have an event triggered when you arrive home, you can put an iBeacon outside your front door. If you set up an OwnTracks iBeacon region called `home` then getting close to the beacon will trigger an update to HA that will set your zone to be `home`.
46+
47+
When you exit an iBeacon region HA will switch back to using GPS to determine your location. Depending on the size of your zone, and the accuracy of your GPS location this may change your HA zone.
48+
49+
Sometimes Owntracks will lose connection with an iBeacon for a few seconds. If you name your beacon starting with `-` Owntracks will wait longer before deciding it has exited the beacon zone. HA will ignore the `-` when it matches the Owntracks region with Zones. So if you call your Owntracks region `-home` then HA will recognise it as `home`, but you will have a more stable iBeacon connection.
50+
51+
### {% linkable_title Using Owntracks iBeacons to track devices %}
52+
iBeacons don't need to be stationary. You could put one on your key ring, or in your car.
53+
54+
When your phone sees a mobile iBeacon that it knows about, it will tell HA the location of that iBeacon. If your phone moves while you are connected to the iBeacon, HA will update the location of the iBeacon. But when your phone loses the connection, HA will stop updating the iBeacon location.
55+
56+
To use mobile iBeacons with HA, you just set up a region that doesn't match your Zone names. If HA sees an entry event for a iBeacon region that doesn't match a Zone name (say `keys`) - it will start tracking it, calling the device `device_tracker.beacon_keys`).
57+
58+
This allows you to write zone automations for devices that can't track themselves (for example `alert me if I leave the house and my keys are still at home`). Another example would be `open the gates if my car arrives home`.
59+
60+
### {% linkable_title Using mobile and fixed iBeacons together %}
61+
You can use iBeacons of both types together, so if you have a Zone `drive` with an iBeacon region called `-drive` and you arrive home with a mobile iBeacon called `-car`, then `device_tracker.beacon_car` will be set to a state of `drive`.
62+

‎source/_components/group.markdown

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,40 @@ logo: home-assistant.png
1111
ha_category: Organization
1212
---
1313

14-
Groups allow the user to combine multiple entities into one.
14+
Groups allow the user to combine multiple entities into one. A group can be promoted to a **view** by setting the `view` option to `yes`. This will make the group available as a new tab in the frontend.
1515

1616
Check the **Set State** page from the **Developer Tools** and browse the **Current entities:** listing for all available entities.
1717

18-
1918
```yaml
2019
# Example configuration.yaml entry
2120
group:
22-
information:
23-
- sensor.time
24-
living_room:
25-
- binary_sensor.tv
26-
- sensor.living_room_temperature
2721
kitchen:
28-
- switch.kitchen_pin_3
29-
- sensor.oven_temperature
22+
name: Kitchen
23+
entities:
24+
- switch.kitchen_pin_3
25+
upstairs:
26+
name: Kids
27+
icon: mdi:account-multiple
28+
view: yes
29+
entities:
30+
- input_boolean.notify_home
31+
- camera.demo_camera
32+
- device_tracker.demo_paulus
33+
- group.garden
3034
```
3135
36+
Configuration variables:
37+
38+
- **name** (*Optional*): Name of the group.
39+
- **icon** (*Optional*): An optional icon to show in the Frontend.
40+
- **view** (*Optional*): If yes then the entry will be shown as a view.
41+
- **entities** array or comma delimited string (*Required*): List of entites to group.
42+
43+
<p class='img'>
44+
<img src='/images/blog/2016-01-release-12/views.png'>
45+
Example of groups shown as views in the frontend.
46+
</p>
47+
3248
If all entities are switches or lights they can be controlled as one with a switch at the top of the card. Grouped states should share the same type of states (ON/OFF or HOME/NOT_HOME).
3349
3450
```yaml
@@ -38,8 +54,5 @@ group:
3854
- light.bowl
3955
- light.ceiling
4056
- light.tv_back_light
41-
children:
42-
- device_tracker.child_1
43-
- device_tracker.child_2
57+
children: device_tracker.child_1, device_tracker.child_2
4458
```
45-

‎source/_components/insteon_hub.markdown

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
layout: component
3+
title: "Insteon"
4+
description: "Instructions how to setup the Insteon Hub within Home Assistant."
5+
date: 2016-01-27 08:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: insteon.png
11+
ha_category: Hub
12+
---
13+
14+
The `insteon` component let you use your [Insteon](http://www.insteon.com/) Hub with Home Assistant.
15+
16+
To integrate your Insteon hub with Home Assistant, add the following section to your `configuration.yaml` file:
17+
18+
```yaml
19+
# Example configuration.yaml entry
20+
insteon:
21+
username: YOUR_USERNAME
22+
password: YOUR_PASSWORD
23+
```
24+
25+
Configuration variables:
26+
27+
- **username** (*Required*): The username that used to access the Insteon interface.
28+
- **password** (*Required*): The password that used to access the Insteon interface.

‎source/_components/light.lifx.markdown

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
layout: component
3+
title: "LIFX"
4+
description: "Instructions how to integrate LIFX into Home Assistant."
5+
date: 2016-01-27 08:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: lifx.png
11+
ha_category: Light
12+
---
13+
14+
The `lifx` platform allows you to integrate your [LIFX](http://www.lifx.com) into Home Assistant.
15+
16+
```yaml
17+
# Example configuration.yaml entry
18+
light:
19+
platform: lifx
20+
server: 192.168.1.98
21+
broadcast: 192.168.1.255
22+
```
23+
Configuration variables:
24+
25+
- **server** (*Optional*): Your server address. Only needed if using more than one network interface. Omit if you are unsure.
26+
- **consumer_secret** (*Optional*): The broadcast address, set to reach all LIFX bulbs.
27+

‎source/_components/light.zigbee.markdown

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: component
3+
title: ZigBee Light
4+
description: "Instructions on how to set up ZigBee lights within Home Assistant."
5+
date: 2016-01-28 12:38
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: zigbee.png
11+
ha_category: Light
12+
---
13+
14+
A ZigBee light in this context is a light connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a light is considered 'on' when the ZigBee device's digital output is held 'high' and considered 'off' when it is held 'low'. This behaviour can be inverted by setting the `on_state` configuration variable to `low`.
15+
16+
To configure a digital output pin as a light, use the following variables:
17+
18+
- **name** (*Required*): The name you'd like to give the light in Home Assistant.
19+
- **platform** (*Required*): Set to `zigbee`.
20+
- **pin** (*Required*): The number identifying which pin to use.
21+
- **address**: The long 64bit address of the remote ZigBee device whose digital output pin you'd like to switch. Do not include this variable if you want to switch the local ZigBee device's pins.
22+
- **on_state**: Either `high` (default) or `low`, depicting whether the digital output pin is pulled high or low when the light is turned on.
23+
24+
#### Example
25+
26+
```yaml
27+
light:
28+
- name: Desk Lamp
29+
platform: zigbee
30+
pin: 0
31+
address: 0013A20040791FA2
32+
on_state: low
33+
```

‎source/_components/mqtt_eventstream.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: component
33
title: "MQTT Eventstream"
4-
description: "Instructions how to setup MQTT within Home Assistant."
4+
description: "Instructions how to setup MQTT eventstream within Home Assistant."
55
date: 2016-01-13 08:00
66
sidebar: true
77
comments: false

‎source/_components/mysensors.markdown

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ featured: true
1414

1515
The [MySensors](https://www.mysensors.org) project combines Arduino boards with NRF24L01 radio boards to build sensor networks. The component will automatically add all available switches and sensors to Home Assistant.
1616

17+
### Configuration
18+
1719
Integrate your Serial MySensors Gateway by adding the following to your `configuration.yaml` file:
1820

1921
```yaml
@@ -32,13 +34,32 @@ mysensors:
3234
Configuration variables:
3335
3436
- **port** (*Required*): The port where your board is connected to your Home Assistant host.
35-
- **debug** (*Optional*): Enable or disable verbose debug logging.
36-
- **persistence** (*Optional*): Enable or disable local persistence of sensor information. If this is disabled, then each sensor will need to send presentation messages after Home Assistant starts.
37+
- **debug** (*Optional*): Enable or disable verbose debug logging. Default is false.
38+
- **persistence** (*Optional*): Enable or disable local persistence of sensor information. If this is disabled, then each sensor will need to send presentation messages after Home Assistant starts. Default is true.
3739
- **persistence_file** (*Optional*): Path to a file to save sensor information. The file extension determines the file type. Currently supported file types are 'pickle' and 'json'.
38-
- **version** (*Optional*): Specifies the MySensors protocol version to use (ex. 1.4, 1.5).
40+
- **version** (*Optional*): Specifies the MySensors protocol version to use. Supports 1.4 and 1.5. Default is 1.4.
3941
4042
If you are using an original Arduino the port will be named `ttyACM*`. The exact number can be determined with the command shown below.
4143

4244
```bash
4345
$ ls /dev/ttyACM*
4446
```
47+
48+
### Presentation
49+
50+
Present a MySensors sensor or actuator, by following these steps:
51+
52+
1. Connect your gateway to your computer.
53+
2. Configure the MySensors component in configuration.yaml.
54+
3. Start hass.
55+
4. Wait for "gateway started" in the log output.
56+
5. Write and upload your MySensors sketch to the sensor. Make sure you:
57+
- Either use a manual node id, or AUTO for requesting a node id from the controller, in gw.begin().
58+
- Send sketch name.
59+
- Present the sensor's S_TYPE.
60+
- Send at least one initial value per V_TYPE.
61+
6. Start the sensor.
62+
63+
Visit the [library api] of MySensors for more information.
64+
65+
[library api]: https://www.mysensors.org/download/sensor_api_15

0 commit comments

Comments
 (0)