This is a big release as weβve completely overhauled the internals of Home Assistant. When I initially wrote Home Assistant, still figuring out the ins and outs of Python, I went for an approach that I was familiar with for an application with many moving parts: threads and locks. This approach has served us well over the years but it was slower than it needed to be, especially on limited hardware.
+
+
This all changed when @bbangert came around and took on the tough job to migrate the core over to use asynchronous programming. He did an amazing job and I am happy to say that the initial port has been done and is included in this release! On top of that, we have been able to keep our simple and straightforward API at the same time. We are still in the process of migrating more and more components over to the asynchronous API, so expect more speedups and awesome features in the upcoming releases.
+
+
SleepIQ and OpenALPR
+
+
There now is support for two new super cool things: Beds and license plates. @technicalpickles created a SleepIQ component that let you monitor the sensor data of your bed. @pvizeli has added license plate recognition based on OpenALPR! This means that you can now be notified about which car is parked on your driveway or in your garage. I also would like to use this opportunity to give a big shoutout to @pvizeli for being such an awesome member of our community. He joined us at the end of June and has helped crush bugs and add awesome features ever since (65 pull requests already!).
+
+
Configuration validation
+
+
On the voluptuous front we have also made great progress. We were able to fully remove the legacy config helpers and have migrated 323 of the 346 components and platforms that needed migrating! This does mean that for some components the configuration has slightly changed, make sure to check out the breaking changes section at the bottom for more info. Thanks everybody for reviewing the Pull requests, testing the changes, and reporting issues.
+
+
Delayed Release
+
+
As you might have noticed, this release has been delayed by 5 days. This was due to a rare, difficult to reproduce problem with the Python interpreter. A huuuuge thanks to all the people that have helped countless hours in researching, debugging and fixing this issue: @bbangert, @turbokongen, @lwis, @kellerza, @technicalpickles, @pvizeli, @persandstrom and @joyrider3774. I am grateful to have all of you as part of the Home Assistant community.
+
+
All changes
+
+
+
+
+
Convert core from thread-based to be async-based (@bbangert, @balloob)
β¦donβt hesitate to use our Forum or join us for a little chat. The release notes have comments enabled but itβs preferred if you the former communication channels. Thanks.
+
+]]>
+
+
@@ -1813,40 +1888,6 @@ target_dir /tmp
Add support for OPTIONS HTTP command to get CORS working (@JshWright)
-]]>
-
-
-
-
-
- 2016-06-01T18:34:00+00:00
- https://home-assistant.io/blog/2016/06/01/community-highlights
- Our community is amazingly helpful and creative. If you havenβt been there yet, make sure to stop by our chat room and come hang out with us. In this blog post I want to highlight a few recent awesome projects and videos from the community.
-
-
SceneGen - cli for making scenes
-
-
SceneGen is a new command line utility developed by Andrew Cockburn that helps with creating scene configurations for Home Assistant. To use it, you put your house in the preferred state, run SceneGen and it will print the scene configuration for your current states.
-
-
Videos
-
-
Nick Touran has been working on integrating IR remotes with Home Assistant. He made it into a component which should be available in the next release which should arrive in a couple of days. In the meanwhile, he wrote up a blog post and has put out a video showing the new integration, very cool!
-
-
-
-
-
-
Ben from BRUH Automation has put out another great video how to get started tracking your location in Home Assistant using MQTT and OwnTracks.
-
-
-
-
-
-
Muhammed Kilic has created a video how to make your Home Assistant instance accessible from the internet using the free dynamic DNS service DuckDNS.
diff --git a/blog/2014/12/26/home-control-home-automation-and-the-smart-home/index.html b/blog/2014/12/26/home-control-home-automation-and-the-smart-home/index.html
index 04b6e6b918..9a32f2b132 100644
--- a/blog/2014/12/26/home-control-home-automation-and-the-smart-home/index.html
+++ b/blog/2014/12/26/home-control-home-automation-and-the-smart-home/index.html
@@ -224,6 +224,12 @@ This article will try to explain how they all relate.
diff --git a/blog/2015/02/08/looking-at-the-past/index.html b/blog/2015/02/08/looking-at-the-past/index.html
index 833f8f27ab..cae54945f4 100644
--- a/blog/2015/02/08/looking-at-the-past/index.html
+++ b/blog/2015/02/08/looking-at-the-past/index.html
@@ -200,6 +200,12 @@ Events are saved in a local database. Google Graphs is used to draw the graph. D
diff --git a/blog/2015/03/08/new-logo/index.html b/blog/2015/03/08/new-logo/index.html
index a265f3a377..3796063633 100644
--- a/blog/2015/03/08/new-logo/index.html
+++ b/blog/2015/03/08/new-logo/index.html
@@ -176,6 +176,12 @@ The old logo, the new detailed logo and the new simple logo.
diff --git a/blog/2015/03/11/release-notes/index.html b/blog/2015/03/11/release-notes/index.html
index 27c7ba3087..10003e587b 100644
--- a/blog/2015/03/11/release-notes/index.html
+++ b/blog/2015/03/11/release-notes/index.html
@@ -209,6 +209,12 @@ An initial version of voice control for Home Assistant has landed. The current i
diff --git a/blog/2015/03/22/release-notes/index.html b/blog/2015/03/22/release-notes/index.html
index a64b91244e..1c3f92cfaa 100644
--- a/blog/2015/03/22/release-notes/index.html
+++ b/blog/2015/03/22/release-notes/index.html
@@ -244,6 +244,12 @@ I (Paulus) have contributed a scene component. A user can create scenes that cap
diff --git a/blog/2015/05/14/release-notes/index.html b/blog/2015/05/14/release-notes/index.html
index c7d340dafd..06a1ef7651 100644
--- a/blog/2015/05/14/release-notes/index.html
+++ b/blog/2015/05/14/release-notes/index.html
@@ -276,6 +276,12 @@ Before diving into the newly supported devices and services, I want to highlight
diff --git a/blog/2015/06/10/release-notes/index.html b/blog/2015/06/10/release-notes/index.html
index 20eaf9699b..b9b5aea584 100644
--- a/blog/2015/06/10/release-notes/index.html
+++ b/blog/2015/06/10/release-notes/index.html
@@ -327,6 +327,12 @@ This switch platform allows you to control your motion detection setting on your
diff --git a/blog/2015/07/11/ip-cameras-arduino-kodi-efergy-support/index.html b/blog/2015/07/11/ip-cameras-arduino-kodi-efergy-support/index.html
index 12904621ba..a52d186939 100644
--- a/blog/2015/07/11/ip-cameras-arduino-kodi-efergy-support/index.html
+++ b/blog/2015/07/11/ip-cameras-arduino-kodi-efergy-support/index.html
@@ -283,6 +283,12 @@ Fabian has added support for Forecast.io to g
diff --git a/blog/2015/08/09/mqtt-raspberry-pi-squeezebox-asuswrt-support/index.html b/blog/2015/08/09/mqtt-raspberry-pi-squeezebox-asuswrt-support/index.html
index 4c5323a46f..c259256872 100644
--- a/blog/2015/08/09/mqtt-raspberry-pi-squeezebox-asuswrt-support/index.html
+++ b/blog/2015/08/09/mqtt-raspberry-pi-squeezebox-asuswrt-support/index.html
@@ -268,6 +268,12 @@ Support for Temper temperature sensors has been contributed by
+
@@ -291,12 +297,6 @@ Support for Temper temperature sensors has been contributed by
- We Have Apps Now
-
-
-
diff --git a/blog/2015/08/17/verisure-and-modern-tp-link-router-support/index.html b/blog/2015/08/17/verisure-and-modern-tp-link-router-support/index.html
index e0ac17ddfb..1b0dd40490 100644
--- a/blog/2015/08/17/verisure-and-modern-tp-link-router-support/index.html
+++ b/blog/2015/08/17/verisure-and-modern-tp-link-router-support/index.html
@@ -192,6 +192,12 @@
diff --git a/blog/2015/08/26/laundry-automation-with-moteino-mqtt-and-home-assistant/index.html b/blog/2015/08/26/laundry-automation-with-moteino-mqtt-and-home-assistant/index.html
index d734c732a3..b4ce405cf4 100644
--- a/blog/2015/08/26/laundry-automation-with-moteino-mqtt-and-home-assistant/index.html
+++ b/blog/2015/08/26/laundry-automation-with-moteino-mqtt-and-home-assistant/index.html
@@ -305,6 +305,12 @@ The automation and script syntax here is using a deprecated and no longer suppor
diff --git a/blog/2015/09/18/monitoring-with-glances-and-home-assistant/index.html b/blog/2015/09/18/monitoring-with-glances-and-home-assistant/index.html
index 70b4274777..ba092a018c 100644
--- a/blog/2015/09/18/monitoring-with-glances-and-home-assistant/index.html
+++ b/blog/2015/09/18/monitoring-with-glances-and-home-assistant/index.html
@@ -234,6 +234,12 @@ Glances web server started on http://0.0.0.0:61208/
diff --git a/blog/2015/09/19/alarm-sonos-and-itunes-support/index.html b/blog/2015/09/19/alarm-sonos-and-itunes-support/index.html
index 08cd2816ee..cd6a53c144 100644
--- a/blog/2015/09/19/alarm-sonos-and-itunes-support/index.html
+++ b/blog/2015/09/19/alarm-sonos-and-itunes-support/index.html
@@ -219,6 +219,12 @@ Automation has gotten a lot of love. It now supports conditions, multiple trigge
diff --git a/blog/2015/10/05/home-assistant-goes-geo-with-owntracks/index.html b/blog/2015/10/05/home-assistant-goes-geo-with-owntracks/index.html
index 2997360d05..9a5a70efd2 100644
--- a/blog/2015/10/05/home-assistant-goes-geo-with-owntracks/index.html
+++ b/blog/2015/10/05/home-assistant-goes-geo-with-owntracks/index.html
@@ -199,6 +199,12 @@ Map in Home Assistant showing two people and three zones (home, school, work)
diff --git a/blog/2015/10/11/measure-temperature-with-esp8266-and-report-to-mqtt/index.html b/blog/2015/10/11/measure-temperature-with-esp8266-and-report-to-mqtt/index.html
index 924dd14d43..fa249f47d6 100644
--- a/blog/2015/10/11/measure-temperature-with-esp8266-and-report-to-mqtt/index.html
+++ b/blog/2015/10/11/measure-temperature-with-esp8266-and-report-to-mqtt/index.html
@@ -408,6 +408,12 @@ Home Assistant will keep track of historical values and allow you to integrate i
diff --git a/blog/2015/10/26/firetv-and-radiotherm-now-supported/index.html b/blog/2015/10/26/firetv-and-radiotherm-now-supported/index.html
index 2a7f0ab5bb..c6cdd82daf 100644
--- a/blog/2015/10/26/firetv-and-radiotherm-now-supported/index.html
+++ b/blog/2015/10/26/firetv-and-radiotherm-now-supported/index.html
@@ -210,6 +210,12 @@ This makes more sense as most people run Home Assistant as a daemon
diff --git a/blog/2015/12/10/activating-tasker-tasks-from-home-assistant-using-command-line-switches/index.html b/blog/2015/12/10/activating-tasker-tasks-from-home-assistant-using-command-line-switches/index.html
index 4f8b07dd8c..1f3b5ad960 100644
--- a/blog/2015/12/10/activating-tasker-tasks-from-home-assistant-using-command-line-switches/index.html
+++ b/blog/2015/12/10/activating-tasker-tasks-from-home-assistant-using-command-line-switches/index.html
@@ -225,6 +225,12 @@ This is where weβll configure our task, so select the plus icon to select an a
diff --git a/blog/2016/01/30/insteon-lifx-twitter-and-zigbee/index.html b/blog/2016/01/30/insteon-lifx-twitter-and-zigbee/index.html
index 20241c70b7..92aa31c6f8 100644
--- a/blog/2016/01/30/insteon-lifx-twitter-and-zigbee/index.html
+++ b/blog/2016/01/30/insteon-lifx-twitter-and-zigbee/index.html
@@ -208,6 +208,12 @@ Example of the new views in the frontend. Learn mor
diff --git a/blog/2016/02/20/community-highlights/index.html b/blog/2016/02/20/community-highlights/index.html
index ee81264eff..ef493ad1ed 100644
--- a/blog/2016/02/20/community-highlights/index.html
+++ b/blog/2016/02/20/community-highlights/index.html
@@ -219,6 +219,12 @@ Hold your NFC tag against the belly of Garfield to unlock the alarm.
diff --git a/blog/2016/04/30/ibeacons-part-1-making-presence-detection-work-better/index.html b/blog/2016/04/30/ibeacons-part-1-making-presence-detection-work-better/index.html
index c3fe9c6c13..977132d2ee 100644
--- a/blog/2016/04/30/ibeacons-part-1-making-presence-detection-work-better/index.html
+++ b/blog/2016/04/30/ibeacons-part-1-making-presence-detection-work-better/index.html
@@ -299,6 +299,12 @@ For example, my wife works next door - and I couldnβt detect whether sheβs a
diff --git a/blog/2016/07/06/pocketchip-running-home-assistant/index.html b/blog/2016/07/06/pocketchip-running-home-assistant/index.html
index 9e030c18cf..77ee715c1f 100644
--- a/blog/2016/07/06/pocketchip-running-home-assistant/index.html
+++ b/blog/2016/07/06/pocketchip-running-home-assistant/index.html
@@ -218,6 +218,12 @@ Over a year ago I participated in the
+
@@ -241,12 +247,6 @@ Over a year ago I participated in the
- We Have Apps Now
-
-
-
diff --git a/blog/2016/07/16/sqlalchemy-knx-join-simplisafe/index.html b/blog/2016/07/16/sqlalchemy-knx-join-simplisafe/index.html
index e56e1dd1eb..efaa95cc7f 100644
--- a/blog/2016/07/16/sqlalchemy-knx-join-simplisafe/index.html
+++ b/blog/2016/07/16/sqlalchemy-knx-join-simplisafe/index.html
@@ -218,6 +218,12 @@
diff --git a/blog/2016/07/23/internet-of-things-data-exploration-with-jupyter-notebooks/index.html b/blog/2016/07/23/internet-of-things-data-exploration-with-jupyter-notebooks/index.html
index 68edbcce7a..15f823f340 100644
--- a/blog/2016/07/23/internet-of-things-data-exploration-with-jupyter-notebooks/index.html
+++ b/blog/2016/07/23/internet-of-things-data-exploration-with-jupyter-notebooks/index.html
@@ -235,6 +235,12 @@ One of the graphs created with this tutorial.
diff --git a/blog/2016/07/28/esp8266-and-micropython-part1/index.html b/blog/2016/07/28/esp8266-and-micropython-part1/index.html
index 0b49585ac4..0cc7e30af1 100644
--- a/blog/2016/07/28/esp8266-and-micropython-part1/index.html
+++ b/blog/2016/07/28/esp8266-and-micropython-part1/index.html
@@ -322,6 +322,12 @@ If a module is missing then you need to download it from the
+
@@ -345,12 +351,6 @@ If a module is missing then you need to download it from the
- We Have Apps Now
-
-
-
diff --git a/blog/2016/07/30/custom-frontend-panels-jupyter-notebooks-directv/index.html b/blog/2016/07/30/custom-frontend-panels-jupyter-notebooks-directv/index.html
index 5d087dab5c..d464feb2ec 100644
--- a/blog/2016/07/30/custom-frontend-panels-jupyter-notebooks-directv/index.html
+++ b/blog/2016/07/30/custom-frontend-panels-jupyter-notebooks-directv/index.html
@@ -237,6 +237,12 @@
diff --git a/blog/2016/08/31/esp8266-and-micropython-part2/index.html b/blog/2016/08/31/esp8266-and-micropython-part2/index.html
index 05d85b2a4c..d8fed47b27 100644
--- a/blog/2016/08/31/esp8266-and-micropython-part2/index.html
+++ b/blog/2016/08/31/esp8266-and-micropython-part2/index.html
@@ -266,6 +266,12 @@ So, part 1 of ESP8266
Two weeks ago, September 17 marked our 3 year anniversary. In this time Home Assistant managed to grow from a simple script that turned on my lights when the sun set to a kick ass open source project with the best community an open-source project could wish for. This release contains features, bug fixes and performance tweaks by a total of 50 different people! We have also managed to cross the 1000 forks on GitHub. Talking about momentum!
+
+
This is a big release as weβve completely overhauled the internals of Home Assistant. When I initially wrote Home Assistant, still figuring out the ins and outs of Python, I went for an approach that I was familiar with for an application with many moving parts: threads and locks. This approach has served us well over the years but it was slower than it needed to be, especially on limited hardware.
+
+
This all changed when @bbangert came around and took on the tough job to migrate the core over to use asynchronous programming. He did an amazing job and I am happy to say that the initial port has been done and is included in this release! On top of that, we have been able to keep our simple and straightforward API at the same time. We are still in the process of migrating more and more components over to the asynchronous API, so expect more speedups and awesome features in the upcoming releases.
+
+
SleepIQ and OpenALPR
+
+
There now is support for two new super cool things: Beds and license plates. @technicalpickles created a SleepIQ component that let you monitor the sensor data of your bed. @pvizeli has added license plate recognition based on OpenALPR! This means that you can now be notified about which car is parked on your driveway or in your garage. I also would like to use this opportunity to give a big shoutout to @pvizeli for being such an awesome member of our community. He joined us at the end of June and has helped crush bugs and add awesome features ever since (65 pull requests already!).
+
+
Configuration validation
+
+
On the voluptuous front we have also made great progress. We were able to fully remove the legacy config helpers and have migrated 323 of the 346 components and platforms that needed migrating! This does mean that for some components the configuration has slightly changed, make sure to check out the breaking changes section at the bottom for more info. Thanks everybody for reviewing the Pull requests, testing the changes, and reporting issues.
+
+
Delayed Release
+
+
As you might have noticed, this release has been delayed by 5 days. This was due to a rare, difficult to reproduce problem with the Python interpreter. A huuuuge thanks to all the people that have helped countless hours in researching, debugging and fixing this issue: @bbangert, @turbokongen, @lwis, @kellerza, @technicalpickles, @pvizeli, @persandstrom and @joyrider3774. I am grateful to have all of you as part of the Home Assistant community.
+
+
All changes
+
+
+
+
+
Convert core from thread-based to be async-based (@bbangert, @balloob)
β¦donβt hesitate to use our Forum or join us for a little chat. The release notes have comments enabled but itβs preferred if you the former communication channels. Thanks.
+
+
+
+
+
Comments
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/blog/archives/index.html b/blog/archives/index.html
index cec814d5f0..0c7e5401f7 100644
--- a/blog/archives/index.html
+++ b/blog/archives/index.html
@@ -2801,6 +2801,38 @@
+
+
+
+
diff --git a/blog/categories/release-notes/atom.xml b/blog/categories/release-notes/atom.xml
index c7273b9dbc..c55d1d5c06 100644
--- a/blog/categories/release-notes/atom.xml
+++ b/blog/categories/release-notes/atom.xml
@@ -4,7 +4,7 @@
- 2016-09-28T08:38:15+00:00
+ 2016-09-29T04:42:54+00:00https://home-assistant.io/
@@ -13,6 +13,151 @@
Octopress
+
+
+
+ 2016-09-29T03:04:05+00:00
+ https://home-assistant.io/blog/2016/09/29/async-sleepiq-emoncms-stocks
+ SleepIQ and OpenALPR
+
+There now is support for two new super cool things: Beds and license plates. [@technicalpickles] created a [SleepIQ] component that let you monitor the sensor data of your bed. [@pvizeli] has added license plate recognition based on [OpenALPR]! This means that you can now be notified about which car is parked on your driveway or in your garage. I also would like to use this opportunity to give a big shoutout to [@pvizeli] for being such an awesome member of our community. He joined us at the end of June and has helped crush bugs and add awesome features ever since (65 pull requests already!).
+
+### Configuration validation
+
+On the voluptuous front we have also made great progress. We were able to fully remove the legacy config helpers and have migrated 323 of the 346 components and platforms that needed migrating! This does mean that for some components the configuration has slightly changed, make sure to check out the breaking changes section at the bottom for more info. Thanks everybody for reviewing the Pull requests, testing the changes, and reporting issues.
+
+### Delayed Release
+
+As you might have noticed, this release has been delayed by 5 days. This was due to a rare, difficult to reproduce problem with the Python interpreter. A huuuuge thanks to all the people that have helped countless hours in researching, debugging and fixing this issue: [@bbangert], [@turbokongen], [@lwis], [@kellerza], [@technicalpickles], [@pvizeli], [@persandstrom] and [@joyrider3774]. I am grateful to have all of you as part of the Home Assistant community.
+
+### All changes
+
+
+
+- Convert core from thread-based to be async-based ([@bbangert], [@balloob])
+- New [SleepIQ] support ([@technicalpickles])
+- Cover: [Vera] is now supported ([@pavoni])
+- Climate: Vera [climate] devices are now supported ([@robjohnson189])
+- Climate: [MySensors] is now supported ([@kaustubhphatak])
+- Control Home Assistant with [keyboard shortcuts][keyboard_remote] ([@deisi])
+- More voluptuous config validations ([@fabaff], [@kellerza], [@balloob])
+- New [Nuimo] controller support added ([@gross1989])
+- Sensor: [BOM] Weather component ([@tinglis1])
+- Automation: Option added to hide entity ([@milaq])
+- Sensor: [Emoncms] feeds now supported ([@joyrider])
+- Sensor: Mi Flora [plant] sensor now supported ([@open-homeautomation])
+- Logbook: Allow [filtering] entities and hide hidden entities ([@wokar])
+- Notify: [Kodi] support added ([@chrom3])
+- Notify: Support for [Simplepush] added ([@fabaff])
+- Sensor: [KNX] sensors now supported ([@daBONDi])
+- [Wink] improvements ([@w1ll1am23])
+- [ISY] improvements ([@Teagan42])
+- Link to relevant docs in config validation error messages ([@fabaff])
+- Greatly improve the performance of templates ([@balloob], [@pvizeli])
+- Notify - [Slack]: Support for username/icon ([@Khabi])
+- MQTT room detection: Away [timeout] now supported ([@mKeRix])
+- Climate: [Nest] can now control the fan ([@jawilson])
+- Modbus: Major cleanup for [Modbus] switches and sensors ([@persandstrom])
+- HTTP: Allow [passwordless] logins from whitelisted IP addresses ([@Danielhiversen])
+- Sensor: Yahoo! Finance [stocks] now supported ([@tchellomello])
+- Sensor: Set value based on incoming [email] ([@sam-io])
+- Light: White value now supported ([@mxtra], [@MartinHjelmare])
+- [InfluxDB] now allows attaching extra data ([@lwis])
+- [OpenALPR] support ([@pvizeli])
+- Minor features and bug fixes by [@fabaff], [@w1ll1am23], [@turbokongen], [@clach04], [@mKeRix], [@pvizeli], [@DavidLP], [@nvella], [@Teagan42], [@ericwclymer], [@wokar], [@kellerza], [@nkgilley], [@jawilson], [@Danielhiversen], [@ej81], [@danieljkemp], [@balloob], [@philhawthorne], [@LinuxChristian], [@milas], [@simonszu], [@Cinntax], [@irvingwa], [@sytone], [@kk7ds], [@robbiet480].
+
+### Breaking changes
+
+ - `yahooweather` default name is now `yweather`. Also min and max temperature are now correctly called `Temperature Min` and `Temperature Max`.
+ - `ffmpeg` is now a component for manage some things central. All `ffmpeg_bin` options have moved to this compoment from platforms.
+ - Config has changed for [X10] lights.
+
+### If you need help...
+...don't hesitate to use our [Forum](https://community.home-assistant.io/) or join us for a little [chat](https://gitter.im/home-assistant/home-assistant). The release notes have comments enabled but it's preferred if you the former communication channels. Thanks.
+
+[@joyrider3774]: https://github.com/joyrider3774
+[@balloob]: https://github.com/balloob
+[@bbangert]: https://github.com/bbangert
+[@chrom3]: https://github.com/chrom3
+[@Cinntax]: https://github.com/Cinntax
+[@clach04]: https://github.com/clach04
+[@daBONDi]: https://github.com/daBONDi
+[@Danielhiversen]: https://github.com/Danielhiversen
+[@danieljkemp]: https://github.com/danieljkemp
+[@DavidLP]: https://github.com/DavidLP
+[@deisi]: https://github.com/deisi
+[@ej81]: https://github.com/ej81
+[@ericwclymer]: https://github.com/ericwclymer
+[@fabaff]: https://github.com/fabaff
+[@gross1989]: https://github.com/gross1989
+[@irvingwa]: https://github.com/irvingwa
+[@jawilson]: https://github.com/jawilson
+[@joyrider]: https://github.com/joyrider
+[@kaustubhphatak]: https://github.com/kaustubhphatak
+[@kellerza]: https://github.com/kellerza
+[@Khabi]: https://github.com/Khabi
+[@kk7ds]: https://github.com/kk7ds
+[@LinuxChristian]: https://github.com/LinuxChristian
+[@lwis]: https://github.com/lwis
+[@MartinHjelmare]: https://github.com/MartinHjelmare
+[@milaq]: https://github.com/milaq
+[@milas]: https://github.com/milas
+[@mKerix]: https://github.com/mKerix
+[@mxtra]: https://github.com/mxtra
+[@nkgilley]: https://github.com/nkgilley
+[@nvella]: https://github.com/nvella
+[@open-homeautomation]: https://github.com/open-homeautomation
+[@pavoni]: https://github.com/pavoni
+[@persandstrom]: https://github.com/persandstrom
+[@philhawthorne]: https://github.com/philhawthorne
+[@pvizeli]: https://github.com/pvizeli
+[@robbiet480]: https://github.com/robbiet480
+[@robjohnson189]: https://github.com/robjohnson189
+[@sam-io]: https://github.com/sam-io
+[@simonszu]: https://github.com/simonszu
+[@sytone]: https://github.com/sytone
+[@tchellomello]: https://github.com/tchellomello
+[@Teagan42]: https://github.com/Teagan42
+[@technicalpickles]: https://github.com/technicalpickles
+[@tinglis1]: https://github.com/tinglis1
+[@turbokongen]: https://github.com/turbokongen
+[@w1ll1am23]: https://github.com/w1ll1am23
+[@wokar]: https://github.com/wokar
+
+[BOM]: /components/sensor.bom/
+[climate]: /components/climate.vera/
+[email]: /components/sensor.imap_email_content/
+[Emoncms]: /components/sensor.emoncms/
+[filtering]: /components/logbook/
+[InfluxDB]: /components/influxdb/
+[ISY]: /components/isy994/
+[KNX]: /components/sensor.knx/
+[Kodi]: /components/notify.kodi/
+[Modbus]: /components/modbus/
+[Nest]: /components/fan.nest/
+[Nuimo]: /components/nuimo_controller/
+[OpenALPR]: /components/openalpr/
+[passwordless]: /components/http/
+[Simplepush]: /components/notify.simplepush/
+[Slack]: /components/notify.slack/
+[SleepIQ]: /components/sleepiq/
+[stocks]: /components/sensor.yahoo_finance/
+[timeout]: /components/sensor.mqtt_room/
+[Vera]: /components/cover.vera/
+[Wink]: /components/wink/
+[plant]: /components/sensor.miflora/
+[MySensors]: /components/climate.mysensors/
+[keyboard_remote]: /components/keyboard_remote
+[X10]: /components/light.x10/
+]]>
+
+
@@ -675,101 +820,6 @@ I would like to do a shoutout to [@fabianhjr]. He has started adding [typing] da
[Nest]: /components/thermostat.nest/
[filters]: /topics/templating/#home-assistant-template-extensions
[Hyperion]: /components/light.hyperion/
-]]>
-
-
-
-
-
- 2016-07-16T12:00:00+00:00
- https://home-assistant.io/blog/2016/07/16/sqlalchemy-knx-join-simplisafe
-
-
-- Config: Improved support for storing [secrets][secrets] ([@kellerza])
-- Sensor: Support for [Yahoo! Weather][yahoo-weather] ([@pvizeli])
-- Add scripts to command line to expose advanced options ([@balloob])
-- Alarm: [SimpliSafe][simplisafe] is now supported ([@w1ll1am23])
-- Core: Switch to SQLAlchemy for the Recorder component ([@rhooper])
-- Support for [Join by Joaoapps][join-joaoapps] added incl. [Join Notify][join-notify] ([@nkgilley])
-- Media Player: [Plex] will no longer spam the logs if server goes offline ([@dale3h])
-- Sensor: [APCUPSd Sensor][apcupsd-sensor] now supports names, icons and units ([@dale3h])
-- Lock: [Verisure] entities will now use name instead of serial number for entity id ([@turbokongen])
-- [StatsD] can now also export attributes ([@bah2830])
-- Support for [KNX] added ([@usul27])
-- Switch: [TPLink] HS100/HS110 now supported ([@GadgetReactor])
-- Stability fixes for [RFXtrx] ([@Danielhiversen])
-- Tweaks to [Z-Wave] ([@turbokongen])
-- Light: [Brightness] now clamped to 0-255 ([@keatontaylor])
-- Thermostat: [Radiotherm] HVAC mode now supported ([@danieljkemp])
-- Sensor: [Google Travel] times can now use dynamic locations for start/end ([@bah2830])
-- Notify: Allow sending photos to [Telegram] ([@pvizeli])
-- Frontend: Improve loading times ([@balloob])
-- Frontend: Fix stream not reconnecting after standby ([@balloob])
-- Frontend: Wait up to two seconds for new state before resetting toggle after toggling state ([@balloob])
-
-### Hotfix 0.24.1 - July 21
-
-Quick hot fix after we found a bug in the migrator where it wouldn't work with a database in a non-standard location. Thanks to [@n8henrie] and [@AlucardZero].
-
-### Breaking changes
-
-- Migrating existing databases (see above).
-- The [APCUPSd Sensor][apcupsd-sensor] was updated. This will need that you modify your `configuration.yaml` file.
-- Entity IDs of Verisure locks will change. This is a one time change but should improve readability.
-
-[@bah2830]: https://github.com/bah2830/
-[@balloob]: https://github.com/balloob/
-[@dale3h]: https://github.com/dale3h/
-[@danieljkemp]: https://github.com/danieljkemp
-[@GadgetReactor]: https://github.com/GadgetReactor
-[@keatontaylor]: https://github.com/keatontaylor
-[@kellerza]: https://github.com/kellerza/
-[@nkgilley]: https://github.com/nkgilley
-[@pvizeli]: https://github.com/pvizeli/
-[@rhooper]: https://github.com/rhooper/
-[@turbokongen]: https://github.com/turbokongen/
-[@usul27]: https://github.com/usul27
-[@w1ll1am23]: https://github.com/w1ll1am23/
-[@n8henrie]: https://github.com/n8henrie/
-[@AlucardZero]: https://github.com/AlucardZero/
-[@Danielhiversen]: https://github.com/danielhiversen
-
-
-[apcupsd-sensor]: /components/sensor.apcupsd/
-[Brightness]: /components/light/
-[CARTO]: https://carto.com/
-[Google Travel]: /components/sensor.google_travel_time/
-[imap-sensor]: /component/sensor.imap/
-[join-joaoapps]: /components/joaoapps_join/
-[join-notify]: /components/notify.joaoapps_join/
-[KNX]: /components/knx/
-[MapQuest]: https://www.mapquest.com/
-[Plex]: /components/media_player.plex/
-[Radiotherm]: /components/thermostat.radiotherm/
-[recorder]: /components/recorder/
-[secrets]: /topics/secrets/
-[simplisafe]: /components/alarm_control_panel.simplisafe/
-[SQLAlchemy]: http://www.sqlalchemy.org/
-[StatsD]: /components/statsd/
-[Telegram]: /components/notify.telegram/
-[TPLink]: /components/switch.tplink/
-[Verisure]: /components/lock.verisure/
-[yahoo-weather]: /components/sensor.yweather/
-[Z-Wave]: /components/zwave/
-[RFXtrx]: //components/rfxtrx/
]]>
diff --git a/blog/categories/release-notes/index.html b/blog/categories/release-notes/index.html
index cf71b954e3..7b58ff8dd8 100644
--- a/blog/categories/release-notes/index.html
+++ b/blog/categories/release-notes/index.html
@@ -98,6 +98,38 @@
Two weeks ago, September 17 marked our 3 year anniversary. In this time Home Assistant managed to grow from a simple script that turned on my lights when the sun set to a kick ass open source project with the best community an open-source project could wish for. This release contains features, bug fixes and performance tweaks by a total of 50 different people! We have also managed to cross the 1000 forks on GitHub. Talking about momentum!
+
+
This is a big release as weβve completely overhauled the internals of Home Assistant. When I initially wrote Home Assistant, still figuring out the ins and outs of Python, I went for an approach that I was familiar with for an application with many moving parts: threads and locks. This approach has served us well over the years but it was slower than it needed to be, especially on limited hardware.
+
+
This all changed when @bbangert came around and took on the tough job to migrate the core over to use asynchronous programming. He did an amazing job and I am happy to say that the initial port has been done and is included in this release! On top of that, we have been able to keep our simple and straightforward API at the same time. We are still in the process of migrating more and more components over to the asynchronous API, so expect more speedups and awesome features in the upcoming releases.
+
+
SleepIQ and OpenALPR
+
+
There now is support for two new super cool things: Beds and license plates. @technicalpickles created a SleepIQ component that let you monitor the sensor data of your bed. @pvizeli has added license plate recognition based on OpenALPR! This means that you can now be notified about which car is parked on your driveway or in your garage. I also would like to use this opportunity to give a big shoutout to @pvizeli for being such an awesome member of our community. He joined us at the end of June and has helped crush bugs and add awesome features ever since (65 pull requests already!).
+
+
Configuration validation
+
+
On the voluptuous front we have also made great progress. We were able to fully remove the legacy config helpers and have migrated 323 of the 346 components and platforms that needed migrating! This does mean that for some components the configuration has slightly changed, make sure to check out the breaking changes section at the bottom for more info. Thanks everybody for reviewing the Pull requests, testing the changes, and reporting issues.
+
+
Delayed Release
+
+
As you might have noticed, this release has been delayed by 5 days. This was due to a rare, difficult to reproduce problem with the Python interpreter. A huuuuge thanks to all the people that have helped countless hours in researching, debugging and fixing this issue: @bbangert, @turbokongen, @lwis, @kellerza, @technicalpickles, @pvizeli, @persandstrom and @joyrider3774. I am grateful to have all of you as part of the Home Assistant community.
+
+
All changes
+
+
+
+
+
Convert core from thread-based to be async-based (@bbangert, @balloob)
β¦donβt hesitate to use our Forum or join us for a little chat. The release notes have comments enabled but itβs preferred if you the former communication channels. Thanks.
-The first release of Micropython for ESP8266 was delivered a couple of weeks ago. The documentation covers a lot of ground. This post is providing only a little summary which should get you started.
-
-
Until a couple of weeks ago, the pre-built MicroPython binary for the ESP8266 was only available to backers of the Kickstarter campaign. This has changed now and it is available to the public for download.
+The first release of Micropython for ESP8266 was delivered a couple of weeks ago. The documentation covers a lot of ground. This post is providing only a little summary which should get you started.
+
+
Until a couple of weeks ago, the pre-built MicroPython binary for the ESP8266 was only available to backers of the Kickstarter campaign. This has changed now and it is available to the public for download.
Our community is amazingly helpful and creative. If you havenβt been there yet, make sure to stop by our chat room and come hang out with us. In this blog post I want to highlight a few recent awesome projects and videos from the community.
-
-
SceneGen - cli for making scenes
-
-
SceneGen is a new command line utility developed by Andrew Cockburn that helps with creating scene configurations for Home Assistant. To use it, you put your house in the preferred state, run SceneGen and it will print the scene configuration for your current states.
-
-
Videos
-
-
Nick Touran has been working on integrating IR remotes with Home Assistant. He made it into a component which should be available in the next release which should arrive in a couple of days. In the meanwhile, he wrote up a blog post and has put out a video showing the new integration, very cool!
-
-
-
-
-
-
Ben from BRUH Automation has put out another great video how to get started tracking your location in Home Assistant using MQTT and OwnTracks.
-
-
-
-
-
-
Muhammed Kilic has created a video how to make your Home Assistant instance accessible from the internet using the free dynamic DNS service DuckDNS.
Our community is amazingly helpful and creative. If you havenβt been there yet, make sure to stop by our chat room and come hang out with us. In this blog post I want to highlight a few recent awesome projects and videos from the community.
+
+
SceneGen - cli for making scenes
+
+
SceneGen is a new command line utility developed by Andrew Cockburn that helps with creating scene configurations for Home Assistant. To use it, you put your house in the preferred state, run SceneGen and it will print the scene configuration for your current states.
+
+
Videos
+
+
Nick Touran has been working on integrating IR remotes with Home Assistant. He made it into a component which should be available in the next release which should arrive in a couple of days. In the meanwhile, he wrote up a blog post and has put out a video showing the new integration, very cool!
+
+
+
+
+
+
Ben from BRUH Automation has put out another great video how to get started tracking your location in Home Assistant using MQTT and OwnTracks.
+
+
+
+
+
+
Muhammed Kilic has created a video how to make your Home Assistant instance accessible from the internet using the free dynamic DNS service DuckDNS.
After 2.5 years I think we can proudly say: Home Assistant is a success. I write we because Home Assistant is no longer a one-person side project. It has become the side project of many people who spend countless hours on making Home Assistant the best home automation software out there. To acknowledge this we migrated the repositories from being under my name to be under our own organisation on GitHub.
-
-
On our journey weβve reached many noteworthy milestones:
-
-
-
#1 on HackerNews
-
Featured on ProductHunt
-
Trending repository on GitHub
-
3000 stars on GitHub
-
1.5 million page views on our website
-
Speaker at OpenIoT Summit 2016
-
-
-
All these accomplishments are a nice pat on the back but our journey is far from over. There are a lot of challenges ahead if we want to become the go to solution for home automation for everyone.
-
-
Until now the focus has been on making a platform that developers love to use. A platform that is simple but customizable. A platform that is both powerful and reliable. But most important: a platform that is local and open. Home Assistant does a great job at all these things.
-
-
There will be some major challenges ahead of us to target groups other than developers. Easy installation and easy configuration being the #1. Iβm sure that weβll be able to eventually achieve these goals. I canβt say yet how or when. As with everything Home Assistant, weβll take tiny steps, gathering feedback along the way to make sure weβre solving the right problems.
-
-
I am confident that we will get there because we are set up for success: we have a robust architecture, high test coverage and an active community of world class developers and users. On top of that, we use Python which allows us to move fast and tackle complex problems in elegant ways. It is so easy to learn that it allows any programmer, experienced or not, to contribute support for devices and services. Itβs as simple as filling in the blanks.
-
-
I would like to put out a big thank you to all our contributors who make Home Assistant what it is today. It doesnβt matter if it is form of code, documentation or giving support in our chat room or forums. You. all. rock.
After 2.5 years I think we can proudly say: Home Assistant is a success. I write we because Home Assistant is no longer a one-person side project. It has become the side project of many people who spend countless hours on making Home Assistant the best home automation software out there. To acknowledge this we migrated the repositories from being under my name to be under our own organisation on GitHub.
+
+
On our journey weβve reached many noteworthy milestones:
+
+
+
#1 on HackerNews
+
Featured on ProductHunt
+
Trending repository on GitHub
+
3000 stars on GitHub
+
1.5 million page views on our website
+
Speaker at OpenIoT Summit 2016
+
+
+
All these accomplishments are a nice pat on the back but our journey is far from over. There are a lot of challenges ahead if we want to become the go to solution for home automation for everyone.
+
+
Until now the focus has been on making a platform that developers love to use. A platform that is simple but customizable. A platform that is both powerful and reliable. But most important: a platform that is local and open. Home Assistant does a great job at all these things.
+
+
There will be some major challenges ahead of us to target groups other than developers. Easy installation and easy configuration being the #1. Iβm sure that weβll be able to eventually achieve these goals. I canβt say yet how or when. As with everything Home Assistant, weβll take tiny steps, gathering feedback along the way to make sure weβre solving the right problems.
+
+
I am confident that we will get there because we are set up for success: we have a robust architecture, high test coverage and an active community of world class developers and users. On top of that, we use Python which allows us to move fast and tackle complex problems in elegant ways. It is so easy to learn that it allows any programmer, experienced or not, to contribute support for devices and services. Itβs as simple as filling in the blanks.
+
+
I would like to put out a big thank you to all our contributors who make Home Assistant what it is today. It doesnβt matter if it is form of code, documentation or giving support in our chat room or forums. You. all. rock.
+
+
Cheers to the future!
+
+
Paulus
+
+
+
+
+
+
+
@@ -702,90 +769,6 @@ Hold your NFC tag against the belly of Garfield to unlock the alarm.
Read on →
-
-
-
-
-
-
-
-
The focus of 0.13 was on test coverage, big cheers to @rmkraus for his hard work on this. Iβm proud to announce that weβve hit the 90% test coverage of the core + important components. A big milestone for the project.
The focus of 0.13 was on test coverage, big cheers to @rmkraus for his hard work on this. Iβm proud to announce that weβve hit the 90% test coverage of the core + important components. A big milestone for the project.
-Inspried by a feature requests I started looking into the available options to do monitoring of remote hosts. The feature request is about displaying system information in a similar way than the systemmonitor sensor does it for the local system. After a while I started to think that it would be a nice addition for a small home network where no full-blown system monitoring setup is present.
+Inspried by a feature requests I started looking into the available options to do monitoring of remote hosts. The feature request is about displaying system information in a similar way than the systemmonitor sensor does it for the local system. After a while I started to think that it would be a nice addition for a small home network where no full-blown system monitoring setup is present.
I have recently merged code to refactor Home Assistant to use only UTC times internally. A much needed refactor. Iβve added some extra test coverage to time sensitive parts to ensure stability. The code has been live in the dev branch for the last 9 days and will be soon released to the master branch.
-
-
From now on all internal communication will be done in UTC: time changed events, datetime attributes of states, etc. To get the current time in UTC you can call homeassistant.util.dt.utcnow(). This is a timezone aware UTC datetime object. homeassistant.util.dt is a new util package with date helpers.
-
-
There is also such a thing as local time. Local time is based on the time zone that you have setup in your configuration.yaml. Local times should only be used for user facing information: logs, frontend and automation settings in configuration.yaml.
-
-
Setting up your time zone
-
Setting up a time zone happens in configuration.yaml. If you have no time zone setup, it will be auto detected using the existing detection code using freegeoip.net. You can find a list of compatible time zones on Wikipedia.
-
-
homeassistant:
- time_zone:America/Los_Angeles
-
-
-
-
Compatibility
-
The changes to the code are mostly backwards compatible. The old hass.track_time_change and hass.track_point_in_time use now internally two new methods: hass.track_utc_time_change and hass.track_point_in_utc_time. The usage of the old methods have not changed and should be backwards compatible.
-
-
This refactor adds a new migration for the database adding a utc_offset column to events and states. This information is currently not used but can prove useful in the future when we start analyzing the historical data.
-
-
Backwards incompatible stuff
-
-
All built-in components have been upgraded. The following list is only for people that run custom components:
-
-
-
hass.track_time_change and hass.track_point_in_time will now return a time zone aware datetime object. Python does not allow comparing a naive with an aware datetime object.
-
the sun attributes for rising and setting are now in UTC. The methods sun.next_rising(hass) and sun.next_setting(hass) are backwards compatible, just be careful if you used to read the raw attributes.
-
the API sends all times in UTC. If you use anything else besides the frontend to talk to HA, make sure it handles it differently.
I have recently merged code to refactor Home Assistant to use only UTC times internally. A much needed refactor. Iβve added some extra test coverage to time sensitive parts to ensure stability. The code has been live in the dev branch for the last 9 days and will be soon released to the master branch.
+
+
From now on all internal communication will be done in UTC: time changed events, datetime attributes of states, etc. To get the current time in UTC you can call homeassistant.util.dt.utcnow(). This is a timezone aware UTC datetime object. homeassistant.util.dt is a new util package with date helpers.
+
+
There is also such a thing as local time. Local time is based on the time zone that you have setup in your configuration.yaml. Local times should only be used for user facing information: logs, frontend and automation settings in configuration.yaml.
+
+
Setting up your time zone
+
Setting up a time zone happens in configuration.yaml. If you have no time zone setup, it will be auto detected using the existing detection code using freegeoip.net. You can find a list of compatible time zones on Wikipedia.
+
+
homeassistant:
+ time_zone:America/Los_Angeles
+
+
+
+
Compatibility
+
The changes to the code are mostly backwards compatible. The old hass.track_time_change and hass.track_point_in_time use now internally two new methods: hass.track_utc_time_change and hass.track_point_in_utc_time. The usage of the old methods have not changed and should be backwards compatible.
+
+
This refactor adds a new migration for the database adding a utc_offset column to events and states. This information is currently not used but can prove useful in the future when we start analyzing the historical data.
+
+
Backwards incompatible stuff
+
+
All built-in components have been upgraded. The following list is only for people that run custom components:
+
+
+
hass.track_time_change and hass.track_point_in_time will now return a time zone aware datetime object. Python does not allow comparing a naive with an aware datetime object.
+
the sun attributes for rising and setting are now in UTC. The methods sun.next_rising(hass) and sun.next_setting(hass) are backwards compatible, just be careful if you used to read the raw attributes.
+
the API sends all times in UTC. If you use anything else besides the frontend to talk to HA, make sure it handles it differently.
+
+
+
+
+
+
+
@@ -620,59 +688,6 @@ Home Assistant now supports --open-ui and
Most people do not like configuring things. Things just have to work, out of the box. Reaching this scenario is the goal of what we are about to introduce: our new discovery component.
-
-
The discovery component will scan the WiFi network from time to time for connected zeroconf/mDNS and uPnP devices. The intial introduction is mainly focussed on getting the right architecture in place and discovers Belkin WeMo switches and Google Chromecasts connected to your network. When found, it will load and notify the appropritate component and it will be ready to use within seconds.
-
-
Most devices still require some sort of interaction from the user after being discovered - be it a button being pressed or some sort of authentication. This is a challenge that will be solved in the future.
-
-
To enable the discovery component, add the following to your home-assistant.conf:
-
-
[discovery]
-
-
-
-
A new discovery section has been added to the Adding a new platform page with instructions how to make your platform discoverable.
Most people do not like configuring things. Things just have to work, out of the box. Reaching this scenario is the goal of what we are about to introduce: our new discovery component.
+
+
The discovery component will scan the WiFi network from time to time for connected zeroconf/mDNS and uPnP devices. The intial introduction is mainly focussed on getting the right architecture in place and discovers Belkin WeMo switches and Google Chromecasts connected to your network. When found, it will load and notify the appropritate component and it will be ready to use within seconds.
+
+
Most devices still require some sort of interaction from the user after being discovered - be it a button being pressed or some sort of authentication. This is a challenge that will be solved in the future.
+
+
To enable the discovery component, add the following to your home-assistant.conf:
+
+
[discovery]
+
+
+
+
A new discovery section has been added to the Adding a new platform page with instructions how to make your platform discoverable.
diff --git a/components/arduino/index.html b/components/arduino/index.html
index e7a02e29c1..443b7c9170 100644
--- a/components/arduino/index.html
+++ b/components/arduino/index.html
@@ -178,12 +178,18 @@ A word of caution: The Arduino boards are not storing states. This means that wi
diff --git a/components/binary_sensor.arest/index.html b/components/binary_sensor.arest/index.html
index 84359bdb32..08befd9f84 100644
--- a/components/binary_sensor.arest/index.html
+++ b/components/binary_sensor.arest/index.html
@@ -181,12 +181,18 @@ This sensor is not suitable for fast state changes because there is a high possi
The ffmpeg platform allows you to use every video or audio feed with FFmpeg for various sensors in Home Assistant. Available are: noise, motion. If the ffmpeg process is broken, the sensor will be unavailable. To restart the instance, use the service binary_sensor.ffmpeg_restart.
-
-You need the ffmpeg binary in your system path. On Debain 8 you can install it from backports. If you want Hardware support on a Raspberry Pi you need to build it from source. Windows binary are avilable on FFmpeg homepage.
-
-
Noise
To enable your FFmpeg with noise detection in your installation, add the following to your configuration.yaml file:
@@ -105,7 +101,6 @@ You need the ffmpeg binary in your system
tool:noiseinput:FFMPEG_SUPPORTED_INPUTname:FFmpeg Noise
- ffmpeg_bin:/usr/bin/ffmpegpeak:-30duration:1reset:20
@@ -118,7 +113,6 @@ You need the ffmpeg binary in your system
input (Required): A ffmpeg compatible input file, stream or feed.
tool (Required): Is fix set to noise.
name (Optional): This parameter allows you to override the name of your camera.
-
ffmpeg_bin (Optional): Default ffmpeg.
peak (Optional): Default -30. A peak of dB to detect it as noise. 0 is very loud and -100 is low.
duration (Optional): Default 1 seconds. How long need the noise over the peak to trigger the state.
reset (Optional): Defaults to 20 seconds. The time to reset the state after none new noise is over the peak.
@@ -144,13 +138,12 @@ You need the ffmpeg binary in your system
tool:motioninput:FFMPEG_SUPPORTED_INPUTname:FFmpeg Motion
- ffmpeg_bin:/usr/bin/ffmpegchanges:10reset:20# group feature / default not in userepeat:0repeat_time:0
-
+
@@ -160,7 +153,6 @@ You need the ffmpeg binary in your system
input (Required): A ffmpeg compatible input file, stream, or feed.
tool (Required): Is fix set to motion.
name (Optional): This parameter allows you to override the name of your camera.
-
ffmpeg_bin (Optional): Default ffmpeg.
changes (Optional): Default 10 percent. A lower value is more sensitive. I use 4 / 3.5 on my cameras. It describes how much needs to change between two frames to detect it as motion. See on descripton.
reset (Optional): Default 20 seconds. The time to reset the state after no new motion is detected.
repeat (Optional): Default 0 repeats (deactivate). How many events need to be detected in repeat_time in order to trigger a motion.
@@ -174,7 +166,7 @@ You need the ffmpeg binary in your system
-
If you are running into trouble with this sensor, please refer to this Troubleshooting section.
+
If you are running into trouble with this sensor, please refer to this Troubleshooting section.
@@ -201,6 +193,9 @@ You need the ffmpeg binary in your system
diff --git a/components/binary_sensor.http/index.html b/components/binary_sensor.http/index.html
index 957a82a703..dce36a010c 100644
--- a/components/binary_sensor.http/index.html
+++ b/components/binary_sensor.http/index.html
@@ -214,12 +214,18 @@ You should choose a unique device name (DEVICE_NAME) to avoid clashes with other
diff --git a/components/binary_sensor.nest/index.html b/components/binary_sensor.nest/index.html
index e0afba4108..843494e6bb 100644
--- a/components/binary_sensor.nest/index.html
+++ b/components/binary_sensor.nest/index.html
@@ -156,6 +156,9 @@ You must have the Nest component configured to u
Enabling this sensor platform exposes all of your zones as binary sensors, which provides visibility through the UI as well as the ability to trigger automation actions instantly when something happens like a door opening, or a motion sensor trigger.
-
To enable this, add the following lines to your configuration.yaml:
+
To enable this feature, add the following lines to your configuration.yaml:
host (Optional): This is the host connection string (host:port) for the nx584 server process. If unset, it is assumed to be localhost:5007, which will work if the server process is running on the same system as home-assistant.
-
exclude_zones (Optional): This is a list of zone numbers that should be excluded. Use this to avoid exposing a zone that is of no interest, unconnected, etc.
-
zone_types (Optional): This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. The list of available zone types relevant to alarm zones are: opening, motion, gas, smoke, moisture, safety.
host (Optional): This is the host where the nx584 server process is running. If unset, it is assumed to be localhost, which will work if the server process is running on the same system as Home Assistant.
+
port (Optional): The port where the server process is running. Defaults to 5007.
+
exclude_zones (Optional): This is a list of zone numbers that should be excluded. Use this to avoid exposing a zone that is of no interest, unconnected, etc.
+
zone_types (Optional): This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. The list of available zone types relevant to alarm zones are: opening, motion, gas, smoke, moisture, safety.
diff --git a/components/binary_sensor.octoprint/index.html b/components/binary_sensor.octoprint/index.html
index 87020a372a..7b3759e29b 100644
--- a/components/binary_sensor.octoprint/index.html
+++ b/components/binary_sensor.octoprint/index.html
@@ -176,12 +176,18 @@ You must have the OctoPrint component confi
diff --git a/components/binary_sensor.rest/index.html b/components/binary_sensor.rest/index.html
index 6105098117..5cf072aa07 100644
--- a/components/binary_sensor.rest/index.html
+++ b/components/binary_sensor.rest/index.html
@@ -207,12 +207,18 @@ Make sure that the URL matches exactly your endpoint or resource.
The ffmpeg platform allows you to use every video feed with FFmpeg as camera in Home Assistant. The input for ffmpeg need to support that could have multiple connection to source (input) in same time. For every user in UI and all 10 seconds (snapshot image) it make a new connection/reading to source. Normally that should never be a trouble only in strange selfmade constructs can be make mistakes.
-
-You need a ffmpeg binary in your system path. On Debain 8 you can install it from backports. If you want Hardware support on a Raspberry Pi you need tobuild from source by yourself. Windows binary are avilable on the FFmpeg website.
-
-
To enable your FFmpeg feed in your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
@@ -102,7 +98,6 @@ You need a ffmpeg binary in your system p
-platform:ffmpeginput:FFMPEG_SUPPORTED_INPUTname:FFmpeg
- ffmpeg_bin:/usr/bin/ffmpegextra_arguments:-q:v 2
@@ -112,7 +107,6 @@ You need a ffmpeg binary in your system p
input (Required): A ffmpeg compatible input file, stream or feed.
name (Optional): This parameter allows you to override the name of your camera.
-
ffmpeg_bin (Optional): Default βffmpegβ.
extra_arguments (Optional): Extra option they will pass to ffmpeg. i.e. image quality or video filter options.
@@ -120,23 +114,7 @@ You need a ffmpeg binary in your system p
You can control the image quality with extra_arguments-q:v 2-32 or with lossless option -pred 1.
-
Troubleshooting
-
-
In most of case, ffmpeg autodetect all needed options to read a video/audio stream or file. But it is possible in rare cases thatβs needed to set a option to help ffmpeg. Per default ffmpeg use 5 seconds to detect all options or abort.
-
-
First check, if your stream playable by ffmpeg with (use option -an or -vn to disable video or audio stream):
-
-
$ ffmpeg -i INPUT -an -f null -
-
-
-
-
Now you can see what going wrong. Following list could be help to solve your trouble:
-
-
-
[rtsp @ ...] UDP timeout, retrying with TCP: You need to set RTSP transport in the configuration with: input: -rtsp_transport tcp -i INPUT
-
[rtsp @ ...] Could not find codec parameters for stream 0 (Video: ..., none): unspecified size: FFmpeg need more data or time for autodetect. You can set the analyzeduration and/or probesize option, play with this value. If you know the needed value you can set it with: input: -analyzeduration xy -probesize xy -i INPUT. More information about that can be found on FFmpeg.
-
-
+
If you are running into trouble with this sensor, please refer to this Troubleshooting section.
@@ -164,6 +142,9 @@ You need a ffmpeg binary in your system p
V_HVAC_FLOW_STATE is mapped to the state of the Climate component in HA as follows:
+
+
+
+
+
Home Assistant State
+
MySensors State
+
+
+
+
+
STATE_COOL
+
CoolOn
+
+
+
STATE_HEAT
+
HeatOn
+
+
+
STATE_AUTO
+
Off
+
+
+
STATE_OFF
+
AutoChangeOver
+
+
+
+
+
Currently humidity, away_mode, aux_heat, swing_mode is not supported. This will be included in later versions as feasible.
+
+
Set the target temperature using V_HVAC_SETPOINT_HEAT in Heat mode, and V_HVAC_SETPOINT_COOL in Cool Mode. In case of any Auto Change Over mode you can use V_HVAC_SETPOINT_HEAT as well as V_HVAC_SETPOINT_COOL to set the both the low bound and the high bound temperature of the device.
+
+
You can use V_HVAC_SPEED to control the Speed setting of the Fan in the HVAC.
+
+
For more information, visit the serial api of MySensors.
+
+
Example sketch
+
+
/*
+ * Documentation: http://www.mysensors.org
+ * Support Forum: http://forum.mysensors.org
+ *
+ */
+
+#include <MySensor.h>
+/* Include all the other Necessary code here. The example code is limited to message exchange for mysensors with the controller (ha)*/
+
+#define CHILD_ID_HVAC 0 // childId
+MyMessagemsgHVACSetPointC(CHILD_ID_HVAC,V_HVAC_SETPOINT_COOL);
+MyMessagemsgHVACSpeed(CHILD_ID_HVAC,V_HVAC_SPEED);
+MyMessagemsgHVACFlowState(CHILD_ID_HVAC,V_HVAC_FLOW_STATE);
+
+/* Include all the other Necessary code here. The example code is limited to message exchange for mysensors with the controller (ha)*/
+
+voidsetup()
+{
+
+ // Startup and initialize MySensors library. Set callback for incoming messages.
+gw.begin(incomingMessage);
+
+ // Send the sketch version information to the gateway and Controller
+gw.sendSketchInfo("HVAC","0.1");
+
+ gw.present(CHILD_ID_HVAC,S_HVAC,"Thermostat");
+ gw.send(msgHVACFlowState.set("Off"));
+ gw.send(msgHVACSetPointC.set(target_temp));
+ gw.send(msgHVACSpeed.set("Max"));
+}
+
+voidincomingMessage(constMyMessage&message){
+ StringrecvData=message.data;
+ recvData.trim();
+ switch(message.type){
+ caseV_HVAC_SPEED:
+ if(recvData.equalsIgnoreCase("auto"))fan_speed=0;
+ elseif(recvData.equalsIgnoreCase("min"))fan_speed=1;
+ elseif(recvData.equalsIgnoreCase("normal"))fan_speed=2;
+ elseif(recvData.equalsIgnoreCase("max"))fan_speed=3;
+ processHVAC();
+ break;
+ caseV_HVAC_SETPOINT_COOL:
+ target_temp=message.getFloat();
+ processHVAC();
+ break;
+ caseV_HVAC_FLOW_STATE:
+ if(recvData.equalsIgnoreCase("coolon")&&(!Present_Power_On)){
+ togglePower();
+ }
+ elseif(recvData.equalsIgnoreCase("off")&&Present_Power_On){
+ togglePower();
+ }
+ break;
+ }
+}
+
+voidloop(){
+
+ // Process incoming messages (like config from server)
+gw.process();
+
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/climate.nest/index.html b/components/climate.nest/index.html
index c262a0022b..faff26908e 100644
--- a/components/climate.nest/index.html
+++ b/components/climate.nest/index.html
@@ -136,6 +136,9 @@ You must have the Nest component configured to u
diff --git a/components/climate.proliphix/index.html b/components/climate.proliphix/index.html
index 2faaad6e86..eba8386bac 100644
--- a/components/climate.proliphix/index.html
+++ b/components/climate.proliphix/index.html
@@ -171,6 +171,9 @@ of OID values. A complete collection of the API is available in this Radiotherm Thermostat
+
The radiotherm climate platform let you control a thermostat from Radio Thermostat.
The underlaying library supports:
+
CT50 V1.09
CT50 V1.88
@@ -113,8 +114,8 @@
Configuration variables:
-
host (Required): List of your Radiotherm thermostats
-
hold_temp (Required): Boolean to control if Home Assistant temperature adjustments hold (True) or are temporary (False).
+
host (Optional): List of your Radiotherm thermostats. If not provided the thermostats will be auto-detected.
+
hold_temp (Optional): Boolean to control if Home Assistant temperature adjustments hold (True) or are temporary (False). Defaults to False.
Temperature settings from Home Assistant will be sent to thermostat and then hold at that temperature. Set to False if you set a thermostat schedule on the thermostat itself and just want Home Assistant to send temporary temperature changes.
The vera climate platform allows you to control your Vera thermostats from within Home Assistant.
+
+
They will be automatically discovered if the vera component is loaded.
+
+
For more configuration information see the Vera component documentation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/climate.zwave/index.html b/components/climate.zwave/index.html
index 59393309bd..2738819872 100644
--- a/components/climate.zwave/index.html
+++ b/components/climate.zwave/index.html
@@ -179,6 +179,9 @@ If the thermostat support different operationg modes, you will get one thermosta
The isy994 platform allows you to get data from your ISY994 cover from within Home Assistant.
+
+
They will be automatically discovered if the isy994 component is loaded.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/cover.mqtt/index.html b/components/cover.mqtt/index.html
index 6f7632a14a..b6d02abb19 100644
--- a/components/cover.mqtt/index.html
+++ b/components/cover.mqtt/index.html
@@ -216,6 +216,9 @@ state from state_topic. If these messages
diff --git a/components/cover.rfxtrx/index.html b/components/cover.rfxtrx/index.html
index 83aca9e972..7e8d76d485 100644
--- a/components/cover.rfxtrx/index.html
+++ b/components/cover.rfxtrx/index.html
@@ -198,6 +198,9 @@ Then you should update your configuration to:
diff --git a/components/discovery/index.html b/components/discovery/index.html
index 10c22c6d33..65057e7dd3 100644
--- a/components/discovery/index.html
+++ b/components/discovery/index.html
@@ -167,6 +167,9 @@ If you see Not initializing discovery because co
diff --git a/components/emulated_hue/index.html b/components/emulated_hue/index.html
index 45a68896f0..724da60efa 100644
--- a/components/emulated_hue/index.html
+++ b/components/emulated_hue/index.html
@@ -208,6 +208,9 @@ entities. The driving use case behind this functionality is to allow Home Assist
The isy994 platform allows you to get data from your ISY994 fan from within Home Assistant.
+
+
They will be automatically discovered if the isy994 component is loaded.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/fan.mqtt/index.html b/components/fan.mqtt/index.html
index 3676e9f62a..d4cbaa6edb 100644
--- a/components/fan.mqtt/index.html
+++ b/components/fan.mqtt/index.html
@@ -202,9 +202,15 @@ Make sure that your topic match exact. some-topi
It allow other Home-Assistant components to process video/audio streams. It need a ffmpeg binary in your system path. It support all ffmpeg version since 3.0.0. If you have a older version, please update.
+
+
+You need a ffmpeg binary in your system path. On Debain 8 or Raspbian (Jessie) you can install it from backports. If you want Hardware support on a Raspberry Pi you need to build from source by yourself. Windows binary are avilable on the FFmpeg website.
+
+
+
To set it up, add the following information to your configuration.yaml file:
ffmpeg_bin (Optional): Default βffmpegβ. Set the ffmpeg binary.
+
run_test (Optional): Default True. Check if input is usable by ffmpeg.
+
+
+
Troubleshooting
+
+
In most of case, ffmpeg autodetect all needed options to read a video/audio stream or file. But it is possible in rare cases thatβs needed to set a option to help ffmpeg. Per default ffmpeg use 5 seconds to detect all options or abort.
+
+
First check, if your stream playable by ffmpeg with (use option -an or -vn to disable video or audio stream):
+
+
$ ffmpeg -i INPUT -an -f null -
+
+
+
+
Now you can see what going wrong. Following list could be help to solve your trouble:
+
+
+
[rtsp @ ...] UDP timeout, retrying with TCP: You need to set RTSP transport in the configuration with: input: -rtsp_transport tcp -i INPUT
+
[rtsp @ ...] Could not find codec parameters for stream 0 (Video: ..., none): unspecified size: FFmpeg need more data or time for autodetect. You can set the analyzeduration and/or probesize option, play with this value. If you know the needed value you can set it with: input: -analyzeduration xy -probesize xy -i INPUT. More information about that can be found on FFmpeg.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/hdmi_cec/index.html b/components/hdmi_cec/index.html
index 7f6b0be9e8..0b4af779c8 100644
--- a/components/hdmi_cec/index.html
+++ b/components/hdmi_cec/index.html
@@ -220,6 +220,9 @@
diff --git a/components/homematic/index.html b/components/homematic/index.html
index 2c9783060f..b232c1e5e6 100644
--- a/components/homematic/index.html
+++ b/components/homematic/index.html
@@ -262,6 +262,9 @@ The name depends on if you chose to resolve names or not. If not, it will be the
diff --git a/components/http/index.html b/components/http/index.html
index e31042d991..e95f3d8a2e 100644
--- a/components/http/index.html
+++ b/components/http/index.html
@@ -104,6 +104,9 @@ Itβs HIGHLY recommended that you set the api_p
cors_allowed_origins:-https://google.com-https://home-assistant.io
+ approved_ips:
+ -127.0.0.1
+ -192.168.1.9
@@ -117,6 +120,7 @@ Itβs HIGHLY recommended that you set the api_p
ssl_certificate (Optional): Path to your TLS/SSL certificate to serve Home Assistant over a secure connection.
ssl_key (Optional): Path to your TLS/SSL key to serve Home Assistant over a secure connection.
cors_allowed_origins (Optional): A list of origin domain names to allow CORS requests from. Enabling this will set the Access-Control-Allow-Origin header to the Origin header if it is found in the list, and the Access-Control-Allow-Headers header to Origin, Accept, X-Requested-With, Content-type, X-HA-access. You must provide the exact Origin, i.e. https://home-assistant.io will allow requests from https://home-assistant.io but nothttp://home-assistant.io.
+
approved_ips (Optional): A list of approved ips. Then it will be possible to login from given ips without providing a password.
diff --git a/components/ifttt/index.html b/components/ifttt/index.html
index 87bfa7d0b3..ef641508f5 100644
--- a/components/ifttt/index.html
+++ b/components/ifttt/index.html
@@ -234,6 +234,9 @@ You need to setup a unique trigger for each event you sent to IFTTT.
diff --git a/components/index.html b/components/index.html
index 032366491a..db8b3f1598 100644
--- a/components/index.html
+++ b/components/index.html
@@ -103,7 +103,7 @@ Support for these components is provided by the Home Assistant community.
The ISY994 is a home automation controller that is capable of controlling Insteon and X10 devices. The controller is also capable of controlling Z-Wave devices but that functionality has not yet been confirmed with Home Assistant.
+
The ISY994 is a home automation controller that is capable of controlling Insteon and X10 devices. Some models of the ISY994 can even control Z-Wave devices.
The ISY994 controller is manufactured by Universal Devices.
Basic Configuration
-
Home Assistant is capable of communicating with any switch, sensor, and light that is configured on the controller. Using the programs on the controller, custom switches and sensors can also be created.
+
Home Assistant is capable of communicating with any binary sensor, cover, fan, light, lock, sensor and switch that is configured on the controller. Using the programs on the controller, custom binary sensors, cover, fan, lock, and switches can also be created.
To integrate your ISY994 controller with Home Assistant, add the following section to your configuration.yaml file:
@@ -116,30 +116,89 @@ The ISY994 controller is manufactured by Creating Custom Switches
+
Creating Custom Devices
-
Using the Programs tab in the controllerβs Administrative Console, custom switches can be created that will appear natively inside of Home Assistant. Home Assistant will scan two different directories for switch configurations on the controller. These directories must exist at the root level. The two directories used to make switches are HA.doors and HA.switches. Currently, the two receive identical treatment in Home Assistant.
+
Using the Programs tab in the controllerβs Administrative Console, custom devices can be created that will appear natively inside of Home Assistant. Home Assistant will scan the following folders and build the device to the associated domains:
-
A switch is created by creating a directory under either of these root dirctories with the name you would like to call the switch. Two programs are then required in this directory: status and actions. The image below shows a sample configuration. This sample includes an extra program called auto on. This is ignored by Home Assistant.
+
My Programs
+βββ HA.binary_sensor
+| βββ Movement In House
+| | βββ status
+| βββ Garage Open
+| | βββ status
+βββ HA.cover
+| βββ Left Garage Door
+| | βββ actions
+| | βββ status
+| βββ Living Room Blinds
+| | βββ actions
+| | βββ status
+βββ HA.fan
+| βββ Desk Fan
+| | βββ actions
+| | βββ status
+| βββ Living Room Fan
+| | βββ actions
+| | βββ status
+βββ HA.lock
+| βββ Front Door
+| | βββ actions
+| | βββ status
+| βββ Back Door
+| | βββ actions
+| | βββ status
+βββ HA.switch
+| βββ Dining Lights
+| | βββ actions
+| | βββ status
+| βββ Sleep Mode
+| | βββ actions
+| | βββ status
+
+
+
+
A device is created by creating a directory, with the name for the device, under any of the following root directories:
+
+
HA.binary_sensor will create a binary sensor (see Customizing Devices to set the sensor class)
+
HA.cover will create a cover
+
HA.fan will create a fan
+
HA.lock will create a lock
+
HA.switch will create a switch
+
+
+
A program, named status, is required under the program device directory. A program, named actions, is required for all program devices except for binary_sensor. Any other programs in these device directories will be ignored.
-
+
-
The status program in this directory is what indicates if the switch is on or off. Only the IF clause is evaluated. If the clause returns True, the switch will be on. False will indicate the switch is off.
+
The status program in this directory is what indicates the state of the device:
+
+
binary_sensor on if the clause returns true, otherwise off
+
cover closed if the clause returns true, otherwise open
+
fan on if the clause returns true, otherwise off
+
lock locked if the clause returns true, otherwise unlocked
+
switch on if the clause returns true, otherwise off
+
-
The actions program indicates what should be performed to turn the switch on or off. The THEN clause gives instructions for turning the switch on while the ELSE clause gives instructions for turning the switch off. Below is an example.
+
The actions program indicates what should be performed for the following device services:
+
+
cover the THEN clause is evaluated for the open_cover service, the ELSE clause is evaluated for the close_cover service
+
fan the THEN clause is evaluated for the turn_on service, the ELSE clause is evaluated for the turn_off service
+
lock the THEN clause is evaluated for the lock service, the ELSE clause is evaluated for the unlock service
+
switch the THEN clause is evaluated for the turn_on srevice, the ELSE clause is evaluated for the turn_off service
+
@@ -147,28 +206,6 @@ The ISY994 controller is manufactured by Creating Custom Sensors
-
-
Custom sensors can also be created using the Programs tab in the ISY controllerβs Administrative Console. For programs, three different root level folders are evaluated that are all handled a little differently inside of Home Assistant.
-
-
-
HA.sensors will have states of Open or Closed
-
HA.states will have states of On or Off
-
HA.locations will have states of Home or Away
-
-
-
To create a custom sensor, create a program under any of the three root directories. The name of the program will be the name of the sensor. An example below shows a location indicator setup.
-
-
-
-
-
-
The program created only needs an IF clause. It will be evaluated to either Open/On/Home when it returns True and Closed/Off/Away when it returns False. An example is below.
Recieve signals from a keyboard and use it as a remote control.
+
+
This component allows to use a keyboard as remote control. It will
+fire Β΄keyboard_remote_command_receivedΒ΄ events witch can then be used
+in automation rules.
+
+
The evdev package is used to interface with the keyboard and thus this
+is Linux only. It also means you canβt use your normal keyboard for this,
+because evdev will block it.
+
+
# Example configuration.yaml entry
+keyboard_remote:
+ device_descriptor:'/dev/input/by-id/foo'
+ key_value:'key_up'# optional alternaive 'key_down' and 'key_hold'
+ # be carefull, 'key_hold' fires a lot of events
+
+
+
+
And an automation rule to bring breath live into it.
+
+
automation:
+ alias:Keyboard All light on
+ trigger:
+ platform:event
+ event_type:keyboard_remote_command_received
+ event_data:
+ key_code:107# inspect log to obtain desired keycode
+ action:
+ service:light.turn_on
+ entity_id:light.all
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/knx/index.html b/components/knx/index.html
index 28f7bc27df..fca31d048c 100644
--- a/components/knx/index.html
+++ b/components/knx/index.html
@@ -95,6 +95,7 @@
diff --git a/components/light.rfxtrx/index.html b/components/light.rfxtrx/index.html
index 9c622f9a9c..f50401120b 100644
--- a/components/light.rfxtrx/index.html
+++ b/components/light.rfxtrx/index.html
@@ -204,6 +204,9 @@ Then you should update your configuration to:
The isy994 platform allows you to get data from your ISY994 lock from within Home Assistant.
+
+
They will be automatically discovered if the isy994 component is loaded.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/lock.mqtt/index.html b/components/lock.mqtt/index.html
index 6b282cf41d..2f985a36ab 100644
--- a/components/lock.mqtt/index.html
+++ b/components/lock.mqtt/index.html
@@ -202,6 +202,9 @@ Make sure that your topic match exact. some-topi
exclude (Optional): Configure which components should not create logbook enties.
+
entities (Optional): The list of entity ids to be excluded from creating logbook entries.
+
domains (Optional): The list of domains to be excluded from creating logbook entries.
+
+
+
Exclude Events
+
+
Entities customized as hidden are excluded from the logbook by default, but sometimes you want to show the entity in the UI and not in the logbook. For instance you use the sensor.dateto show the current date in the UI, but you do not want an logbook entry for that sensor every day.
+To exclude these entities just add them to the exclude > entities list in the configuration of the logbook.
+
+
To exclude all events from a whole domain add it to the exclude > domain list. For instance you use the sun domain only to trigger automations on the `azimuth attribute, then you possible are not interested in the logbook entries for sun rise and sun set.
+
+
Custom Entries
It is possible to add custom entries to the logbook by using the script component to fire an event.
# Example configuration.yaml entrymedia_player:platform:yamaha
+ host:192.168.1.100name:'BasementReceiver'
@@ -114,12 +115,15 @@
name (Optional): Name of the device
+
host (Optional): IP address or hostname of the device
A few notes:
-
This will automatically search your network for Yamaha receivers. It will add a media player device for each one.
+
Not specifying the host variable will result in automatically searching your network for Yamaha Receivers. It will add a media player device for each one.
+
In some cases, autodiscovery fails due to a known bug in the receiverβs firmware. It is possible to manually specify the reveiverβs IP address or via itβs hostname (if it is discoverably by your DNS) then.
+
Please note: If adding the IP address or hostname manually, you must enable network standby on your receiver, or else startup of Home Assistant will hang if you have your receiver switched off.
Currently the only controls that are available is Power On/Off, Mute, and Volume control. Other functions such as source select are in progress of being developed.
broker (Required): The IP address of your MQTT broker, e.g. 192.168.1.32.
+
broker (Required): The IP address or hostname of your MQTT broker, e.g. 192.168.1.32.
port (Optional): The network port to connect to. Default is 1883.
-
client_id (Optional): Client ID that Home Assistant will use. Has to be unique on the server. Default is a random generated one.
-
keepalive (Optional): The keep alive in seconds for this client. Default is 60.
+
client_id (Optional): The client ID that Home Assistant will use. Has to be unique on the server. Default is a randomly generated one.
+
keepalive (Optional): The time in seconds between sending keep alive messages for this client. Default is 60.
username (Optional): The username to use with your MQTT broker.
password (Optional): The corresponding password for the username to use with your MQTT broker.
-
certificate (Optional): Certificate to use to encrypt communication with the broker.
+
certificate (Optional): The certificate authority certificate file that is to be treated as trusted by this client. This file should contain the root certificate of the certificate authority that signed your brokerβs certificate, but may contain multiple certificates. Example: /home/user/identrust-root.pem
protocol (Optional): Protocol to use: 3.1 or 3.1.1. By default it connects with 3.1.1 and falls back to 3.1 if server does not support 3.1.
@@ -127,7 +127,7 @@
Embedded broker
-
Home Assistant contains an embedded MQTT broker. If no broker configuration is given, the HBMQTT broker is started and Home Asssistant connects to it. Embedded broker default configuration:
+
Home Assistant contains an embedded MQTT broker. If no broker configuration is given, the HBMQTT broker is started and Home Assistant connects to it. Embedded broker default configuration:
@@ -180,7 +180,7 @@ This broker does not currently work with OwnTracks because of a protocol version
Run your own
-
Most private option but requires a bit more work. There are two free and open-source brokers to pick from: Mosquitto and Mosca.
+
This is the most private option but requires a bit more work. There are two free and open-source brokers to pick from: Mosquitto and Mosca.
# Example configuration.yaml entrymqtt:
@@ -199,7 +199,7 @@ There is an issue with the Mosquitto package included in Ubuntu 14.04 LTS. Speci
Public broker
-
The Mosquitto project runs a public broker. Easiest to setup but there is 0 privacy as all messages are public. Use this only for testing purposes and not for real tracking of your devices.
+
The Mosquitto project runs a public broker. This is the easiest to set up, but there is no privacy as all messages are public. Use this only for testing purposes and not for real tracking of your devices.
mqtt:broker:test.mosquitto.org
@@ -215,7 +215,7 @@ There is an issue with the Mosquitto package included in Ubuntu 14.04 LTS. Speci
CloudMQTT
-
CloudMQTT is a hosted private MQTT instance that is free up to 10 connected devices. This is enough to get started with for example OwnTracks and give you a taste of what is possible.
+
CloudMQTT is a hosted private MQTT instance that is free for up to 10 connected devices. This is enough to get started with for example OwnTracks and give you a taste of what is possible.
Home Assistant is not affiliated with CloudMQTT nor will receive any kickbacks.
@@ -228,8 +228,11 @@ Home Assistant is not affiliated with CloudMQTT nor will receive any kickbacks.
From the control panel, click on the Details button.
Create unique users for Home Assistant and each phone to connect (CloudMQTT does not allow two
connections from the same user)
- a. Under manage users, fill in username, password and click add
- b. Under ACLs, select user, topic #, check βread accessβ and βwrite accessβ
+
+
Under manage users, fill in username, password and click add
+
Under ACLs, select user, topic #, check βread accessβ and βwrite accessβ
+
+
Copy the instance info to your configuration.yaml:
@@ -294,19 +297,19 @@ Home Assistant will automatically load the correct certificate if you connect to
Testing your setup
-
The mosquitto broker package is shipping commandline tools to send and recieve MQTT messages. As an alternative have a look at hbmqtt_pub and hbmqtt_sub which are provied by HBMQTT. For sending test messages to a broker running on localhost check the example below:
+
The mosquitto broker package ships commandline tools to send and recieve MQTT messages. As an alternative have a look at hbmqtt_pub and hbmqtt_sub which are provied by HBMQTT. For sending test messages to a broker running on localhost check the example below:
$ mosquitto_pub -h 127.0.0.1 -t home-assistant/switch/1/on -m "Switch is ON"
-
If you are using the embeeded MQTT broker, the command looks a little different because you need to add the MQTT protocol version.
+
If you are using the embedded MQTT broker, the command looks a little different because you need to add the MQTT protocol version.
$ mosquitto_pub -V mqttv311 -t "hello" -m world
-
or if you are using a API password.
+
or if you are using a API password:
$ mosquitto_pub -V mqttv311 -u homeassistant -P <your api password> -t "hello" -m world
@@ -333,7 +336,7 @@ Home Assistant will automatically load the correct certificate if you connect to
-
For the embeeded MQTT broker the command looks like the sample below.
+
For the embedded MQTT broker the command looks like:
$ mosquitto_sub -v -V mqttv311 -t "#"
@@ -343,7 +346,7 @@ Home Assistant will automatically load the correct certificate if you connect to
Processing JSON
-
The MQTT switch and sensor platforms support processing JSON over MQTT messages and parse them using JSONPath. JSONPath allows you to specify where in the JSON the value resides that you want to use. The following examples will always return the value 100.
+
The MQTT switch and sensor platforms support processing JSON over MQTT messages and parsing them using JSONPath. JSONPath allows you to specify where in the JSON the value resides that you want to use. The following examples will always return the value 100.
@@ -460,6 +463,9 @@ Home Assistant will automatically load the correct certificate if you connect to
diff --git a/components/mysensors/index.html b/components/mysensors/index.html
index 1854605d9b..d4d270e4f5 100644
--- a/components/mysensors/index.html
+++ b/components/mysensors/index.html
@@ -279,6 +279,9 @@ The MQTT gateway requires MySensors version 2.0 and only the MQTT client gateway
diff --git a/components/netatmo/index.html b/components/netatmo/index.html
index 5834d0d8dc..00c988b9a1 100644
--- a/components/netatmo/index.html
+++ b/components/netatmo/index.html
@@ -183,6 +183,9 @@ The Home Assistant NetAtmo platform has only be tested with the classic indoor,
diff --git a/components/notify.free_mobile/index.html b/components/notify.free_mobile/index.html
index 18e0dba3e5..c5722a01cc 100644
--- a/components/notify.free_mobile/index.html
+++ b/components/notify.free_mobile/index.html
@@ -179,6 +179,9 @@ If you disable and re-enable the SMS API option, please be sure to update your t
name (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is notify. The notifier will bind to the service notify.NOTIFIER_NAME.
+
device_key (Required): The device key of your device.
+
+
+
To test if the service works, just send a message with curl from the command-line.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/notify.slack/index.html b/components/notify.slack/index.html
index 85338ce9cb..7e29624433 100644
--- a/components/notify.slack/index.html
+++ b/components/notify.slack/index.html
@@ -105,6 +105,8 @@
platform:slackapi_key:ABCDEFGHJKLMNOPQRSTUVXYZdefault_channel:'#general'
+ icon:':robot_face:'
+ username:'Home-Assistant'
@@ -114,6 +116,8 @@
name (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is notify. The notifier will bind to the service notify.NOTIFIER_NAME.
api_key (Required): The slack API token to use for sending slack messages.
default_channel (Required): The default channel to post to if no channel is explicitly specified when sending the notification message.
+
username (Optional): Setting username will allow homeassistant to post to slack using the username specified. By default not setting this will post to slack using the user account or botname that you generated the api_key as.
+
icon (Optional): Use one of the slack emojiβs as an Icon for the supplied username. Slack uses the standard emoji sets used here.
diff --git a/components/notify.smtp/index.html b/components/notify.smtp/index.html
index 4f1c71f9cd..93c6c1debb 100644
--- a/components/notify.smtp/index.html
+++ b/components/notify.smtp/index.html
@@ -212,6 +212,9 @@ which need special attention. By default, the usage by external applications, es
The nuimo_controller component allows you to connect to a Nuimo device for receiving input events and displaying on the LED matrix via the Nuimo SDK for Python on Linux.
+
+
To connect to a Nuimo device add the following section to your configuration.yaml file:
use hcitool lescan to see the mac address of your device
+
+
+
allow non-root user access to Bluetooth LE with sudo setcap cap_net_raw+eip $(eval readlink -f $(which python))
+
+
+
install the newest version of pygattlib from the repository, either because there is no binary package for your system or the pip version contains errors, with pip install hg+https://bitbucket.org/OscarAcena/pygattlib --target $HOME/.homeassistant/deps.
+(Dependencies of pygattlib: sudo apt-get install pkg-config libboost-python-dev libboost-thread-dev libbluetooth-dev libglib2.0-dev python-dev)
+Then invoke home-assistant with hass --skip-pip.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/octoprint/index.html b/components/octoprint/index.html
index e27a6abfc9..c9863144a4 100644
--- a/components/octoprint/index.html
+++ b/components/octoprint/index.html
@@ -156,6 +156,9 @@
OpenAlpr integration for Home Assistant allows you to process licences plates from a camera. You can use them to open a garage door or trigger any other automation.
+
+
+If you want use a video stream. You need setup the ffmpeg component. See also there for troubleshooting local ffmpeg installation.
+
+
+
Local installation
+
+
If you want process all data local you need the command line tool alpr in version > 2.3.1
+
+
If you donβt found binarys for you distribution you can compile from source. A documention how to build a openalpr is found here.
+
+
On a debian system you can use this cmake command to build only the command line tool:
region (Required): Country or region. List of Supported value.
+
confidence (Optional): Default 80. The minimum of confidence in percent to process with Home-Assistant.
+
entities (Required): A list of device to add in Home-Assistant.
+
name (Optional): This parameter allows you to override the name of your openalpr entitie.
+
interval (Optional): Default 2. Time in seconds to poll a picture. If the interval is 0 It donβt poll and it only process data with openalpr.scan service.
+
render (Optional): default is with ffmpeg. How is Home-Assistant to get a picture from. It support ffmpeg for video streams and image for a still image.
+
input (Required): The source from getting pictures. With ffmpeg it could by all supported input. Image only support a url.
+
extra_arguments (Optional): Only available with ffmpeg.
+
username (Optional): Only available with image for http authentification.
+
password (Optional): Only available with image for http authentification.
+ Weather Data by the Bureau of Meteorology Australia
+
+
+
+
+
+
The bom platform allows you to get the current weather conditions from the Bureau of Meteorology (BOM) Australia.
+
+
+
Each sensor will be given the device_id of βbom [optionalname] friendlyname unitsβ
+
Get the station ID for your local BOM station from the BOM website: State -> Observations -> Latest Observations -> Choose the station
+
The URL will look like http://www.bom.gov.au/products/IDS60801/IDS60801.94675.shtml. This is for Adelaide. The URL is read as: http://www.bom.gov.au/products/[zone_id]/[zone_id].[wmo_id].shtml
+
A name is optional but if multiple BOM weather stations are used a name will be required.
+
The sensor will update every minute 35 minutes after last data timestamp. This allows for the 30 minute observation cycle and the approximate 5 minute update delay in publishing the data.
+
+
+
To add the BOM weather observation to your installation, add the following to your configuration.yaml file:
The emoncms sensor platform creates sensors for the feeds available in your local or cloud based version of emoncms.
+
+
To enable this sensor, add the following lines to your configuration.yaml, it will list all feeds as a sensor:
+
+
# Example configuration.yaml entry using cloud based emoncms
+sensor:
+ platform:emoncms
+ api_key:put your emoncms read api key here
+ url:https://emoncms.org
+ id:1
+
+
+
+
Configuration variables
+
+
+
api_key (Required): The read api key for your emoncms user.
+
url (Required): The base url of emoncms, use βhttps://emoncms.orgβ for the cloud based version.
+
id (Required): Positive Integer identifier for the sensor. Must be unique if you specify multiple emoncms sensors.
+
include_only_feed_id (optional): Positive integer list of emoncms feed idβs. Only the feeds with feed idβs specified here will be displayed. Can not be specified if exclude_feed_id is specified.
+
exclude_feed_id (optional): Positive integer list of emoncms feed idβs. All the feeds will be displayed as sensors except the ones listed here. Can not be specified if include_only_feed_id is specified.
+
sensor_names (optional): Dictionary of names for the sensors created that are created based on feedid. The dictionary consists of feedid:name pairs. Sensors for feeds with their feedid mentioned here will get the chosen name instead of the default name
+
value_template (Optional): Defines a template to alter the feed value.
+
scan_interval (Optional): Defines the update interval of the sensor in seconds.
+
unit_of_measurement (Optional): Defines the unit of measurement of for all the sensors. default is βWβ.
+
+
+
Default naming scheme
+
+
The names of the sensors created by this component, will be a combination of static text, id from the config and feedid from the emoncms feed, unless sensor_names is used.
+An example name would be βemoncms1_feedid_10β
+
+
Examples
+
+
In this section you find some more examples of how this sensor can be used.
+
+
# Display only feeds with their feed id's specified in "include_only_feed_id"
+sensor:
+ -platform:emoncms
+ api_key:put your emoncms read api key here
+ url:https://emoncms.org
+ id:1
+ unit_of_measurement:"W"
+ include_only_feed_id:
+ -107
+ -106
+ -105
+
+
+
+
# Display all feeds except feeds with their feed id specified in "exclude_feed_id"
+sensor:
+ -platform:emoncms
+ api_key:put your emoncms read api key here
+ url:https://emoncms.org
+ id:1
+ unit_of_measurement:"KWH"
+ exclude_feed_id:
+ -107
+ -106
+ -105
+
+
+
+
# Display only feeds with their feed id's specified in "include_only_feed_id" and give the feed sensors a name using "sensor_names". You don't have to specify all feeds names in "sensor_names", the remaining sensor names will be chosen based on "id" and the emoncms feedid
+sensor:
+ -platform:emoncms
+ api_key:put your emoncms read api key here
+ url:https://emoncms.org
+ id:1
+ unit_of_measurement:"KW"
+ include_only_feed_id:
+ -5
+ -18
+ -29
+ -48
+ -61
+ -110
+ -116
+ -120
+ sensor_names:
+ 5:"feed1"
+ 18:"feed2"
+ 29:"feed3"
+ 48:"kwhfeed"
+ 61:"ampfeed"
+ 110:"wattfeed"
+
+
+
+
# Use a "value_template" to add 1500 to the feed value for all specified feed id's in "include_feed_id"
+sensor:
+ -platform:emoncms
+ api_key:put your emoncms read api key here
+ url:https://emoncms.org
+ scan_interval:15
+ id:1
+ value_template:"{{value|float+1500}}"
+ include_only_feed_id:
+ -107
+ -106
+ -105
+ -61
+
+
+
+
# Display feeds from the same emoncms instance with 2 groups of feeds, diffrent scan_interval and a diffrent unit_of_measurement
+sensor:
+ -platform:emoncms
+ api_key:put your emoncms read api key here
+ url:https://emoncms.org
+ scan_interval:30
+ id:1
+ unit_of_measurement:"W"
+ include_only_feed_id:
+ -107
+ -106
+ -105
+ -platform:emoncms
+ api_key:put your emoncms read api key here
+ url:https://emoncms.org
+ id:2
+ scan_interval:60
+ unit_of_measurement:"A"
+ include_only_feed_id:
+ -108
+ -109
+ -110
+ -61
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/sensor.enocean/index.html b/components/sensor.enocean/index.html
index 314d23e428..54bae25751 100644
--- a/components/sensor.enocean/index.html
+++ b/components/sensor.enocean/index.html
@@ -163,6 +163,9 @@
diff --git a/components/sensor.http/index.html b/components/sensor.http/index.html
index 7ce7043471..9349f1bf14 100644
--- a/components/sensor.http/index.html
+++ b/components/sensor.http/index.html
@@ -182,6 +182,9 @@ You should choose a unique device name (DEVICE_NAME) to avoid clashes with other
The imap_email_content sensor platform will read emails from an IMAP email server and report them as a state change within Home Assistant. This is useful if you have a device that only reports its state via email.
+
+
To enable this sensor, add the following lines to your configuration.yaml file:
server (Required): The IP address or hostname of the IMAP server.
+
port (Required): The port where the server is accessible.
+
name (Optional): Name of the IMAP sensor to use in the frontend.
+
username (Required): Username for the IMAP server.
+
password (Required): Password for the IMAP server.
+
senders (Required): A list of sender email addresses that are allowed to report state via email. Only emails recieved from these addresses will be processed.
+
+
value_template (Optional): If specified this template will be used to render the state of sensor. If a template is not supplied the raw message body will be used for the sensor value. The following attributes will be supplied to the template:
The Mi Flora plant sensor is a small Bluetooth Low Energy device that monitors not only the moisture, but also light, temperature and
+conductivity. As only a single BLE device can be polled at the same time, the library implements locking to make sure this is the case.
+
+
To use your Mi Flora plant sensor in your installation, add the following to your configuration.yaml file:
mac (Required): The MAC address of your sensor. You can find this be running hcitool lescan from command line.
+
name (Optional): The name displayed in the frontend.
+
force_update (Optional): Sends update events even if the value hasnβt changed.
+
median (Optional): Sometimes the sensor measurements show spikes. Using this parameter, the poller will report the median of the last
+3 (you can also use larger values) measurements. This filters out single spikes. Median: 5 will also filter double spikes.
+If you never have problems with spikes, median=1 will work fine.
+
monitored_conditions (Required): The paramaters that should be monitored.
+
+
+
Note that by default the sensor is only polled once every 15 minutes. This means with the median=3 setting, it will take as least 30 minutes before the sensor will report a value after a Home Assistant restart. As the values usually change very slowly, this isnβt a big problem.
+Reducing polling intervals will have a negative effect on the battery life.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/sensor.modbus/index.html b/components/sensor.modbus/index.html
index ad85ef588e..7bada284bd 100644
--- a/components/sensor.modbus/index.html
+++ b/components/sensor.modbus/index.html
@@ -89,64 +89,50 @@
-
The modbus sensor platform allows you to gather data from your Modbus sensors.
+
The modbus sensor allows you to gather data from Modbus registers.
To use your Modbus sensors in your installation, add the following to your configuration.yaml file:
diff --git a/components/sensor.moldindicator/index.html b/components/sensor.moldindicator/index.html
index fe41d72b31..cef55e239b 100644
--- a/components/sensor.moldindicator/index.html
+++ b/components/sensor.moldindicator/index.html
@@ -152,6 +152,9 @@ With the three measured temperatures (in Celsius or Fahrenheit), the calibration
state_topic (Optional): The topic that contains all subtopics for the rooms.
timeout (Optional): The time in seconds after which a room presence state is considered old. An example: device1 is reported at scanner1 with a distance of 1. No further updates are sent from scanner1. After 5 secoonds scanner2 reports device with a distance of 2. The old location info is discarded in favor of the new scanner2 information as the timeout has passed.
+
away_timeout (Optional): The time in seconds after which the state should be set to away if there were no updates. 0 disables the check and is the default.
Example JSON that should be published to the room topics:
diff --git a/components/sensor.nest/index.html b/components/sensor.nest/index.html
index b6594017f0..d5aecec240 100644
--- a/components/sensor.nest/index.html
+++ b/components/sensor.nest/index.html
@@ -171,6 +171,9 @@ You must have the Nest component configured to u
diff --git a/components/sensor.nest_weather/index.html b/components/sensor.nest_weather/index.html
index e2ae6b7bef..d253f01ac5 100644
--- a/components/sensor.nest_weather/index.html
+++ b/components/sensor.nest_weather/index.html
@@ -166,6 +166,9 @@ You must have the Nest component configured to u
diff --git a/components/sensor.octoprint/index.html b/components/sensor.octoprint/index.html
index a57720b58c..7dde15016b 100644
--- a/components/sensor.octoprint/index.html
+++ b/components/sensor.octoprint/index.html
@@ -169,6 +169,9 @@ You must have the OctoPrint component confi
diff --git a/components/sensor.rest/index.html b/components/sensor.rest/index.html
index c2b8b986e5..2cd76df113 100644
--- a/components/sensor.rest/index.html
+++ b/components/sensor.rest/index.html
@@ -236,6 +236,9 @@ Make sure that the URL matches exactly your endpoint or resource.
diff --git a/components/sensor.rfxtrx/index.html b/components/sensor.rfxtrx/index.html
index e6636b4ba0..714af40f80 100644
--- a/components/sensor.rfxtrx/index.html
+++ b/components/sensor.rfxtrx/index.html
@@ -211,6 +211,9 @@ Then you should update your configuration to:
diff --git a/components/sensor.temper/index.html b/components/sensor.temper/index.html
index cea18ad24b..b054785df9 100644
--- a/components/sensor.temper/index.html
+++ b/components/sensor.temper/index.html
@@ -146,6 +146,9 @@ The calculation follows the formula scale * sens
diff --git a/components/sensor.template/index.html b/components/sensor.template/index.html
index 3935f49e6c..aa4e0a1c22 100644
--- a/components/sensor.template/index.html
+++ b/components/sensor.template/index.html
@@ -268,6 +268,9 @@ Please note the blank line to close the multi-line template.
The yahoo_finance platform uses Yahoo Finance to monitor the stock market.
+
+
To enable the yahoo_finance platform, add the following lines to your configuration.yaml file:
+
+
# Example configuration.yaml entry
+sensor:
+ -platform:yahoo_finance
+ name:Red Hat Inc.
+ symbol:RHT
+
+
+
+
Configuration variables:
+
+
+
name (Optional): The name of the sensor. If not specified, it defaults to Yahoo Stock.
+
symbol (Optional): The stock market symbol for a given company. If not specified, it defaults to Yahoo (YHOO).
+
+
+
Example configuration:
+
+
# Example configuration.yaml entry
+sensor:
+ -platform:yahoo_finance
+ name:Red Hat Inc.
+ symbol:RHT
+
+ -platform:yahoo_finance
+ name:Google
+ symbol:GOOGL
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/sensor.yr/index.html b/components/sensor.yr/index.html
index 05d68c7df4..3b90373eb5 100644
--- a/components/sensor.yr/index.html
+++ b/components/sensor.yr/index.html
@@ -191,6 +191,9 @@ weather forecast is delivered by the Norwegian Meteorological Institute and the
diff --git a/components/sensor.yweather/index.html b/components/sensor.yweather/index.html
index 6a08a18b4f..ee8dbf4a85 100644
--- a/components/sensor.yweather/index.html
+++ b/components/sensor.yweather/index.html
@@ -195,6 +195,9 @@ Use of the Yahoo Weather API should not exceed reasonable request volume. Access
The SleepIQ implementation lets you view sensor data from SleepIQ by SleepNumber. In particular, it lets you see the occupancy and current SleepNumber (ie current firmness) of each side of a SleepNumber bed.
+
+
You will need an account on SleepIQ to use this component.
+
+
To set it up, add the following information to your configuration.yaml file:
+
+
# Example configuration.yaml entry
+sleepiq:
+ username:you@example.com
+ password:omgsecure
+
+
+
+
Configuration variables:
+
+
+
username (Required): Your SleepIQ username (usually an email address).
+
password (Required): Your SleepIQ password.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/sun/index.html b/components/sun/index.html
index 820a60f90a..d29deee7f0 100644
--- a/components/sun/index.html
+++ b/components/sun/index.html
@@ -214,6 +214,9 @@
diff --git a/components/switch.command_line/index.html b/components/switch.command_line/index.html
index 12802f6c55..62a8c76a4c 100644
--- a/components/switch.command_line/index.html
+++ b/components/switch.command_line/index.html
@@ -267,6 +267,9 @@ This switch will shutdown your host immediately, there will be no confirmation.
diff --git a/components/switch.hikvision/index.html b/components/switch.hikvision/index.html
index 529c845e1e..ab8eeb5547 100644
--- a/components/switch.hikvision/index.html
+++ b/components/switch.hikvision/index.html
@@ -168,6 +168,9 @@ Currently works using default https port only.
The isy994 platform allows you to get data from your ISY994 switch from within Home Assistant.
+
+
They will be automatically discovered if the isy994 component is loaded.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/components/switch.knx/index.html b/components/switch.knx/index.html
index 1cb5bad1e5..7bc3fc4dfa 100644
--- a/components/switch.knx/index.html
+++ b/components/switch.knx/index.html
@@ -145,6 +145,9 @@ For switching actuators that are only controlled by a single group address and c
diff --git a/components/switch.mqtt/index.html b/components/switch.mqtt/index.html
index b290eb3662..7f931aeb14 100644
--- a/components/switch.mqtt/index.html
+++ b/components/switch.mqtt/index.html
@@ -226,6 +226,9 @@ Make sure that your topic match exact. some-topi
diff --git a/components/switch.pulseaudio_loopback/index.html b/components/switch.pulseaudio_loopback/index.html
index 2f82619d1d..d8c90d61c5 100644
--- a/components/switch.pulseaudio_loopback/index.html
+++ b/components/switch.pulseaudio_loopback/index.html
@@ -180,6 +180,9 @@ This component relies on raw TCP commands to PulseAudio. In order for PulseAudio
diff --git a/components/switch.rest/index.html b/components/switch.rest/index.html
index c5c4efecd4..f8e3dc28da 100644
--- a/components/switch.rest/index.html
+++ b/components/switch.rest/index.html
@@ -180,6 +180,9 @@ Make sure that the URL matches exactly your endpoint or resource.
diff --git a/components/switch.rfxtrx/index.html b/components/switch.rfxtrx/index.html
index ca13008046..f449ff15d8 100644
--- a/components/switch.rfxtrx/index.html
+++ b/components/switch.rfxtrx/index.html
@@ -215,6 +215,9 @@ Then you should update your configuration to:
diff --git a/components/switch.rpi_rf/index.html b/components/switch.rpi_rf/index.html
index af1da9b214..be88ec62f0 100644
--- a/components/switch.rpi_rf/index.html
+++ b/components/switch.rpi_rf/index.html
@@ -184,6 +184,9 @@ For more info see the PyPi module description: Charles Spirakis
diff --git a/getting-started/automation/index.html b/getting-started/automation/index.html
index c3528a3d34..b89c9a6b81 100644
--- a/getting-started/automation/index.html
+++ b/getting-started/automation/index.html
@@ -212,7 +212,7 @@ The difference between a condition and a trigger can be confusing as they are ve
diff --git a/getting-started/autostart-macos/index.html b/getting-started/autostart-macos/index.html
index 9fa8d70a97..c7376ecdf9 100644
--- a/getting-started/autostart-macos/index.html
+++ b/getting-started/autostart-macos/index.html
@@ -169,7 +169,7 @@ Home Assistant has been uninstalled.
diff --git a/getting-started/basic/index.html b/getting-started/basic/index.html
index ede93cbf0c..960c06ae9c 100644
--- a/getting-started/basic/index.html
+++ b/getting-started/basic/index.html
@@ -207,7 +207,7 @@ If you are planing to expose your Home Assistant instance to the internet and do
For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting assumed_state to false you will get the default switch icon.
+
+
sensor_class
+
Sets the class of the sensor, changing the device state and icon that is displayed on the UI (see below).
+
+
+
+
+
+
+
+
sensor_class
+
Description
+
+
+
+
+
cold
+
On means cold (or too cold)
+
+
+
connectivity
+
On meanse connection present, Off means no connection
+
+
+
gas
+
CO, CO2, etc.
+
+
+
heat
+
On means hot (or too hot)
+
+
+
light
+
Lightness threshold
+
+
+
moisture
+
Specifically a wetness sensor
+
+
+
motion
+
Motion sensor
+
+
+
moving
+
On means moving, Off means stopped
+
+
+
opening
+
Door, window, etc.
+
+
+
power
+
Power, over-current, etc.
+
+
+
safety
+
On meanse unsafe, Off means safe
+
+
+
smoke
+
Smoke detector
+
+
+
sound
+
On means sound detected, Off meanse no sound
+
+
+
vibration
+
On means vibration detected, Off meanse no vibration
+
@@ -218,7 +289,7 @@ New customize information will be applied the next time the state of the entity
diff --git a/getting-started/devices/index.html b/getting-started/devices/index.html
index f4538d18c8..5934ea14b6 100644
--- a/getting-started/devices/index.html
+++ b/getting-started/devices/index.html
@@ -209,7 +209,7 @@ Each group consists of a name and a list of entity IDs. Entity IDs can be retrie
diff --git a/getting-started/installation-docker/index.html b/getting-started/installation-docker/index.html
index 569d28bf69..f3718c7dba 100644
--- a/getting-started/installation-docker/index.html
+++ b/getting-started/installation-docker/index.html
@@ -183,7 +183,7 @@ To do that you have 2 options.
diff --git a/getting-started/installation-raspberry-pi/index.html b/getting-started/installation-raspberry-pi/index.html
index a6bd1707e5..2d08ca58fd 100644
--- a/getting-started/installation-raspberry-pi/index.html
+++ b/getting-started/installation-raspberry-pi/index.html
@@ -305,7 +305,7 @@ To enable One Wire support add the following line to the end of au
diff --git a/getting-started/presence-detection/index.html b/getting-started/presence-detection/index.html
index a6b963105b..d851249cad 100644
--- a/getting-started/presence-detection/index.html
+++ b/getting-started/presence-detection/index.html
@@ -186,7 +186,7 @@ OwnTracks communicates directly with your MQTT broker, no data will pass through
diff --git a/getting-started/scripts-conditions/index.html b/getting-started/scripts-conditions/index.html
index 0c62ba764c..596d4ebf5a 100644
--- a/getting-started/scripts-conditions/index.html
+++ b/getting-started/scripts-conditions/index.html
@@ -305,7 +305,7 @@ This allows you to mix several AND and OR conditions together.
diff --git a/getting-started/troubleshooting-configuration/index.html b/getting-started/troubleshooting-configuration/index.html
index dd5b719c9d..42f5fd6b30 100644
--- a/getting-started/troubleshooting-configuration/index.html
+++ b/getting-started/troubleshooting-configuration/index.html
@@ -229,7 +229,7 @@ Whenever you report an issue, be aware that we are volunteers who do not have ac
diff --git a/getting-started/yaml/index.html b/getting-started/yaml/index.html
index a593492f1b..b7edfa7392 100644
--- a/getting-started/yaml/index.html
+++ b/getting-started/yaml/index.html
@@ -203,7 +203,7 @@ The other properties (like name) are specified using mappings. Note that the sec
Z-Wave is a popular home automation protocol that is not always straightforward to setup. This page will try to help you make sense of it all.
-Upon first run, the z-wave component will take time to initialize entities and entities may appear with incomplete names. Running a network heal may expidite this proccess.
+Upon first run, the zwave component will take time to initialize entities and entities may appear with incomplete names. Running a network heal may expidite this proccess.
-
Supported Z-Wave Sticks
+
Supported Z-Wave USB Sticks & Hardware Modules
@@ -119,6 +119,12 @@ Upon first run, the z-wave component will take time to initialize entities and e
Β
Β
+
+
Pine64 Z-Wave Module
+
β
+
Β
+
Β
+
Razberry GPIO Module
β
@@ -140,6 +146,7 @@ Upon first run, the z-wave component will take time to initialize entities and e
In order for Home Assistant to recognize well the sensor, you will need to change its configuration from Basic Set (default) to Binary Sensor report or Alarm report. Currently thereβs no way to do this in Home Assistant but you can use ozwcp (OpenZWave control panel), Domoticz or similar to do it
+
In order for Home Assistant to recognize well the sensor, you will need to change its configuration from Basic Set (default) to Binary Sensor report or Alarm report. Currently thereβs no way to do this in Home Assistant but you can use ozwcp (OpenZWave control panel), Domoticz or similar to do it.
These devices will either show as a binary sensor or a sensor called Alarm xxxx and will report a numeric value. Test to see what value is what. Sometimes this is noted in the device manual.
Locks and other secure devices
-
These devices require a network key to be set for the zwave network before they are paired. This key is set in OpenZwaveβs options.xml which is located in Open Zwaveβs directory. This should also be the same directory as config_path: in your configuration.yaml. If itβs not, make sure you have the same values in all the files you are using.
+
These devices require a network key to be set for the Z-Wave network before they are paired. This key is set in OpenZwaveβs options.xml which is located in OpenZWaveβs directory. This should also be the same directory as config_path: in your configuration.yaml. If itβs not, make sure you have the same values in all the files you are using.
The option is commented out by default in options.xml and is a default key. Make your own unique key. The key is in Hexadecimals.
-It is best to pair these devices in Open Zwave Control Panel or other Zwave tool that can show you logs while pairing. Test the device before you save the configuration.
-Make sure you copy the newly saved zwcfg_[home_id].xmlinto your HomeAssistant config directory.
+It is best to pair these devices in OpenZWave Control Panel or other Z-wave tool that can show you logs while pairing. Test the device before you save the configuration.
+Make sure you copy the newly saved zwcfg_[home_id].xmlinto your Home Assistant configuration directory.
Aeon Minimote
@@ -231,7 +231,7 @@ Make sure you copy the newly saved zwcfg_[home_i
You may wish to modify the Z-Wave settings in your ozw*.xml file stored in the .homeassistant directory, or certain situations/devices may require it (i.e. Aeon Multisensor 6). To do this, utilize Open-Zwave Control Panel. Alternatively, use Domoticz, which incorporates the Open-Zwave Control Panel project into an easy to use Raspberry Pi image.
+
You may wish to modify the Z-Wave settings in your ozw*.xml file stored in the .homeassistant configuration directory, or certain situations/devices may require it (i.e. Aeon Multisensor 6). To do this, utilize Open-Zwave Control Panel. Alternatively, use Domoticz, which incorporates the Open-Zwave Control Panel project into an easy to use Raspberry Pi image.
-
The reasoning for using these tools is that your Z-Wave controller stores the values and data that are used to control the network. The XML file in the .homeassistant folder acts as a settings/values cache for the Z-Wave network, so modifying it directly wonβt change the network values. The Open-Zwave Control Panel writes values directly to the network and will provide you with an updated .xml file to overwrite in your .homeassistant folder. This is the most foolproof way to make modifications to your Z-Wave devices.
+
The reasoning for using these tools is that your Z-Wave controller stores the values and data that are used to control the network. The XML file in the .homeassistant configuration directory acts as a settings/values cache for the Z-Wave network, so modifying it directly wonβt change the network values. The Open-Zwave Control Panel writes values directly to the network and will provide you with an updated .xml file to overwrite in your .homeassistant configuration directory. This is the most foolproof way to make modifications to your Z-Wave devices.
Although totally normal for your Z-Wave stick (Aeon Aeotec Z-Stick Gen5 for example) to cycle through its LEDs (Yellow, Blue and Red) while plugged into your system. If you don like this behaviour then you could turn it off.
-
Use the following commands from a terminal session to your Pi where your Z-Wave stick is connected as an example.
+
Use the following commands from a terminal session on your Pi where your Z-Wave stick is connected as an example.
Z-Wave integration for Home Assistant allows you to observe and control connected Z-Wave devices. Z-Wave support requires a supported Z-Wave USB stick to be plugged into the host.
+
Z-Wave integration for Home Assistant allows you to observe and control connected Z-Wave devices. Z-Wave support requires a supported Z-Wave USB stick or module to be plugged into the host.
-
There is currently support for switches, lights and sensors. All will be picked up automatically after configuring this platform.
+
There is currently support for climate, covers, lights, locks, sensors, switches and thermostats. All will be picked up automatically after configuring this platform.
Installation
@@ -148,8 +148,8 @@ Instead of make install, you can alternat
usb_path (Required): The port where your device is connected to your Home Assistant host.
-
config_path (Optional): The path to the Python Open Z-Wave configuration files.
-
autoheal (Optional): Allows disabling auto ZWave heal at midnight. Defaults to True.
+
config_path (Optional): The path to the Python OpenZWave configuration files.
+
autoheal (Optional): Allows disabling auto Z-Wave heal at midnight. Defaults to True.
polling_interval (Optional): The time period in milliseconds between polls of a nodes value. Be careful about using polling values below 30000 (30 seconds) as polling can flood the zwave network and cause problems.
customize (Optional): This attribute contains node-specific override values:
@@ -158,7 +158,7 @@ Instead of make install, you can alternat
-
To find the path of your Z-Wave stick, run:
+
To find the path of your Z-Wave USB stick or module, run:
$ ls /dev/ttyUSB*
@@ -170,6 +170,12 @@ Instead of make install, you can alternat
+
Or, on some other systems (such as Pine 64), use:
+
+
$ ls /dev/ttyS*
+
+
+
Or, on macOS, use:
$ ls /dev/cu.usbmodem*
@@ -182,9 +188,9 @@ Depending on whatβs plugged into your USB ports, the name found above may chan
Adding Security Devices
-
Security Z-Wave devices require a network key before being added to the network using the zwave.add_node_secure service. You must edit the options.xml file, located in your python-openzwave config_path to use a network key before adding these devices.
+
Security Z-Wave devices require a network key before being added to the network using the zwave.add_node_secure service. You must edit the options.xml file, located in your python-openzwave config_path to use a network key before adding these devices.
@@ -194,14 +200,14 @@ Depending on whatβs plugged into your USB ports, the name found above may chan
-
You can replace these values with your own 16 byte network key. For more information on this process see the Open-Zwave wiki article Adding Security Devices to OZW
+
You can replace these values with your own 16 byte network key. For more information on this process see the OpenZwave wiki article Adding Security Devices to OZW
Events
zwave.network_complete
-
HomeAssistant will trigger a event when the zwave network is complete. Meaning all of the nodes on the network have been queried. This can take quite som time, depending on wakeup intervals on the battery powered devices on the network.
+
Home Assistant will trigger a event when the Z-Wave network is complete. Meaning all of the nodes on the network have been queried. This can take quite som time, depending on wakeup intervals on the battery powered devices on the network.
-
-alias:ZWave network is complete
+
-alias:Z-Wave network is completetrigger:platform:eventevent_type:zwave.network_complete
@@ -209,9 +215,9 @@ Depending on whatβs plugged into your USB ports, the name found above may chan
zwave.network_ready
-
HomeAssistant will trigger a event when the zwave network is ready for use. Between zwave.network_start and zwave.network_ready HomeAssistant will feel sluggish when trying to send commands to zwave nodes. This is because the controller is requesting information from all of the nodes on the network. When this is triggered all awake nodes have been queried and sleeping nodes will be queried when they awake.
+
Home Assistant will trigger a event when the Z-Wave network is ready for use. Between zwave.network_start and zwave.network_ready Home Assistant will feel sluggish when trying to send commands to Z-Wave nodes. This is because the controller is requesting information from all of the nodes on the network. When this is triggered all awake nodes have been queried and sleeping nodes will be queried when they awake.
-
-alias:ZWave network is ready
+
-alias:Z-Wave network is readytrigger:platform:eventevent_type:zwave.network_ready
@@ -219,9 +225,9 @@ Depending on whatβs plugged into your USB ports, the name found above may chan
zwave.network_start
-
HomeAssistant will trigger a event when the zwave network is set up to be started.
+
Home Assistant will trigger a event when the Z-Wave network is set up to be started.
-
-alias:ZWave network is starting
+
-alias:Z-Wave network is startingtrigger:platform:eventevent_type:zwave.network_start
@@ -229,9 +235,9 @@ Depending on whatβs plugged into your USB ports, the name found above may chan
zwave.network_stop
-
HomeAssistant will trigger a event when the zwave network stopping.
+
Home Assistant will trigger a event when the Z-Wave network stopping.
-
-alias:ZWave network is stopping
+
-alias:Z-Wave network is stoppingtrigger:platform:eventevent_type:zwave.network_stop
@@ -239,7 +245,7 @@ Depending on whatβs plugged into your USB ports, the name found above may chan
zwave.node_event
-
HomeAssistant will trigger a event when command_class_basic changes value on a node.
+
Home Assistant will trigger a event when command_class_basic changes value on a node.
This can be virtually anything, so tests have to be made to determine what value equals what.
You can use this for automations.
@@ -257,8 +263,8 @@ You can use this for automations.
The object_id and basic_level of all triggered events can be seen in the console output.
-
zwave.scene_activated
-Some devices can also trigger scene activation events, which can be used in automation scripts (for example the press of a button on a wall switch):
+
zwave.scene_activated
+
Some devices can also trigger scene activation events, which can be used in automation scripts (for example the press of a button on a wall switch):
# Example configuration.yaml automation entryautomation:
@@ -276,7 +282,7 @@ Some devices can also trigger scene activation events, which can be used in auto
Services
-
The Z-Wave component exposes seven services to help maintain the network.
+
The zwave component exposes ten services to help maintain the network.
@@ -288,28 +294,36 @@ Some devices can also trigger scene activation events, which can be used in auto
add_node
-
Put the zwave controller in inclusion mode. Allows one to add a new device to the zwave network.
+
Put the Z-Wave controller in inclusion mode. Allows one to add a new device to the Z-Wave network.
add_node_secure
-
Put the zwave controller in secure inclusion mode. Allows one to add a new device with secure communications to the zwave network.
+
Put the Z-Wave controller in secure inclusion mode. Allows one to add a new device with secure communications to the Z-Wave network.
cancel_command
-
Cancels a running zwave command. If you have started a add_node or remove_node command, and decides you are not going to do it, then this must be used to stop the inclusion/exclusion command.
+
Cancels a running Z-Wave command. If you have started a add_node or remove_node command, and decides you are not going to do it, then this must be used to stop the inclusion/exclusion command.
heal_network
-
Tells the controller to βhealβ the network. Bascially asks the nodes to tell the controller all of their neighbors so the controller can refigure out optimal routing.
+
Tells the controller to βhealβ the Z-Wave network. Bascially asks the nodes to tell the controller all of their neighbors so the controller can refigure out optimal routing.
remove_node
-
Put the zwave controller in exclusion mode. Allows one to remove a device from the zwave network.
+
Put the Z-Wave controller in exclusion mode. Allows one to remove a device from the Z-Wave network.
soft_reset
Tells the controller to do a βsoft resetβ. This is not supposed to lose any data, but different controllers can behave differently to a βsoft resetβ command.
+
+
start_network
+
Starts the Z-Wave network.
+
+
+
stop_network
+
Stops the Z-Wave network.
+
test_network
Tells the controller to send no-op commands to each node and measure the time for a response. In theory, this can also bring back nodes which have been marked βpresumed deadβ.
@@ -321,8 +335,7 @@ Some devices can also trigger scene activation events, which can be used in auto
-
The soft_reset and heal_network commands can be used as part of an automation script
-to help keep a zwave network running relliably. For example:
+
The soft_reset and heal_network commands can be used as part of an automation script to help keep a Z-Wave network running reliably as shown in the example below. By default, Home Assistant will run a heal_network at midnight. This is a configuration option for the zwave component, the option defaults to true but can be disabled by setting auto_heal to false. Using the soft_reset function with some Z-Wave controllers can cause the Z-Wave network to hang. If youβre having issues with your Z-Wave network try disabling this automation.
# Example configuration.yaml automation entryautomation:
@@ -402,7 +415,7 @@ to help keep a zwave network running relliably. For example: