From fba68cd78eaab113cd70be25cc9e25c10baa3304 Mon Sep 17 00:00:00 2001 From: cogneato Date: Sat, 3 Nov 2018 14:51:35 -0600 Subject: [PATCH 01/43] clearing up instructions for network config (#7349) --- source/getting-started/index.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/getting-started/index.markdown b/source/getting-started/index.markdown index 4e866386574..13731fb856c 100644 --- a/source/getting-started/index.markdown +++ b/source/getting-started/index.markdown @@ -39,7 +39,7 @@ We will need a few things to get started with installing Home Assistant. For bes 1. Put the SD card in your SD card reader. 1. Open Etcher, select the Hass.io image and flash it to the SD card. -1. WiFi and Static IP setup only: Format a USB-Stick with name `CONFIG`, create the folder `network` and create the file `my-network`. Copy one of [the examples] to the `my-network` file. +1. WiFi and Static IP setup only: Format a USB-Stick with name `CONFIG`, create a folder named `network` and within that folder a file named `my-network`. Copy one of [the examples] to the `my-network` file. 1. Unmount the SD card and remove it from your SD card reader. 1. Insert the SD card into your Raspberry Pi 3. If you are going to use an Ethernet cable, connect that too. 1. Connect your Raspberry Pi to the power supply, so it turns on. From 6801beeb0abf6ed7699a3a736a1d876d7af8f183 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Sat, 3 Nov 2018 23:20:03 +0100 Subject: [PATCH 02/43] Update samba.markdown --- source/_addons/samba.markdown | 56 ++--------------------------------- 1 file changed, 3 insertions(+), 53 deletions(-) diff --git a/source/_addons/samba.markdown b/source/_addons/samba.markdown index fe967f6ab28..f28ac32f215 100644 --- a/source/_addons/samba.markdown +++ b/source/_addons/samba.markdown @@ -13,22 +13,12 @@ featured: true This add-on allows you to set up a [Samba](https://samba.org/) server to access Hass.io folders using Windows network shares.

-It is strongly recommended to set a username and password. By using guest mode, you expose your configuration and secrets to every user in local network.
-Also be careful when setting up port forwarding for remote access. If you don't restrict access by setting a username and password, your configuration could be exposed to the entire internet! +Be careful when setting up port forwarding for remote access. If you don't restrict access by setting a username and strong password, your configuration could be exposed to the entire internet!

```json { - "name": "hassio", "workgroup": "WORKGROUP", - "guest": true, - "map": { - "config": true, - "addons": true, - "share": true, - "backup": true, - "ssl": false - }, "username": "", "password": "", "interface": "eth0", @@ -41,58 +31,18 @@ Also be careful when setting up port forwarding for remote access. If you don't ``` {% configuration %} -name: - description: Set netbios name of Hass.io device. - required: false - default: "`hassio`" - type: string workgroup: description: Set network workgroup name. required: false default: "`WORKGROUP`" type: string -guest: - description: Allow login without a username or password. - required: false - default: true - type: boolean -map: - description: Control which folders will be exposed. - required: false - type: map - keys: - config: - description: The Home Assistant configuration folder - required: false - default: true - type: boolean - addons: - description: The local custom addons repository - required: false - default: true - type: boolean - share: - description: The folder that can be accessed by add-ons and Home Assistant - required: false - default: true - type: boolean - backup: - description: Access to snapshot files - required: false - default: true - type: boolean - ssl: - description: Certificate storage (Careful! Sharing is set to `false` by default) - required: false - default: false - type: boolean username: description: Username for logging in if guest login is not used. - required: false + required: true type: string password: description: Password for `username`. An empty password is not supported. - required: false + required: true type: string interface: description: Interface that will start the share. Normally this is `eth0` for ethernet wired connection and `wlan0` for wireless connection. If you are running on an Intel NUC this could also be `enp3s0` for ethernet or `wlp5s0` for wireless connection. From c3d3de691f71db705fd497dd447f1a4133dec0ce Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 4 Nov 2018 09:14:25 +0100 Subject: [PATCH 03/43] Mark as internal (#7351) --- source/_components/binary_sensor.http.markdown | 1 + source/_components/sensor.http.markdown | 1 + 2 files changed, 2 insertions(+) diff --git a/source/_components/binary_sensor.http.markdown b/source/_components/binary_sensor.http.markdown index 779cafb95e2..36ee7eba9e0 100644 --- a/source/_components/binary_sensor.http.markdown +++ b/source/_components/binary_sensor.http.markdown @@ -10,6 +10,7 @@ footer: true logo: http.png ha_category: Binary Sensor ha_release: pre 0.7 +ha_qa_scale: internal --- The HTTP binary sensor is dynamically created with the first request that is made to its URL. You don't have to define it in the configuration first. diff --git a/source/_components/sensor.http.markdown b/source/_components/sensor.http.markdown index 9b0ec80fe16..e01041b1a46 100644 --- a/source/_components/sensor.http.markdown +++ b/source/_components/sensor.http.markdown @@ -11,6 +11,7 @@ logo: http.png ha_category: Sensor ha_release: pre 0.7 ha_iot_class: "Local Push" +ha_qa_scale: internal --- From 6888625b702ec439907441ecc778833136d12326 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Sun, 4 Nov 2018 14:19:37 +0100 Subject: [PATCH 04/43] Release 81.6 --- _config.yml | 6 +++--- source/_posts/2018-10-29-release-81.markdown | 9 +++++++++ 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/_config.yml b/_config.yml index 9fb7a2b9e92..c7491ba2734 100644 --- a/_config.yml +++ b/_config.yml @@ -142,13 +142,13 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 81 -current_patch_version: 4 -date_released: 2018-11-02 +current_patch_version: 6 +date_released: 2018-11-04 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. # Major release: -patch_version_notes: "#release-0814---november-3" +patch_version_notes: "#release-0816---november-4" # Minor release (Example #release-0431---april-25): # Date we moved to Discourse for comments diff --git a/source/_posts/2018-10-29-release-81.markdown b/source/_posts/2018-10-29-release-81.markdown index be29bdf68e9..a98a8deb8f6 100644 --- a/source/_posts/2018-10-29-release-81.markdown +++ b/source/_posts/2018-10-29-release-81.markdown @@ -122,6 +122,15 @@ _0.81.3 was skipped because it broke LL._ [switch.flux docs]: /components/switch.flux/ [weather.smhi docs]: /components/weather.smhi/ +## {% linkable_title Release 0.81.5 - November 3 %} + +- Fix lovelace +- Remove FFmpeg input tests (@jjlawren - #18131) + +## {% linkable_title Release 0.81.6 - November 4 %} + +- Bugfix discovery (delete/mqtt) call for Hass.io #18159 + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. From 58c4a4786780027c5d5c9a2b9341cfbe550bb2eb Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sun, 4 Nov 2018 20:56:49 +0000 Subject: [PATCH 05/43] Made API key clearer (#7362) It's not that obvious that it refers to the Homegraph API key --- source/_components/google_assistant.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index 1d16c317c6e..545d0a497db 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -125,7 +125,7 @@ project_id: required: true type: string api_key: - description: Your API key. + description: Your Homegraph API key (for the `google_assistant.request_sync` service) required: false type: string expose_by_default: From c58a019c7d0f5d08b731545594aa6f7caba1c73e Mon Sep 17 00:00:00 2001 From: "Matthew T. Kelley" Date: Sun, 4 Nov 2018 15:59:21 -0500 Subject: [PATCH 06/43] Update device_tracker.owntracks.markdown (#7360) Spelling error. Changed "iBecons" to "iBeacons" --- source/_components/device_tracker.owntracks.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/device_tracker.owntracks.markdown b/source/_components/device_tracker.owntracks.markdown index 9a2e98158de..8180739e9bc 100644 --- a/source/_components/device_tracker.owntracks.markdown +++ b/source/_components/device_tracker.owntracks.markdown @@ -104,7 +104,7 @@ When you exit a zone, Home Assistant will start using location updates to track ### {% linkable_title Using Owntracks regions - forcing Owntracks to update using iBeacons %}

-Owntracks v2.0.0 removes support for iBecons on Android. +Owntracks v2.0.0 removes support for iBeacons on Android.

When run in the usual *significant changes mode* (which is kind to your phone battery), Owntracks sometimes doesn't update your location as quickly as you'd like when you arrive at a zone. This can be annoying if you want to trigger an automation when you get home. You can improve the situation using iBeacons. From 8f3ae1f5a3eb32fd4818ea52ff2b8a1f904e20be Mon Sep 17 00:00:00 2001 From: Kevin Date: Sun, 4 Nov 2018 21:01:54 +0000 Subject: [PATCH 07/43] Astronomical vs Meteorological information (#7359) The added link will provide a brief and easy to understand guide to how the sensor's two settings will differ. --- source/_components/sensor.season.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/_components/sensor.season.markdown b/source/_components/sensor.season.markdown index c2ce54a145c..e12c1c401f2 100644 --- a/source/_components/sensor.season.markdown +++ b/source/_components/sensor.season.markdown @@ -16,6 +16,10 @@ ha_qa_scale: internal The `season` sensor will display the current astronomical or meteorological season (Spring, Summer, Autumn, Winter) based on the user's setting in the configuration file. +For information on the difference between astronomical and meteorological seasons please see the link below: + + - [https://www.ncei.noaa.gov/news/meteorological-versus-astronomical-seasons](https://www.ncei.noaa.gov/news/meteorological-versus-astronomical-seasons) + All information about how the seasons work was taken from Wikipedia: - [https://en.wikipedia.org/wiki/Season#Astronomical](https://en.wikipedia.org/wiki/Season#Astronomical) From 6e6aeed631d6e9bc10a6721bba571f9737e4c704 Mon Sep 17 00:00:00 2001 From: pleeja <41104650+pleeja@users.noreply.github.com> Date: Sun, 4 Nov 2018 22:02:24 +0100 Subject: [PATCH 08/43] Fix typo (#7358) --- source/_components/media_player.webostv.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/media_player.webostv.markdown b/source/_components/media_player.webostv.markdown index f321a4807f9..ba5646c91a3 100644 --- a/source/_components/media_player.webostv.markdown +++ b/source/_components/media_player.webostv.markdown @@ -145,7 +145,7 @@ remembering to split them per line into your `sources:` configuration. ### {% linkable_title Change channel through play_media service %} The `play_media` service can be used in a script to switch to the specified tv -channel. It selects the best matching cannel according to the `media_content_id` +channel. It selects the best matching channel according to the `media_content_id` parameter: 1. Channel number *(i.e. '1' or '6')* From 497e16cea084efde7fb93221a2eb7be934a49287 Mon Sep 17 00:00:00 2001 From: Chris Feist Date: Sun, 4 Nov 2018 13:50:32 -0800 Subject: [PATCH 09/43] Update TP Link Switch markdown to include power readings (#7361) * Update TP Link Switch markdown to include power Update the markdown to include how to retrieve power readings from a switch that has Energy Monitoring features, such as the HS110 https://www.tp-link.com/us/products/details/cat-5516_HS110.html * Use latest attributes and add friendly name * remove comment in yaml * Update kW to kWh * Minor changes --- source/_components/switch.tplink.markdown | 34 +++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/source/_components/switch.tplink.markdown b/source/_components/switch.tplink.markdown index 59912f87d1f..2be6ca2ed68 100644 --- a/source/_components/switch.tplink.markdown +++ b/source/_components/switch.tplink.markdown @@ -22,6 +22,8 @@ Supported units: - HS110 - HS200 +## {% linkable_title Configuration %} + To use your TP-Link switch or socket in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -59,3 +61,35 @@ switch: - platform: tplink host: SECOND_IP_ADDRESS ``` + +## {% linkable_title Configure Energy Sensors %} ## + +In order to get the power consumption readings from the HS110, you'll have to create a [template sensor](/components/switch.template/). In the example below, change all of the `my_tp_switch`'s to match your switch's entity ID. + +{% raw %} +```yaml +sensor: + - platform: template + sensors: + my_tp_switch_amps: + friendly_name_template: "{{ states.switch.my_tp_switch.name}} Current" + value_template: '{{ states.switch.my_tp_switch.attributes["current_a"] | float }}' + unit_of_measurement: 'A' + my_tp_switch_watts: + friendly_name_template: "{{ states.switch.my_tp_switch.name}} Current Consumption" + value_template: '{{ states.switch.my_tp_switch.attributes["current_power_w"] | float }}' + unit_of_measurement: 'W' + my_tp_switch_total_kwh: + friendly_name_template: "{{ states.switch.my_tp_switch.name}} Total Consumption" + value_template: '{{ states.switch.my_tp_switch.attributes["total_energy_kwh"] | float }}' + unit_of_measurement: 'kWh' + my_tp_switch_volts: + friendly_name_template: "{{ states.switch.my_tp_switch.name}} Voltage" + value_template: '{{ states.switch.my_tp_switch.attributes["voltage"] | float }}' + unit_of_measurement: 'V' + my_tp_switch_today_kwh: + friendly_name_template: "{{ states.switch.my_tp_switch.name}} Today's Consuption" + value_template: '{{ states.switch.my_tp_switch.attributes["today_energy_kwh"] | float }}' + unit_of_measurement: 'kWh' +``` +{% endraw %} From a24446b14efd7e99d116b6234bece9277f3d4590 Mon Sep 17 00:00:00 2001 From: "Matthew T. Kelley" Date: Sun, 4 Nov 2018 16:51:02 -0500 Subject: [PATCH 10/43] Update device_tracker.tomato.markdown (#7355) Remove duplicate paragraph. --- source/_components/device_tracker.tomato.markdown | 5 ----- 1 file changed, 5 deletions(-) diff --git a/source/_components/device_tracker.tomato.markdown b/source/_components/device_tracker.tomato.markdown index 0c080449b64..bb394f8c56b 100644 --- a/source/_components/device_tracker.tomato.markdown +++ b/source/_components/device_tracker.tomato.markdown @@ -16,11 +16,6 @@ The `tomato` platform requires an extra config variable called `http_id`. The value can be obtained by logging in to the Tomato admin interface and search for `http_id` in the page source code. -Because of a limitation in Tomato's API, this platform will only track wireless -devices. If tracking wired devices like a Philips Hue Hub is necessary, it is -possible to use another platform like -[NMAP](/components/device_tracker.nmap_tracker/). - Because of a limitation in Tomato's API, this platform will only track wireless devices. If tracking wired devices like a Philips Hue Hub is necessary, it is possible to use another platform like [Nmap](/components/device_tracker.nmap_tracker/). From 10248cd4e4c7044c4aaf1185a40bd6f8ce64f948 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sun, 4 Nov 2018 22:01:44 +0000 Subject: [PATCH 11/43] Adding some documentation for the services (#7356) As nowhere do we document `homeassistant.update_entity`, or the other `homeassistant` services, it seems overdue that we actually document them. --- source/_docs/scripts/service-calls.markdown | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/source/_docs/scripts/service-calls.markdown b/source/_docs/scripts/service-calls.markdown index ab73aad5290..2724a7a0784 100644 --- a/source/_docs/scripts/service-calls.markdown +++ b/source/_docs/scripts/service-calls.markdown @@ -82,4 +82,16 @@ data_template: temperature: {% raw %}{{ 22 - distance(states.device_tracker.paulus) }}{% endraw %} ``` +### {% linkable_title `homeassistant` services %} + +There are four `homeassistant` services that aren't tied to any single domain, these are: + +* `homeassistant.turn_on` - Turns on an entity (that supports being turned on), for example an `automation`, `switch`, etc +* `homeassistant.turn_off` - Turns off an entity (that supports being turned off), for example an `automation`, `switch`, etc +* `homeassistant.toggle` - Turns off an entity that is on, or turns on an entity that is off (that supports being turned on and off) +* `homeassistant.update_entity` - Request the update of an entity, rather than waiting for the next scheduled update, for example [google travel time] sensor, a [template sensor], or a [light] + [templating]: /topics/templating/ +[google travel time]: /components/sensor.google_travel_time/ +[template sensor]: /components/sensor.template/ +[light]: /components/light/ From c07729d3931d815bc00e1f955dfcbfc6651d5010 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Mon, 5 Nov 2018 00:29:46 +0100 Subject: [PATCH 12/43] Update mosquitto.markdown --- source/_addons/mosquitto.markdown | 59 ++++++------------------------- 1 file changed, 11 insertions(+), 48 deletions(-) diff --git a/source/_addons/mosquitto.markdown b/source/_addons/mosquitto.markdown index fc1808a6ccb..b64da38dbf3 100644 --- a/source/_addons/mosquitto.markdown +++ b/source/_addons/mosquitto.markdown @@ -14,13 +14,10 @@ Set up [Mosquitto](https://mosquitto.org/) as MQTT broker. ```json { - "plain": true, - "ssl": false, - "anonymous": true, "logins": [ - {"username": "testuser", "password": "mypw"}, - {"username": "testuser2", "password": "mypw2"} + {"username": "local-user", "password": "mypw"} ], + "anonymous": false, "customize": { "active": false, "folder": "mosquitto" @@ -35,23 +32,13 @@ Make sure you use logins and disable anonymous access if you want to secure the

{% configuration %} -plain: - description: Listen on port 1883 without SSL/TLS. - required: false - default: true - type: boolean -ssl: - description: Listen on port 8883 with SSL/TLS. This requires certificates. - required: false - default: false - type: boolean anonymous: description: Allow anonymous connections. If *logins* is set, the anonymous user can only read data. required: false - default: true + default: false type: boolean logins: - description: A list of users that will be created with *username* and *password*. + description: A list of local users that will be created with *username* and *password*. required: false type: list customize: @@ -60,41 +47,17 @@ customize: type: [boolean, string] {% endconfiguration %} +### {% linkable_title Home Assistant user management %} + +This Add-on is attached to Home Assistant user system. That means a user can log in with her credential. Currently, we support also local users they can add via config. For the internal Hass.io ecosystem we register `homeassistant` and `addons`, this user name will not work anymore inside configuration. + ### {% linkable_title Home Assistant configuration %} -To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), add the following entry to the `configuration.yaml` file. +To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the integration page and install the configuration with one click. -```yaml -# Example configuration.yaml entry -mqtt: - broker: core-mosquitto -``` +### {% linkable_title Disable listening on insecure (1883) ports %} -If username and password are set up in add-on, your `configuration.yaml` file should contain that data. - -```yaml -mqtt: - broker: core-mosquitto - username: YOUR_USERNAME - password: YOUR_PASSWORD -``` - -### {% linkable_title Listening simultaneously on SSL/TLS (8883) and insecure (1883) ports %} - -1. Configure SSL/TLS as normal. -2. Set `customize` flag to `true` in your configuration. -3. Create a file in `/share/mosquitto` named `insecure.conf` with the following contents: - -```text -listener 1883 -protocol mqtt -``` - -4. Restart MQTT - -

-It's recommended that you only open your firewall to the SSL/TLS port (8883) and only use the insecure port (1883) for local devices. Also, disable `anonymous:` and set `logins:`. -

+Remove the ports from network card if you not want to expose this external. ### {% linkable_title Access Control Lists (ACLs) %} From e403b3fd1b6b043b897331f6f4b51af41ea104a6 Mon Sep 17 00:00:00 2001 From: cogneato Date: Mon, 5 Nov 2018 12:37:56 -0700 Subject: [PATCH 13/43] Grammar / Clarity fixes (#7375) --- source/_addons/mosquitto.markdown | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/_addons/mosquitto.markdown b/source/_addons/mosquitto.markdown index b64da38dbf3..2b0025640f4 100644 --- a/source/_addons/mosquitto.markdown +++ b/source/_addons/mosquitto.markdown @@ -49,15 +49,15 @@ customize: ### {% linkable_title Home Assistant user management %} -This Add-on is attached to Home Assistant user system. That means a user can log in with her credential. Currently, we support also local users they can add via config. For the internal Hass.io ecosystem we register `homeassistant` and `addons`, this user name will not work anymore inside configuration. +This add-on is attached to the Home Assistant user system, so mqtt clients can make use of these credentials. Local users may also still be set independently within the configuration options for the add-on. For the internal Hass.io ecosystem we register `homeassistant` and `addons`, so these may not be used as user names. ### {% linkable_title Home Assistant configuration %} -To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the integration page and install the configuration with one click. +To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the integration page and install the configuration with one click. The `discovery:` component must be enabled for one-click integration. ### {% linkable_title Disable listening on insecure (1883) ports %} -Remove the ports from network card if you not want to expose this external. +Remove the ports from the add-on page network card (set them as blank) to disable them. ### {% linkable_title Access Control Lists (ACLs) %} From d5cbe79fd0359ccc80a4194d920b942e5438efe3 Mon Sep 17 00:00:00 2001 From: mvn23 Date: Mon, 5 Nov 2018 20:38:42 +0100 Subject: [PATCH 14/43] Fix it's -> its in opentherm_gw.markdown (#7369) Change it's to its. --- source/_components/opentherm_gw.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/opentherm_gw.markdown b/source/_components/opentherm_gw.markdown index 62aa3def7f5..9a6a81173c5 100644 --- a/source/_components/opentherm_gw.markdown +++ b/source/_components/opentherm_gw.markdown @@ -14,7 +14,7 @@ ha_iot_class: "Local Push" --- The `opentherm_gw` component is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant. -When enabled, this component will automatically add it's [`climate` entity](/components/climate.opentherm_gw) to Home Assistant. +When enabled, this component will automatically add its [`climate` entity](/components/climate.opentherm_gw) to Home Assistant. # {% linkable_title Configuration %} From ada896a3e7b2f12e1fcf2e0737659de35447a8b6 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Mon, 5 Nov 2018 20:38:59 +0100 Subject: [PATCH 15/43] Update homematic.markdown --- source/_addons/homematic.markdown | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/source/_addons/homematic.markdown b/source/_addons/homematic.markdown index 706ef2a754c..ce8972998d0 100644 --- a/source/_addons/homematic.markdown +++ b/source/_addons/homematic.markdown @@ -76,6 +76,12 @@ homematic: rf: host: core-homematic port: 2001 + wired: + host: core-homematic + port: 2000 + hmip: + host: core-homematic + port: 2001 ``` ## {% linkable_title Raspberry Pi3 %} @@ -85,3 +91,7 @@ With HM-MOD-RPI-PCB you need to add follow into your `config.txt` on boot partit ```text dtoverlay=pi3-miniuart-bt ``` + +## {% linkable_title HmIP-RFUSB %} + +HassOS > 1.11 support HmIP-RFUSB default and don't need any configuration. If you run a Linux, you need to follow the installation guide from documentation to set up the UART USB interface on your computer. From f96fa70272d2d1d3c00dac298d62ecdf6b6a9002 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Mon, 5 Nov 2018 23:01:39 +0100 Subject: [PATCH 16/43] Update snips.markdown --- source/_addons/snips.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_addons/snips.markdown b/source/_addons/snips.markdown index b002ff1a4a1..f7c86cecf11 100644 --- a/source/_addons/snips.markdown +++ b/source/_addons/snips.markdown @@ -11,7 +11,9 @@ footer: true [Snips.ai](https://snips.ai/) is an AI-powered voice assistant that runs on the Raspberry Pi 3 and x86 platforms. It runs on-device and is Private by Design. +

The Snips add-on depends on the Mosquitto add on to bridge to Home Assistant, so make sure that is installed. +

Home Assistant comes with certain Intents builtin to handle common tasks. A complete list of Intents can be found in this wiki [Hass Snips Bundle](https://github.com/tschmidty69/hass-snips-bundle-intents/wiki). @@ -51,7 +53,6 @@ Now it's time to start Snips for the first time. You can configure the microphon Configuration variables: -- **mqtt_bridge**: Snips uses MQTT to communicate and defaults to their own broker. Use this config option to bridge their broker to your the Mosquitto add-on. - **assistant**: The name of your custom assistant in `/share`. If no assistant is found then a default assistant will be used. - **language**: Language. This is used to select the default custom assistant, Currently `en`, `de` and `fr` are supported. - **custom_tts**: Whether to use a TTS provider from Home Assistant for a variety of voices. From 49dbc4873ad197553d29c7ef83954cec9a0e4710 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 6 Nov 2018 08:08:29 +0100 Subject: [PATCH 17/43] Update Fritzbox component configuration (#7385) --- .../sensor.fritzbox_callmonitor.markdown | 43 +++++++++++++++---- .../sensor.fritzbox_netmonitor.markdown | 15 +++++-- 2 files changed, 46 insertions(+), 12 deletions(-) diff --git a/source/_components/sensor.fritzbox_callmonitor.markdown b/source/_components/sensor.fritzbox_callmonitor.markdown index 013a8af18ec..0666febbf86 100644 --- a/source/_components/sensor.fritzbox_callmonitor.markdown +++ b/source/_components/sensor.fritzbox_callmonitor.markdown @@ -13,7 +13,6 @@ ha_release: 0.27 ha_iot_class: "Local Polling" --- - The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes. It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes. @@ -41,14 +40,40 @@ sensor: - platform: fritzbox_callmonitor ``` -Configuration variables: - -- **host** (*Optional*): The IP address of your router, eg. 192.168.1.1. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1. -- **port** (*Optional*): The TCP port of the call monitor. There is usually no reason to change this. -- **username** (*Optional*): Fritz!Box user's user name. This is required to use the phone book lookup feature. The user needs to have the "voice message, fax message, Fritz!App Fon and call list" permission. -- **password** (*Optional*): Fritz!Box user's user password. This is required to use the phone book lookup feature. -- **phonebook** (*Optional*): Numerical ID identifying the phonebook to be used. If there is just one phonebook, this is usually 0. -- **prefixes** (*Optional*): In case of a local call, the phone number seen by the router might differ from the one stored in the phone book by an area code, similarly for the international prefix. To remedy this, a list of prefixes, that can be appended to the phone number in case it is not found in the phone book, can be given. +{% configuration %} +name: + description: Give the sensor a friendly name for in the front-end. + required: false + default: Phone + type: string +host: + description: The IP address of your router, e.g., 192.168.1.1. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1. + required: false + default: 169.254.1.1 + type: string +port: + description: The TCP port of the call monitor. There is usually no reason to change this. + required: false + default: 1012 + type: integer +username: + description: Fritz!Box user's user name. This is required to use the phone book lookup feature. The user needs to have the "voice message, fax message, Fritz!App Fon and call list" permission. + required: false + type: string +password: + description: Fritz!Box user's user password. This is required to use the phone book lookup feature. + required: false + type: string +phonebook: + description: Numerical ID identifying the phonebook to be used. If there is just one phonebook, this is usually 0. + required: false + default: 0 + type: integer +prefixes: + description: In case of a local call, the phone number seen by the router might differ from the one stored in the phone book by an area code, similarly for the international prefix. To remedy this, a list of prefixes, that can be appended to the phone number in case it is not found in the phone book, can be given. + required: false + type: list +{% endconfiguration %} ## {% linkable_title Examples %} diff --git a/source/_components/sensor.fritzbox_netmonitor.markdown b/source/_components/sensor.fritzbox_netmonitor.markdown index 240ffcf6641..9fcaa72084a 100644 --- a/source/_components/sensor.fritzbox_netmonitor.markdown +++ b/source/_components/sensor.fritzbox_netmonitor.markdown @@ -28,9 +28,18 @@ sensor: - platform: fritzbox_netmonitor ``` -Configuration variables: - -- **host** (*Optional*): The IP address of your router, eg. 192.168.1.1. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1. +{% configuration %} +host: + description: The IP address of your router, e.g., 192.168.1.1. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1. + required: false + default: 169.254.1.1 + type: string +name: + description: Give the sensor a friendly name for in the front-end. + required: false + default: fritz_netmonitor + type: string +{% endconfiguration %} The following statistics will be exposed as attributes. From 6b6431b9d6d080d736a95ba72f490adf264b75d4 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 6 Nov 2018 08:09:03 +0100 Subject: [PATCH 18/43] Update bh1750 sensor component configuration (#7392) --- source/_components/sensor.bh1750.markdown | 48 ++++++++++++++++++----- 1 file changed, 38 insertions(+), 10 deletions(-) diff --git a/source/_components/sensor.bh1750.markdown b/source/_components/sensor.bh1750.markdown index b7bae73cf1e..1da1ae5eba3 100644 --- a/source/_components/sensor.bh1750.markdown +++ b/source/_components/sensor.bh1750.markdown @@ -13,7 +13,6 @@ ha_release: 0.48 ha_iot_class: "Local Push" --- - The `bh1750` sensor platform allows you to read the ambient light level in Lux from a [BH1750FVI sensor](http://cpre.kmutnb.ac.th/esl/learning/bh1750-light-sensor/bh1750fvi-e_datasheet.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet. Tested devices: @@ -30,15 +29,43 @@ sensor: - platform: bh1750 ``` -Configuration variables: - -- **name** (*Optional*): The name of the sensor -- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x23 or 0x5C. -- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3. -- **operation_mode** (*Optional*): Working mode for the sensor. Defaults to `continuous_high_res_mode_1` for continuous measurement and 1 lx resolution. -- **measurement_delay_ms** (*Optional*): Delay time in ms for waiting the sensor to get the measure. Defaults to 120 ms. -- **multiplier** (*Optional*): Correction coefficient to multiply the measured light level. Value between 0.1 and 10. Default is 1. - +{% configuration %} +name: + description: Name of the sensor. + required: false + default: BH1750 Light Sensor + type: string +i2c_address: + description: I2c address of the sensor. It is 0x23 or 0x5C. + required: false + default: 0x23 + type: string +i2c_bus: + description: I2c bus where the sensor is. + required: false + default: 1, for Raspberry Pi 2 and 3. + type: integer +operation_mode: + description: Working mode for the sensor. + required: false + default: continuous_high_res_mode_1 + type: string +sensitivity: + description: The sensitivity of the sensor can be a value between 31 and 254. + required: false + default: 69 + type: integer +measurement_delay_ms: + description: Delay time in ms for waiting the sensor to get the measure. + required: false + default: 120 + type: integer +multiplier: + description: Correction coefficient to multiply the measured light level. Value between 0.1 and 10. + required: false + default: 1 + type: integer +{% endconfiguration %} ## {% linkable_title Full Examples %} @@ -53,6 +80,7 @@ sensor: name: Ambient light i2c_address: 0x5C operation_mode: one_time_high_res_mode_1 + sensitivity: 60 measurement_delay_ms: 200 scan_interval: 25 ``` From 45be71ee545a4df0a3aac2705194c27355dad5bf Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 6 Nov 2018 08:09:56 +0100 Subject: [PATCH 19/43] Update Tellstick sensor component configuration (#7382) --- source/_components/sensor.tellstick.markdown | 29 ++++++++++++++------ 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/source/_components/sensor.tellstick.markdown b/source/_components/sensor.tellstick.markdown index d7f07a92d7b..f25207d60bd 100644 --- a/source/_components/sensor.tellstick.markdown +++ b/source/_components/sensor.tellstick.markdown @@ -12,10 +12,8 @@ ha_category: Sensor ha_iot_class: "Local Polling" --- - The `tellstick` sensor platform allows you to get current meteorological data from a [TellStick](http://www.telldus.se/products/tellstick) device. - To use your TellStick device, you first have to set up your [Tellstick hub](/components/tellstick/) and then add the following to your `configuration.yaml` file: ```yaml @@ -24,12 +22,27 @@ sensor: - platform: tellstick ``` -Configuration variables: - -- **ID: Name** (*Optional*): Entry for a sensor with the name for it and its ID. -- **only_named** (*Optional*): Only show the named sensors. Set to `True` to hide sensors. -- **temperature_scale** (*Optional*): The scale of the temperature value. -- **datatype_mask** (*Optional*): Mask to determine which sensor values to show based on. Please check the [TellCore tellcore.constants documentation](https://tellcore-py.readthedocs.org/en/v1.1.2/constants.html#module-tellcore.constants) for details. +{% configuration %} +sensor: + description: "Entry for a sensor with the ID and its name, e.g., ID: Name." + required: false + type: string +only_named: + description: Only show the named sensors. Set to `True` to hide sensors. + required: false + default: false + type: boolean +temperature_scale: + description: The scale of the temperature value. + required: false + default: °C + type: string +datatype_mask: + description: Mask to determine which sensor values to show based on. Please check the [TellCore tellcore.constants documentation](https://tellcore-py.readthedocs.org/en/v1.1.2/constants.html#module-tellcore.constants) for details. + required: false + default: 127 + type: integer +{% endconfiguration %} ## {% linkable_title Examples %} From 8dfd9b573320fca7ebed45d4e223950d528c07c5 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 6 Nov 2018 08:10:21 +0100 Subject: [PATCH 20/43] Update Certificate component configuration (#7381) --- source/_docs/mqtt/certificate.markdown | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/source/_docs/mqtt/certificate.markdown b/source/_docs/mqtt/certificate.markdown index 252e0a5160a..f673741c245 100644 --- a/source/_docs/mqtt/certificate.markdown +++ b/source/_docs/mqtt/certificate.markdown @@ -20,9 +20,17 @@ mqtt: certificate: /home/paulus/dev/addtrustexternalcaroot.crt ``` -Configuration variables: - -- **certificate** (*Optional*): 'auto' or the certificate authority certificate file that is to be treated as trusted by this client. 'auto' uses the bundled certificates. If a file is specified the file should contain the root certificate of the certificate authority that signed your broker's certificate, but may contain multiple certificates. Example: `/home/user/identrust-root.pem` -- **client_key** (*Optional*): Client key, eg. `/home/user/owntracks/cookie.key`. -- **client_cert** (*Optional*): Client certificate, eg. `/home/user/owntracks/cookie.crt`. - +{% configuration %} +certificate: + description: "'auto' or the certificate authority certificate file that is to be treated as trusted by this client. 'auto' uses the bundled certificates. If a file is specified the file should contain the root certificate of the certificate authority that signed your broker's certificate, but may contain multiple certificates. Example: `/home/user/identrust-root.pem`" + required: false + type: string +client_key: + description: Client key, e.g., `/home/user/owntracks/cookie.key`. + required: false + type: string +client_cert: + description: Client certificate, e.g., `/home/user/owntracks/cookie.crt`. + required: false + type: string +{% endconfiguration %} From d126bd6d6ba5047bad209fa4ec942be587106764 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 6 Nov 2018 08:10:50 +0100 Subject: [PATCH 21/43] Update Nuimo_controller component configuration (#7391) --- source/_components/nuimo_controller.markdown | 24 ++++++++++++-------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/source/_components/nuimo_controller.markdown b/source/_components/nuimo_controller.markdown index e450fc515f0..cfbb5f66d89 100644 --- a/source/_components/nuimo_controller.markdown +++ b/source/_components/nuimo_controller.markdown @@ -19,14 +19,20 @@ To connect to a Nuimo device add the following section to your `configuration.ya ```yaml # Example configuration.yaml entry -nuimo_controller: +nuimo_controller: ``` -Configuration variables: - -- **mac** (*Optional*): Skip discovery and connect to this device address. -- **name** (*Optional*): To handle more than one device by names, add the name of the device. - +{% configuration %} +mac: + description: Skip discovery and connect to this device address. + required: false + type: string +name: + description: To handle more than one device by names, add the name of the device. + required: false + default: None + type: string +{% endconfiguration %} Example for testing rotation value and sending to the LED matrix: @@ -42,7 +48,7 @@ automation Nuimo_rotate_right: value_template: {% raw %}'{{ trigger.event.data.value > 100 }}'{% endraw %} action: service: nuimo_controller.led_matrix - data: + data: matrix: '........ 0000000. @@ -52,7 +58,7 @@ automation Nuimo_rotate_right: .00.000. .000000. .000000. - ........ ' + ........' interval: 0.5 ``` @@ -60,7 +66,7 @@ Troubleshooting: - use `hcitool lescan` to see the mac address of your device -- allow non-root user access to Bluetooth LE with `sudo setcap cap_net_raw+eip $(eval readlink -f $(which python))` +- allow non-root user access to Bluetooth LE with `sudo setcap cap_net_raw+eip $(eval readlink -f $(which python))` - install the newest version of [pygattlib](https://bitbucket.org/OscarAcena/pygattlib) from the repository, either because there is no binary package for your system or the pip version contains errors, with `pip install hg+https://bitbucket.org/OscarAcena/pygattlib --target $HOME/.homeassistant/deps`. (Dependencies of pygattlib: `sudo apt-get install pkg-config libboost-python-dev libboost-thread-dev libbluetooth-dev libglib2.0-dev python-dev`) From 554897174530f14b52d7b28da4cacf6fcdf6f8af Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 6 Nov 2018 08:11:30 +0100 Subject: [PATCH 22/43] Update Gntp notify component configuration (#7390) --- source/_components/notify.gntp.markdown | 39 +++++++++++++++++++------ 1 file changed, 30 insertions(+), 9 deletions(-) diff --git a/source/_components/notify.gntp.markdown b/source/_components/notify.gntp.markdown index da4f718eb29..f2a3ee782b3 100644 --- a/source/_components/notify.gntp.markdown +++ b/source/_components/notify.gntp.markdown @@ -12,7 +12,6 @@ ha_category: Notifications ha_release: 0.16 --- - [GNTP](http://www.growlforwindows.com/gfw/help/gntp.aspx) is a specification for sending and receiving notifications between computers. The most well known server implementations are [Growl](http://growl.info) for Mac and [Growl for Windows](http://www.growlforwindows.com/gfw/). To use GNTP notifications, add the following to your `configuration.yaml` file: @@ -26,13 +25,35 @@ notify: GNTP will attempt to connect to a local server running on port 23053 if no `hostname` is provided. -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`. -- **app_name** (*Optional*): The application name that will be displayed on every notification and will be registered with the server. -- **app_icon** (*Optional*): The icon that will be displayed on every notification. You can provide an HTTP URL or a `file://` URL. File URLs only work if Home Assistant and the GNTP server are running on the same machine. If no `app_icon` is set a local copy of the Home Assistant logo will be used. If you choose to use an HTTP URL please make the maximum image size 150 px by 150 px as Growl for Mac will sometimes timeout when registering. -- **hostname** (*Optional*): The hostname or IP address of the GNTP server to contact. -- **password** (*Optional*): The password to authenticate to the GNTP server with. -- **port** (*Optional*): The port that the GNTP server runs on. The specification states that servers should not allow users to use any port other than 23053 but `port` is provided here just in case. +{% configuration %} +name: + description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. + required: false + default: notify + type: string +app_name: + description: The application name that will be displayed on every notification and will be registered with the server. + required: false + default: HomeAssistant + type: string +app_icon: + description: "The icon that will be displayed on every notification. You can provide an HTTP URL or a `file://` URL. File URLs only work if Home Assistant and the GNTP server are running on the same machine. If no `app_icon` is set a local copy of the Home Assistant logo will be used. If you choose to use an HTTP URL please make the maximum image size 150 px by 150 px as Growl for Mac will sometimes timeout when registering." + required: false + type: string +hostname: + description: The hostname or IP address of the GNTP server to contact. + required: false + default: localhost + type: string +password: + description: The password to authenticate to the GNTP server with. + required: false + type: string +port: + description: The port that the GNTP server runs on. The specification states that servers should not allow users to use any port other than 23053 but `port` is provided here just in case. + required: false + default: 23053 + type: integer +{% endconfiguration %} To use notifications, please see the [getting started with automation page](/getting-started/automation/). From 7012cb32040289aea1c19e1946b21f9ec34a3744 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 6 Nov 2018 08:12:09 +0100 Subject: [PATCH 23/43] Update Clickatell notify component configuration (#7389) --- source/_components/notify.clickatell.markdown | 22 +++++++++++++------ 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/source/_components/notify.clickatell.markdown b/source/_components/notify.clickatell.markdown index 8ac5d9a614c..5204f3a3fcf 100644 --- a/source/_components/notify.clickatell.markdown +++ b/source/_components/notify.clickatell.markdown @@ -12,7 +12,6 @@ ha_category: Notifications ha_release: 0.56 --- - The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver SMS notifications from Home Assistant. ### Get your Clickatell API Credentials @@ -36,11 +35,20 @@ notify: recipient: PHONE_NO ``` -Configuration variables: - -* **name** (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is `clickatell`. The notifier will bind to the service notify.NOTIFIER_NAME. -* **api_key** (Required): Your API key. -* **recipient** (Required): Your phone number. This is where you want to send your notification SMS messages. e.g., `61444333444`. - +{% configuration %} +name: + description: Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME. + required: false + default: clickatell + type: string +api_key: + description: Your API key. + required: true + type: string +recipient: + description: Your phone number. This is where you want to send your notification SMS messages. e.g., `61444333444`. + required: true + type: string +{% endconfiguration %} To use notifications, please see the [getting started with automation page](/getting-started/automation/). From 11102d31dfdea478f93ff086bf6b036c30857a0c Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 6 Nov 2018 08:12:31 +0100 Subject: [PATCH 24/43] Update Russound_rio media_player component configuration (#7388) --- .../media_player.russound_rio.markdown | 20 ++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/source/_components/media_player.russound_rio.markdown b/source/_components/media_player.russound_rio.markdown index 7a63ab7c666..c431cbbec1d 100644 --- a/source/_components/media_player.russound_rio.markdown +++ b/source/_components/media_player.russound_rio.markdown @@ -27,8 +27,18 @@ media_player: name: Russound ``` -Configuration variables: - -- **host** (*Required*): The IP of the TCP gateway -- **port** (*Optional*): The port of the TCP gateway (default: 9621) -- **name** (*Required*): The name of the device +{% configuration %} +host: + description: The IP of the TCP gateway. + required: true + type: string +port: + description: The port of the TCP gateway. + required: false + default: 9621 + type: integer +name: + description: The name of the device. + required: true + type: string +{% endconfiguration %} From cd62d7d99602975bac655cf0cf97778fedc7afa8 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 6 Nov 2018 08:12:51 +0100 Subject: [PATCH 25/43] Update Lets_Encrypt Add-on component configuration (#7387) --- source/_addons/lets_encrypt.markdown | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/source/_addons/lets_encrypt.markdown b/source/_addons/lets_encrypt.markdown index 755d039a2f7..6b298f43b9f 100644 --- a/source/_addons/lets_encrypt.markdown +++ b/source/_addons/lets_encrypt.markdown @@ -23,10 +23,16 @@ Setup and manage a [Let's Encrypt](https://letsencrypt.org/) certificate. This a } ``` -Configuration variables: - -- **email** (*Required*): Your email address for registration on Let's Encrypt. -- **domains** (*Required*): A list of domains to create/renew the certificate. +{% configuration %} +email: + description: Your email address for registration on Let's Encrypt. + required: true + type: string +domains: + description: A list of domains to create/renew the certificate. + required: true + type: list +{% endconfiguration %} ## {% linkable_title Home Assistant configuration %} From 0f32dbdd606d156f09beb58e7262e9d9bf500197 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 6 Nov 2018 08:13:18 +0100 Subject: [PATCH 26/43] Update Dweet sensor component configuration (#7386) --- source/_components/sensor.dweet.markdown | 29 +++++++++++++++++------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/source/_components/sensor.dweet.markdown b/source/_components/sensor.dweet.markdown index 1bc81d27e67..6fcfa134ac4 100644 --- a/source/_components/sensor.dweet.markdown +++ b/source/_components/sensor.dweet.markdown @@ -25,12 +25,25 @@ sensor: value_template: '{% raw %}{{ value_json.VARIABLE }}{% endraw %}' ``` -Configuration variables: - -- **device** (*Required*): Identification of the device (also known as `thing`). -- **value_template** (*Required*): The variable to extract a value from the content. -- **name** (*Optional*): Let you overwrite the name of the device in the frontend. -- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any. +{% configuration %} +device: + description: Identification of the device (also known as `thing`). + required: true + type: string +value_template: + description: The variable to extract a value from the content. + required: true + type: template +name: + description: Let you overwrite the name of the device in the frontend. + required: false + default: Dweet.io Sensor + type: string +unit_of_measurement: + description: Defines the unit of measurement of the sensor, if any. + required: false + type: string +{% endconfiguration %} ### {% linkable_title Full configuration sample %} @@ -53,6 +66,7 @@ You can easily send dweets from the command-line to test your sensor with `curl` ```bash $ curl -H 'Content-Type: application/json' -d '{"temperature": 40, "humidity": 65}' https://dweet.io/dweet/for/ha-sensor ``` + will give you a response like the one below: ```json @@ -61,7 +75,7 @@ will give you a response like the one below: The [dweepy](https://github.com/paddycarey/dweepy) module gives you another option to work with [Dweet.io](https://dweet.io/). -Send a dweet. +Send a dweet. ```bash $ python3 @@ -76,4 +90,3 @@ Receive the latest dweet. >>> dweepy.get_latest_dweet_for('ha-sensor') [{'thing': 'ha-sensor'', 'created': '2015-12-10T09:43:31.133Z', 'content': {'humidity': 65, 'temperature': 40}}] ``` - From 9899c4c8177085064727775e6f67ea8c095f4c90 Mon Sep 17 00:00:00 2001 From: John Evans Date: Tue, 6 Nov 2018 07:15:32 +0000 Subject: [PATCH 27/43] Added Lovelace info to the dev-tools page (#7383) I've added a paragraph in the dev-tools page mentioning that it's possible to both try Lovelace and set it as the default UI, as this I not mentioned in the docs --- source/_docs/tools/dev-tools.markdown | 3 +++ 1 file changed, 3 insertions(+) diff --git a/source/_docs/tools/dev-tools.markdown b/source/_docs/tools/dev-tools.markdown index 99ce3e7cf7e..18c39443b4d 100644 --- a/source/_docs/tools/dev-tools.markdown +++ b/source/_docs/tools/dev-tools.markdown @@ -101,3 +101,6 @@ Even though MQTT in general provides deeper functionality, the developer tools s {% linkable_title Info %} The Information tab simply provides information about the current installed version, additional links and credits. The tab also contains a section that shows `syslog` information, and the contents of `home-assistant.log` with an option to clear and refresh the logs. + +The Information tab also allows makes it possible to try out the Lovelace User Interface (UI) by clicking "Try out the new Lovelace UI (experimental)" or set Lovelace as the default UI, so that when the "Overview" link in the Sidebar is selected, the Lovelace UI will load by default. + From 7da774c0e957e7a4a60ec10fd8d93d355091becd Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 6 Nov 2018 08:16:13 +0100 Subject: [PATCH 28/43] Update Birth_will MQTT component configuration (#7380) --- source/_docs/mqtt/birth_will.markdown | 60 +++++++++++++++++++++------ 1 file changed, 48 insertions(+), 12 deletions(-) diff --git a/source/_docs/mqtt/birth_will.markdown b/source/_docs/mqtt/birth_will.markdown index 8ba1aa593ad..d0c46687279 100644 --- a/source/_docs/mqtt/birth_will.markdown +++ b/source/_docs/mqtt/birth_will.markdown @@ -25,15 +25,51 @@ mqtt: payload: 'offline' ``` -Configuration variables: - -- **birth_message** (*Optional*): - - **topic** (*Required*): The MQTT topic to publish the message. - - **payload** (*Required*): The message content. - - **qos** (*Optional*): The maximum QoS level of the topic. Default is 0. - - **retain** (*Optional*): If the published message should have the retain flag on or not. Defaults to `True`. -- **will_message** (*Optional*): - - **topic** (*Required*): The MQTT topic to publish the message. - - **payload** (*Required*): The message content. - - **qos** (*Optional*): The maximum QoS level of the topic. Default is 0. - - **retain** (*Optional*): If the published message should have the retain flag on or not. Defaults to `True`. +{% configuration %} +birth_message: + description: Birth Message. + required: false + type: list + keys: + topic: + description: The MQTT topic to publish the message. + required: true + type: string + payload: + description: The message content. + required: true + type: string + qos: + description: The maximum QoS level of the topic. + required: false + default: 0 + type: integer + retain: + description: If the published message should have the retain flag on or not. + required: false + default: true + type: boolean +will_message: + description: Will Message + required: false + type: list + keys: + topic: + description: The MQTT topic to publish the message. + required: true + type: string + payload: + description: The message content. + required: true + type: string + qos: + description: The maximum QoS level of the topic. + required: false + default: 0 + type: integer + retain: + description: If the published message should have the retain flag on or not. + required: false + default: true + type: boolean +{% endconfiguration %} From 4c6246d9a93b4cd36982e0558d16afd14207f44e Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 6 Nov 2018 08:18:29 +0100 Subject: [PATCH 29/43] Minor updates --- source/_components/sensor.dweet.markdown | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/source/_components/sensor.dweet.markdown b/source/_components/sensor.dweet.markdown index 6fcfa134ac4..971c4e734bb 100644 --- a/source/_components/sensor.dweet.markdown +++ b/source/_components/sensor.dweet.markdown @@ -15,15 +15,19 @@ ha_iot_class: "Cloud Polling" The `dweet` sensor platform allows you to get details from your devices which are publishing their values to [Dweet.io](https://dweet.io/). -To use Dweet.io in your installation, add the following to your `configuration.yaml` file: +## {% linkable_title Configuration %} +To use Dweet.io sensors in your installation, add the following to your `configuration.yaml` file: + +{% raw %} ```yaml # Example configuration.yaml entry sensor: - platform: dweet device: THING_NAME - value_template: '{% raw %}{{ value_json.VARIABLE }}{% endraw %}' + value_template: '{{ value_json.VARIABLE }}' ``` +{% endraw %} {% configuration %} device: @@ -49,15 +53,17 @@ unit_of_measurement: A full configuration entry could look like the sample below. +{% raw %} ```yaml # Example configuration.yaml entry sensor: - platform: dweet name: Temperature device: THING_NAME - value_template: '{% raw %}{{ value_json.VARIABLE }}{% endraw %}' + value_template: '{{ value_json.VARIABLE }}' unit_of_measurement: "°C" ``` +{% endraw %} ### {% linkable_title Interacting with Dweet.io %} From 9a233fc520618be04dc585c778b0d5a060cf696a Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 6 Nov 2018 08:20:28 +0100 Subject: [PATCH 30/43] Minor changes --- source/_components/notify.clickatell.markdown | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/source/_components/notify.clickatell.markdown b/source/_components/notify.clickatell.markdown index 5204f3a3fcf..e7ed3b902db 100644 --- a/source/_components/notify.clickatell.markdown +++ b/source/_components/notify.clickatell.markdown @@ -14,7 +14,8 @@ ha_release: 0.56 The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver SMS notifications from Home Assistant. -### Get your Clickatell API Credentials +## {% linkable_title Setup %} + Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) section and create a new SMS integration. There are three screens of information required to create an integration. Please ensure the following: 1. Give the new Integration an identification name. @@ -24,6 +25,8 @@ Go to your [Clickatell SMS Platform Portal](https://portal.clickatell.com/#/) se 5. Be aware of the international number format option as this impacts the structure of the phone numbers you provide. 6. Once you have completed entering your details an API key is generated. Copy the API key. +## {% linkable_title Configuration %} + To add Clickatell to your installation, add the following to your Home Assistant `configuration.yaml` file: ```yaml @@ -42,7 +45,7 @@ name: default: clickatell type: string api_key: - description: Your API key. + description: Your Clicktell API key. required: true type: string recipient: From 12cdb1aaa0773d45368ed866e23ad5df72b400d7 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Tue, 6 Nov 2018 09:54:55 +0100 Subject: [PATCH 31/43] Update mosquitto.markdown --- source/_addons/mosquitto.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_addons/mosquitto.markdown b/source/_addons/mosquitto.markdown index 2b0025640f4..dfffaabf7c4 100644 --- a/source/_addons/mosquitto.markdown +++ b/source/_addons/mosquitto.markdown @@ -38,7 +38,7 @@ anonymous: default: false type: boolean logins: - description: A list of local users that will be created with *username* and *password*. + description: A list of local users that will be created with *username* and *password*. You don't need do this because you can use Home Assistant users too without any configuration. required: false type: list customize: @@ -53,7 +53,7 @@ This add-on is attached to the Home Assistant user system, so mqtt clients can m ### {% linkable_title Home Assistant configuration %} -To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the integration page and install the configuration with one click. The `discovery:` component must be enabled for one-click integration. +To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the integration page and install the configuration with one click. If you have old mqtt settings available, remove this old integration and restart Home Assistant to see the new one. ### {% linkable_title Disable listening on insecure (1883) ports %} From 2675eea2764698ad375accc18a4ee0fc426761f8 Mon Sep 17 00:00:00 2001 From: themoffatt Date: Tue, 6 Nov 2018 03:29:25 -0600 Subject: [PATCH 32/43] Update calendar.todoist.markdown with link (#7367) Adding a link to the comment describing the logic used to determine the "most important" task used in the sensor. --- source/_components/calendar.todoist.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/calendar.todoist.markdown b/source/_components/calendar.todoist.markdown index 36c6e844b78..d738b4b0914 100644 --- a/source/_components/calendar.todoist.markdown +++ b/source/_components/calendar.todoist.markdown @@ -94,7 +94,7 @@ As you can see, there are 4 custom projects here: You can mix-and-match these attributes to create all sorts of custom projects. You can even use [IFTTT](https://ifttt.com/todoist) to create a task with a certain label, then have Home Assistant do some kind of automation when a task with that label comes due. -Home Assistant does its best to determine what task in each project is "most" important, and it's that task which has its state reported. You can access the other tasks you have due soon via the `all_tasks` array (see below). +Home Assistant does its best to [determine what task in each project is "most" important](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/calendar/todoist.py#L432), and it's that task which has its state reported. You can access the other tasks you have due soon via the `all_tasks` array (see below). ### {% linkable_title Sensor attributes %} From f1e699e7a1429de61074dbc795082fd95b30b94f Mon Sep 17 00:00:00 2001 From: Alex Lauerman Date: Tue, 6 Nov 2018 12:53:50 -0600 Subject: [PATCH 33/43] Updated scan_interval documentation (#7394) Minor changes to clarity (primary addition was clarifying this was in seconds). I've read on the forums frequent teslafi polling has impacted battery, but I don't have exact statistics to support this. --- source/_components/tesla.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/tesla.markdown b/source/_components/tesla.markdown index 5c09dd4f6bf..ecff18947fb 100644 --- a/source/_components/tesla.markdown +++ b/source/_components/tesla.markdown @@ -44,7 +44,7 @@ password: required: true type: string scan_interval: - description: API polling interval. Minimal value can't be less then 300. + description: API polling interval in seconds. Minimum value can't be less than 300 (5 minutes). Very frequent polling can use battery. required: false type: integer default: 300 From bd260a0d76cefe1875ffbbdebc94c8e465dac72a Mon Sep 17 00:00:00 2001 From: TheRedBull205 Date: Tue, 6 Nov 2018 23:41:44 +0100 Subject: [PATCH 34/43] Typo fix (#7400) --- source/_docs/mqtt/broker.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/mqtt/broker.markdown b/source/_docs/mqtt/broker.markdown index 8923f93f3ff..cfff837d8ea 100644 --- a/source/_docs/mqtt/broker.markdown +++ b/source/_docs/mqtt/broker.markdown @@ -164,7 +164,7 @@ Home Assistant is not affiliated with CloudMQTT nor will receive any kickbacks. ```yaml mqtt: - broker: CLOUTMQTT_SERVER + broker: CLOUDMQTT_SERVER port: CLOUDMQTT_PORT username: CLOUDMQTT_USER password: CLOUDMQTT_PASSWORD From d328e9782f79361db0f3bdad51f2e57df460059a Mon Sep 17 00:00:00 2001 From: Ben Nelson Date: Wed, 7 Nov 2018 01:34:53 -0600 Subject: [PATCH 35/43] typo "minded" replace with "mined" (#7413) --- source/_components/sensor.bitcoin.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/sensor.bitcoin.markdown b/source/_components/sensor.bitcoin.markdown index ba47bf8d9e1..4465554c50c 100644 --- a/source/_components/sensor.bitcoin.markdown +++ b/source/_components/sensor.bitcoin.markdown @@ -59,7 +59,7 @@ display_options: timestamp: description: Timestamp mined_blocks: - description: Minded Blocks + description: Mined Blocks blocks_size: description: Block size total_fees_btc: From e9686509cafa8153e052f6ef664bcc458b244c0a Mon Sep 17 00:00:00 2001 From: Max Rydahl Andersen Date: Wed, 7 Nov 2018 08:35:29 +0100 Subject: [PATCH 36/43] clarify the filenames needed for appdemon example (#7399) Small thing but I at first try just copied the python and template code into the appdemon examples - which won't work as the names must match :) --- source/_components/deconz.markdown | 3 +++ 1 file changed, 3 insertions(+) diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index db8927e9a4e..a579fef358f 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -150,6 +150,7 @@ automation: #### {% linkable_title Appdaemon event helper %} Helper app that creates a sensor `sensor.deconz_event` with a state that represents the id from the last event and an attribute to show the event data. +Put this in `apps.yaml`: {% raw %} ```yaml deconz_helper: @@ -157,6 +158,7 @@ deconz_helper: class: DeconzHelper ``` +Put this in `deconz_helper.py`: ```python import appdaemon.plugins.hass.hassapi as hass import datetime @@ -176,6 +178,7 @@ class DeconzHelper(hass.Hass): ``` {% endraw %} +Note: the event will not be visible before one event gets sent. #### {% linkable_title Appdaemon remote template %} From a2fe91aeec1378167da970906dccba67c130e4f8 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 7 Nov 2018 08:40:59 +0100 Subject: [PATCH 37/43] Update Fastdotcom sensor component configuration (#7407) * Update Fastdotcom sensor component configuration * :shirt: Fix typo error --- source/_components/sensor.fastdotcom.markdown | 28 +++++++++++++++---- 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/source/_components/sensor.fastdotcom.markdown b/source/_components/sensor.fastdotcom.markdown index 1f808674777..a5e972ff6a8 100644 --- a/source/_components/sensor.fastdotcom.markdown +++ b/source/_components/sensor.fastdotcom.markdown @@ -28,7 +28,7 @@ Once per hour, on the hour (default): ```yaml sensor: - - platform: fastdotcom + - platform: fastdotcom ``` More examples: @@ -42,12 +42,28 @@ sensor: - 0 - 30 ``` -Configuration variables: -- **minute** (*Optional*): Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries. Default is 0. -- **hour** (*Optional*): Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries. Default is None. -- **day** (*Optional*): Specify the day(s) of the month to schedule the speedtest. Use a list for multiple entries. Default is None. -- **manual** (*Optional*): True or False to turn manual mode on or off. Manual mode will disable scheduled speedtests. +{% configuration %} +second: + description: Specify the second(s) of the hour to schedule the speedtest. Use a list for multiple entries. + required: false + default: 0 + type: list +minute: + description: Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries. + required: false + default: 0 + type: list +hour: + description: Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries. + required: false + type: list +manual: + description: True or False to turn manual mode on or off. Manual mode will disable scheduled speedtests. + required: false + default: false + type: boolean +{% endconfiguration %} There is also a service named `sensor.update_fastdotcom` that you can use to run a fast.com speedtest on demand. You can turn on manual mode to disable the scheduled speedtests. From 05c58e6feee5ef46136f9c9235c52f94a9498200 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 7 Nov 2018 08:41:29 +0100 Subject: [PATCH 38/43] Update Fido sensor component configuration (#7405) --- source/_components/sensor.fido.markdown | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/source/_components/sensor.fido.markdown b/source/_components/sensor.fido.markdown index 00694b0d71b..62c55385344 100644 --- a/source/_components/sensor.fido.markdown +++ b/source/_components/sensor.fido.markdown @@ -13,7 +13,6 @@ ha_release: 0.39 ha_iot_class: "Cloud Polling" --- - Integrate your [Fido](https://www.fido.ca/) account information into Home Assistant. ## {% linkable_title Configuration %} @@ -32,9 +31,8 @@ sensor: - data_used ``` -Configuration variables: {% configuration %} -username: +username: description: Your Fido username (your Fido phone number or your email). required: true type: string @@ -48,7 +46,7 @@ number: type: string monitored_variables: description: Variables to monitor. - required: true + required: true type: list keys: fido_dollar: From f7499b966f4e5946c7189f1f28fad60e74999e42 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 7 Nov 2018 08:42:18 +0100 Subject: [PATCH 39/43] Update Bme280 sensor component configuration (#7406) --- source/_components/sensor.bme280.markdown | 71 ++++++++++++++++++----- 1 file changed, 57 insertions(+), 14 deletions(-) diff --git a/source/_components/sensor.bme280.markdown b/source/_components/sensor.bme280.markdown index 7887aff3dde..59612eb46d1 100644 --- a/source/_components/sensor.bme280.markdown +++ b/source/_components/sensor.bme280.markdown @@ -13,7 +13,6 @@ ha_release: 0.48 ha_iot_class: "Local Push" --- - The `bme280` sensor platform allows you to read temperature, humidity and pressure values of a [Bosch BME280 Environmental sensor](https://cdn-shop.adafruit.com/datasheets/BST-BME280_DS001-10.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet. Tested devices: @@ -30,19 +29,63 @@ sensor: - platform: bme280 ``` -Configuration variables: - -- **name** (*Optional*): The name of the sensor -- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x76 or 0x77. -- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3. -- **operation_mode** (*Optional*): Power mode for the sensor. Use 2 for forced mode or 3 for normal mode. Defaults to normal mode. -- **time_standby** (*Optional*): Standby time in ms for normal mode of operation as described in the sensor datasheet. Defaults to 5 ms. -- **oversampling_temperature** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1. -- **oversampling_pressure** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1. -- **oversampling_humidity** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1. -- **filter_mode** (*Optional*): IIR filter coeficient as described in the sensor datasheet. Default is 0, for filter off. -- **delta_temperature** (*Optional*): Absolute delta for temperature correction. -- **monitored_conditions** array (*Optional*): Conditions to monitor. Available conditions are *temperature*, *humidity* and *pressure*. By default all three are displayed. +{% configuration %} +name: + description: The name of the sensor. + required: false + default: BME280 Sensor + type: string +i2c_address: + description: I2c address of the sensor. It is 0x76 or 0x77. + required: false + default: 0x76 + type: string +i2c_bus: + description: I2c bus where the sensor is. + required: false + default: 1, for Raspberry Pi 2 and 3. + type: integer +operation_mode: + description: Power mode for the sensor. Use 2 for forced mode or 3 for normal mode. + required: false + default: 3 + type: integer +time_standby: + description: Standby time in ms for normal mode of operation as described in the sensor datasheet. + required: false + default: 5 + type: integer +oversampling_temperature: + description: Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. + required: false + default: 1 + type: integer +oversampling_pressure: + description: Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. + required: false + default: 1 + type: integer +oversampling_humidity: + description: Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. + required: false + default: 1 + type: integer +filter_mode: + description: IIR filter coeficient as described in the sensor datasheet. + required: false + default: 0 + type: integer +delta_temperature: + description: Absolute delta for temperature correction. + required: false + default: 0 + type: float +monitored_conditions: + description: Conditions to monitor. Available conditions are *temperature*, *humidity* and *pressure*. + required: false + default: All three conditions + type: list +{% endconfiguration %} ## {% linkable_title Full Examples %} From ebddedaae4ee699347bd5eb5fb48b13bc4e7490c Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 7 Nov 2018 08:42:46 +0100 Subject: [PATCH 40/43] Update Ebox sensor component configuration (#7404) --- source/_components/sensor.ebox.markdown | 61 ++++++++++++++++++------- 1 file changed, 44 insertions(+), 17 deletions(-) diff --git a/source/_components/sensor.ebox.markdown b/source/_components/sensor.ebox.markdown index c71643c4c81..cbdad34af61 100644 --- a/source/_components/sensor.ebox.markdown +++ b/source/_components/sensor.ebox.markdown @@ -31,20 +31,47 @@ sensor: - before_offpeak_total ``` -Configuration variables: - -- **username** (*Required*): Your EBox username. -- **password** (*Required*): Your EBox password. -- **monitored_variables** array (*Required*): Variables to monitor. - - **before_offpeak_download**: Download before offpeak usage - - **before_offpeak_upload**: Upload before offpeak usage - - **before_offpeak_total**: Total before offpeak usage - - **offpeak_download**: Download offpeak usage - - **offpeak_upload**: Upload offpeak usage - - **offpeak_total**: Total offpeak usage - - **download**: Download usage - - **upload**: Upload usage - - **total**: Total usage - - **balance**: Account balance - - **limit**: Limit usage - - **usage**: Percent usage +{% configuration %} +username: + description: Your EBox username. + required: true + type: string +password: + description: Your EBox password. + required: true + type: string +name: + description: The name of the sensor. + required: false + default: EBox + type: string +monitored_variables: + description: Variables to monitor. + required: true + type: list + keys: + before_offpeak_download: + description: Download before offpeak usage + before_offpeak_upload: + description: Upload before offpeak usage + before_offpeak_total: + description: Total before offpeak usage + offpeak_download: + description: Download offpeak usage + offpeak_upload: + description: Upload offpeak usage + offpeak_total: + description: Total offpeak usage + download: + description: Download usage + upload: + description: Upload usage + total: + description: Total usage + balance: + description: Account balance + limit: + description: Limit usage + usage: + description: Percent usage +{% endconfiguration %} From 85dff9f3a8dc2352269e93ca77e06b1e87047acc Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 7 Nov 2018 08:43:24 +0100 Subject: [PATCH 41/43] Update Efergy sensor component configuration (#7403) --- source/_components/sensor.efergy.markdown | 53 +++++++++++++++++------ 1 file changed, 40 insertions(+), 13 deletions(-) diff --git a/source/_components/sensor.efergy.markdown b/source/_components/sensor.efergy.markdown index 3ffd7d36d77..3291644614e 100644 --- a/source/_components/sensor.efergy.markdown +++ b/source/_components/sensor.efergy.markdown @@ -45,16 +45,43 @@ sensor: - type: current_values ``` -Configuration variables: - -- **app_token** (*Required*): The App Token for your account. -- **utc_offset** (*Required*): Some variables (currently only the daily_cost) require that the negative number of minutes your timezone is ahead/behind UTC time. -- **monitored_variables** array (*Required*): Variables to monitor. - - **type** (*Required*): Name of the variable. - - **instant_readings**: Instant energy consumption. - - **budget**: Monthly budget. - - **cost**: The cost for energy consumption (with the tariff that has been set in Efergy) over a given period. - - **amount**: The amount of energy consumed over a given period. - - **current_values**: This returns the current energy usage of each device on your account, as `efergy_\`. If you only have one device in your account, this is effectively the same as instant_readings. - - **period** (*Optional*): Some variables take a period argument. Valid options are "day", "week", "month", and "year". - - **currency** (*Optional*): This is used to display the cost/period as the unit when monitoring the cost. It should correspond to the actual currency used in your dashboard. +{% configuration %} +app_token: + description: The App Token for your account. + required: true + type: string +utc_offset: + description: Some variables (currently only the daily_cost) require that the negative number of minutes your timezone is ahead/behind UTC time. + required: false + default: 0 + type: string +monitored_variables: + description: Variables to monitor. + required: true + type: list + keys: + type: + description: Name of the variable. + required: true + type: list + keys: + instant_readings: + description: Instant energy consumption. + budget: + description: Monthly budget. + cost: + description: The cost for energy consumption (with the tariff that has been set in Efergy) over a given period. + amount: + description: The amount of energy consumed over a given period. + current_values: + description: This returns the current energy usage of each device on your account, as `efergy_\`. If you only have one device in your account, this is effectively the same as instant_readings. + period: + description: Some variables take a period argument. Valid options are "day", "week", "month", and "year". + required: false + default: year + type: string + currency: + description: This is used to display the cost/period as the unit when monitoring the cost. It should correspond to the actual currency used in your dashboard. + required: false + type: string +{% endconfiguration %} From d1ac5fa588a740ef0e61b534ad728e90129ef3f4 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 7 Nov 2018 09:12:04 +0100 Subject: [PATCH 42/43] Update Satel_integra component configuration (#7408) * Update Satel_integra component configuration * Minor changes --- source/_components/satel_integra.markdown | 44 ++++++++++++++++++----- 1 file changed, 36 insertions(+), 8 deletions(-) diff --git a/source/_components/satel_integra.markdown b/source/_components/satel_integra.markdown index 8e71d59e7f0..7d808f2e300 100644 --- a/source/_components/satel_integra.markdown +++ b/source/_components/satel_integra.markdown @@ -50,13 +50,42 @@ satel_integra: ``` -Configuration variables: - -- **host** (*Required*): The IP address of the Satel Integra ETHM module on your home network, if using socket type. Default: `localhost` -- **port** (*Optional*): The port on which the ETHM module listens for clients using integration protocol. Default: `7094` -- **partition** (*Optional*): The partition to operate on. Integra can support multiple partitions, this platform only supports one. Default: `1` -- **arm_home_mode** (*Optional*): The mode in which arm Satel Integra when 'arm home' is used. Possible options are `1`,`2` or `3`, default being `1`. For more information on what are the differences between them, please refer to Satel Integra manual. -- **zones** (*Optional*): This module does not discover currently which zones are actually in use, so it will only monitor the ones defined in the config. For each zone, a proper ID must be given as well as its name (does not need to match the one specified in Satel Integra alarm). For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.* +{% configuration %} +host: + description: The IP address of the Satel Integra ETHM module on your home network, if using socket type. + required: true + default: localhost + type: string +port: + description: The port on which the ETHM module listens for clients using integration protocol. + required: false + default: 7094 + type: integer +partition: + description: The partition to operate on. Integra can support multiple partitions, this platform only supports one. + required: false + default: 1 + type: integer +arm_home_mode: + description: The mode in which arm Satel Integra when 'arm home' is used. Possible options are `1`,`2` or `3`. For more information on what are the differences between them, please refer to Satel Integra manual. + required: false + default: 1 + type: integer +zones: + description: "This module does not discover currently which zones are actually in use, so it will only monitor the ones defined in the config. For each zone, a proper ID must be given as well as its name (does not need to match the one specified in Satel Integra alarm). For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) documentation. Note: If no zones are specified, Home Assistant will not load any binary_sensor components." + required: false + type: [integer, list] + keys: + name: + description: Name of the zone. + required: true + type: string + type: + description: The zone type. + required: false + default: motion + type: string +{% endconfiguration %} List of all zone IDs can be taken from DloadX program. @@ -73,7 +102,6 @@ For example: service: input_boolean.turn_on data: entity_id: input_boolean.movement_detected - ``` Enjoy! From 199fa8fe3272295869da79c58eb5b5f26192415e Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Wed, 7 Nov 2018 09:17:42 +0100 Subject: [PATCH 43/43] Minor changes --- source/_components/satel_integra.markdown | 61 ++++++++++++++--------- 1 file changed, 37 insertions(+), 24 deletions(-) diff --git a/source/_components/satel_integra.markdown b/source/_components/satel_integra.markdown index 7d808f2e300..b330fd29938 100644 --- a/source/_components/satel_integra.markdown +++ b/source/_components/satel_integra.markdown @@ -22,32 +22,22 @@ There is currently support for the following device types within Home Assistant: The module communicates via Satel's open TCP protocol published on their website. It subscribes for new events coming from alarm system and reacts to them immediately. -**IMPORTANT:** The library currently doesn't support encrypted connection to your alarm, so you need **to turn off encryption for integration protocol**. In Polish: "koduj integracje" must be unchecked. You will find this setting in your DLOADX program. +## {% linkable_title Setup %} -A `satel_integra` section must be present in the `configuration.yaml` file and contain the following options as required: +The library currently doesn't support encrypted connection to your alarm, so you need **to turn off encryption for integration protocol**. In Polish: "koduj integracje" must be unchecked. You will find this setting in your DloadX program. + +A list of all zone IDs can be taken from DloadX program. + +For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) documentation. Note: If no zones are specified, Home Assistant will not load any binary_sensor components." + +## {% linkable_title Configuration %} + +A `satel_integra` section must be present in the `configuration.yaml` file: ```yaml # Example configuration.yaml entry satel_integra: - host: 192.168.1.100 - port: 7094 - partition: 1 - arm_home_mode: 1 - - zones: - 01: - name: 'Bedroom' - type: 'motion' - 02: - name: 'Hall' - type: 'motion' - 30: - name: 'Kitchen - smoke' - type: 'smoke' - 113: - name: 'Entry door' - type: 'opening' - + host: IP_ADDRESS ``` {% configuration %} @@ -72,7 +62,7 @@ arm_home_mode: default: 1 type: integer zones: - description: "This module does not discover currently which zones are actually in use, so it will only monitor the ones defined in the config. For each zone, a proper ID must be given as well as its name (does not need to match the one specified in Satel Integra alarm). For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) documentation. Note: If no zones are specified, Home Assistant will not load any binary_sensor components." + description: "This module does not discover currently which zones are actually in use, so it will only monitor the ones defined in the configuration. For each zone, a proper ID must be given as well as its name (does not need to match the one specified in Satel Integra alarm)." required: false type: [integer, list] keys: @@ -87,7 +77,31 @@ zones: type: string {% endconfiguration %} -List of all zone IDs can be taken from DloadX program. + +## {% linkable_title Full examples %} + + +```yaml +# Example configuration.yaml entry +satel_integra: + host: 192.168.1.100 + port: 7094 + partition: 1 + arm_home_mode: 1 + zones: + 01: + name: 'Bedroom' + type: 'motion' + 02: + name: 'Hall' + type: 'motion' + 30: + name: 'Kitchen - smoke' + type: 'smoke' + 113: + name: 'Entry door' + type: 'opening' +``` Having configured the zones, you can use them for automation, such as to react on the movement in your bedroom. For example: @@ -104,4 +118,3 @@ For example: entity_id: input_boolean.movement_detected ``` -Enjoy!