Skip to content

Release 0.12 #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 37 commits into from
Jan 30, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
88d7d04
Update script docs
balloob Jan 22, 2016
8fb97ae
Add FreakingDean to credits
balloob Jan 22, 2016
b3ce5c2
Add initial statsd docs
fabaff Jan 26, 2016
ebe0c70
Add new view
fabaff Jan 26, 2016
921862e
Update configuration entries
fabaff Jan 26, 2016
66c7794
Add trollkarlen
fabaff Jan 26, 2016
a58bbbc
Add Michael
fabaff Jan 26, 2016
90cd3aa
Add 1-wire docs
fabaff Jan 27, 2016
dd7b3b3
Add twitter docs
fabaff Jan 27, 2016
0280389
Add lifx docs
fabaff Jan 27, 2016
30ca8cc
Add names:
fabaff Jan 27, 2016
650916e
Add nest binary sensor docs
fabaff Jan 27, 2016
c04adf6
Update array
fabaff Jan 27, 2016
d760009
UPdate description
fabaff Jan 27, 2016
647c005
Add template sensor docs
fabaff Jan 27, 2016
33758a2
Add insteon docs
fabaff Jan 27, 2016
874c42c
Change ISY to insteon
fabaff Jan 27, 2016
cdf09b2
Add new contributors
fabaff Jan 27, 2016
ce83393
Update documentation
fabaff Jan 27, 2016
bc4688e
Minor changes
fabaff Jan 27, 2016
583e4f9
Add ZigBee component documentation.
flyte Jan 28, 2016
5e53809
Update mysensors documentation
MartinHjelmare Jan 29, 2016
9676626
Merge pull request #170 from MartinHjelmare/mysensors-update
balloob Jan 29, 2016
58a9a98
Add details about multiple files
fabaff Jan 29, 2016
e24bcbf
Add cookbook entry for battery levels
fabaff Jan 29, 2016
a719fb8
Add example (thanks @pavoni)
fabaff Jan 29, 2016
275ac47
Fix typo
fabaff Jan 29, 2016
0bf424e
Add details about else
fabaff Jan 29, 2016
40868c0
Add links, fix code block, add missing config variable.
flyte Jan 29, 2016
a039a67
Add new cookbook entry
fabaff Jan 29, 2016
56e14e5
Add iBeacon documentation.
pavoni Jan 29, 2016
4103438
Merge pull request #175 from pavoni/ibeacon-docs
balloob Jan 30, 2016
7b935b1
Merge pull request #171 from flyte/zigbee-pr
balloob Jan 30, 2016
a4a1edf
Merge branch 'master' into next
balloob Jan 30, 2016
4ed80fe
Add 0.12 release blog post
balloob Jan 30, 2016
4863b26
More updates
balloob Jan 30, 2016
65a3711
Update demo
balloob Jan 30, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sass/custom/_paulus.scss
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ p.note {
box-shadow: rgba(0,0,0,0.06) 0 0 10px;

&::before {
font-family: "FontAwesome";
font-family: "FontAwesome", sans-serif;
content: "\f05a" " Note " attr(data-title);
background-color: #6ab0de;
color: white;
Expand Down
22 changes: 15 additions & 7 deletions source/_components/automation.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -161,23 +161,31 @@ automation:

#### {% linkable_title Time trigger %}

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.
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.

```yaml
automation:
trigger:
platform: time
# All following are optional.
# Matches every hour at 5 minutes past whole
minutes: 5
seconds: 0

automation 2:
trigger:
platform: time
# When 'after' is used, you cannot also match on hour, minute, seconds.
# Military time format.
# after: '15:32:00'
hours: 0
minutes: 5
after: '15:32:00'

automation 3:
trigger:
platform: time
# You can also match on interval. This will match every 5 minutes
minutes: '/5'
seconds: 0
```

The above example will trigger every hour on the 5 (2:05, 3:05, 4:05, etc).

#### {% 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/).
Expand Down
2 changes: 1 addition & 1 deletion source/_components/binary_sensor.command.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: component
title: "Command binary sensor"
title: "Command line binary sensor"
description: "Instructions how to integrate Command binary sensors within Home Assistant."
date: 2016-01-13 12:15
sidebar: true
Expand Down
38 changes: 38 additions & 0 deletions source/_components/binary_sensor.nest.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
layout: component
title: "Nest binary sensor"
description: "Instructions how to integrate Nest binary sensors within Home Assistant."
date: 2016-01-26 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: nest_thermostat.png
ha_category: Binary Sensor
---


The Nest binary sensor platform let you monitor various states of a thermostat from [Nest](https://nest.com).

To set it up, add the following information to your `configuration.yaml` file:

```yaml
sensor:
platform: nest
monitored_conditions:
- 'fan'
- 'hvac_ac_state',
- 'hvac_aux_heater_state',
- 'hvac_heat_x2_state',
- 'hvac_heat_x3_state',
- 'hvac_alt_heat_state',
- 'hvac_alt_heat_x2_state',
- 'hvac_emer_heat_state',
- 'online'
```

Configuration variables:

- **monitored_conditions** array (*Required*): States to monitor.

<p class='note'>You must have the [Nest component](https://home-assistant.io/components/nest/) configured to use this sensor.</p>
33 changes: 33 additions & 0 deletions source/_components/binary_sensor.zigbee.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
layout: component
title: ZigBee Binary Sensor
description: "Instructions on how to set up ZigBee binary sensors within Home Assistant."
date: 2016-01-28 12:38
sidebar: true
comments: false
sharing: true
footer: true
logo: zigbee.png
ha_category: Binary Sensor
---

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`.

To configure a digital input as a binary sensor, use the following variables:

- **name** (*Required*): The name you'd like to give the binary sensor in Home Assistant.
- **platform** (*Required*): Set to `zigbee`.
- **pin** (*Required*): The number identifying which pin to use.
- **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.
- **on_state**: Either `high` (default) or `low`, depicting whether the binary sensor is considered 'on' when the pin is 'high' or 'low'.

#### Example

```yaml
binary_sensor:
- name: Hallway PIR Sensor
platform: zigbee
pin: 0
address: 0013A20040892FA2
on_state: low
```
2 changes: 1 addition & 1 deletion source/_components/device_tracker.asuswrt.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ha_category: Presence Detection
---


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

<p class='note warning'>
This device tracker needs telnet to be enabled on the router.
Expand Down
32 changes: 32 additions & 0 deletions source/_components/device_tracker.owntracks.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,36 @@ device_tracker:

There is no further configuration needed for tracking Owntracks devices.

### {% linkable_title Using Owntracks with other device trackers %}
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.

### {% linkable_title Using Owntracks regions %}
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/)

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.

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.

### {% linkable_title Using Owntracks regions - forcing Owntracks to update using %}iBeacons
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.

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

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`.

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.

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.

### {% linkable_title Using Owntracks iBeacons to track devices %}
iBeacons don't need to be stationary. You could put one on your key ring, or in your car.

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.

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`).

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`.

### {% linkable_title Using mobile and fixed iBeacons together %}
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`.

39 changes: 26 additions & 13 deletions source/_components/group.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,40 @@ logo: home-assistant.png
ha_category: Organization
---

Groups allow the user to combine multiple entities into one.
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.

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


```yaml
# Example configuration.yaml entry
group:
information:
- sensor.time
living_room:
- binary_sensor.tv
- sensor.living_room_temperature
kitchen:
- switch.kitchen_pin_3
- sensor.oven_temperature
name: Kitchen
entities:
- switch.kitchen_pin_3
upstairs:
name: Kids
icon: mdi:account-multiple
view: yes
entities:
- input_boolean.notify_home
- camera.demo_camera
- device_tracker.demo_paulus
- group.garden
```

Configuration variables:

- **name** (*Optional*): Name of the group.
- **icon** (*Optional*): An optional icon to show in the Frontend.
- **view** (*Optional*): If yes then the entry will be shown as a view.
- **entities** array or comma delimited string (*Required*): List of entites to group.

<p class='img'>
<img src='/images/blog/2016-01-release-12/views.png'>
Example of groups shown as views in the frontend.
</p>

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

```yaml
Expand All @@ -38,8 +54,5 @@ group:
- light.bowl
- light.ceiling
- light.tv_back_light
children:
- device_tracker.child_1
- device_tracker.child_2
children: device_tracker.child_1, device_tracker.child_2
```

28 changes: 28 additions & 0 deletions source/_components/insteon_hub.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
layout: component
title: "Insteon"
description: "Instructions how to setup the Insteon Hub within Home Assistant."
date: 2016-01-27 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: insteon.png
ha_category: Hub
---

The `insteon` component let you use your [Insteon](http://www.insteon.com/) Hub with Home Assistant.

To integrate your Insteon hub with Home Assistant, add the following section to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
insteon:
username: YOUR_USERNAME
password: YOUR_PASSWORD
```

Configuration variables:

- **username** (*Required*): The username that used to access the Insteon interface.
- **password** (*Required*): The password that used to access the Insteon interface.
27 changes: 27 additions & 0 deletions source/_components/light.lifx.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
layout: component
title: "LIFX"
description: "Instructions how to integrate LIFX into Home Assistant."
date: 2016-01-27 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lifx.png
ha_category: Light
---

The `lifx` platform allows you to integrate your [LIFX](http://www.lifx.com) into Home Assistant.

```yaml
# Example configuration.yaml entry
light:
platform: lifx
server: 192.168.1.98
broadcast: 192.168.1.255
```
Configuration variables:

- **server** (*Optional*): Your server address. Only needed if using more than one network interface. Omit if you are unsure.
- **consumer_secret** (*Optional*): The broadcast address, set to reach all LIFX bulbs.

33 changes: 33 additions & 0 deletions source/_components/light.zigbee.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
layout: component
title: ZigBee Light
description: "Instructions on how to set up ZigBee lights within Home Assistant."
date: 2016-01-28 12:38
sidebar: true
comments: false
sharing: true
footer: true
logo: zigbee.png
ha_category: Light
---

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`.

To configure a digital output pin as a light, use the following variables:

- **name** (*Required*): The name you'd like to give the light in Home Assistant.
- **platform** (*Required*): Set to `zigbee`.
- **pin** (*Required*): The number identifying which pin to use.
- **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.
- **on_state**: Either `high` (default) or `low`, depicting whether the digital output pin is pulled high or low when the light is turned on.

#### Example

```yaml
light:
- name: Desk Lamp
platform: zigbee
pin: 0
address: 0013A20040791FA2
on_state: low
```
2 changes: 1 addition & 1 deletion source/_components/mqtt_eventstream.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: component
title: "MQTT Eventstream"
description: "Instructions how to setup MQTT within Home Assistant."
description: "Instructions how to setup MQTT eventstream within Home Assistant."
date: 2016-01-13 08:00
sidebar: true
comments: false
Expand Down
27 changes: 24 additions & 3 deletions source/_components/mysensors.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ featured: true

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.

### Configuration

Integrate your Serial MySensors Gateway by adding the following to your `configuration.yaml` file:

```yaml
Expand All @@ -32,13 +34,32 @@ mysensors:
Configuration variables:

- **port** (*Required*): The port where your board is connected to your Home Assistant host.
- **debug** (*Optional*): Enable or disable verbose debug logging.
- **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.
- **debug** (*Optional*): Enable or disable verbose debug logging. Default is false.
- **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.
- **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'.
- **version** (*Optional*): Specifies the MySensors protocol version to use (ex. 1.4, 1.5).
- **version** (*Optional*): Specifies the MySensors protocol version to use. Supports 1.4 and 1.5. Default is 1.4.

If you are using an original Arduino the port will be named `ttyACM*`. The exact number can be determined with the command shown below.

```bash
$ ls /dev/ttyACM*
```

### Presentation

Present a MySensors sensor or actuator, by following these steps:

1. Connect your gateway to your computer.
2. Configure the MySensors component in configuration.yaml.
3. Start hass.
4. Wait for "gateway started" in the log output.
5. Write and upload your MySensors sketch to the sensor. Make sure you:
- Either use a manual node id, or AUTO for requesting a node id from the controller, in gw.begin().
- Send sketch name.
- Present the sensor's S_TYPE.
- Send at least one initial value per V_TYPE.
6. Start the sensor.

Visit the [library api] of MySensors for more information.

[library api]: https://www.mysensors.org/download/sensor_api_15
Loading