From ec9087ceac347bbb23ba3e847a2179ecbac56625 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Thu, 22 Nov 2018 00:02:58 +0100 Subject: [PATCH 01/19] Update Hass.io 1.13 --- source/hassio/installation.markdown | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 9fa3c528910..4490e8f4e0a 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -92,14 +92,14 @@ A detailed guide about running Hass.io as a virtual machine is available in the [etcher]: https://etcher.io/ [Virtual Appliance]: https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/ova.md [hassos-network]: https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md -[pi0-w]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi0-w-1.12.img.gz -[pi1]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi-1.12.img.gz -[pi2]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi2-1.12.img.gz -[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi3-1.12.img.gz -[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi3-64-1.12.img.gz +[pi0-w]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi0-w-1.13.img.gz +[pi1]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi-1.13.img.gz +[pi2]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi2-1.13.img.gz +[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi3-1.13.img.gz +[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi3-64-1.13.img.gz [tinker]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_tinker-2.2.img.gz [odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_odroid-c2-2.2.img.gz -[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_ova-1.12.vmdk +[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_ova-1.13.vmdk.gz [linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio [local]: http://hassio.local:8123 [samba]: /addons/samba/ From e44b817d033d7ad310b4655ecfb055bb74d7e0ea Mon Sep 17 00:00:00 2001 From: Frankwin Hooglander Date: Thu, 22 Nov 2018 13:24:34 -0700 Subject: [PATCH 02/19] Update tuya.markdown (#7594) Add Jinvoo Smart Platform description --- source/_components/tuya.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/tuya.markdown b/source/_components/tuya.markdown index 7166c6142ed..c08bc5ab3fa 100644 --- a/source/_components/tuya.markdown +++ b/source/_components/tuya.markdown @@ -40,7 +40,7 @@ country_code: required: true type: string platform: - description: "The app where your account register. `tuya` for Tuya Smart and `smart_life` for Smart Life." + description: "The app where your account register. `tuya` for Tuya Smart, `smart_life` for Smart Life, `jinvoo_smart` for Jinvoo Smart." required: false type: string default: tuya From 5cc1aaec3ca8731216eec3150219a2101bd99393 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Thu, 22 Nov 2018 22:16:47 +0100 Subject: [PATCH 03/19] Update google_assistant.markdown --- source/_components/google_assistant.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index 814ef6bad49..5fc330909e4 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -19,6 +19,8 @@ The `google_assistant` component allows you to control things via Google Assista With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instance in a few simple clicks to Google Assistant. With Home Assistant Cloud you don't have to deal with dynamic DNS, SSL certificates or opening ports on your router. Just log in via the user interface and a secure connection with the cloud will be established. Home Assistant Cloud requires a paid subscription after a 30-day free trial. +For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/google_assistant/). + ## {% linkable_title Manual setup %} The Google Assistant component requires a bit more setup than most due to the way Google requires Assistant Apps to be set up. From edc27d31bd82cd8a4f6b45ffec50f8f702a4a4ba Mon Sep 17 00:00:00 2001 From: DubhAd Date: Thu, 22 Nov 2018 21:25:01 +0000 Subject: [PATCH 04/19] Adding path for Docker --- source/_docs/configuration.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_docs/configuration.markdown b/source/_docs/configuration.markdown index fb4193f7265..f97eb07c867 100644 --- a/source/_docs/configuration.markdown +++ b/source/_docs/configuration.markdown @@ -21,6 +21,7 @@ The location of the folder differs between operating systems: | Linux | `~/.homeassistant` | | Windows | `%APPDATA%/.homeassistant` | | Hass.io | `/config` | +| Docker | `/config` | If you want to use a different folder for configuration, use the config command line parameter: `hass --config path/to/config`. From 891c0dd314a7373dae25f1e4dadf6596bf820285 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Fri, 23 Nov 2018 14:04:37 +0100 Subject: [PATCH 05/19] Update beta device to 2.3 --- source/hassio/installation.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 4490e8f4e0a..87a63216f97 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -97,8 +97,8 @@ A detailed guide about running Hass.io as a virtual machine is available in the [pi2]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi2-1.13.img.gz [pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi3-1.13.img.gz [pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi3-64-1.13.img.gz -[tinker]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_tinker-2.2.img.gz -[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_odroid-c2-2.2.img.gz +[tinker]: https://github.com/home-assistant/hassos/releases/download/2.3/hassos_tinker-2.3.img.gz +[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.3/hassos_odroid-c2-2.3.img.gz [vmdk]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_ova-1.13.vmdk.gz [linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio [local]: http://hassio.local:8123 From b1ae60a9995c3aaef65adce1c07c89dbca8d613f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20H=C3=B8yer=20Iversen?= Date: Sat, 24 Nov 2018 12:22:02 +0100 Subject: [PATCH 06/19] remove optional config params --- source/_components/device_tracker.netgear.markdown | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/_components/device_tracker.netgear.markdown b/source/_components/device_tracker.netgear.markdown index 78f05695e00..0f27e78ac1b 100644 --- a/source/_components/device_tracker.netgear.markdown +++ b/source/_components/device_tracker.netgear.markdown @@ -21,8 +21,6 @@ To use this device tracker in your installation, add the following to your `conf # Example configuration.yaml entry device_tracker: - platform: netgear - host: YOUR_ROUTER_IP - username: YOUR_ADMIN_USERNAME password: YOUR_ADMIN_PASSWORD ``` From 05c16687aba114ad8182438ebc232134dc723b6f Mon Sep 17 00:00:00 2001 From: Nicholas Westerhausen Date: Sat, 24 Nov 2018 07:22:56 -0500 Subject: [PATCH 07/19] Clarify cache path variable (#7598) Removes ambiguous statement about cache directory. The cache_path is for an authentication token, and it is a file. Addresses #7330 --- source/_components/media_player.spotify.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_components/media_player.spotify.markdown b/source/_components/media_player.spotify.markdown index 8bc1f70e8a8..3ba710b06d8 100644 --- a/source/_components/media_player.spotify.markdown +++ b/source/_components/media_player.spotify.markdown @@ -72,9 +72,10 @@ client_secret: required: true type: string cache_path: - description: Path to cache authentication token (defaults to configuration directory). + description: Path to cache authentication token. required: false type: string + default: .spotify-token-cache aliases: description: "Dictionary of device ids to be aliased, handy for devices that Spotify cannot properly determine the device name of. New devices will be logged to the `info` channel for ease of aliasing." required: false From bb8b98826b89f17d98447426bfec86c7599bf2af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Mart=C3=ADn?= Date: Sat, 24 Nov 2018 13:33:30 +0100 Subject: [PATCH 08/19] Added TV model UE40ES6800 (#7611) --- source/_components/media_player.samsungtv.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/media_player.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown index b9a3a223a3c..74f78a29642 100644 --- a/source/_components/media_player.samsungtv.markdown +++ b/source/_components/media_player.samsungtv.markdown @@ -93,6 +93,7 @@ Currently known supported models: - U6000 (port must be set to 8001) - U6300 (port must be set to 8001, and `pip3 install websocket-client` must be executed) - UE40KU6400U (port must be set to 8001, and `pip3 install websocket-client` must be executed) +- UE40ES6800 - UE46D7000 - UE6199UXZG (port must be set to 8001, On/Off, Forward/Backward, Volume control, but no Play button) - UE65KS8005 (port must be set to 8001, On/Off, Forward/Backward, Volume are OK, but no Play button) From 3fd858367e7413312404c4d43adb9d94bddf3069 Mon Sep 17 00:00:00 2001 From: datafx Date: Sat, 24 Nov 2018 07:38:30 -0500 Subject: [PATCH 09/19] Fix indentation for advanced configuration (#7608) * Fix indentation for advanced configuration Corrected indentation per original PR at https://github.com/home-assistant/home-assistant/pull/15143 * Add note about MDNS --- source/_components/cast.markdown | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/source/_components/cast.markdown b/source/_components/cast.markdown index 1bd86aef388..7b67fe98aa8 100644 --- a/source/_components/cast.markdown +++ b/source/_components/cast.markdown @@ -34,9 +34,13 @@ you want to configure the IP address of the Cast device directly: # Example configuration.yaml entry cast: media_player: - - host: 192.168.1.10 + - host: 192.168.1.10 ``` +

