diff --git a/sass/custom/_paulus.scss b/sass/custom/_paulus.scss index 9ad00e409e..70dbdb2c32 100644 --- a/sass/custom/_paulus.scss +++ b/sass/custom/_paulus.scss @@ -159,6 +159,10 @@ article.post, article.page, article.listing { text-decoration: none; } } + + .frontpage a { + text-decoration: none; + } } p.note { diff --git a/source/_components/alarm_control_panel.alarmdotcom.markdown b/source/_components/alarm_control_panel.alarmdotcom.markdown index 2d81393f77..2e65422593 100644 --- a/source/_components/alarm_control_panel.alarmdotcom.markdown +++ b/source/_components/alarm_control_panel.alarmdotcom.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: alarmdotcom.png ha_category: Alarm +ha_release: 0.11 --- The `alarmdotcom` platform is consuming the information provided by a [Alarm.com](https://www.alarm.com/). diff --git a/source/_components/alarm_control_panel.manual.markdown b/source/_components/alarm_control_panel.manual.markdown index c5ce1ff835..3a4eb6a790 100644 --- a/source/_components/alarm_control_panel.manual.markdown +++ b/source/_components/alarm_control_panel.manual.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: Alarm +ha_release: 0.7.6 --- diff --git a/source/_components/apcupsd.markdown b/source/_components/apcupsd.markdown index 9ecd802fa2..54375c28df 100644 --- a/source/_components/apcupsd.markdown +++ b/source/_components/apcupsd.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: apcupsd.png ha_category: Hub +ha_release: 0.13 --- [APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) is enabled on the APC device. diff --git a/source/_components/binary_sensor.apcupsd.markdown b/source/_components/binary_sensor.apcupsd.markdown index 4d8be1efbd..650786af19 100644 --- a/source/_components/binary_sensor.apcupsd.markdown +++ b/source/_components/binary_sensor.apcupsd.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: apcupsd.png ha_category: Binary Sensor +ha_release: 0.13 --- In addition to the [APCUPSd Sensor](/components/sensor.apcupsd/) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times. diff --git a/source/_components/binary_sensor.arest.markdown b/source/_components/binary_sensor.arest.markdown index 0ded7c3f24..5dc581c119 100644 --- a/source/_components/binary_sensor.arest.markdown +++ b/source/_components/binary_sensor.arest.markdown @@ -10,6 +10,7 @@ footer: true logo: arest.png ha_category: Binary Sensor ha_iot_class: "Local Polling" +ha_release: 0.9 --- diff --git a/source/_components/binary_sensor.bloomsky.markdown b/source/_components/binary_sensor.bloomsky.markdown index 305dbe86c9..ba3b32a98f 100644 --- a/source/_components/binary_sensor.bloomsky.markdown +++ b/source/_components/binary_sensor.bloomsky.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: bloomsky.png ha_category: Binary Sensor +ha_release: 0.14 --- The `bloomsky` binary sensor platform allows you to get data from your BloomSky device. diff --git a/source/_components/binary_sensor.command_line.markdown b/source/_components/binary_sensor.command_line.markdown index f00c788d28..f62784929c 100644 --- a/source/_components/binary_sensor.command_line.markdown +++ b/source/_components/binary_sensor.command_line.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: command_line.png ha_category: Binary Sensor +ha_release: 0.12 --- diff --git a/source/_components/binary_sensor.mqtt.markdown b/source/_components/binary_sensor.mqtt.markdown index ddb23f9df2..a5cd4ab05f 100644 --- a/source/_components/binary_sensor.mqtt.markdown +++ b/source/_components/binary_sensor.mqtt.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: mqtt.png ha_category: Binary Sensor +ha_release: 0.9 --- diff --git a/source/_components/binary_sensor.mysensors.markdown b/source/_components/binary_sensor.mysensors.markdown index 30bdca12b0..32a31c409b 100644 --- a/source/_components/binary_sensor.mysensors.markdown +++ b/source/_components/binary_sensor.mysensors.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: mysensors.png ha_category: Binary Sensor -featured: false +ha_release: 0.14 --- Integrates MySensors binary sensors into Home Assistant. See the [main component] for configuration instructions. diff --git a/source/_components/binary_sensor.nx584.markdown b/source/_components/binary_sensor.nx584.markdown index 65f8ace47b..e9e1ae774d 100644 --- a/source/_components/binary_sensor.nx584.markdown +++ b/source/_components/binary_sensor.nx584.markdown @@ -10,6 +10,7 @@ footer: true logo: networx.png ha_category: Binary Sensor ha_iot_class: "Local Push" +ha_release: 0.14 --- The `nx584` platform provides integration with GE, Caddx, Interlogix (and other brands) alarm panels that support the NX584 interface module (or have it built in). Supported panels include NX4/6/8/8E. Actual integration is done through [pynx584](http://github.com/kk7ds/pynx584) which is required for this to work. @@ -48,4 +49,4 @@ binary_sensor: 2: opening 4: motion 6: moisture -``` \ No newline at end of file +``` diff --git a/source/_components/binary_sensor.rest.markdown b/source/_components/binary_sensor.rest.markdown index d6fc619a1a..1bca8ac767 100644 --- a/source/_components/binary_sensor.rest.markdown +++ b/source/_components/binary_sensor.rest.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: Binary Sensor +ha_release: 0.10 --- diff --git a/source/_components/binary_sensor.tcp.markdown b/source/_components/binary_sensor.tcp.markdown index 9cd1be3043..4f1842d62d 100644 --- a/source/_components/binary_sensor.tcp.markdown +++ b/source/_components/binary_sensor.tcp.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: Binary Sensor +ha_release: 0.14 --- The TCP Binary Sensor is a type of [TCP Sensor](/components/sensor.tcp/) which is either "off" or "on". In order to use this sensor type, in addition to the configuration for the TCP Sensor, you must supply a `value_on` value to represent what is returned when the device is turned on. diff --git a/source/_components/binary_sensor.wink.markdown b/source/_components/binary_sensor.wink.markdown index 4f5cebe235..262d9c4861 100644 --- a/source/_components/binary_sensor.wink.markdown +++ b/source/_components/binary_sensor.wink.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: wink.png ha_category: Binary Sensor +ha_release: 0.14 --- diff --git a/source/_components/binary_sensor.zwave.markdown b/source/_components/binary_sensor.zwave.markdown index d2934cf5c6..80b29acab8 100644 --- a/source/_components/binary_sensor.zwave.markdown +++ b/source/_components/binary_sensor.zwave.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: z-wave.png ha_category: Binary Sensor +ha_release: 0.14 --- To get your Z-Wave binary sensors working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/). diff --git a/source/_components/camera.rpi_camera.markdown b/source/_components/camera.rpi_camera.markdown index a63a436e9e..e2b6b4f263 100644 --- a/source/_components/camera.rpi_camera.markdown +++ b/source/_components/camera.rpi_camera.markdown @@ -10,6 +10,7 @@ footer: true logo: raspberry-pi.png ha_category: Camera ha_iot_class: "Local Polling" +ha_release: 0.17 --- diff --git a/source/_components/camera.uvc.markdown b/source/_components/camera.uvc.markdown index 0bd523537d..152203103f 100644 --- a/source/_components/camera.uvc.markdown +++ b/source/_components/camera.uvc.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: ubiquiti.png ha_category: Camera +ha_release: 0.13 --- diff --git a/source/_components/device_tracker.aruba.markdown b/source/_components/device_tracker.aruba.markdown index 4d76b30dd5..1834d591db 100644 --- a/source/_components/device_tracker.aruba.markdown +++ b/source/_components/device_tracker.aruba.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: aruba.png ha_category: Presence Detection +ha_release: 0.7 --- diff --git a/source/_components/device_tracker.bluetooth_tracker.markdown b/source/_components/device_tracker.bluetooth_tracker.markdown index 141466e17e..f164bdaa3b 100644 --- a/source/_components/device_tracker.bluetooth_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_tracker.markdown @@ -10,6 +10,7 @@ footer: true logo: bluetooth.png ha_category: Presence Detection ha_iot_class: "Local Poll" +ha_release: 0.18 --- This tracker discovers new devices on boot and tracks bluetooth devices periodically based on interval_seconds value. Devices discovered are stored with 'bt_' as the prefix for device mac in `known_devices.yaml`. diff --git a/source/_components/device_tracker.fritz.markdown b/source/_components/device_tracker.fritz.markdown index 2d1a0d11ce..b695d02ad7 100644 --- a/source/_components/device_tracker.fritz.markdown +++ b/source/_components/device_tracker.fritz.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: avm.png ha_category: Presence Detection +ha_release: 0.10 --- diff --git a/source/_components/device_tracker.icloud.markdown b/source/_components/device_tracker.icloud.markdown index ecb6c92887..bc617e0de7 100644 --- a/source/_components/device_tracker.icloud.markdown +++ b/source/_components/device_tracker.icloud.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: icloud.png ha_category: Presence Detection +ha_release: 0.10 --- diff --git a/source/_components/device_tracker.netgear.markdown b/source/_components/device_tracker.netgear.markdown index 8c4febce59..4466885b50 100644 --- a/source/_components/device_tracker.netgear.markdown +++ b/source/_components/device_tracker.netgear.markdown @@ -24,6 +24,7 @@ device_tracker: host: YOUR_ROUTER_IP username: YOUR_ADMIN_USERNAME password: YOUR_ADMIN_PASSWORD + port: YOUR_ROUTER_PORT ``` Configuration variables: @@ -31,5 +32,6 @@ Configuration variables: - **host** (*Required*): The IP address of your router, e.g. 192.168.1.1. - **username** (*Required*: The username of an user with administrative privileges, usually *admin*. - **password** (*Required*): The password for your given admin account. +- **port** (*Optional*): The port your router communicates with (defaults to 5000, but 80 is also known to be used on some models) See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/device_tracker.snmp.markdown b/source/_components/device_tracker.snmp.markdown index 9f23170c6e..7452f39f74 100644 --- a/source/_components/device_tracker.snmp.markdown +++ b/source/_components/device_tracker.snmp.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: network-snmp.png ha_category: Presence Detection +ha_release: 0.7.5 --- diff --git a/source/_components/device_tracker.ubus.markdown b/source/_components/device_tracker.ubus.markdown index 71a8c26db3..ffa6d159d9 100644 --- a/source/_components/device_tracker.ubus.markdown +++ b/source/_components/device_tracker.ubus.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: openwrt.png ha_category: Presence Detection +ha_release: 0.7.6 --- _This is one of the two ways we support OpenWRT. If you encounter problems, try [luci](/components/device_tracker.luci/)._ diff --git a/source/_components/device_tracker.unifi.markdown b/source/_components/device_tracker.unifi.markdown index bd9bfa0540..6ddf916606 100644 --- a/source/_components/device_tracker.unifi.markdown +++ b/source/_components/device_tracker.unifi.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: ubiquiti.png ha_category: Presence Detection +ha_release: 0.14 --- diff --git a/source/_components/feedreader.markdown b/source/_components/feedreader.markdown index 2c35e89c67..70e0718c48 100644 --- a/source/_components/feedreader.markdown +++ b/source/_components/feedreader.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: rss.gif ha_category: Other +ha_release: 0.18 --- Add an RSS/Atom feed reader that polls feeds every hour and sends new entries into the event bus. @@ -26,3 +27,25 @@ feedreader: Configuration variables: - **urls** (*Required*): List of URLS for your feeds. + +Feedreader events can be used out of the box to trigger automation actions, e.g.: + +```yaml +automation: + - alias: Trigger action when new element(s) in RSS feed + trigger: + platform: event + event_type: feedreader + action: + service: script.turn_on + entity_id: script.my_action +``` + +For more advanced use cases, a custom component registering to the `feedreader` event type could be used instead: + +```python +EVENT_FEEDREADER = "feedreader" +hass.bus.listen(EVENT_FEEDREADER, event_listener) +``` + +To get started developing custom components, please refer to the [developers](/developers) documentation diff --git a/source/_components/garage_door.mqtt.markdown b/source/_components/garage_door.mqtt.markdown index 6a4f78936f..b7e78a5c29 100644 --- a/source/_components/garage_door.mqtt.markdown +++ b/source/_components/garage_door.mqtt.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: mqtt.png ha_category: Garage Door +ha_release: 0.18 --- diff --git a/source/_components/garage_door.wink.markdown b/source/_components/garage_door.wink.markdown index 85fc8e388d..d905f66d7e 100644 --- a/source/_components/garage_door.wink.markdown +++ b/source/_components/garage_door.wink.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: wink.png ha_category: Garage Door +ha_release: 0.13 --- Wink garage door functionality is currently limited to view only. Wink garage doors will still show the current state of the door, but control has been disabled for third parties. If you have a Chamberlain garage door, and would like to control it via Home Assistant, please contact Chamberlain and request that they re-enabled third-party control. diff --git a/source/_components/graphite.markdown b/source/_components/graphite.markdown index 8346d0b141..172d17d9b6 100644 --- a/source/_components/graphite.markdown +++ b/source/_components/graphite.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: ha_category: History +ha_release: 0.13 --- The `graphite` component records all events and state changes and feeds the data to a [graphite](http://graphite.wikidot.com/) instance. diff --git a/source/_components/influxdb.markdown b/source/_components/influxdb.markdown index b17c53fd14..adb5c49e8b 100644 --- a/source/_components/influxdb.markdown +++ b/source/_components/influxdb.markdown @@ -10,6 +10,7 @@ footer: true logo: influxdb.png ha_category: "History" featured: true +ha_release: 0.9 --- The `influxdb` component makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. For more details, [see the blog post on InfluxDB](/blog/2015/12/07/influxdb-and-grafana/). diff --git a/source/_components/input_select.markdown b/source/_components/input_select.markdown index dd626c689d..6bc2bddfe3 100644 --- a/source/_components/input_select.markdown +++ b/source/_components/input_select.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Automation +ha_release: 0.13 --- The `input_select` component allows the user to define a list of values that can be selected via the frontend and can be used within conditions of automation. When a user selectes a new item, a state transition event is generated. This state event can be used in an `automation` trigger. diff --git a/source/_components/input_slider.markdown b/source/_components/input_slider.markdown index 9cd341aac9..0fc6fc0897 100644 --- a/source/_components/input_slider.markdown +++ b/source/_components/input_slider.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Automation +ha_release: 0.16 --- The `input_slider` component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the slider generate state events. These state events can be utilized as `automation` triggers as well. diff --git a/source/_components/keyboard.markdown b/source/_components/keyboard.markdown index 40f15421e0..3c020b0d3b 100644 --- a/source/_components/keyboard.markdown +++ b/source/_components/keyboard.markdown @@ -28,7 +28,7 @@ keyboard: ## {% linkable_title Dependencies %} -You may need to install platform-specific [dependencies for PyUserInput](https://github.com/SavinaRoja/PyUserInput#dependencies) in order to use the keyboard component. In most cases this can be done by running: +You may need to install platform-specific [dependencies for PyUserInput](https://github.com/PyUserInput/PyUserInput#dependencies) in order to use the keyboard component. In most cases this can be done by running: ```bash $ pip3 install [package name] diff --git a/source/_components/light.blinksticklight.markdown b/source/_components/light.blinksticklight.markdown index 0d80ee2086..5040ee6fe9 100644 --- a/source/_components/light.blinksticklight.markdown +++ b/source/_components/light.blinksticklight.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: blinkstick.png ha_category: Light +ha_release: 0.7.5 --- diff --git a/source/_components/light.hyperion.markdown b/source/_components/light.hyperion.markdown index 48889a36e8..18e6dcc31f 100644 --- a/source/_components/light.hyperion.markdown +++ b/source/_components/light.hyperion.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: Light +ha_release: 0.7.6 --- This platform allows you to integrate your [Hyperion](https://github.com/tvdzwan/hyperion/wiki) into Home Assistant. diff --git a/source/_components/light.lifx.markdown b/source/_components/light.lifx.markdown index 79ec38d8bd..bc61eef7fb 100644 --- a/source/_components/light.lifx.markdown +++ b/source/_components/light.lifx.markdown @@ -10,6 +10,7 @@ footer: true logo: lifx.png ha_category: Light ha_iot_class: "Local Push" +ha_release: 0.12 --- The `lifx` platform allows you to integrate your [LIFX](http://www.lifx.com) into Home Assistant. diff --git a/source/_components/light.mysensors.markdown b/source/_components/light.mysensors.markdown index 92b06ce967..b66c1b9340 100644 --- a/source/_components/light.mysensors.markdown +++ b/source/_components/light.mysensors.markdown @@ -10,6 +10,7 @@ footer: true logo: mysensors.png ha_category: Light featured: false +ha_release: 0.13 --- Integrates MySensors lights into Home Assistant. See the [main component] for configuration instructions. diff --git a/source/_components/light.rfxtrx.markdown b/source/_components/light.rfxtrx.markdown index c5b42bb52b..95dd54f172 100644 --- a/source/_components/light.rfxtrx.markdown +++ b/source/_components/light.rfxtrx.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: Light +ha_release: 0.7.5 --- The `rfxtrx` platform support lights that communicate in the frequency range of 433.92 MHz. diff --git a/source/_components/light.scsgate.markdown b/source/_components/light.scsgate.markdown index baec226359..5162abe217 100644 --- a/source/_components/light.scsgate.markdown +++ b/source/_components/light.scsgate.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: bus_scs.png ha_category: Light +ha_release: 0.13 --- The SCSGate device can control lights of the BTicino MyHome system. diff --git a/source/_components/light.wemo.markdown b/source/_components/light.wemo.markdown index 21e61accd4..a2ff553aad 100644 --- a/source/_components/light.wemo.markdown +++ b/source/_components/light.wemo.markdown @@ -10,6 +10,7 @@ footer: true logo: belkin_wemo.png ha_category: Light ha_iot_class: "Local Polling" +ha_release: 0.14 --- diff --git a/source/_components/lock.mqtt.markdown b/source/_components/lock.mqtt.markdown index b49309475c..7394ddf773 100644 --- a/source/_components/lock.mqtt.markdown +++ b/source/_components/lock.mqtt.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: mqtt.png ha_category: Lock +ha_release: 0.15 --- The `mqtt` lock platform let you control your MQTT enabled locks. diff --git a/source/_components/lock.verisure.markdown b/source/_components/lock.verisure.markdown index ab4b04de8d..61e901986e 100644 --- a/source/_components/lock.verisure.markdown +++ b/source/_components/lock.verisure.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: verisure.png ha_category: Lock +ha_release: 0.13 --- diff --git a/source/_components/lock.wink.markdown b/source/_components/lock.wink.markdown index d9abf003f8..b12225d5b1 100644 --- a/source/_components/lock.wink.markdown +++ b/source/_components/lock.wink.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: wink.png ha_category: Lock +ha_release: 0.9 --- diff --git a/source/_components/media_player.firetv.markdown b/source/_components/media_player.firetv.markdown index 98f6afe202..9a5aca9937 100644 --- a/source/_components/media_player.firetv.markdown +++ b/source/_components/media_player.firetv.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: firetv.png ha_category: Media Player +ha_release: 0.7.6 --- diff --git a/source/_components/media_player.onkyo.markdown b/source/_components/media_player.onkyo.markdown index 7303fe90f5..dca6873bf1 100644 --- a/source/_components/media_player.onkyo.markdown +++ b/source/_components/media_player.onkyo.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: onkyo.png ha_category: Media Player +ha_release: 0.17 --- diff --git a/source/_components/media_player.panasonic_viera.markdown b/source/_components/media_player.panasonic_viera.markdown index 744869cc2e..f9135c75fc 100644 --- a/source/_components/media_player.panasonic_viera.markdown +++ b/source/_components/media_player.panasonic_viera.markdown @@ -10,6 +10,7 @@ footer: true logo: panasonic.png ha_category: Media Player featured: false +ha_release: 0.17 --- The `panasonic_viera` platform allows you to control a Panasonic Viera TV. diff --git a/source/_components/media_player.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown index 273e96b694..75cff8e9a3 100644 --- a/source/_components/media_player.samsungtv.markdown +++ b/source/_components/media_player.samsungtv.markdown @@ -10,6 +10,7 @@ footer: true logo: samsung.png ha_category: Media Player featured: false +ha_release: 0.13 --- The `samsungtv` platform allows you to control a [Samsung Smart TV](http://www.samsung.com/uk/consumer/tv-audio-video/televisions/). @@ -35,6 +36,7 @@ Configuration variables: Currently known supported models: - C7700 +- D7000 - D8000 - ES5500 - ES6800 diff --git a/source/_components/media_player.snapcast.markdown b/source/_components/media_player.snapcast.markdown index 7dee79e7a0..f694932b9b 100644 --- a/source/_components/media_player.snapcast.markdown +++ b/source/_components/media_player.snapcast.markdown @@ -10,6 +10,7 @@ footer: true logo: ha_category: Media Player featured: false +ha_release: 0.13 --- The `snapcast` platform allows you to control [SnapCast](https://github.com/badaix/snapcast) from Home Assistant. diff --git a/source/_components/media_player.webostv.markdown b/source/_components/media_player.webostv.markdown index bf3aa6dc86..32e65807f1 100644 --- a/source/_components/media_player.webostv.markdown +++ b/source/_components/media_player.webostv.markdown @@ -10,6 +10,7 @@ footer: true logo: webos.png ha_category: Media Player ha_iot_class: "Local Poll" +ha_release: 0.18 --- The `webostv` platform allows you to control a LG WebOS Smart TV. diff --git a/source/_components/media_player.yamaha.markdown b/source/_components/media_player.yamaha.markdown index a76776a35e..85c6e4e07d 100644 --- a/source/_components/media_player.yamaha.markdown +++ b/source/_components/media_player.yamaha.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: yamaha.png ha_category: Media Player +ha_release: 0.16 --- The `yamaha` platform allows you to control [Yamaha Network Receivers](http://usa.yamaha.com/products/audio-visual/av-receivers-amps/rx) from Home Assistant. diff --git a/source/_components/mqtt_eventstream.markdown b/source/_components/mqtt_eventstream.markdown index b31c1c71f0..4844302ac2 100644 --- a/source/_components/mqtt_eventstream.markdown +++ b/source/_components/mqtt_eventstream.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: mqtt.png ha_category: Other +ha_release: 0.11 --- The `mqtt_eventstream` components connects two Home Assistant instances via MQTT. diff --git a/source/_components/notify.command_line.markdown b/source/_components/notify.command_line.markdown index e00b840288..b6f7a2ce9e 100644 --- a/source/_components/notify.command_line.markdown +++ b/source/_components/notify.command_line.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: command_line.png ha_category: Notifications +ha_release: 0.14 --- The `command_line` platform allows you to use external tools for notifications from Home Assistant. The message will be passed in as STDIN. diff --git a/source/_components/notify.free_mobile.markdown b/source/_components/notify.free_mobile.markdown index 43ae84c090..ed79113add 100644 --- a/source/_components/notify.free_mobile.markdown +++ b/source/_components/notify.free_mobile.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: free_mobile.png ha_category: Notifications +ha_release: 0.11 --- The `free_mobile` platform is using the French mobile operator [Free Mobile](http://mobile.free.fr/) to send SMS to your own cell phone. diff --git a/source/_components/notify.gntp.markdown b/source/_components/notify.gntp.markdown index f54d0344b2..bf84923a0e 100644 --- a/source/_components/notify.gntp.markdown +++ b/source/_components/notify.gntp.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: gntp.png ha_category: Notifications +ha_release: 0.16 --- diff --git a/source/_components/notify.message_bird.markdown b/source/_components/notify.message_bird.markdown index 82209bda95..3a48b2d9f0 100644 --- a/source/_components/notify.message_bird.markdown +++ b/source/_components/notify.message_bird.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: message_bird.png ha_category: Notifications +ha_release: 0.16 --- The `MessageBird` notification platform sends notifications as SMS messages using [MessageBird](https://www.messagebird.com/) to your mobile phone. diff --git a/source/_components/notify.rest.markdown b/source/_components/notify.rest.markdown index 0d10da00b3..253b78096d 100644 --- a/source/_components/notify.rest.markdown +++ b/source/_components/notify.rest.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: Notifications +ha_release: 0.13 --- diff --git a/source/_components/notify.telegram.markdown b/source/_components/notify.telegram.markdown index bf8b2b8f8b..e2f656f92d 100644 --- a/source/_components/notify.telegram.markdown +++ b/source/_components/notify.telegram.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: telegram.png ha_category: Notifications +ha_release: 0.7.5 --- diff --git a/source/_components/notify.twitter.markdown b/source/_components/notify.twitter.markdown index 2b4a4ea740..c8f22d3ffc 100644 --- a/source/_components/notify.twitter.markdown +++ b/source/_components/notify.twitter.markdown @@ -9,12 +9,13 @@ sharing: true footer: true logo: twitter.png ha_category: Notifications +ha_release: 0.12 --- The `twitter` platform uses [Twitter](https://twitter.com) to delivery notifications from Home Assistant. -Go to [Twitter Apps](https://apps.twitter.com/app/new) and create an application. Visit "Keys and Access Tokens" of the application to get the details ("Consumer Key", "Consumer Secret", and "Access Token Secret" which needs to be generated). +Go to [Twitter Apps](https://apps.twitter.com/app/new) and create an application. Visit "Keys and Access Tokens" of the application to get the details ("Consumer Key", "Consumer Secret", "Access Token" and "Access Token Secret" which needs to be generated). To add Twitter to your installation, add the following to your `configuration.yaml` file: @@ -25,6 +26,7 @@ notify: platform: twitter consumer_key: ABCDEFGHJKLMNOPQRSTUVXYZ consumer_secret: ABCDEFGHJKLMNOPQRSTUVXYZ + access_token: ABCDEFGHJKLMNOPQRSTUVXYZ access_token_secret: ABCDEFGHJKLMNOPQRSTUVXYZ ``` @@ -33,6 +35,7 @@ Configuration variables: - **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`. - **consumer_key** (*Required*): Your "Consumer Key" (API Key) for the application. - **consumer_secret** (*Required*): Your "Consumer Secret" (API Secret) for the application. +- **access_token** (*Required*): Your "Access Token" for the application. - **access_token_secret** (*Required*): Your "Access Token Secret" for the application. To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/notify.webostv.markdown b/source/_components/notify.webostv.markdown index d5d4c190d8..f69708da52 100644 --- a/source/_components/notify.webostv.markdown +++ b/source/_components/notify.webostv.markdown @@ -10,6 +10,7 @@ footer: true logo: webos.png ha_category: Notifications ha_iot_class: "Local Poll" +ha_release: 0.18 --- The `webostv` platform allows you to send notifications to a LG WebOS Smart TV. diff --git a/source/_components/proximity.markdown b/source/_components/proximity.markdown index 04a0c0fc2c..c0fdcd24cd 100644 --- a/source/_components/proximity.markdown +++ b/source/_components/proximity.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Organization +ha_release: 0.13 --- The `proximity` component allows you to monitor the proximity of devices to a particular [zone](/components/zone/) and the direction of travel. The result is an entity created in Home Assistant which maintains the proximity data. diff --git a/source/_components/rollershutter.command_line.markdown b/source/_components/rollershutter.command_line.markdown index 789dc64207..6a2651f61a 100644 --- a/source/_components/rollershutter.command_line.markdown +++ b/source/_components/rollershutter.command_line.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: command_line.png ha_category: Rollershutter +ha_release: 0.14 --- A rollershutter platform that issues specific commands when it is moved up, down and stopped. This might very well become our most powerful platform as it allows anyone to integrate any type of rollershutter into Home Assistant that can be controlled from the command line, including calling other scripts! diff --git a/source/_components/rollershutter.mqtt.markdown b/source/_components/rollershutter.mqtt.markdown index 51a840c3a9..a880f101a3 100644 --- a/source/_components/rollershutter.mqtt.markdown +++ b/source/_components/rollershutter.mqtt.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: mqtt.png ha_category: Rollershutter +ha_release: 0.9 --- diff --git a/source/_components/scene.hunterdouglas_powerview.markdown b/source/_components/scene.hunterdouglas_powerview.markdown index d35c4e49ec..3c6ab60238 100644 --- a/source/_components/scene.hunterdouglas_powerview.markdown +++ b/source/_components/scene.hunterdouglas_powerview.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: hunter-douglas-powerview.png ha_category: Rollershutter +ha_release: 0.15 --- Implements the [Hunter Douglas PowerView](http://www.hunterdouglas.com/operating-systems/powerview-motorization/support) platform scene control. It queries the PowerView Hub and Home Assistant displays them as scenes. diff --git a/source/_components/scsgate.markdown b/source/_components/scsgate.markdown index 62930c52f4..43841dc0cd 100644 --- a/source/_components/scsgate.markdown +++ b/source/_components/scsgate.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: bus_scs.png ha_category: Hub +ha_release: 0.13 --- The SCSGate component support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a homebrew device allows to interact with the MyHome system from BTicino/Legrande. diff --git a/source/_components/sensor.dht.markdown b/source/_components/sensor.dht.markdown index 271be938f1..d559e85fdd 100644 --- a/source/_components/sensor.dht.markdown +++ b/source/_components/sensor.dht.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: DIY +ha_release: 0.7 --- diff --git a/source/_components/sensor.dweet.markdown b/source/_components/sensor.dweet.markdown index 5d20971bf4..1894645a77 100644 --- a/source/_components/sensor.dweet.markdown +++ b/source/_components/sensor.dweet.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: dweet.png ha_category: Sensor +ha_release: 0.10 --- The `dweet` sensor platform allows you to get details from your devices which are publishing their values to [Dweet.io](https://dweet.io/). diff --git a/source/_components/sensor.eliqonline.markdown b/source/_components/sensor.eliqonline.markdown index 44f3214b2d..c39161635f 100644 --- a/source/_components/sensor.eliqonline.markdown +++ b/source/_components/sensor.eliqonline.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: eliq.png ha_category: Sensor +ha_release: 0.10 --- diff --git a/source/_components/sensor.gtfs.markdown b/source/_components/sensor.gtfs.markdown index dce5fb4dd3..306d9dfdf8 100644 --- a/source/_components/sensor.gtfs.markdown +++ b/source/_components/sensor.gtfs.markdown @@ -10,6 +10,7 @@ footer: true logo: 'gtfs.png' ha_category: Sensor ha_iot_class: "Local Polling" +ha_release: 0.17 --- diff --git a/source/_components/sensor.loop_energy.markdown b/source/_components/sensor.loop_energy.markdown index df3e1d6c45..0e399d3d66 100644 --- a/source/_components/sensor.loop_energy.markdown +++ b/source/_components/sensor.loop_energy.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: loop.png ha_category: Sensor +ha_release: 0.17 --- diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown index be3d99c360..f6c4c5e148 100644 --- a/source/_components/sensor.mqtt.markdown +++ b/source/_components/sensor.mqtt.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: mqtt.png ha_category: Sensor +ha_release: 0.7 --- diff --git a/source/_components/sensor.neurio_energy.markdown b/source/_components/sensor.neurio_energy.markdown index 502b2b0835..6ef192d745 100644 --- a/source/_components/sensor.neurio_energy.markdown +++ b/source/_components/sensor.neurio_energy.markdown @@ -10,6 +10,7 @@ footer: true logo: neurio.png ha_category: Sensor ha_iot_class: "Cloud Polling" +ha_release: 0.14 --- diff --git a/source/_components/sensor.nzbget.markdown b/source/_components/sensor.nzbget.markdown index 359ab33e10..b5b2ab5d06 100644 --- a/source/_components/sensor.nzbget.markdown +++ b/source/_components/sensor.nzbget.markdown @@ -9,6 +9,7 @@ sharing: true footer: true ha_category: Sensor ha_iot_class: "Local Polling" +ha_release: 0.17 --- The `NZBGet` platform will allow you to monitor your downloads with [NZBGet](http://NZBGet.net) from within Home Assistant and setup automation based on the information. diff --git a/source/_components/sensor.onewire.markdown b/source/_components/sensor.onewire.markdown index 15fb06ec85..1acd557c5a 100644 --- a/source/_components/sensor.onewire.markdown +++ b/source/_components/sensor.onewire.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: Sensor +ha_release: 0.12 --- The `onewire` platform supports sensors which are using the One wire (1-wire) bus for communication. diff --git a/source/_components/sensor.speedtest.markdown b/source/_components/sensor.speedtest.markdown index a2d22c2b20..29b620cce1 100644 --- a/source/_components/sensor.speedtest.markdown +++ b/source/_components/sensor.speedtest.markdown @@ -10,6 +10,7 @@ footer: true logo: speedtest.png ha_category: Sensor featured: false +ha_release: 0.13 --- The `speedtest` sensor component uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance. diff --git a/source/_components/sensor.steam_online.markdown b/source/_components/sensor.steam_online.markdown index c3a7a9d71d..dd448fe0de 100644 --- a/source/_components/sensor.steam_online.markdown +++ b/source/_components/sensor.steam_online.markdown @@ -2,13 +2,15 @@ layout: page title: "Steam" description: "Instructions on how to set up Steam sensors in Home Assistant." -date: 2015-12-19 09:00 +date: 2016-04-30 09:00 sidebar: true comments: false sharing: true footer: true logo: steam.png ha_category: Sensor +ha_iot_class: "Cloud Polling" +ha_release: 0.14 --- diff --git a/source/_components/sensor.tcp.markdown b/source/_components/sensor.tcp.markdown index bbf501e734..6e5bc6a0a4 100644 --- a/source/_components/sensor.tcp.markdown +++ b/source/_components/sensor.tcp.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: Sensor +ha_release: 0.14 --- The TCP component allows the integration of some services for which a specific Home Assistant component does not exist. If the service communicates over a TCP socket with a simple request/reply mechanism then the chances are that this component will allow integration with it. diff --git a/source/_components/sensor.template.markdown b/source/_components/sensor.template.markdown index 27f78dead2..956d276aca 100644 --- a/source/_components/sensor.template.markdown +++ b/source/_components/sensor.template.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: Sensor +ha_release: 0.12 --- The `template` platform supports sensors which breaks out `state_attributes` from other entities. diff --git a/source/_components/sensor.thinkingcleaner.markdown b/source/_components/sensor.thinkingcleaner.markdown index 564fcbda43..b3562066f5 100644 --- a/source/_components/sensor.thinkingcleaner.markdown +++ b/source/_components/sensor.thinkingcleaner.markdown @@ -10,6 +10,7 @@ footer: true logo: thinkingcleaner.png ha_category: Sensor ha_iot_class: "Local Poll" +ha_release: 0.18 --- The `ThinkingCleaner` sensor platform simple displays information about your [ThinkingCleaner](http://www.thinkingcleaner.com) addon. diff --git a/source/_components/sensor.torque.markdown b/source/_components/sensor.torque.markdown index f8911e5fad..1ba4627919 100644 --- a/source/_components/sensor.torque.markdown +++ b/source/_components/sensor.torque.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: torque.png ha_category: Sensor +ha_release: 0.10 --- The `torque` platform will allow you to monitor [Torque](http://torque-bhp.com/) data relayed from a bluetooth OBD2 stick via the Torque mobile application. diff --git a/source/_components/sensor.twitch.markdown b/source/_components/sensor.twitch.markdown index b1b81299ca..4edbbbcfe1 100644 --- a/source/_components/sensor.twitch.markdown +++ b/source/_components/sensor.twitch.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: twitch.png ha_category: Sensor +ha_release: 0.10 --- diff --git a/source/_components/sensor.uber.markdown b/source/_components/sensor.uber.markdown index 6b1dee6a78..e73bf44d7a 100644 --- a/source/_components/sensor.uber.markdown +++ b/source/_components/sensor.uber.markdown @@ -10,6 +10,7 @@ footer: true logo: uber.png ha_category: Sensor ha_iot_class: "Cloud Polling" +ha_release: 0.16 --- diff --git a/source/_components/sensor.yr.markdown b/source/_components/sensor.yr.markdown index 3c0072da25..0cbeb4f7f0 100644 --- a/source/_components/sensor.yr.markdown +++ b/source/_components/sensor.yr.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: yr.png ha_category: Weather +ha_release: 0.11 --- diff --git a/source/_components/splunk.markdown b/source/_components/splunk.markdown index 12c81cc4ab..514b908b14 100644 --- a/source/_components/splunk.markdown +++ b/source/_components/splunk.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: splunk.png ha_category: "History" +ha_release: 0.13 --- The `splunk` component makes it possible to log all state changes to an external [Splunk](http://splunk.com/) database using Splunk's HTTP Event Collector feature. You can either use this alone, or with the HomeAssistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). Since the HEC feature is new to Splunk, you will need to use at least version 6.3. diff --git a/source/_components/statsd.markdown b/source/_components/statsd.markdown index 80a473c445..0ad7398e3c 100644 --- a/source/_components/statsd.markdown +++ b/source/_components/statsd.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: "History" +ha_release: 0.12 --- The `statsd` component makes it possible to transfer all state changes to an external [StatsD](https://github.com/etsy/statsd) instance. diff --git a/source/_components/switch.arest.markdown b/source/_components/switch.arest.markdown index f3e3223176..9307e02953 100644 --- a/source/_components/switch.arest.markdown +++ b/source/_components/switch.arest.markdown @@ -10,6 +10,7 @@ footer: true logo: arest.png ha_category: Switch ha_iot_class: "Local Polling" +ha_release: 0.16 --- The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with a ethernet/wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. diff --git a/source/_components/switch.dlink.markdown b/source/_components/switch.dlink.markdown index 7be07433dd..405c6a6624 100644 --- a/source/_components/switch.dlink.markdown +++ b/source/_components/switch.dlink.markdown @@ -10,6 +10,7 @@ footer: true logo: dlink.png ha_category: Switch ha_iot_class: "Local Polling" +ha_release: 0.14 --- diff --git a/source/_components/switch.mqtt.markdown b/source/_components/switch.mqtt.markdown index 746b0b26da..a12213a51f 100644 --- a/source/_components/switch.mqtt.markdown +++ b/source/_components/switch.mqtt.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: mqtt.png ha_category: Switch +ha_release: 0.7 --- The `mqtt` switch platform let you control your MQTT enabled light. diff --git a/source/_components/switch.pulseaudio_loopback.markdown b/source/_components/switch.pulseaudio_loopback.markdown index afb00a3095..bf8d0bf5f9 100644 --- a/source/_components/switch.pulseaudio_loopback.markdown +++ b/source/_components/switch.pulseaudio_loopback.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: pulseaudio.png ha_category: Switch +ha_release: 0.16 --- diff --git a/source/_components/switch.rest.markdown b/source/_components/switch.rest.markdown index 3d56ca231b..b2c7e02711 100644 --- a/source/_components/switch.rest.markdown +++ b/source/_components/switch.rest.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: Switch +ha_release: 0.7.6 --- diff --git a/source/_components/switch.rfxtrx.markdown b/source/_components/switch.rfxtrx.markdown index 7621a3cdf9..ee66a922d7 100644 --- a/source/_components/switch.rfxtrx.markdown +++ b/source/_components/switch.rfxtrx.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: Switch +ha_release: 0.7.5 --- The `rfxtrx` platform support switches that communicate in the frequency range of 433.92 MHz. diff --git a/source/_components/switch.scsgate.markdown b/source/_components/switch.scsgate.markdown index 2c257b7ce4..d09b50de07 100644 --- a/source/_components/switch.scsgate.markdown +++ b/source/_components/switch.scsgate.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: bus_scs.png ha_category: Switch +ha_release: 0.13 --- The SCSGate device can control switches of the BTicino MyHome system. diff --git a/source/_components/switch.template.markdown b/source/_components/switch.template.markdown index 2f5f627ec2..21057e5878 100644 --- a/source/_components/switch.template.markdown +++ b/source/_components/switch.template.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: Switch +ha_release: 0.13 --- The `template` platform creates switches that combine components. diff --git a/source/_components/switch.thinkingcleaner.markdown b/source/_components/switch.thinkingcleaner.markdown index 15c6d553d5..a8137652fc 100644 --- a/source/_components/switch.thinkingcleaner.markdown +++ b/source/_components/switch.thinkingcleaner.markdown @@ -10,6 +10,7 @@ footer: true logo: thinkingcleaner.png ha_category: Switch ha_iot_class: "Local Poll" +ha_release: 0.18 --- The `ThinkingCleaner` switch platform allows you to control your [ThinkingCleaner](http://www.thinkingcleaner.com) addon. @@ -22,4 +23,4 @@ switch: - platform: thinkingcleaner ``` -This will automatically add switches for each Thinking Cleaner in your network. \ No newline at end of file +This will automatically add switches for each Thinking Cleaner in your network. diff --git a/source/_components/switch.wake_on_lan.markdown b/source/_components/switch.wake_on_lan.markdown index 53e9e12504..c9d3344359 100644 --- a/source/_components/switch.wake_on_lan.markdown +++ b/source/_components/switch.wake_on_lan.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: ethernet.png ha_category: Switch +ha_release: 0.16 --- The `wake_on_lan` (WOL) switch platform allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer. diff --git a/source/_components/tellduslive.markdown b/source/_components/tellduslive.markdown index 3898d4d89b..134440c00a 100644 --- a/source/_components/tellduslive.markdown +++ b/source/_components/tellduslive.markdown @@ -10,6 +10,7 @@ footer: true logo: telldus.png ha_category: Hub featured: false +ha_release: 0.11 --- The `tellduslive` component let you connect to [Telldus Live](https://live.telldus.com). It's cloud platform that connects to your Tellstick connected gear at home. diff --git a/source/_components/thermostat.ecobee.markdown b/source/_components/thermostat.ecobee.markdown index d209c458a0..15a7f040d2 100644 --- a/source/_components/thermostat.ecobee.markdown +++ b/source/_components/thermostat.ecobee.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: ecobee.png ha_category: Thermostat +ha_release: 0.9 --- To get your Ecobee thermostats working with Home Assistant, follow the instructions for the general [Ecobee component](/components/ecobee/). diff --git a/source/_components/thermostat.heatmiser.markdown b/source/_components/thermostat.heatmiser.markdown index f528f579b0..1143dbc07a 100644 --- a/source/_components/thermostat.heatmiser.markdown +++ b/source/_components/thermostat.heatmiser.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: heatmiser.png ha_category: Thermostat +ha_release: 0.10 --- diff --git a/source/_components/thermostat.homematic.markdown b/source/_components/thermostat.homematic.markdown index dc206f5a7a..e7b85c7290 100644 --- a/source/_components/thermostat.homematic.markdown +++ b/source/_components/thermostat.homematic.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: homematic.png ha_category: Thermostat +ha_release: 0.9 --- diff --git a/source/_components/thermostat.proliphix.markdown b/source/_components/thermostat.proliphix.markdown index c9c13f91d1..13b53668b8 100644 --- a/source/_components/thermostat.proliphix.markdown +++ b/source/_components/thermostat.proliphix.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: proliphix.png ha_category: Thermostat +ha_release: 0.11 --- diff --git a/source/_components/thermostat.zwave.markdown b/source/_components/thermostat.zwave.markdown index 58bff34961..3817564c5b 100644 --- a/source/_components/thermostat.zwave.markdown +++ b/source/_components/thermostat.zwave.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: z-wave.png ha_category: Thermostat +ha_release: 0.17 --- To get your Z-Wave thermostat working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/). diff --git a/source/_components/upnp.markdown b/source/_components/upnp.markdown index 1ce3785115..64061eb08a 100644 --- a/source/_components/upnp.markdown +++ b/source/_components/upnp.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: "Other" +ha_release: 0.18 --- The `upnp` component automatically creates port forwarding mappings on your router for Home Assistant. UPnP or NAT-PMP needs to be enabled on your router for this component to work. diff --git a/source/_components/weblink.markdown b/source/_components/weblink.markdown index 69467bfaaf..1b91e3f722 100644 --- a/source/_components/weblink.markdown +++ b/source/_components/weblink.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: ha_category: Other +ha_release: 0.13 --- The `weblink` component allows you to display links in the Home Assistant frontend. diff --git a/source/_components/zeroconf.markdown b/source/_components/zeroconf.markdown index a8aaf11101..f243c10dbf 100644 --- a/source/_components/zeroconf.markdown +++ b/source/_components/zeroconf.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true ha_category: "Other" +ha_release: 0.18 --- The `zeroconf` component exposes your Home Assistant to the local network using [Zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking). Zeroconf is also sometimes known as Bonjour, Rendezvous and Avahi. diff --git a/source/_components/zigbee.markdown b/source/_components/zigbee.markdown index 01770a49e1..0d973649f9 100644 --- a/source/_components/zigbee.markdown +++ b/source/_components/zigbee.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: zigbee.png ha_category: DIY +ha_release: 0.12 --- [ZigBee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilise modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The component requires a local ZigBee device to be connected over a serial port. Through this it will send and receive commands to and from other devices on the ZigBee mesh network. diff --git a/source/_components/zwave.markdown b/source/_components/zwave.markdown index 9b759cb93e..248e7d8d36 100644 --- a/source/_components/zwave.markdown +++ b/source/_components/zwave.markdown @@ -214,3 +214,7 @@ Here's a handy configuration for the Aeon Labs Minimote that defines all possibl entity_id: aeon_labs_minimote_1 scene_id: 8 ``` + +##### {% linkable_title Aeotec MultiSensor 6 %} + +In order for Home Assistant to recognize well the motion sensor, you will need to change its configuration from `Basic Set (default)` to `Binary Sensor 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 diff --git a/source/_cookbook/python_component_basic_state.markdown b/source/_cookbook/python_component_basic_state.markdown index 7a95cec30a..d81d478ad1 100644 --- a/source/_cookbook/python_component_basic_state.markdown +++ b/source/_cookbook/python_component_basic_state.markdown @@ -10,7 +10,7 @@ footer: true ha_category: Custom Python Component Examples --- -This is a simple tutorial/example on how to write a component for [Home Assistant](https://home-assistant.io/). We will work on a component called "hello_state" to beginn with. The purpose of this component is to display a given text in the frontend. +This is a simple tutorial/example on how to write a component for [Home Assistant](https://home-assistant.io/). We will work on a component called "hello_state" to begin with. The purpose of this component is to display a given text in the frontend. The setup of a development environment is described in the [Developers section](/developers/#starting-development) of the documentation. diff --git a/source/_includes/asides/component_navigation.html b/source/_includes/asides/component_navigation.html index 6fc98ef023..66c5fc2964 100644 --- a/source/_includes/asides/component_navigation.html +++ b/source/_includes/asides/component_navigation.html @@ -27,6 +27,12 @@ {% endif %} + {% if page.ha_release %} +
+ Introduced in release: {{ page.ha_release }} +
+ {% endif %} + {% if is_platform and parent_name != 'sensor' and parent_name != 'binary_sensor' %}
This is a platform for diff --git a/source/_posts/2016-04-30-ibeacons-part-1-making-presence-detection-work-better.markdown b/source/_posts/2016-04-30-ibeacons-part-1-making-presence-detection-work-better.markdown new file mode 100644 index 0000000000..07e518a783 --- /dev/null +++ b/source/_posts/2016-04-30-ibeacons-part-1-making-presence-detection-work-better.markdown @@ -0,0 +1,140 @@ +--- +layout: post +title: "iBeacons: Making presence detection work better (part I)" +description: A step by step guide how to vastly improve your presence detection by integrating iBeacons. +date: 2016-04-30 07:50:09 +0100 +date_formatted: "April 30, 2016" +author: Greg Dowling +author_twitter: pavoni240 +comments: true +categories: iBeacons Presence-Detection OwnTracks +--- + +_This post is by Home Assistant contributor [Greg Dowling](https://github.com/pavoni)._ + +In 2013 Apple introduced iBeacons: a class of Bluetooth low energy (LE) devices that broadcast their identifier to nearby devices, including most smartphones. At first glance it’s hard to imagine why they might be useful. In this two part blog I’ll try and explain why they are useful and how you can use them with Home Assistant. + +The reason I started using iBeacons was to improve presence detection (and I think that’s the case with most people) so that's what I’ll discuss in _part 1_. In _part 2_ I’ll talk about using iBeacons to track devices that can’t track themselves. + +### {% linkable_title Using beacons to improve OwnTracks location data %} + +When you use OwnTracks in standard _major move_ mode (which is kind to your phone battery) it sometimes fails to update when you’d like it to. In my case I found that it would often send a location update as I was on my way home, but then not update when I got home. The result would be that Home Assistant would think I was 500M away from home, and take quite a while to notice I was home. It would also mean that the automation that should turn on my lights when I got home didn’t work very well! There were a few times when my phone location updated at 2am and turned the lights on for me. Fortunately my wife is very patient! + +Luckily, OwnTracks supports iBeacons so I could use them to make presence detection more reliable. When OwnTracks sees a beacon it recognises, it will send an update. This means that if you put a beacon at your front door - OwnTracks will see it within a few seconds of you arriving home - and send an update saying it has seen this iBeacon. + + + +### {% linkable_title Getting Started %} + +To do this you first need to set up [MQTT] and [OwnTracks] in Home assistant - and make sure that HA can track your phone. + +[MQTT]: /components/mqtt/#picking-a-broker +[OwnTracks]: /components/device_tracker.owntracks/ + +You then have to (A) tell Home Assistant where the beacon is located and (B) tell OwnTracks to recognise the beacon. + +#### {% linkable_title A. Tell Home Assistant where your beacon is located %} + +You tell HomeAssistant about fixed locations by creating a Zone with the longitude and latitude of your beacon. You should also give the zone a name which you will also use when you set up OwnTracks. An an example this zone specifies the location of my drive way. + +**Example `configuration.yaml` entry** + +````yaml + +zone: + - name: 'Drive' + latitude: XXX + longitude: YYY + radius: 100 +```` + +The radius isn’t used by the beacon code, but it is used by the GPS location sensing code. I’ll come back to this a little later. For now just use 50 or 100. + +Once you’ve created the zone - you need to restart HA. The next step is:- + +#### {% linkable_title B. Tell OwnTracks to track your beacon %} + +1. Go to the OwnTracks app on your phone +2. Touch the `Regions` menu at the bottom of the screen +3. Touch the `+` symbol at the top right of the screen +4. Give the beacon a name e.g. `-drive` ’(start the name with a `-` see below for the reason) +5. Turn Share to `On` +6. Skip the `Circular Region` section +7. Enter the `UUID` of your beacon - this may be written on your beacon - or you can copy it from the management app that came with your iBeacon device. It’s a long number – so it’s easier to copy if you can! +8. Enter the `Minor` and `Major` numbers for your iBeacon - or leave them at 0 which will match all beacons with that `UUID` + +

+ +

+ +Once you’ve added the iBeacon - you should be able to see it on the OwnTracks region screen. If your phone can see the packets from that beacon, OwnTracks will turn the relevant Region red. + +

+ +

+ +When OwnTracks sees the beacon (and turns the region red), it also sends an MQTT packet to HA to say that you have entered that region. + +The result of the configuration above would be to set the location of device.phone to `Drive` , (and the GPS location to XXX,YYY) when your phone sees the beacon. + +So with the steps above you should be able to improve the reliability of tracking your phone - and send timely updates to HA. I did this for my home - and the lights now turn on before I reach the house on foot. If I arrive by car they turn on within a few seconds of arriving, before I can get to the front door. + +I’m also pleased to say I no longer get an _arrive home_ event at 2am that turns the lights on. I hope I’ve convinced you that iBeacons are worth trying! + +### {% linkable_title Mixing Beacons and GPS locations %} + +You will probably use beacons to make entry into your existing GPS zones more reliable. By default either a beacon or a GPS location can cause you to enter a zone - and HA has some logic that should make them two work well together (it ignores GPS updates when you’re in an iBeacon Zone). + +However you can also use beacons for situations where GPS doesn’t work well. + +This might be because the zones are too close together - or even on top of each other! +For example, my wife works next door - and I couldn’t detect whether she’s at home or in the office via GPS because the accuracy wasn’t high enough. However I can do this by using two beacons. + +To make this type of presence detection work you need to turn GPS off for a zone in Home Assistant by making them `passive`. This is important because otherwise HA will try to decide between two close together zones without enough data. This doesn’t work well. + +A passive zone can only be entered via an iBeacon, so a GPS location update will always pick the other zone. + +I set up my Home zone to be a standard region, and my office zone to be passive, so the home zone can be entered in the normal way via either GPS or a Beacon. + +**Example `configuration.yaml` entry** + +````yaml + +zone: + - name: 'Office' + latitude: XXX + longitude: YYY + radius: 3 + passive: true +```` + +You could use this technique to try to detect which room someone is in. This might allow you to notice whether someone is in the living room or the bedroom - even though one is above the other (although beacon packets do pass through walls and floors). + +To get this to work you’ll probably need to experiment with the beacon signal strength to try to match the beacon reception area to the location you want to track. Let me know if you get this to work (it doesn’t make sense in my open plan house) + +### {% linkable_title Conclusion %} + +Presence tracking sounds easy - and it's an important part of Home Automation. Trying it shows how difficult it is to get presence detection right. I've found that iBeacons have improved the reliability and timeliness of knowing where I am, and I hope I encouraged you to try them too. + +### {% linkable_title Tips %} + +You can find out more about configuring the OwnTracks application and beacons [here](http://owntracks.org/booklet/features/beacons/) + +There is information about configuring Homeassistant to use beacons [here](https://home-assistant.io/components/device_tracker.owntracks/) + +#### {% linkable_title Connections and disconnecting %} + +Owntracks treats a region name with a leading `-` as a hint that it shouldn't disconnect after a single missed packet. This improves the ability to keep a connection to a beacon. + +However, even when using this feature I’ve noticed that you can still lose connections (although it seems to vary by beacon manufacturer and type - I’ll talk more about this in _part 2_). This means that it's best to take into account that you may see false enter/leave events in HA. You may be able to improve this by changing how often the beacons send packets - and by increasing the signal strength (both will drain your beacon batteries more quickly). You can usually change these parameters in the app supplied by the iBeacon maker. You can also find some high power beacons (which have worked well for me). + +In automations you can use a `for:` to avoid triggering during a brief disconnect, or use a script with a delay. Stay tuned for _part 2_ for an example of this. + +#### {% linkable_title Using Multiple beacons for the same Zone %} +iBeacons have a `UUID` (usually set to the same value for beacons from the same manufacturer), as well as a `minor` and `major` number. If you set two beacons to have exactly same details then OwnTracks will think multiple beacons are at the same location. + +This means you can have more than one beacon around your home - and a connection to any of them will count as `home` to OwnTracks and HA. This reduces disconnections. + +You can achieve the same effect by using the same the same `UUID` but different `major` / `minor` numbers - and tell OwnTracks not to worry about the `minor` / `major` numbers for a particular region by setting them to 0). + +_Stay tuned for part II where I’ll talk about how to use iBeacons to track any object._ diff --git a/source/_topics/splitting_configuration.markdown b/source/_topics/splitting_configuration.markdown index 644296f28e..562827bc1d 100644 --- a/source/_topics/splitting_configuration.markdown +++ b/source/_topics/splitting_configuration.markdown @@ -26,7 +26,7 @@ homeassistant: # Location required to calculate the time the sun rises and sets latitude: 37 longitude: -121 - # C for Celcius, F for Fahrenheit + # C for Celsius, F for Fahrenheit temperature_unit: F # Pick yours from here: http://en.wikipedia.org/wiki/List_of_tz_database_time_zones time_zone: America/Los_Angeles diff --git a/source/developers/platform_example_sensor.markdown b/source/developers/platform_example_sensor.markdown index 6519ced0ba..873e63856d 100644 --- a/source/developers/platform_example_sensor.markdown +++ b/source/developers/platform_example_sensor.markdown @@ -26,7 +26,7 @@ sensor: ### {% linkable_title Code %} ```python -from homeassistant.const import TEMP_CELCIUS +from homeassistant.const import TEMP_CELSIUS from homeassistant.helpers.entity import Entity @@ -45,5 +45,5 @@ class ExampleSensor(Entity): @property def unit_of_measurement(self): - return TEMP_CELCIUS + return TEMP_CELSIUS ``` diff --git a/source/getting-started/autostart-systemd.markdown b/source/getting-started/autostart-systemd.markdown index 9cfccf45ab..a2fdeedfb1 100644 --- a/source/getting-started/autostart-systemd.markdown +++ b/source/getting-started/autostart-systemd.markdown @@ -35,10 +35,10 @@ WantedBy=multi-user.target EOF' ``` -There is also another [sample service file](https://raw.githubusercontent.com/balloob/home-assistant/master/script/home-assistant%40.service) available. To use this one, just download it. +There is also another [sample service file](https://raw.githubusercontent.com/home-assistant/home-assistant/master/script/home-assistant%40.service) available. To use this one, just download it. ```bash -$ sudo wget https://raw.githubusercontent.com/balloob/home-assistant/master/script/home-assistant%40.service -O /lib/systemd/system/home-assistant@[your user].service +$ sudo wget https://raw.githubusercontent.com/home-assistant/home-assistant/master/script/home-assistant%40.service -O /lib/systemd/system/home-assistant@[your user].service ``` You need to reload `systemd` to make the daemon aware of the new configuration. Enable and launch Home Assistant after that. diff --git a/source/getting-started/autostart-upstart.markdown b/source/getting-started/autostart-upstart.markdown index ac77809463..f11daea8cf 100644 --- a/source/getting-started/autostart-upstart.markdown +++ b/source/getting-started/autostart-upstart.markdown @@ -17,7 +17,7 @@ $ ps -p 1 -o comm= If the preceding command returns the string `init`, you are likely using Upstart. -Upstart will launch init scripts that are located in the directory `/etc/init.d/`. A sample init script for systems using Upstart is maintained by this project. +Upstart will launch init scripts that are located in the directory `/etc/init.d/`. A sample init script for systems using Upstart is maintained by this project. To install this script, download it, tweak it to you liking, and install it by following the directions in the header. This script will setup Home Assistant to run when the system boots. To start/stop Home Assistant manually, issue the following commands: diff --git a/source/getting-started/customizing-devices.markdown b/source/getting-started/customizing-devices.markdown index d780301494..43caeed11a 100644 --- a/source/getting-started/customizing-devices.markdown +++ b/source/getting-started/customizing-devices.markdown @@ -19,6 +19,9 @@ You may have to create the `www` directory yourself as it is not made automatica You can also use `icon` and refer to any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). +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. + + ```yaml # Example configuration.yaml entry homeassistant: @@ -37,6 +40,8 @@ homeassistant: switch.wemo_switch_2: friendly_name: Kitchen kettle icon: mdi:kettle + switch.rfxtrx_switch: + assumed_state: false ``` ### [Next step: Setting up presence detection »](/getting-started/presence-detection/) diff --git a/source/getting-started/installation-docker.markdown b/source/getting-started/installation-docker.markdown index 41c555de17..be7924d49c 100644 --- a/source/getting-started/installation-docker.markdown +++ b/source/getting-started/installation-docker.markdown @@ -28,7 +28,7 @@ If you run into any issues, please see [the troubleshooting page](/getting-start In addition to this site, check out these sources for additional help: - [Forum](https://community.home-assistant.io) for Home Assistant discussions and questions. - - [Gitter Chat Room](https://gitter.im/balloob/home-assistant) for real-time chat about Home Assistant. + - [Gitter Chat Room](https://gitter.im/home-assistant/home-assistant) for real-time chat about Home Assistant. - [GitHub Page](https://github.com/home-assistant/home-assistant/issues) for issue reporting. ### [Next step: Configuring Home Assistant »](/getting-started/configuration/) diff --git a/source/getting-started/installation-raspberry-pi.markdown b/source/getting-started/installation-raspberry-pi.markdown index 5cc49c1c00..5262bc93fb 100644 --- a/source/getting-started/installation-raspberry-pi.markdown +++ b/source/getting-started/installation-raspberry-pi.markdown @@ -38,7 +38,7 @@ If you run into any issues, please see [the troubleshooting page](/getting-start In addition to this site, check out these sources for additional help: - [Forum](https://community.home-assistant.io) for Home Assistant discussions and questions. - - [Gitter Chat Room](https://gitter.im/balloob/home-assistant) for real-time chat about Home Assistant. + - [Gitter Chat Room](https://gitter.im/home-assistant/home-assistant) for real-time chat about Home Assistant. - [GitHub Page](https://github.com/home-assistant/home-assistant/issues) for issue reporting. ### {% linkable_title What's next %} diff --git a/source/help/index.markdown b/source/help/index.markdown index 57b31e80dd..bb219c631a 100644 --- a/source/help/index.markdown +++ b/source/help/index.markdown @@ -14,7 +14,7 @@ There are various ways to get in touch with the Home Assistant community. It doe ### {% linkable_title Communication channels %} - [Forum](https://community.home-assistant.io/) - - [Gitter Chatroom](https://gitter.im/balloob/home-assistant) for general Home Assistant discussions and questions. + - [Gitter Chatroom](https://gitter.im/home-assistant/home-assistant) for general Home Assistant discussions and questions. - Follow us on [Twitter](https://twitter.com/home_assistant), use @home_assistant - Join the [Google+ community](https://plus.google.com/u/0/b/110560654828510104551/communities/106562234893511202708) diff --git a/source/help/trivia.markdown b/source/help/trivia.markdown index 74d886db6c..175b4269c5 100644 --- a/source/help/trivia.markdown +++ b/source/help/trivia.markdown @@ -33,7 +33,7 @@ This sections just contains some random numbers of the Home Assistant eco-system | Description | 2015 | |---|---| -| [Gitter.io](https://gitter.im/balloob/home-assistant) | 334 | +| [Gitter.io](https://gitter.im/home-assistant/home-assistant) | 334 | | [Forum posts](https://community.home-assistant.io/) | 352 | | [Forum topics](https://community.home-assistant.io/) | 83 | | [Forum members](https://community.home-assistant.io/) | 92 | diff --git a/source/images/blog/2016-04-ibeacons/owntracks_beacon_setup.png b/source/images/blog/2016-04-ibeacons/owntracks_beacon_setup.png new file mode 100644 index 0000000000..296fdfa95b Binary files /dev/null and b/source/images/blog/2016-04-ibeacons/owntracks_beacon_setup.png differ diff --git a/source/images/blog/2016-04-ibeacons/owntracks_red_beacon.png b/source/images/blog/2016-04-ibeacons/owntracks_red_beacon.png new file mode 100644 index 0000000000..273a509ca6 Binary files /dev/null and b/source/images/blog/2016-04-ibeacons/owntracks_red_beacon.png differ diff --git a/source/index.html b/source/index.html index e269f78d9c..4f31415477 100644 --- a/source/index.html +++ b/source/index.html @@ -11,7 +11,7 @@ description: Open-source home automation platform running on Python 3. Track and hide_github_edit: true --- -
+