From 74ffd555052f8cc96296a510df979238e165014d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20H=C3=B8yer=20Iversen?= Date: Sun, 28 Feb 2016 22:13:52 +0100 Subject: [PATCH 01/49] Update sensor.rfxtrx.markdown --- source/_components/sensor.rfxtrx.markdown | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/source/_components/sensor.rfxtrx.markdown b/source/_components/sensor.rfxtrx.markdown index 1f9ce224c85..3efb14a9919 100644 --- a/source/_components/sensor.rfxtrx.markdown +++ b/source/_components/sensor.rfxtrx.markdown @@ -16,6 +16,25 @@ To enable RFXtrx sensors in your installation, add the following to your `config ```yaml # Example configuration.yaml entry -sensor: - platform: rfxtrx +sensor: + platform: rfxtrx + automatic_add: True + devices: + sensor_0502: + name: Lving + packetid: 0a52080705020095220269 + data_type: Temperature + sensor_0601: + name: Bath_Humidity + packetid: 0a520802060100ff0e0269 + data_type: Humidity + sensor_0601 2: + name: Bath + packetid: 0a520802060100ff0e0269 ``` + +Configuration variables: + +- **devices** (*Optional*): A list of devices with their name to use in the frontend. +- **automatic_add** (*Optional*): To enable the automatic addition of new lights. +- **data_type** (*Optional*): Which data type the sensor should show From 8c415204d71e848e8d30091cb1e97f49130112af Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Sun, 28 Feb 2016 13:24:41 -0800 Subject: [PATCH 02/49] Update 2016-02-28-steam-d-link-smart-plugs-and-neurio-energy-sensors.markdown --- ...-steam-d-link-smart-plugs-and-neurio-energy-sensors.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_posts/2016-02-28-steam-d-link-smart-plugs-and-neurio-energy-sensors.markdown b/source/_posts/2016-02-28-steam-d-link-smart-plugs-and-neurio-energy-sensors.markdown index 4a213045a99..076bb8f48a3 100644 --- a/source/_posts/2016-02-28-steam-d-link-smart-plugs-and-neurio-energy-sensors.markdown +++ b/source/_posts/2016-02-28-steam-d-link-smart-plugs-and-neurio-energy-sensors.markdown @@ -48,7 +48,9 @@ It's been another two weeks which means it's time for release: 0.14! - Script: Turning on a [script] that is already on is now a no-op instead of skipping current delay. - Wemo switches now have to be set up via the main [Wemo component] - Command line platforms for [switch][switch.cmd], [sensor][sensor.cmd] and [binary_sensor][binary_sensor.cmd] have been renamed to `command_line`. + - The rfxtrx sensors entity ids will incur a one time change to move to a stable format. See [the docs][sensor.rfxtrx] for more details. +[sensor.rfxtrx]: /components/sensor.rfxtrx/ [notify.command_line]: /components/notify.command_line/ [Verisure]: /components/sensor.verisure/ [binary_sensor.tcp]: /components/binary_sensor.tcp/ From f95a907d6e19851b861195beba47edff64f7e5cd Mon Sep 17 00:00:00 2001 From: Andy Loughran Date: Mon, 29 Feb 2016 11:42:54 +0000 Subject: [PATCH 03/49] Update thermostat.heatmiser.markdown --- source/_components/thermostat.heatmiser.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_components/thermostat.heatmiser.markdown b/source/_components/thermostat.heatmiser.markdown index 49529fb0eb2..f528f579b0e 100644 --- a/source/_components/thermostat.heatmiser.markdown +++ b/source/_components/thermostat.heatmiser.markdown @@ -14,6 +14,8 @@ ha_category: Thermostat The `heatmiser` thermostat platform let you control [Heatmiser DT/DT-E/PRT/PRT-E](http://www.heatmisershop.co.uk/heatmiser-slimline-programmable-room-thermostat/) thermostats from Heatmiser. The module itself is currently setup to work over a RS232 -> RS485 converter, therefore it connects over IP. +Further work would be required to get this setup to connect over Wifi, but the HeatmiserV3 python module being used is a full implementation of the V3 protocol. If you would like to contribute to making this work over wifi, please contact @andylockran on github. + To set it up, add the following information to your `configuration.yaml` file: ```yaml From ea1be26cf105d48cac378734db7b2f22ceb4ca19 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 29 Feb 2016 22:13:03 +0100 Subject: [PATCH 04/49] Add sensor classes --- source/_components/binary_sensor.markdown | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/source/_components/binary_sensor.markdown b/source/_components/binary_sensor.markdown index f3bbd430190..7d1437439bc 100644 --- a/source/_components/binary_sensor.markdown +++ b/source/_components/binary_sensor.markdown @@ -14,3 +14,21 @@ Binary sensors are gathering information about state of switches, contacts, pins Knowing that there are only two states allows Home Assistant to represent the sensor better in the frontend. For analog sensors please check the [component overview](https://home-assistant.io/components/#sensor). + +Most binary sensors supports the `SENSOR_CLASSES` which let you specify the type of your sensor. The following types are supoorted: + +- **None**: Generic on/off +- **opening**: Door, window, etc +- **motion**: Motion sensor +- **gas'**: CO, CO2, etc +- **smoke'**: Smoke detector +- **moisture**: Specifically a wetness sensor +- **light**: Lightness threshold +- **power**: Power, over-current, etc +- **safety**: Generic on=unsafe, off=safe +- **heat**: On means hot (or too hot) +- **cold**: On means cold (or too cold) +- **moving**: On means moving, Off means stopped +- **sound**: On means sound detected, Off means no sound +- **vibration**: On means vibration detected, Off means no vibration + From 70a2a98c02e841b6eb0fc46c0774fe7c9aff3fb5 Mon Sep 17 00:00:00 2001 From: Dan Smith Date: Mon, 29 Feb 2016 18:10:21 -0800 Subject: [PATCH 05/49] Add TLS config options for mFi sensors and switches --- source/_components/sensor.mfi.markdown | 6 +++++- source/_components/switch.mfi.markdown | 5 ++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/source/_components/sensor.mfi.markdown b/source/_components/sensor.mfi.markdown index c7dcc96257a..58b25e26ea6 100644 --- a/source/_components/sensor.mfi.markdown +++ b/source/_components/sensor.mfi.markdown @@ -24,12 +24,16 @@ sensor: port: PORT username: USERNAME password: PASSWORD + use_tls: true + verify_tls: true ``` Configuration variables: - **host** (*Required*): The IP address or hostname of your mFi controller. -- **port** (*Optional*): The port of your mFi controller. Defaults to 6443. +- **port** (*Optional*): The port of your mFi controller. Defaults to 6443 for TLS, otherwise 6080. - **username** (*Required*): The mFi admin username. - **password** (*Required*): The mFi admin user's password. +- **use_tls** (*Optional*): If true, use TLS to contact the mFi controller. Defaults to true. +- **verify_tls** (*Optional*): Set this to false if your mFi controller has a self-signed certificate. Defaults to true. diff --git a/source/_components/switch.mfi.markdown b/source/_components/switch.mfi.markdown index 353a6d6a2c0..7c0bd1c582b 100644 --- a/source/_components/switch.mfi.markdown +++ b/source/_components/switch.mfi.markdown @@ -24,6 +24,8 @@ sensor: port: PORT username: USERNAME password: PASSWORD + use_tls: true + verify_tls: true ``` Configuration variables: @@ -32,4 +34,5 @@ Configuration variables: - **port** (*Optional*): The port of your mFi controller. Defaults to 6443. - **username** (*Required*): The mFi admin username. - **password** (*Required*): The mFi admin user's password. - +- **use_tls** (*Optional*): If true, use TLS to contact the mFi controller. Defaults to true. +- **verify_tls** (*Optional*): Set this to false if your mFi controller has a self-signed certificate. Defaults to true. From 153eee18f9719b2de037e5c8435a406686afa188 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 1 Mar 2016 07:30:54 +0100 Subject: [PATCH 06/49] Move sensor link to the bottom --- source/_components/binary_sensor.markdown | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/source/_components/binary_sensor.markdown b/source/_components/binary_sensor.markdown index 7d1437439bc..48c8dd29afd 100644 --- a/source/_components/binary_sensor.markdown +++ b/source/_components/binary_sensor.markdown @@ -13,9 +13,7 @@ Binary sensors are gathering information about state of switches, contacts, pins Knowing that there are only two states allows Home Assistant to represent the sensor better in the frontend. -For analog sensors please check the [component overview](https://home-assistant.io/components/#sensor). - -Most binary sensors supports the `SENSOR_CLASSES` which let you specify the type of your sensor. The following types are supoorted: +Most binary sensors support the `SENSOR_CLASSES` which let you specify the type of your sensor. The following types are supported: - **None**: Generic on/off - **opening**: Door, window, etc @@ -32,3 +30,4 @@ Most binary sensors supports the `SENSOR_CLASSES` which let you specify the type - **sound**: On means sound detected, Off means no sound - **vibration**: On means vibration detected, Off means no vibration +For analog sensors please check the [component overview](https://home-assistant.io/components/#sensor). From 0d28e3a810d532c6caae2900be6c9f697772c811 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 1 Mar 2016 07:44:23 +0100 Subject: [PATCH 07/49] Add discoverable docs --- source/_components/discoverable.markdown | 35 ++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 source/_components/discoverable.markdown diff --git a/source/_components/discoverable.markdown b/source/_components/discoverable.markdown new file mode 100644 index 00000000000..19c16ce0ac3 --- /dev/null +++ b/source/_components/discoverable.markdown @@ -0,0 +1,35 @@ +--- +layout: page +title: "Discoverable" +description: "Instructions how to setup the discoverable component with Home Assistant." +date: 2016-03-01 07:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +The Home Assistant discovery protocol is a lightweight feature that introduces support for Home Assistant servers to be discoverable. This will allow [Home Assistant instances](https://github.com/balloob/micropython-home-assistant) running with [MicroPython](https://micropython.org/) to get started without any required configuration (Example from the [MicroPython Home Assistant](https://github.com/balloob/micropython-home-assistant) documentation): + +```python +from homeassistant.discovery import get_instance() + +hass = get_instance() + +for state in hass.states(): + print(state) +``` + +To enable `discovery` in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yml entry +discoverable: + expose_password: yes +``` + + +Configuration variables: + +- **expose_password** (*Optional*): It is up to the user to expose the password in the discovery response (Default: off). If password not exposed, uHA instances will have to provide it (`get_instance('my password')`). + From 16c1ea3910b07b0fe63ee664cc60d74096a76137 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 1 Mar 2016 08:29:49 +0100 Subject: [PATCH 08/49] Add MQTT lock docs --- source/_components/lock.mqtt.markdown | 53 +++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 source/_components/lock.mqtt.markdown diff --git a/source/_components/lock.mqtt.markdown b/source/_components/lock.mqtt.markdown new file mode 100644 index 00000000000..a307db56649 --- /dev/null +++ b/source/_components/lock.mqtt.markdown @@ -0,0 +1,53 @@ +--- +layout: page +title: "MQTT Lock" +description: "Instructions how to integrate MQTT locks into Home Assistant." +date: 2016-02-28 15:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: mqtt.png +ha_category: Lock +--- + +The `mqtt` lock platform let you control your MQTT enabled locks. + +In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with RETAIN flag, the MQTT lock will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/unlocked. + +When a `state_topic` is not available, the lock will work in optimistic mode. In this mode, the lock will immediately change state after every command. Otherwise, the lock will wait for state confirmation from device (message from `state_topic`). + +Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect lock operation. + +To enable MQTT locks in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yml entry +lock: + platform: mqtt + name: Frontdoor + state_topic: "home/frontdoor/" + command_topic: "home/frontdoor/set" + payload_lock: "LOCK" + payload_unlock: "UNLOCK" + optimistic: false + qos: 0 + retain: true + value_template: '{% raw %}{{ value.x }}{% endraw %}' +``` + +Configuration variables: + +- **name** (*Optional*): The name of the lock. Default is 'MQTT Lock'. +- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates. +- **command_topic** (*Required*): The MQTT topic to publish commands to change the lock state. +- **payload_lock** (*Optional*): The payload that represents enabled/locked state. Default is "LOCK". +- **payload_unlock** (*Optional*): The payload that represents disabled/unlocked state. Default is "UNLOCK". +- **optimistic** (*Optional*): Flag that defines if lock works in optimistic mode. Default is true if no state topic defined, else false. +- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. +- **retain** (*Optional*): If the published message should have the retain flag on or not. +- **value_template** (*Optional*): Defines a [template](/getting-started/templating/) to extract a value from the payload. + +

+Make sure that your topic match exact. `some-topic/` and `some-topic` are different topics. +

From 375701697381ee0a9cfc009e2df198c1425cf4aa Mon Sep 17 00:00:00 2001 From: Lars Alexander Blumberg Date: Tue, 1 Mar 2016 12:57:05 +0100 Subject: [PATCH 09/49] Remove unwanted backslashes from filename --- source/developers/add_new_platform.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/developers/add_new_platform.markdown b/source/developers/add_new_platform.markdown index 91f5b6b49aa..197b172f76a 100644 --- a/source/developers/add_new_platform.markdown +++ b/source/developers/add_new_platform.markdown @@ -11,7 +11,7 @@ footer: true Components that interact with devices are structured in core- and platform logic. This allows the same logic to be used for different platforms. -For example, the built-in `switch` component consists of various platform in [`homeassistant/components/switch/`](https://github.com/balloob/home-assistant/tree/master/homeassistant/components/switch). The file `\_\_init\_\_.py` contains the core logic of all platform and the `vendor_name.py` files only the relevant platform code. +For example, the built-in `switch` component consists of various platform in [`homeassistant/components/switch/`](https://github.com/balloob/home-assistant/tree/master/homeassistant/components/switch). The file `__init__.py` contains the core logic of all platform and the `vendor_name.py` files only the relevant platform code. If you are planning to add support for a new type of device to an existing component, you can get away with only writing platform logic. Have a look at how the component works with other platforms and create a similar file for the platform that you would like to add. From 8a600ee68dc7d2b8f30754646e0ae393eec2cdae Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 1 Mar 2016 09:04:49 +0100 Subject: [PATCH 10/49] Remove blank line --- source/_components/binary_sensor.arest.markdown | 1 - 1 file changed, 1 deletion(-) diff --git a/source/_components/binary_sensor.arest.markdown b/source/_components/binary_sensor.arest.markdown index da0684b5088..0ded7c3f247 100644 --- a/source/_components/binary_sensor.arest.markdown +++ b/source/_components/binary_sensor.arest.markdown @@ -37,7 +37,6 @@ Accessing the URL http://IP_ADDRESS/digital/PIN_NUMBER should give you the state ```bash $ curl -X GET http://10.100.0.157/digital/9 {"return_value": 0, "id": "office1", "name": "Office", "connected": true} - ```

From 420016cdbedc9a69f0bd94d7d383eaa77827e33d Mon Sep 17 00:00:00 2001 From: "St. John Johnson" Date: Tue, 1 Mar 2016 10:15:34 -0800 Subject: [PATCH 11/49] Adding detail about brightness_scale --- source/_components/light.mqtt.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index f0d4680a8a7..4dace8936f7 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -69,6 +69,7 @@ Configuration variables: - **state_value_template** (*Optional*): Defines a [template](/getting-started/templating/) to extract the state value. - **brightness_value_template** (*Optional*): Defines a [template](/getting-started/templating/) to extract the brightness value. - **rgb_value_template** (*Optional*): Defines a [template](/getting-started/templating/) to extract the RGB value. +- **brightness_scale** (*Optional*): Defines the maximum brightness value (i.e. 100%) of the MQTT device (defaults to 255). - **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. - **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON". - **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF". From 5aeacb3b3b288c3fdd44ce0a968e65ecc292cb7d Mon Sep 17 00:00:00 2001 From: Gregor Gruener Date: Tue, 1 Mar 2016 22:08:50 +0100 Subject: [PATCH 12/49] Added NetAtmo rainmeter support I've added the new parameters for the rainmeter in the example configuration and I've adjusted the "note" block. This page should be go live, when the new home-assistant version is going live with the NetAtmo rain gauge support (see below commit). https://github.com/balloob/home-assistant/commit/c14ca9983c66e6a2dd7bba7d42cf4a3a5e70d442 --- source/_components/sensor.netatmo.markdown | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/source/_components/sensor.netatmo.markdown b/source/_components/sensor.netatmo.markdown index ad196eda243..966f90095ee 100644 --- a/source/_components/sensor.netatmo.markdown +++ b/source/_components/sensor.netatmo.markdown @@ -33,6 +33,10 @@ sensor: - co2 module_name2: - temperature + rainmeter_name3: + - rain + - sum_rain_1 + - sum_rain_24 ``` Configuration variables: @@ -75,5 +79,5 @@ You have to provide these name in your Home Assistant configuration file.

-The Home Assistant NetAtmo platform has only be tested with the classic indoor and outdoor module. There is no support for the rainmeter and windmeter module at this time because developers does not own these modules. +The Home Assistant NetAtmo platform has only be tested with the classic indoor, outdoor module and rainmeter. There is no support for the windmeter module at this time because developers does not own these modules.

From 20d329f1dea8a2085181b644a0ab29749386953f Mon Sep 17 00:00:00 2001 From: Yannick KERMAREC Date: Wed, 2 Mar 2016 13:59:43 +0100 Subject: [PATCH 13/49] Update rollershutter.command_line.markdown --- source/_components/rollershutter.command_line.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/rollershutter.command_line.markdown b/source/_components/rollershutter.command_line.markdown index a338b901a02..789dc642075 100644 --- a/source/_components/rollershutter.command_line.markdown +++ b/source/_components/rollershutter.command_line.markdown @@ -17,7 +17,7 @@ To enable command_rollershutter in your installation, add the following to your ```yaml # Example configuration.yaml entry rollershutter: -- platform: command_rollershutter +- platform: command_line rollershutters: Kitchen Rollershutter: upcmd: move_command up kitchen From 140fa1881005546a53e9957feb92259ea3470c8e Mon Sep 17 00:00:00 2001 From: MartinHjelmare Date: Wed, 2 Mar 2016 18:33:32 +0100 Subject: [PATCH 14/49] Update mysensors light and switch pages Clarify some of the V_TYPES used for these actuators. --- source/_components/light.mysensors.markdown | 12 +++++++----- source/_components/switch.mysensors.markdown | 4 ++-- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/source/_components/light.mysensors.markdown b/source/_components/light.mysensors.markdown index 94b01e77d2e..f6a74f40f8b 100644 --- a/source/_components/light.mysensors.markdown +++ b/source/_components/light.mysensors.markdown @@ -2,7 +2,7 @@ layout: page title: "MySensors Light" description: "Instructions how to integrate MySensors lights into Home Assistant." -date: 2016-02-15 17:37 +0100 +date: 2016-03-02 18:20 +0100 sidebar: true comments: false sharing: true @@ -16,18 +16,20 @@ Integrates MySensors lights into Home Assistant. See the [main component] for co The following actuator types are supported: -##### MySensors version 1.4 and higher +##### MySensors version 1.4 S_TYPE | V_TYPE ---------|-------------- -S_DIMMER | V_DIMMER +S_DIMMER | V_DIMMER\*, V_LIGHT\* ##### MySensors version 1.5 and higher S_TYPE | V_TYPE ------------|------------- -S_DIMMER | V_PERCENTAGE -S_RGB_LIGHT | V_RGB +S_DIMMER | [V_DIMMER\* or V_PERCENTAGE\*], [V_LIGHT\* or V_STATUS\*] +S_RGB_LIGHT | V_RGB*, [V_LIGHT\* or V_STATUS\*], [V_DIMMER or V_PERCENTAGE] + +V_TYPES with a star (\*) denotes required V_TYPES. Use either V_LIGHT or V_STATUS and either V_DIMMER or V_PERCENTAGE for an applicable actuator. For more information, visit the [serial api] of MySensors. diff --git a/source/_components/switch.mysensors.markdown b/source/_components/switch.mysensors.markdown index 6b5bb9ea45f..f79cd8b8f29 100644 --- a/source/_components/switch.mysensors.markdown +++ b/source/_components/switch.mysensors.markdown @@ -2,7 +2,7 @@ layout: page title: "MySensors Switch" description: "Instructions how to integrate MySensors switches into Home Assistant." -date: 2016-02-28 01:20 +0100 +date: 2016-03-02 18:20 +0100 sidebar: true comments: false sharing: true @@ -31,7 +31,7 @@ S_LOCK | V_LOCK_STATUS S_TYPE | V_TYPE -------------|------------------ S_LIGHT | V_STATUS -S_BINARY | V_STATUS, V_LIGHT +S_BINARY | [V_STATUS or V_LIGHT] S_SPRINKLER | V_STATUS S_WATER_LEAK | V_ARMED S_SOUND | V_ARMED From a099de6217bf5e9ee4938299482eab9650f49eb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maido=20K=C3=A4=C3=A4ra?= Date: Wed, 2 Mar 2016 23:48:41 +0200 Subject: [PATCH 15/49] Missing disarmed state No armed state in constants, but disarmed is missing here https://github.com/balloob/home-assistant/blob/dev/homeassistant/const.py#L56 --- source/_components/alarm_control_panel.mqtt.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/alarm_control_panel.mqtt.markdown b/source/_components/alarm_control_panel.mqtt.markdown index 1606d89b85a..36c9230b87e 100644 --- a/source/_components/alarm_control_panel.mqtt.markdown +++ b/source/_components/alarm_control_panel.mqtt.markdown @@ -15,7 +15,7 @@ The `mqtt` alarm panel platform enables the possibility to control MQTT capable The component will accept the following states from your Alarm Panel (in lower case): -- 'armed' +- 'disarmed' - 'armed_home' - 'armed_away' - 'pending' From 44fee36ab0be983efe59dd17e2ef373387cf3665 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Fri, 4 Mar 2016 13:29:48 +0100 Subject: [PATCH 16/49] Add another ping example --- .../_components/binary_sensor.command_line.markdown | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/source/_components/binary_sensor.command_line.markdown b/source/_components/binary_sensor.command_line.markdown index 7a6bfc73c83..c34be637491 100644 --- a/source/_components/binary_sensor.command_line.markdown +++ b/source/_components/binary_sensor.command_line.markdown @@ -60,9 +60,19 @@ Check if [RasPlex](http://www.rasplex.com/) is `online`. ```yaml binary_sensor: platform: command_line - command: 'ping rasplex.local -c 1 | grep "1 received" | wc -l' + command: 'ping -c 1 rasplex.local | grep "1 received" | wc -l' name: 'is_rasplex_online' payload_on: 1 payload_off: 0 ``` +An alternative solution could look like this: + +```yaml +binary_sensor: + platform: command_line + name: Printer + command: ping -c 1 192.168.1.10 &> /dev/null && echo success || echo fail + payload_on: "success" + payload_off: "fail" +``` From 25afe5192cddb5d81acff86bef6369369e6ea4e2 Mon Sep 17 00:00:00 2001 From: Dan Smith Date: Fri, 4 Mar 2016 13:24:56 -0800 Subject: [PATCH 17/49] Add another reported/confirmed Mikrotik SNMP OID This adds a new OID confirmed by a RouterOS 6.x user (the existing one provides no results on that platform). Also correct misspelling in the existing Mikrotik example. Reported by @llauren --- source/_components/device_tracker.snmp.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_components/device_tracker.snmp.markdown b/source/_components/device_tracker.snmp.markdown index c33e605c692..b61e1f8fad8 100644 --- a/source/_components/device_tracker.snmp.markdown +++ b/source/_components/device_tracker.snmp.markdown @@ -19,7 +19,8 @@ This device tracker needs SNMP to be enabled on the router.

OID examples: -- Microtik: 1.3.6.1.4.1.14988.1.1.1.2.1.1 (confirmed) +- Mikrotik: 1.3.6.1.4.1.14988.1.1.1.2.1.1 (confirmed, unknown RouterOS version/model) +- Mikrotik: 1.3.6.1.2.1.4.22.1.2 (confirmed, RouterOS 6.x on RB2011) - Aruba: 1.3.6.1.4.1.14823.2.3.3.1.2.4.1.2 (untested) - BiPAC 7800DXL: 1.3.6.1.2.1.17.7.1.2.2.1.1 (confirmed on firmware 2.32e) From 3a2e7fecd66f47e458e24cc9ed8cffb8dc8f3420 Mon Sep 17 00:00:00 2001 From: hydreliox Date: Fri, 4 Mar 2016 23:53:15 +0100 Subject: [PATCH 18/49] Add Owntracks parameter max_gps_accuracy in documentation --- source/_components/device_tracker.owntracks.markdown | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/_components/device_tracker.owntracks.markdown b/source/_components/device_tracker.owntracks.markdown index 10a04326a4b..6fceeda3805 100644 --- a/source/_components/device_tracker.owntracks.markdown +++ b/source/_components/device_tracker.owntracks.markdown @@ -23,9 +23,12 @@ To integrate Owntracks in Home Assistant, add the following section to your `con # Example configuration.yaml entry device_tracker: platform: owntracks + max_gps_accuracy: 200 ``` -There is no further configuration needed for tracking Owntracks devices. +Configuration variables: + +- **max_gps_accuracy** (*Optional*): Sometimes Owntracks can report GPS location with a very low accuracy (few kilometers). That can trigger false zoning in your Home Assistant installation. With the parameter, you can filter these GPS reports. The number has to be in meter. For example, if you put 200 only GPS report with an accuracy under 200 will be take in account. ### {% linkable_title Using Owntracks with other device trackers %} Owntracks can also be used with other device trackers, such as [Nmap](/components/device_tracker.nmap_scanner/) or [Netgear](/components/device_tracker.netgear/). To do this, fill in the `mac` field to the Owntracks entry in `known_devices.yaml` with the MAC address of the device you want to track. This way the state of the device will be determined by the source that reported last. From baa0bb366319e588287eeb24871d1808052bea49 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Sat, 5 Mar 2016 00:54:24 -0800 Subject: [PATCH 19/49] Update 2015-12-13-setup-encryption-using-lets-encrypt.markdown --- .../2015-12-13-setup-encryption-using-lets-encrypt.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_posts/2015-12-13-setup-encryption-using-lets-encrypt.markdown b/source/_posts/2015-12-13-setup-encryption-using-lets-encrypt.markdown index 19ba680da44..6a12fddecce 100644 --- a/source/_posts/2015-12-13-setup-encryption-using-lets-encrypt.markdown +++ b/source/_posts/2015-12-13-setup-encryption-using-lets-encrypt.markdown @@ -54,7 +54,7 @@ Now you're ready to run Let's Encrypt: $ git clone https://github.com/letsencrypt/letsencrypt […] $ cd letsencrypt -$ ./letsencrypt-auto certonly --email $ ./letsencrypt-auto certonly --email your@email.address -d hass-example.duckdns.org +$ ./letsencrypt-auto certonly --email your@email.address -d hass-example.duckdns.org Updating letsencrypt and virtual environment dependencies....... Running with virtualenv: sudo /path/letsencrypt/bin/letsencrypt certonly --email your@e-mail.address -d hass-example.duckdns.org From 90fba14835bcace05c73ac8024afd0526f4f30ec Mon Sep 17 00:00:00 2001 From: Dan Smith Date: Fri, 4 Mar 2016 13:24:56 -0800 Subject: [PATCH 20/49] Add another reported/confirmed Mikrotik SNMP OID This adds a new OID confirmed by a RouterOS 6.x user (the existing one provides no results on that platform). Also correct misspelling in the existing Mikrotik example. Reported by @llauren --- source/_components/device_tracker.snmp.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_components/device_tracker.snmp.markdown b/source/_components/device_tracker.snmp.markdown index c33e605c692..b61e1f8fad8 100644 --- a/source/_components/device_tracker.snmp.markdown +++ b/source/_components/device_tracker.snmp.markdown @@ -19,7 +19,8 @@ This device tracker needs SNMP to be enabled on the router.

OID examples: -- Microtik: 1.3.6.1.4.1.14988.1.1.1.2.1.1 (confirmed) +- Mikrotik: 1.3.6.1.4.1.14988.1.1.1.2.1.1 (confirmed, unknown RouterOS version/model) +- Mikrotik: 1.3.6.1.2.1.4.22.1.2 (confirmed, RouterOS 6.x on RB2011) - Aruba: 1.3.6.1.4.1.14823.2.3.3.1.2.4.1.2 (untested) - BiPAC 7800DXL: 1.3.6.1.2.1.17.7.1.2.2.1.1 (confirmed on firmware 2.32e) From 31a48bc0496035b169cc5090aa47915159b17c7e Mon Sep 17 00:00:00 2001 From: Stefan Jonasson Date: Sat, 5 Mar 2016 10:29:21 +0100 Subject: [PATCH 21/49] Added assumed state to the props. --- source/_components/switch.tellstick.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/switch.tellstick.markdown b/source/_components/switch.tellstick.markdown index e9f3baf21e4..055d445f07b 100644 --- a/source/_components/switch.tellstick.markdown +++ b/source/_components/switch.tellstick.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: telldus_tellstick.png ha_category: Switch +ha_iot_class: "Assumed State" --- From cef2ef2a4030db36b9bfd507d68f7279f3ec5cd5 Mon Sep 17 00:00:00 2001 From: Stefan Jonasson Date: Sat, 5 Mar 2016 10:31:49 +0100 Subject: [PATCH 22/49] Added assumed state to the props. Related to issue #1476 --- source/_components/light.tellstick.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/light.tellstick.markdown b/source/_components/light.tellstick.markdown index 1e5b40e34df..8daa1e4918b 100644 --- a/source/_components/light.tellstick.markdown +++ b/source/_components/light.tellstick.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: telldus_tellstick.png ha_category: Light +ha_iot_class: "Assumed State" --- From e4831ab7d0c621493ee08724f54f4f5f21105c71 Mon Sep 17 00:00:00 2001 From: Chris LaRose Date: Sat, 5 Mar 2016 15:51:50 -0800 Subject: [PATCH 23/49] Made quick spelling fixes --- source/developers/index.markdown | 4 ++-- source/getting-started/automation.markdown | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/developers/index.markdown b/source/developers/index.markdown index f7d376c7473..1b1e571000f 100644 --- a/source/developers/index.markdown +++ b/source/developers/index.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -Home Assistant is build from the ground-up to be easily extensible by other developers using components. It uses [Python 3](https://www.python.org/) for the backend and [Polymer (Webcomponents)](https://www.polymer-project.org/) for the frontend. +Home Assistant is built from the ground up to be easily-extensible by other developers using components. It uses [Python 3](https://www.python.org/) for the backend and [Polymer (Webcomponents)](https://www.polymer-project.org/) for the frontend. Home Assistant is open-source and MIT licensed. The source can be found here: @@ -19,7 +19,7 @@ Home Assistant is open-source and MIT licensed. The source can be found here: ### {% linkable_title Starting development %} -You will need to setup a development environment if you want to start developing a new feature or component for Home Assistant. Please follow these steps to perform it. Visit the [the Home Assistant repository](https://github.com/balloob/home-assistant) first and click fork in the top right. +You will need to set up a development environment if you want to start developing a new feature or component for Home Assistant. Please follow these steps to perform it. Visit the [the Home Assistant repository](https://github.com/balloob/home-assistant) first and click fork in the top right. ```bash $ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant.git diff --git a/source/getting-started/automation.markdown b/source/getting-started/automation.markdown index 807c7f3479e..4c790f9f275 100644 --- a/source/getting-started/automation.markdown +++ b/source/getting-started/automation.markdown @@ -21,7 +21,7 @@ Actions will call services within Home Assistant. For example, turn a light on, Conditions are used to prevent actions from firing unless certain conditions are met. For example, it is possible to only turn on the light if someone comes home and it is after a certain point in time. -The difference between a condition and a trigger can be confusing. The difference is that the trigger looks at the event that is happening, i.e. a car engine turning on. Conditions looks at the current state of the system, i.e. is the car engine on. +The difference between a condition and a trigger can be confusing. The difference is that the trigger looks at the event that is happening, e.g., a car engine turning on. Conditions looks at the current state of the system, e.g., is the car engine on. ### {% linkable_title Exploring the internal state %} From 3700e1c43c234415cf31f904c30114526faec9f7 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 7 Mar 2016 21:09:58 +0100 Subject: [PATCH 24/49] Move content from source to docs --- source/_components/device_tracker.tomato.markdown | 3 +++ 1 file changed, 3 insertions(+) diff --git a/source/_components/device_tracker.tomato.markdown b/source/_components/device_tracker.tomato.markdown index db77f188633..e9bb3582dcf 100644 --- a/source/_components/device_tracker.tomato.markdown +++ b/source/_components/device_tracker.tomato.markdown @@ -33,3 +33,6 @@ Configuration variables: - **http_id** (*Required*): The value can be obtained by logging in to the Tomato admin interface and search for `http_id` in the page source code. See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. + +A description of the API s available in this [Tomato API](http://paulusschoutsen.nl/blog/2013/10/tomato-api-documentation/) blog post. + From 2cd46cc09ec946fd0fe140f128726ec389c9c886 Mon Sep 17 00:00:00 2001 From: "St. John Johnson" Date: Mon, 7 Mar 2016 12:20:29 -0800 Subject: [PATCH 25/49] Adding example of using input_select for automation --- ...orm_actions_based_on_input_select.markdown | 77 +++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 source/_cookbook/perform_actions_based_on_input_select.markdown diff --git a/source/_cookbook/perform_actions_based_on_input_select.markdown b/source/_cookbook/perform_actions_based_on_input_select.markdown new file mode 100644 index 00000000000..63372ff3325 --- /dev/null +++ b/source/_cookbook/perform_actions_based_on_input_select.markdown @@ -0,0 +1,77 @@ +--- +layout: page +title: "Perform actions based on input select" +description: "Example playing media to chromecast based on input select element" +date: 2016-03-07 12:05 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Automation Examples +--- + +This example uses an [`input_select`](/components/input_select/) element to pick which mp3 file to play on a [Chromecast](components/media_player.cast/). + +```yaml +# Define our dropdown list +input_select: + lullaby: + name: Lullaby + options: + - Rain + - Babbling Brook + - None + initial: None + icon: mdi:weather-rainy + +# Define our media player +media_player: + - platform: cast + host: chromecast-nursery + name: Nursery + +automation: + # If you select "Rain", play the "rain.mp3" file + - alias: Play Rain Lullaby + + trigger: + platform: state + entity_id: input_select.lullaby + to: "Rain" + + action: + service: media_player.play_media + data: + entity_id: media_player.nursery + media_id: http://fileserver/rain.mp3 + media_type: audio/mp4 + + + # If you select "Babbling Brook", play the "babbling_brook.mp3" file + - alias: Play Babbling Brook Lullaby + + trigger: + platform: state + entity_id: input_select.lullaby + to: "Babbling Brook" + + action: + service: media_player.play_media + data: + entity_id: media_player.nursery + media_id: http://fileserver/babbling_brook.mp3 + media_type: audio/mp4 + + # If you select "None, turn the Chromecast off + - alias: Stop the Lullaby + + trigger: + platform: state + entity_id: input_select.lullaby + to: "None" + + action: + service: media_player.turn_off + data: + entity_id: media_player.nursery +``` From 227d484c69f26cf6b99d14d201e49abeb343e09e Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Mon, 7 Mar 2016 13:49:31 -0800 Subject: [PATCH 26/49] Add links to often needed docs --- source/cookbook/index.markdown | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/source/cookbook/index.markdown b/source/cookbook/index.markdown index 4ee992e1a87..61990b01be9 100644 --- a/source/cookbook/index.markdown +++ b/source/cookbook/index.markdown @@ -11,7 +11,13 @@ regenerate: true hide_github_edit: true --- -This is a community currated list of different ways to use Home Assistant. New recipes can be added via the [home-assistant.io repository](https://github.com/balloob/home-assistant.io/tree/master/source/_cookbook). +This is a community curated list of different ways to use Home Assistant. Most of these examples are using the [automation] component and other built-in [automation related][sec-automation] and [organization] components available. + +[automation]: /components/automation/ +[sec-automation]: /components/#automation +[organization]: /components/#organization + +New recipes can be added via the [home-assistant.io repository](https://github.com/balloob/home-assistant.io/tree/master/source/_cookbook). {% assign cookbook = site.cookbook | sort: 'title' %} {% assign categories = cookbook | map: 'ha_category' | uniq | sort %} From e93682035ff7b0895a62f88eb7ab3ccdb9b377d4 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Mon, 7 Mar 2016 13:49:46 -0800 Subject: [PATCH 27/49] Add RPi youtube video to getting started --- source/getting-started/index.markdown | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/getting-started/index.markdown b/source/getting-started/index.markdown index a750a6e98ec..5cea89b7460 100644 --- a/source/getting-started/index.markdown +++ b/source/getting-started/index.markdown @@ -33,7 +33,7 @@ Running these commands will: - Launch Home Assistant and serve the web interface on [http://localhost:8123](http://localhost:8123) -If would prefer to watch a video tutorial however, [tktino](https://github.com/tktino) has made some great ones. +If you prefer to watch a video tutorial, [tktino](https://github.com/tktino) has made some great ones. - [Windows 10](https://www.youtube.com/watch?v=X27eVvuqwnY) - [Mac OS X](https://www.youtube.com/watch?v=hej6ipN86ls) @@ -75,6 +75,9 @@ Running these commands will: - Install Home Assistant - Launch Home Assistant and serve the web interface on [http://localhost:8123](http://localhost:8123) +There is also a [video tutorial](https://www.youtube.com/watch?v=GjzOXkPb7XE) created by [brusc](https://github.com/brusc). + +
From 9b20f0523ac09281dec873a816d9ae77feba7086 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Mon, 7 Mar 2016 14:14:54 -0800 Subject: [PATCH 28/49] Components: Hide non-featured component on page load --- source/components/index.html | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/source/components/index.html b/source/components/index.html index d4df448da67..87b08f3085b 100644 --- a/source/components/index.html +++ b/source/components/index.html @@ -36,7 +36,9 @@ Support for these components is provided by the Home Assistant community.
{% for component in components %} {% if component.ha_category %} - +
{% if component.logo %} @@ -60,8 +62,19 @@ Support for these components is provided by the Home Assistant community. {% endcomment %} - - + +