+You may need to enable Multicast DNS (MDNS) on your router if you are on a different subnet or VLAN. +

+ {% configuration %} media_player: description: A list that contains all Cast devices. @@ -62,6 +66,6 @@ those as follows: # Example configuration.yaml entry for multiple devices cast: media_player: - - host: IP_ADDRESS_DEVICE_1 - - host: IP_ADDRESS_DEVICE_2 + - host: IP_ADDRESS_DEVICE_1 + - host: IP_ADDRESS_DEVICE_2 ``` From d4d09d9c63bce0ba284a55d4c25124a58947855f Mon Sep 17 00:00:00 2001 From: Nicholas Westerhausen Date: Sat, 24 Nov 2018 07:39:20 -0500 Subject: [PATCH 10/19] Make configuration.yaml more generic (#7607) Example configuration should not include optional configuration. To make the names configuration clearer, add a second example. --- source/_components/sensor.onewire.markdown | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/source/_components/sensor.onewire.markdown b/source/_components/sensor.onewire.markdown index 9f28de6ad70..73633a4900c 100644 --- a/source/_components/sensor.onewire.markdown +++ b/source/_components/sensor.onewire.markdown @@ -66,8 +66,6 @@ To enable One wire sensors in your installation, add the following to your `conf # Example configuration.yaml entry sensor: - platform: onewire - names: - some_id: your name ``` {% configuration %} @@ -81,3 +79,15 @@ mount_dir: type: string {% endconfiguration %} +### Configuration Example + +When `onewire` is added to Home Assistant, it will generate an ID for the sensor. You can specify a friendly name for the sensor with the name configuration option. + +```yaml +# Named sensor configuration.yaml entry +sensor: + - platform: onewire + names: + GENERATED_ID: FRIENDLY_NAME +``` + From 9683029ff59e7145c555f81bc0bc77b627d93050 Mon Sep 17 00:00:00 2001 From: inputd <38230664+inputd@users.noreply.github.com> Date: Sat, 24 Nov 2018 13:02:41 -0700 Subject: [PATCH 11/19] Update media_player.russound_rnet_markdown (#7626) I have a Russound CAA66. This component also works to control it. Important note: While the CAV6.6 uses a straight through cable, the CAA66 uses a null-modem cable! --- source/_components/media_player.russound_rnet.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/media_player.russound_rnet.markdown b/source/_components/media_player.russound_rnet.markdown index bd5a7ff68c0..c8bd43a1739 100644 --- a/source/_components/media_player.russound_rnet.markdown +++ b/source/_components/media_player.russound_rnet.markdown @@ -15,7 +15,7 @@ ha_iot_class: "Local Polling" The `russound_rnet` platform allows you to control Russound devices that make use of the RNET protocol. -This has initially been tested against a Russound CAV6.6 unit with six zones and six sources. +This has initially been tested against a Russound CAV6.6 unit with six zones and six sources. It will also work with a Russound CAA66, but be sure to use a null-modem cable. Connecting to the Russound device is only possible by TCP, you can make use of a TCP to Serial gateway such as [tcp_serial_redirect](https://github.com/pyserial/pyserial/blob/master/examples/tcp_serial_redirect.py) From 516bea7fe34c5bcdb75467582993469d23bad661 Mon Sep 17 00:00:00 2001 From: Alec Rust Date: Sat, 24 Nov 2018 20:05:11 +0000 Subject: [PATCH 12/19] Mention discovery component in Samsung TV docs (#7603) --- source/_components/media_player.samsungtv.markdown | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/_components/media_player.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown index 74f78a29642..e0c8b5095a7 100644 --- a/source/_components/media_player.samsungtv.markdown +++ b/source/_components/media_player.samsungtv.markdown @@ -20,8 +20,7 @@ The `samsungtv` platform allows you to control a When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication. -To add a TV to your installation, -add the following to your `configuration.yaml` file: +To add a TV to your installation without relying on the [discovery component](/components/discovery/), add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry From 42303df08e3060caf26fbf93370c400e1c24aa78 Mon Sep 17 00:00:00 2001 From: Nicholas Westerhausen Date: Sat, 24 Nov 2018 15:14:13 -0500 Subject: [PATCH 13/19] Add strip light to supported lights (#7610) Address #7609 by adding YLDD04YL to supported models. --- source/_components/light.yeelight.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/light.yeelight.markdown b/source/_components/light.yeelight.markdown index ac8b651e0f2..609bd18e1c3 100644 --- a/source/_components/light.yeelight.markdown +++ b/source/_components/light.yeelight.markdown @@ -91,6 +91,7 @@ This component is tested to work with the following models. If you have a differ | `color2` | YLDP06YL | LED Bulb (Color) - 2nd generation | | `strip1` | YLDD01YL | Lightstrip (Color) | | `strip1` | YLDD02YL | Lightstrip (Color) | +| ? | YLDD04YL | Lightstrip (Color) | `bslamp1` | MJCTD01YL | Xiaomi Mijia Bedside Lamp - WIFI Version! | | `lamp1` | MJTD01YL | Xiaomi Mijia Smart LED Desk Lamp (autodiscovery isn't possible because the device doesn't support mDNS due to the small amount of RAM) | | `ceiling1` | YLXD01YL | Yeelight Ceiling Light | From 9f34c5b9e9338eb4f827038640b45901ad4f76f6 Mon Sep 17 00:00:00 2001 From: ticapix Date: Sat, 24 Nov 2018 21:16:20 +0100 Subject: [PATCH 14/19] Update xiaomi_aqara.markdown (#7618) * Update xiaomi_aqara.markdown * Fix typos --- source/_components/xiaomi_aqara.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown index 8685d30a2be..5f5cbd77fd8 100644 --- a/source/_components/xiaomi_aqara.markdown +++ b/source/_components/xiaomi_aqara.markdown @@ -273,5 +273,7 @@ That means that Home Assistant is not getting any response from your Xiaomi gate - Try to disable and then enable LAN access. - Hard reset the gateway: Press the button of the gateway 30 seconds and start again from scratch. - If you are using Home Assistant in [Docker](/docs/installation/docker/), make sure to use `--net=host`. -- If you receive an `{"error":"Invalid key"}` in your log while trying to control the gateway light, you should generate the key again using an Android Phone or alternatively an emulator such as [bluestacks](https://www.bluestacks.com). In some instances there is an issue with keys being generated using the iOS application. +- If you receive an `{"error":"Invalid key"}` in your log while trying to control the gateway light + - You should generate the key again using an Android Phone or alternatively an emulator such as [bluestacks](https://www.bluestacks.com). In some instances there is an issue with keys being generated using the iOS application. + - You need to make sure to have multicast support on your network. If you are running Home Assistant in a virtual machine (like Proxmox), try `echo 0 >/sys/class/net/vmbr0/bridge/multicast_snooping` on the host and restart the service or reboot the host. - If the required library "PyXiaomiGateway" cannot be installed you will need to install some missing system dependencies `python3-dev`, `libssl-dev`, `libffi-dev` manually (e.g., `$ sudo apt-get install python3-dev libssl-dev libffi-dev`). From 890c1f4ec98b511beafec0050b67ba5657b5ffec Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 25 Nov 2018 10:03:06 +0100 Subject: [PATCH 15/19] Update aws_sqs notify component configuration (#7629) --- source/_components/notify.aws_sqs.markdown | 31 +++++++++++++++++----- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/source/_components/notify.aws_sqs.markdown b/source/_components/notify.aws_sqs.markdown index 6aa9288f7bf..f2b3a340f5c 100644 --- a/source/_components/notify.aws_sqs.markdown +++ b/source/_components/notify.aws_sqs.markdown @@ -32,13 +32,30 @@ notify: region_name: 'us-east-1' ``` -Configuration variables: - -- **aws_access_key_id** (*Required if aws_secret_access_key is provided*): Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`. -- **aws_secret_access_key** (*Required if aws_access_key_id is provided*): Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`. -- **profile_name** (*Optional*): A credentials profile name. -- **region_name** (*Required*): The region identifier to connect to. The default is `us-east-1`. -- **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`. +{% configuration %} +aws_access_key_id: + description: Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`. + required: Required if aws_secret_access_key is provided + type: string +aws_secret_access_key: + description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`. + required: Required if aws_access_key_id is provided + type: string +profile_name: + description: A credentials profile name. + required: false + type: string +region_name: + description: The region identifier to connect to. + required: true + default: us-east-1 + type: string +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 +{% endconfiguration %} ### {% linkable_title Usage %} From dc6c55bf2631e2499cd050e501f88562c5a255ff Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 25 Nov 2018 10:03:31 +0100 Subject: [PATCH 16/19] Update pushover notify component configuration (#7628) --- source/_components/notify.pushover.markdown | 23 +++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/source/_components/notify.pushover.markdown b/source/_components/notify.pushover.markdown index 9fe57cc7e1c..e266291146c 100644 --- a/source/_components/notify.pushover.markdown +++ b/source/_components/notify.pushover.markdown @@ -12,7 +12,6 @@ ha_category: Notifications ha_release: pre 0.7 --- - The [Pushover service](https://pushover.net/) is a platform for the notify component. This allows components to send messages to the user using Pushover. ## {% linkable_title Configuration %} @@ -30,11 +29,21 @@ notify: user_key: YOUR_USER_KEY ``` -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`. -- **api_key** (*Required*): Your API key. -- **user_key** (*Required*): Your user key for Pushover. +{% 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 +api_key: + description: Your API key. + required: true + type: string +user_key: + description: Your user key for Pushover. + required: true + type: string +{% endconfiguration %} Example Automation: @@ -58,6 +67,7 @@ When sending a notification, optional parameters can also be set as per the push Example notification triggered from the Alexa component for an intents is shown below which also uses [Automation Templating](/getting-started/automation-templating/) for the message: {% raw %} + ```yaml # Example configuration.yaml entries alexa: @@ -74,4 +84,5 @@ alexa: device: pixel url: "https://www.home-assistant.io/" ``` + {% endraw %} From 8b42e52394fd450e4df3bfac5b1a7bee62a30c63 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 25 Nov 2018 10:03:53 +0100 Subject: [PATCH 17/19] Update qnap sensor component configuration (#7627) * Update qnap sensor component configuration * :pencil2: Fix error --- source/_components/sensor.qnap.markdown | 129 +++++++++++++++++------- 1 file changed, 92 insertions(+), 37 deletions(-) diff --git a/source/_components/sensor.qnap.markdown b/source/_components/sensor.qnap.markdown index 7731bb33110..c9bbe117708 100644 --- a/source/_components/sensor.qnap.markdown +++ b/source/_components/sensor.qnap.markdown @@ -13,7 +13,6 @@ ha_release: 0.38 ha_iot_class: "Local Polling" --- - This `qnap` sensor allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/). ## {% linkable_title Configuration %} @@ -35,48 +34,104 @@ sensor: - volume_percentage_used ``` -Configuration variables: +{% configuration %} +host: + description: The IP address of the QNAP NAS to monitor. + required: true + type: string +port: + description: The port number on which the QNAP NAS web interface is reachable. + required: false + default: 8080 + type: integer +ssl: + description: Whether to connect via `https`. + required: false + default: false + type: boolean +verify_ssl: + description: Whether SSL certificates should be validated. + required: false + default: true + type: boolean +timeout: + description: How long (in seconds) to wait for a response from the QNAP device before giving up. + required: false + default: 10 + type: integer +username: + description: An user to connect to the QNAP NAS. + required: true + type: string +password: + description: The password of the user to connect to the QNAP NAS. + required: true + type: string +drivers: + description: "Array of drives to monitor (ex: `0:1`)." + required: false + default: all drivers + type: list +volumes: + description: "Array of volumes to monitor (ex: `DataVol1`)." + required: false + default: all volumes + type: list +nics: + description: "Array of network interfaces to monitor (ex: `eth0`)." + required: false + default: all NICs + type: list +monitored_conditions: + description: Defines the stats to monitor as sensors. + required: true + type: list + keys: + status: + description: Displays overall system health. + system_temp: + description: Displays the overall system temperature. + cpu_temp: + description: Displays the CPU's temperature. + cpu_usage: + description: Displays the CPU's utilization as a percentage. + memory_free: + description: Displays the size of available RAM in GB. + memory_used: + description: Displays the size of used RAM in GB. + memory_percent_used: + description: Displays the size of used RAM as a percentage of total RAM. + network_link_status: + description: Displays whether the network interfaces is up (creates a new entry for each interface). + network_tx: + description: Displays the upload speed of a network interface in MB/s (creates a new entry for each interface). + network_rx: + description: Displays the download speed of a network interface in MB/s (creates a new entry for each interface). + drive_smart_status: + description: Displays the S.M.A.R.T. status of the drive (creates a new entry for each drive). + drive_temp: + description: Displays the temperature of the drive (creates a new entry for each drive). + volume_size_free: + description: Displays the available space of the volume in GB (creates a new entry for each volume). + volume_size_used: + description: Displays the used space of the volume in GB (creates a new entry for each volume). + volume_percentage_used: + description: Displays the used space of the volume as a percentage (creates a new entry for each volume). +{% endconfiguration %} -- **host** (*Required*): The IP address of the QNAP NAS to monitor -- **port** (*Optional*): The port number on which the QNAP NAS web interface is reachable. Defaults to `8080`. -- **ssl** (*Optional*): Whether to connect via `https`. Defaults to `false`. -- **verify_ssl** (*Optional*): Whether SSL certificates should be validated. Defaults to `true`. -- **timeout** (*Optional*): How long (in seconds) to wait for a response from the QNAP device before giving up. Defaults to `10`. -- **username** (*Required*): An user to connect to the QNAP NAS. -- **password** (*Required*): The password of the user to connect to the QNAP NAS. -- **drives** (*Optional*): Array of drives to monitor (ex: `0:1`). Defaults to all drives. -- **volumes** (*Optional*): Array of volumes to monitor (ex: `DataVol1`). Defaults to all volumes. -- **nics** (*Optional*): Array of network interfaces to monitor (ex: `eth0`). Defaults to all NICs. -- **monitored_conditions** (*Required*): Defines the stats to monitor as sensors. - - **status**: Displays overall system health. - - **system_temp**: Displays the overall system temperature. - - **cpu_temp**: Displays the CPU's temperature. - - **cpu_usage**: Displays the CPU's utilization as a percentage. - - **memory_free**: Displays the size of available RAM in GB. - - **memory_used**: Displays the size of used RAM in GB. - - **memory_percent_used**: Displays the size of used RAM as a percentage of total RAM. - - **network_link_status**: Displays whether the network interfaces is up (creates a new entry for each interface). - - **network_tx**: Displays the upload speed of a network interface in MB/s (creates a new entry for each interface). - - **network_rx**: Displays the download speed of a network interface in MB/s (creates a new entry for each interface). - - **drive_smart_status**: Displays the S.M.A.R.T. status of the drive (creates a new entry for each drive). - - **drive_temp**: Displays the temperature of the drive (creates a new entry for each drive). - - **volume_size_free**: Displays the available space of the volume in GB (creates a new entry for each volume). - - **volume_size_used**: Displays the used space of the volume in GB (creates a new entry for each volume). - - **volume_percentage_used**: Displays the used space of the volume as a percentage (creates a new entry for each volume). - -### Self-signed certificates +### {% linkable_title Self-signed certificates %} If your QNAP device uses self-signed certificates, set the `verify_ssl` option to `false`. -### QNAP device support: +### {% linkable_title QNAP device support: %} This component has been tested on the following devices: - - TS-259 Pro+ (QTS 4.2.6) - - TS-410 (QTS 4.2.3) - - TS-419 (QTS 4.2.3) - - TS-451 (QTS 4.2.2) - - TS-470 (QTS 4.2.2) - - TS-639 (QTS 4.2.3) +- TS-259 Pro+ (QTS 4.2.6) +- TS-410 (QTS 4.2.3) +- TS-419 (QTS 4.2.3) +- TS-451 (QTS 4.2.2) +- TS-470 (QTS 4.2.2) +- TS-639 (QTS 4.2.3) Other QNAP NAS devices using similar firmware should work fine. For more information about supported devices, or to report issues with your device, please visit the [qnapstats project](https://github.com/colinodell/python-qnapstats#device-support). From 78a5bc7f65dfb318c1e19fbca91c9901822de310 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sun, 25 Nov 2018 09:05:21 +0000 Subject: [PATCH 18/19] Moving webhook details (#7624) It's proving very easy to overlook how to get the webhook URL --- source/_components/dialogflow.markdown | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown index beb5f795656..f5f90b18ce5 100644 --- a/source/_components/dialogflow.markdown +++ b/source/_components/dialogflow.markdown @@ -40,10 +40,10 @@ Using Dialogflow will be easy to create conversations like: To use this integration, you should define a conversation (intent) in Dialogflow, configure Home Assistant with the speech to return and, optionally, the action to execute. -To get the webhook url, go to the integrations page in the configuration screen and find Dialogflow. Click on configure. Follow the instructions on the screen. - ### {% linkable_title Configuring your Dialogflow account %} +To get the webhook url, go to the integrations page in the configuration screen and find Dialogflow. Click on configure. Follow the instructions on the screen. + - [Login](https://console.dialogflow.com/) with your Google account - Click on "Create Agent" - Select name, language (if you are planning to use Google Actions check their [supported languages](https://support.google.com/assistant/answer/7108196?hl=en)) and time zone @@ -62,7 +62,6 @@ To get the webhook url, go to the integrations page in the configuration screen Take a look to "Integrations", in the left menu, to configure third parties. - ### {% linkable_title Configuring Home Assistant %} When activated, the [`alexa` component](/components/alexa/) will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) component. From 29595acb24ef8a3cd9961061f330655611e2a4ff Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 25 Nov 2018 10:06:45 +0100 Subject: [PATCH 19/19] Minor changes --- source/_components/dialogflow.markdown | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown index f5f90b18ce5..e7f00e1a74f 100644 --- a/source/_components/dialogflow.markdown +++ b/source/_components/dialogflow.markdown @@ -14,10 +14,6 @@ ha_release: 0.56 redirect_from: /components/apiai/ --- -

-Before 0.56 this component was named `apiai`. -

- The `dialogflow` component is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook. To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](https://www.home-assistant.io/components/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds). @@ -42,7 +38,7 @@ To use this integration, you should define a conversation (intent) in Dialogflow ### {% linkable_title Configuring your Dialogflow account %} -To get the webhook url, go to the integrations page in the configuration screen and find Dialogflow. Click on configure. Follow the instructions on the screen. +To get the webhook URL, go to the integrations page in the configuration screen and find "Dialogflow". Click on "configure". Follow the instructions on the screen. - [Login](https://console.dialogflow.com/) with your Google account - Click on "Create Agent"