Skip to content

Commit 810a0a7

Browse files
committed
Merge branch 'current' into next
2 parents 33f2a8c + a4af4d5 commit 810a0a7

15 files changed

+464
-254
lines changed

credits_generator/README.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
credits_generator
2+
=================
3+
4+
This tool can be used to update the [Home Assistant's Credits page](https://home-assistant.io/developers/credits/).
5+
6+
```bash
7+
$ cd credits_generator
8+
$ npm install
9+
```
10+
11+
Set your personal GitHub access token as environmental variable.
12+
13+
```bash
14+
$ export GITHUB_TOKEN=<Your GitHub access token>
15+
```
16+
17+
Run the script.
18+
19+
```bash
20+
$ node update_credits.js
21+
```
22+
23+
Commit the changes (depending on our setup).
24+
25+
```bash
26+
$ git commit ../source/developers/credits.markdown
27+
$ git push upstream
28+
```
29+

credits_generator/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
"scripts": {
77
"test": "echo \"Error: no test specified\" && exit 1"
88
},
9-
"author": "",
10-
"license": "MIT",
9+
"author": "Home Assistant Community",
10+
"license": "Apache 2.0",
1111
"dependencies": {
1212
"async": "^2.1.4",
1313
"github": "^8.1.0",

source/_components/alert.markdown

+8-6
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ The `alert` component is designed to notify you when problematic issues arise. F
1616

1717
Alerts will add an entity to the front end only when they are firing. This entity allows you to silence an alert until it is resolved.
1818

19+
When using the `alert` component it is important that the timezone used for Home Assistant and the underlying operating system match. Failing to do so may result in multiple alerts being sent at the same time (such as when Home Assistant is set to the `America/Detroit` timezone but the operating system uses `UTC`).
20+
1921
### {% linkable_title Basic Example %}
2022

2123
The `alert` component makes use of any of the `notifications` components. To setup the `alert` component, first, you must setup a `notification` component. Then, add the following to your configuration file:
@@ -83,12 +85,12 @@ binary_sensor:
8385
8486
alert:
8587
motion_battery:
86-
- name: Motion Battery is Low
87-
entity_id: binary_sensor.motion_battery_low
88-
repeat: 30
89-
notifiers:
90-
- ryans_phone
91-
- kristens_phone
88+
name: Motion Battery is Low
89+
entity_id: binary_sensor.motion_battery_low
90+
repeat: 30
91+
notifiers:
92+
- ryans_phone
93+
- kristens_phone
9294
```
9395

9496
This example will begin firing as soon as the entity `sensor.motion`'s `battery` attribute falls below 15. It will continue to fire until the battery attribute raises above 15 or the alert is acknowledged on the frontend.

source/_components/fan.mqtt.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Configuration variables:
5353
- **payload_medium_speed** (*Optional*): The payload that represents the fan's medium speed.
5454
- **payload_high_speed** (*Optional*): The payload that represents the fan's high speed.
5555
- **speed_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the speed payload.
56-
- **speeds** array (*Optional*): Valid entries for the list are `off`, `low`, `med`, and `high`.
56+
- **speeds** array (*Optional*): Valid entries for the list are `off`, `low`, `medium`, and `high`.
5757

5858
<p class='note warning'>
5959
Make sure that your topic is an exact match. `some-topic/` and `some-topic` are different topics.

source/_components/logger.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ data:
6868
homeassistant.components.media_player.yamaha: debug
6969
```
7070

71-
The log information are stored in the [configuration directory](/docs/configuration/) as `home-assistant.log` and you can read it with the command-line tool `cat` or follow it dynamicly with `tail -f`. If you are a Rasbian user then like the example below:
71+
The log information are stored in the [configuration directory](/docs/configuration/) as `home-assistant.log` and you can read it with the command-line tool `cat` or follow it dynamically with `tail -f`. If you are a Hassbian user you can use the example below:
7272

7373
```bash
74-
$ tail -f /home/pi/.homeassistant/home-assistant.log
74+
$ tail -f /home/homeassistant/.homeassistant/home-assistant.log
7575
```

source/_components/telegram_webhooks.markdown

+7-7
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ telegram_webhooks:
6363

6464
### {% linkable_title Configuration samples %}
6565

66-
Telegram webhooks raise an event `telegram.command` with a payload.
66+
Telegram webhooks raise an event `telegram_command` with a payload.
6767

6868
```json
6969
{
70-
'command': '/thecommand'
71-
'args': 'strings after command'
72-
'user_id': 12345
70+
"command": "/thecommand",
71+
"args": "strings after command",
72+
"user_id": "12345"
7373
}
7474
```
7575

@@ -80,7 +80,7 @@ alias: 'telegram bot that reply pong to ping'
8080
hide_entity: true
8181
trigger:
8282
platform: event
83-
event_type: telegram.command
83+
event_type: telegram_command
8484
event_data:
8585
command: '/ping'
8686
action:
@@ -94,7 +94,7 @@ Example that show keyboard interaction with `notify.telegram`
9494
```yaml
9595
trigger:
9696
platform: event
97-
event_type: telegram.command
97+
event_type: telegram_command
9898
event_data:
9999
command: '/start'
100100
action:
@@ -112,7 +112,7 @@ and an automation to trigger a related command "/siren".
112112
```yaml
113113
trigger:
114114
platform: event
115-
event_type: telegram.command
115+
event_type: telegram_command
116116
event_data:
117117
command: '/siren'
118118
action:

source/_docs/ecosystem/ios/integration.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Query parameters are passed as a dictionary in the call.
1818
Example: `homeassistant://call_service/device_tracker.see?entity_id=device_tracker.entity`
1919

2020
## Fire event
21+
You can create an [event trigger](https://home-assistant.io/docs/automation/trigger/#event-trigger) and fire the event.
2122

22-
Example `homeassistant://fire_event/custom_event?entity_id=device_tracker.entity`
23+
Example: `homeassistant://fire_event/custom_event?entity_id=MY_CUSTOM_EVENT`
2324

2425
## Send one shot location
25-
2626
Example: `homeassistant://send_location/`

source/_docs/hassbian/installation.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The easiest way to install Home Assistant on your Raspberry Pi is by using HASSb
1717
3. Ensure your Raspberry Pi has access to the internet.
1818
4. Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 5 minutes.
1919

20-
These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk). And additioning info is available in this [video](https://www.youtube.com/watch?v=tCGlQSsQ-Mc).
20+
These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk). Additional information is available in this [video](https://www.youtube.com/watch?v=tCGlQSsQ-Mc).
2121

2222
After initial boot, you can reach Home Assistant in your browser at [http://hassbian.local:8123]. If you want to login via SSH, the default username is `pi` and password is `raspberry` (please change this by running `passwd`). The Home Assistant configuration is located at `/home/homeassistant/.homeassistant/`.
2323

source/_docs/installation/raspberry-pi-all-in-one.markdown

-6
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,6 @@ To upgrade the All-In-One setup manually:
7474
* Type `exit` to logout the hass user and return to the `pi` user.
7575
</div>
7676

77-
To upgrade with fabric:
78-
79-
* Login to Raspberry Pi `ssh pi@your_raspberry_pi_ip`
80-
* Change to `cd ~/fabric-home-assistant`
81-
* Run `fab upgrade_homeassistant`
82-
8377
After upgrading, you can restart Home Assistant a few different ways:
8478

8579
* Restarting the Raspberry Pi `sudo reboot`

source/_docs/mqtt/discovery.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ A motion detection device which can be represented by a [binary sensor](/compone
5454
- State topic: `homeassistant/binary_sensor/garden/state`
5555
- Payload: `{"name": "garden", "device_class": "motion"}`
5656

57-
To create a new sensor manually. For more details please refer to the [MQTT testing section](/component/mqtt_testing).
57+
To create a new sensor manually. For more details please refer to the [MQTT testing section](/docs/mqtt/testing/).
5858

5959
```bash
6060
$ mosquitto_pub -h 127.0.0.1 -p 1883 -t "homeassistant/binary_sensor/garden/config" -m '{"name": "garden", "device_class": "motion"}'
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
---
2+
layout: post
3+
title: "IKEA Trådfri: Internet of Things done right"
4+
description: "We analyzed the recently released IKEA Trådfri hardware. It is the perfect companion hardware to Home Assistant."
5+
date: 2017-04-17 08:04:05 +0000
6+
date_formatted: "April 17, 2017"
7+
author: Paulus Schoutsen
8+
author_twitter: balloob
9+
comments: true
10+
categories: Internet-of-Things
11+
og_image: /images/blog/2017-04-tradfri/gateway.jpg
12+
---
13+
14+
Last month IKEA released a new home automation lineup called [Trådfri][tradfri]. It consists of white bulbs, dimming remotes, color temperature remotes and motion sensors. After almost two weeks of research, we have come to the conclusion that this is going to be the perfect companion hardware to work with Home Assistant. Here is the gist of our breakdown:
15+
16+
- **Works out of the box.** You can get started by just buying the already paired light and remote. You only need to buy the gateway if you want to set time-based rules for your lights or use your phone as a remote.
17+
- **Local only hub.** No cloud that gathers data about how you live your life and it will keep working even if IKEA stops supporting it.
18+
- **Based on open standards.** It uses Zigbee between devices and CoAP/dTLS to talk to the gateway. This means that you are not locked into a single vendor. You can pair it with Philips Hue bulbs and other compatible vendors.
19+
- **Affordable.** Lights start at $12 standalone and $20 if bundled with a remote (USA prices).
20+
- **Useful design.** The gateway has built-in space to hide excess cables and remotes come with magnetic holders for on the wall.
21+
- **Able to subscribe to changes (local push).** Automations will be able to instantly respond to changes to device states by subscribing to the gateway for changes.
22+
- **Full integration in Home Assistant 0.43 (scheduled for release April 22).** Our community built a standalone library [pytradfri] and we use it in Home Assistant. Home Assistant will automatically discover gateways on your network and guide the user to set them up.
23+
- **Downside: no integration with other systems yet.** There are rumors that Homekit support will land in October and I expect both Google Home and Amazon Echo to eventually add support. Use Home Assistant to connect them all in the meanwhile.
24+
- **Semi-downside: you can’t control your lights remotely.** Because it’s local only, you won’t be able to control your lights remotely unless via a third-party integration.
25+
26+
Full breakdown available after clicking read more.
27+
28+
_(Note: we are not affiliated with IKEA nor do we receive commission for sales. We are just big fans of their new line up!)_
29+
30+
<!--more-->
31+
## {% linkable_title Works out of the box %}
32+
33+
IKEA Trådfri focuses on the basics: making a product that works out of the box. They sell various dimming kits. Each contain a light and a remote paired to control the light. You put the light into the socket, slide the battery into the remote and. it. works. No need to purchase a gateway, download an app and use your phone to set it up. Heck, you don’t even need internet to get started!
34+
35+
You will only need to buy the gateway if you want to use your phone as a remote or set up home automation.
36+
37+
## {% linkable_title Only works locally %}
38+
39+
The gateway only works locally. It only reaches out to the internet to synchronize the time and to check for firmware updates. This is awesome for many different reasons.
40+
41+
**Privacy & Security.** No one but yourself will have access to the state of your house. And inside your house your communication with the gateway is encrypted.
42+
43+
**Reliability & Speed.** All communication will always happen locally. Even if your internet will go out, you can still control your lights and your automations will still run. Even if IKEA would decide to drop support it will still continue to work.
44+
45+
Check out [this blog post by Matthew Garrett][mjg59] for a more in-depth analysis of the security of the gateway. His conclusion:
46+
47+
<blockquote>
48+
Overall: as far as design goes, this is one of the most secure IoT-style devices I've looked at. I haven't examined the COAP stack in detail to figure out whether it has any exploitable bugs, but the attack surface is pretty much as minimal as it could be while still retaining any functionality at all. I'm impressed.
49+
</blockquote>
50+
51+
## {% linkable_title Based on open standards %}
52+
53+
IKEA Trådfri devices use the open standard Zigbee to communicate. The gateway speaks both Zigbee and connects to your network to offer an API based on the open standard CoAP. The API communication is secured via the open standard DTLS.
54+
55+
Because it’s based on Zigbee, you don’t have to just buy IKEA devices the rest of your life. For example, Philips Hue lights will pair just fine with the IKEA gateway.
56+
57+
Note that there are reports that the other way around, pairing an IKEA light to the Philips Hue hub is currently not possible. IKEA is working on it according to [a post by Philips Hue support][hue-support]:
58+
59+
<blockquote>
60+
The non-interoperability between the newly launched IKEA smart lighting products and the Philips Hue bridge has been analyzed. One of the issues found is that the IKEA bulbs report their ProfileID as corresponding to the ZigBee Home Automation (ZHA) profile rather than the ZigBee Light Link (ZLL) profile. As the IKEA bulbs do not behave fully compliant with the ZLL standard, they are rejected by the Hue bridge. IKEA is aware of this and informed us their intent is to have the IKEA smart lighting bulbs to work with the Philips Hue bridge.
61+
</blockquote>
62+
63+
## {% linkable_title Affordable %}
64+
65+
A white IKEA light bulb that just supports dimming starts at $12. You’ll have to shell out $18 If you want a white bulb that can control the light temperature to allow for different shades of white (relax, cool, focus etc). These prices are slightly lower than the competition. Right now on Amazon the cheapest just-dimming white bulbs come in at $15.
66+
67+
However what really differentiates this system is the availability of all the cheap remotes and motion sensors. Ranging between $20 and $27 you get a light and a remote. Standalone Zigbee remotes on Amazon currently start at $21!
68+
69+
Remotes are [a very important aspect of home automation][perfect]. The electricity has to be always on for the bulbs to function so you’ll need Zigbee switches and remotes to control your lights. The fact that they are so cheap will really help with adoption.
70+
71+
<p class='img'>
72+
<img src='/images/blog/2017-04-tradfri/prices.png' />
73+
Prices of the various available dimming kits.
74+
</p>
75+
76+
## {% linkable_title Useful design %}
77+
78+
The lights and gateway are all made with a simple design and will easily blend into your home. They did sneak in some great and useful things. You can slide the cover off the gateway and open it up. Inside is a mini case for the actual electronics but mainly it’s just empty space so you can roll up any excess network and usb cable from the hub inside!
79+
80+
<p class='img'>
81+
<img src='/images/blog/2017-04-tradfri/gateway.jpg' />
82+
The cables you don't need can be hidden in the gateway.
83+
</p>
84+
85+
Another nice feature is that the remote comes with a magnetic mount for the wall.
86+
87+
## {% linkable_title Able to subscribe to changes (local push) %}
88+
89+
This is a feature that I am really excited about. By being able to subscribe to changes in the Zigbee network Home Assistant will be able to instantly be notified about changes and trigger automations if necessary.
90+
91+
This means that you will be able to turn the power on for a light and see it instantly turn on in Home Assistant.
92+
93+
[_(Learn more about the different ways IoT devices broadcast changes)_][classification]
94+
95+
## {% linkable_title Full integration in Home Assistant 0.43 (scheduled for release April 22) %}
96+
97+
Home Assistant will automatically discover gateways on your network and guide the user to set them up.
98+
99+
Once IKEA Trådfri got released, our community, lead by [Patrik], got quickly organized and started analyzing the different aspects [in our forums][forums]. I am happy to say that the end result is a standalone Python library [pytradfri] to control the gateway. This means that starting from our next release, Home Assistant 0.43, we will auto discover your gateway and integrate all your lights.
100+
101+
The initial version of our integration will not yet stream events from the gateway. We’re still working on figuring out that part of the API.
102+
103+
<p class='img'>
104+
<img src='/images/blog/2017-04-tradfri/discovery.png' />
105+
After automatic discovery, Home Assistant will ask the user to finish pairing with the gateway.
106+
</p>
107+
108+
## {% linkable_title Downside: not many integrations yet %}
109+
110+
The one major downside right now is that there are not many integrations yet because the system is brand new. There are [rumors] that Homekit is planned for October. And given the way the API is set up, I expect Google Home and Amazon Echo (Alexa) to eventually announce integration too.
111+
112+
Since Home Assistant does integrate with it, you can use Home Assistant to bridge to these systems. For Homekit use [Homebridge] with the [Home Assistant plugin][hb-hass]. For integration with Google Home and Amazon Echo use [the Emulated Hue component][emulated_hue]. For Google Home you can also use [the API.ai integration][apiai] and Amazon Echo can also work with [Haaska].
113+
114+
## {% linkable_title Semi-downside: you can’t control your lights remotely %}
115+
116+
Because the system is local only, you won’t be able to control your lights remotely. As with the previous downside, you will be able to use Home Assistant to make your system available remotely.
117+
118+
Classified this as a semi-downside because besides showing off, the actual use cases are very rare. Although it makes [great marketing material].
119+
120+
## {% linkable_title Conclusion %}
121+
122+
With Trådfri, IKEA has managed to put out an affordable and secure home automation system that does not compromise on functionality or design. There are still some downsides which I expect to get resolved in the future.
123+
124+
As it currently stands, this is going to be the perfect companion hardware to work with Home Assistant: local, affordable, secure. And as cherry on the pie, local push will make us aware of changes right away.
125+
126+
[tradfri]: http://www.ikea.com/us/en/catalog/categories/departments/lighting/36812/
127+
[mjg59]: http://mjg59.dreamwidth.org/47803.html
128+
[hue-support]: https://developers.meethue.com/content/philips-hue-and-ikea-tr%C3%A5dfri#comment-2686
129+
[perfect]: https://home-assistant.io/blog/2016/01/19/perfect-home-automation/#you-should-not-have-to-adapt-to-technology
130+
[Patrik]: https://github.com/ggravlingen
131+
[forums]: https://community.home-assistant.io/t/ikea-tradfri-gateway-zigbee/14788
132+
[pytradfri]: https://github.com/ggravlingen/pytradfri
133+
[rumors]: https://github.com/bwssytems/ha-bridge/issues/570#issuecomment-293505087
134+
[Homebridge]: https://github.com/nfarina/homebridge
135+
[hb-hass]: https://github.com/home-assistant/homebridge-homeassistant
136+
[emulated_hue]: https://home-assistant.io/components/emulated_hue/
137+
[apiai]: https://home-assistant.io/components/apiai/
138+
[Haaska]: https://github.com/auchter/haaska
139+
[great marketing material]: https://i2.wp.com/blog.smartthings.com/wp-content/uploads/2014/06/summer-vacay-683x405-blog.png?fit=683%2C405&ssl=1
140+
[classification]: https://home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things/

0 commit comments

Comments
 (0)