Merge branch 'current' into rc

Gemfile

@@ -15,6 +15,7 @@ group :jekyll_plugins do
   gem 'jekyll-sitemap', '1.4.0'
   gem 'jekyll-time-to-read', '0.1.2'
   gem 'jekyll-commonmark', '1.3.1'
+  gem 'jekyll-toc', '0.15.0'
 end
 
 gem 'sinatra', '2.1.0'

Gemfile.lock

@@ -56,6 +56,9 @@ GEM
       jekyll (>= 3.7, < 5.0)
     jekyll-time-to-read (0.1.2)
       jekyll
+    jekyll-toc (0.15.0)
+      jekyll (>= 3.8)
+      nokogiri (~> 1.10)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     kramdown (2.3.0)
@@ -63,7 +66,7 @@ GEM
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liquid (4.0.3)
-    listen (3.3.0)
+    listen (3.3.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.4.0)
@@ -124,6 +127,7 @@ DEPENDENCIES
   jekyll-paginate (= 1.1.0)
   jekyll-sitemap (= 1.4.0)
   jekyll-time-to-read (= 0.1.2)
+  jekyll-toc (= 0.15.0)
   nokogiri (= 1.10.10)
   rake (= 13.0.1)
   sass-globbing (= 1.1.5)

_config.yml

@@ -46,6 +46,7 @@ highlighter: none
 
 plugins:
   - jekyll-time-to-read
+  - jekyll-toc
 
 paginate: 10 # Posts per page on the blog index
 paginate_path: "blog/posts/:num" # Directory base for pagination URLs eg. /posts/2/
@@ -123,6 +124,7 @@ defaults:
       featured: false
   # Defaults for blogs posts
   - scope:
+      path: ""
       type: posts
     values:
       layout: post
@@ -130,9 +132,26 @@ defaults:
       footer: true
       sharing: true
       sidebar: true
+  # Enable table of contents for integrations
+  #
+  # To set toc as a default value, we need to set the scope with an empty path
+  # and the collection as type
+  # https://github.com/toshimaru/jekyll-toc/issues/116#issuecomment-644205770
+  #
+  - scope:
+      path: ""
+      type: integrations
+    values:
+      toc: true
 
 # Support for files Jekyll will normally exclude
 include:
   - "_headers"
   - "_redirects"
   - ".well-known"
+
+# Table of contents
+# https://github.com/toshimaru/jekyll-toc
+toc:
+  min_level: 2 # default: 1
+  max_level: 3 # default: 6

sass/custom/_paulus.scss

@@ -426,6 +426,21 @@ div.note {
 .aside-module {
   .section {
     margin-bottom: 10px;
+
+    ul.section-nav {
+      margin-left: 0px;
+
+      li.toc-entry {
+        list-style-type: none;
+        li {
+          list-style-type: circle;
+          margin-left: 1em;
+        }
+        ul {
+          margin-left: 1em;
+        }
+      }
+    }
   }
 
   .brand-logo-container {

source/_docs/installation/docker.markdown

@@ -310,6 +310,6 @@ On Mac, USB devices are [not passed through](https://github.com/docker/for-mac/i
 
 The Home Assistant Container is using an alternative memory allocation library [jemalloc](http://jemalloc.net/) for better memory management and Python runtime speedup.
 
-As Jemalloc can cause issues on certain hardware, it can be disabled by passing the environment variable `DISABLE_JEMALLOC` with any value, for example: `-e "JEMALLOC_DISABLE=true"`.
+As jemalloc can cause issues on certain hardware, it can be disabled by passing the environment variable `DISABLE_JEMALLOC` with any value, for example: `-e "DISABLE_JEMALLOC=true"`.
 
-The error message `<jemalloc>: Unsupported system page size` is one known indicator. 
+The error message `<jemalloc>: Unsupported system page size` is one known indicator.

source/_docs/scripts.markdown

@@ -178,7 +178,7 @@ With both types of waits it is possible to set a timeout after which the script
 ```
 {% endraw %}
 
-You can also get the script to abort after the timeout by using optional `continue_on_timeout`.
+You can also get the script to abort after the timeout by using optional `continue_on_timeout: false`.
 
 {% raw %}
 ```yaml
@@ -194,7 +194,7 @@ You can also get the script to abort after the timeout by using optional `contin
 ```
 {% endraw %}
 
-Without `continue_on_timeout` the script will always continue.
+Without `continue_on_timeout: false` the script will always continue since the default for `continue_on_timeout` is `true`.
 
 ### Wait Variable
 

source/_headers

@@ -1,7 +1,8 @@
 /*
   Cache-Control: public, max-age: 0, s-maxage=3600, must-revalidate
   Content-Security-Policy: form-action https:
-  Feature-Policy: vibrate 'none'; geolocation 'none'; midi 'none'; microphone 'none'; camera 'none'; magnetometer 'none'; gyroscope 'none'; speaker 'none'; vibrate 'none'; payment 'none'
+  Feature-Policy: geolocation 'none'; midi 'none'; microphone 'none'; camera 'none'; magnetometer 'none'; gyroscope 'none'; payment 'none'
+  Permissions-Policy: geolocation=(), midi=(), microphone=(), camera=(), magnetometer=(), gyroscope=(), payment=()
   Referrer-Policy: no-referrer-when-downgrade
   X-Content-Type-Options: nosniff
   X-XSS-Protection: 1; mode=block

source/_includes/asides/component_navigation.html

@@ -66,6 +66,12 @@
     </ul>
     </div>
   {%- endif -%}
+
+  {%- unless page.no_toc -%}
+    <div class='section'>
+    <h1 class="title delta">On this page</h1>
+    {% toc %}
+  {%- endunless -%}
 </section>
 
 <script src="https://alerts.home-assistant.io/ce-alert-link.js"></script>

source/_integrations/alexa.smart_home.markdown

@@ -115,6 +115,7 @@ Next you need create a Lambda function.
 - You will then be prompted to input the `Skill ID` from the skill you created in previous step. (Tips: you may need switch back to Alexa Developer Console to copy the `Skill ID`.) Then click `Add`.
 - Click your Lambda function icon in the middle of the diagram (above Layers), scroll down you will see a `Function code` window.
 - Clear the example code, copy the Python script from: [https://gist.github.com/matt2005/744b5ef548cc13d88d0569eea65f5e5b](https://gist.github.com/matt2005/744b5ef548cc13d88d0569eea65f5e5b) (modified code to support Alexa's proactive mode, see details below)
+- Click `Deploy` button to publish updated code.
 - Scroll down a little bit, you will find `Environment variables`, you need add 1 environment variable and, if required, 3 optional variables. This is done by selecting `Manage environment variables` then adding the following:
   - *(required)* Key = BASE_URL, Value = your Home Assistant instance's Internet accessible URL with port if needed. *Do not include the trailing `/`*.
   - *(optional)* Key = NOT_VERIFY_SSL, Value = *True*. You can set this to *True* to ignore SSL issues, for example if you don't have a valid SSL certificate or you are using a self-signed certificate.

source/_integrations/denonavr.markdown

@@ -28,6 +28,7 @@ Known supported devices:
 - Denon AVR-X2200W
 - Denon AVR-X2300W
 - Denon AVR-X2400H
+- Denon AVR-X2500H
 - Denon AVR-X3200W
 - Denon AVR-X3300W
 - Denon AVR-X3400H

source/_integrations/garadget.markdown

@@ -37,33 +37,30 @@ covers:
   description: List of your doors.
   required: true
   type: list
-  covers:
-      keys:
-        device:
-          description: This is the device id from your Garadget portal.
-          required: true
-          type: string
-        username:
-          description: Your Garadget account username.
-          required: true
-          type: string
-        password:
-          description: Your Garadget account password.
-          required: true
-          type: string
-        access_token:
-          description: A generated `access_token` from your Garadget account.
-          required: true
-          type: string
-        name:
-          description: me to use in the frontend, will use name configured in Garadget otherwise.
-          required: false
-          default: Garadget
-          type: string
+  keys:
+    device:
+      description: This is the device id from your Garadget portal. It can be found in the Settings section of the Garadget website or mobile application.
+      required: true
+      type: string
+    username:
+      description: Your Garadget account username. Use with `password` to obtain the `access_token` automatically.
+      required: false
+      type: string
+    password:
+      description: Your Garadget account password. Use with `username` to obtain the `access_token` automatically.
+      required: false
+      type: string
+    access_token:
+      description: A generated `access_token` from your Garadget account. To obtain an `access_token`, use the network tab of the developer tools for your web browser while logged into the Garadget website. When supplied, the `username` and `password` values are not required.
+      required: false
+      type: string
+    name:
+      description: Name to use in the frontend, will use name configured in Garadget otherwise.
+      required: false
+      default: Garadget
+      type: string
 {% endconfiguration %}
 
-If provided, the **access_token** will be used, otherwise the **username** and **password** will be used to automatically generate an access token at start time.
-
 ## Example
 
 <p class='img'>

source/_integrations/google_assistant.markdown

@@ -75,9 +75,9 @@ If you want to allow other household users to control the devices:
     1. Enter the email address of the user you want to add.
     2. Click Select a role and choose Project < Viewer.
     3. Click SAVE
-    4. Copy and share the link with the new user.
-    5. When the new user opens the link with their own Google account, it will enable your draft test app under their account.
-5. Have the new user go to their `Google Assistant` app to add `[test] your app name` to their account.
+    4. Copy and share the Actions project link (`https://console.actions.google.com/project/YOUR_PROJECT_ID/simulator`) with the new user.
+5. Have the new user open the link with their own Google account, agree to the Terms of Service popup, then select "Start Testing", select VERSION - Draft in the dropdown, and click "Done".
+6. Have the new user go to their `Google Assistant` app to add `[test] your app name` to their account.
 
 ### Enable Device Sync
 

source/_integrations/insteon.markdown

@@ -234,7 +234,7 @@ device_override:
   type: list
   keys:
     address:
-      description: is found on the device itself in the form 1A.2B.3C or 1a2b3c.
+      description: "Is found on the device itself in the form `1A.2B.3C` or `1a2b3c`. If there's no letter in the address you need to use quotation marks, e.g., `\"123456\"`, to avoid it becoming a number in YAML."
       required: true
       type: string
     cat:

source/_integrations/logbook.markdown

@@ -13,7 +13,7 @@ ha_iot_class:
 The logbook integration provides a different perspective on the history of your
 house by showing all the changes that happened to your house in reverse
 chronological order. It depends on
-the `recorder` integration for storing the data. This means that if the
+the [`recorder`](/integrations/recorder/) integration for storing the data. This means that if the
 [`recorder`](/integrations/recorder/) integration is set up to use e.g., MySQL or
 PostgreSQL as data store, the `logbook` integration does not use the default
 SQLite database to store data.

source/_integrations/microsoft.markdown

@@ -8,7 +8,7 @@ ha_release: 0.57
 ha_domain: microsoft
 ---
 
-The `microsoft` text-to-speech platform uses the [TTS engine of the Microsoft Speech Service](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/text-to-speech) to read a text with natural sounding voices. This integration uses an API that is part of the Cognitive Services offering and is known as the Microsoft Speech API. For this integration to work, you need a free API key. You can use your [Azure subscription](https://azure.microsoft.com) to create an [Azure Speech resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices/).
+The `microsoft` text-to-speech platform uses the [TTS engine of the Microsoft Speech Service](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/text-to-speech) to read a text with natural sounding voices. This integration uses an API that is part of the Cognitive Services offering and is known as the Microsoft Speech API. For this integration to work, you need a free API key. You can use your [Azure subscription](https://azure.microsoft.com) to create an [Azure Speech resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices).
 
 ## Configuration
 

source/_integrations/opensky.markdown

@@ -37,6 +37,8 @@ Both events have three attributes:
 
 - **sensor**: Name of `opensky` sensor that fired the event.
 - **callsign**: Callsign of the flight.
+- **latitude**: Latitude of the flight.
+- **longitude**: Longitude of the flight.
 - **altitude**: Altitude of the flight in meters.
 
 To receive notifications of the entering flights using the [Home Assistant Companion App](https://companion.home-assistant.io/), add the following lines to your `configuration.yaml` file:

source/_integrations/withings.markdown

@@ -125,7 +125,7 @@ In a text editor, replace ```USER_PROFILE_NAME``` in the template sensors below
 
 ```yaml
 # Example configuration.yaml entry
-sensors:
+sensor:
   - platform: template
     sensors:
       withings_weight_lbs_USER_PROFILE_NAME:

source/_integrations/xiaomi.markdown

@@ -18,6 +18,7 @@ In order to integrate the camera with Home Assistant, it is necessary to install
 
 * [Yi 720p](https://github.com/fritz-smh/yi-hack)
 * [Yi Home 17CN / 27US / 47US / 1080p Home / Dome / 1080p Dome](https://github.com/shadow-1/yi-hack-v3)
+* [Recent Yi 1080p Home / 1080p Dome](https://github.com/roleoroleo/yi-hack-MStar)
 * [Xiaofang 1080p Camera](https://github.com/samtap/fang-hacks)
 
 Once installed, please ensure that you have enabled FTP.

source/_integrations/yessssms.markdown

@@ -57,7 +57,7 @@ name:
   type: string
   default: notify
 username:
-  description: This is your login name (usually your phone number). Veryfy that you can use your credentials on the Yesss.at website.
+  description: This is your login name (usually your phone number, but in some cases it could be your e-mail). Veryfy that you can use your credentials on the Yesss.at website.
   required: true
   type: string
 password:
@@ -81,9 +81,9 @@ For an alternative provider you would set the `provider` option. An example conf
 notify:
   - name: sms_to_self
     platform: yessssms
-    username: 06641234567
+    username: "+436641234567"
     password: tops3cr3tpass0rd
-    recipient: 06641234567
+    recipient: "+436641234567"
     provider: educom
 ```
 

source/_posts/2020-10-28-release-117.markdown

@@ -60,6 +60,7 @@ So, keep an eye on our social media for the announcement.
 - [Release 0.117.3 - November 4](#release-01173---november-4)
 - [Release 0.117.4 - November 4](#release-01174---november-4)
 - [Release 0.117.5 - November 5](#release-01175---november-5)
+- [Release 0.117.6 - November 11](#release-01176---november-11)
 - [If you need help...](#if-you-need-help)
 - [Breaking Changes](#breaking-changes)
 - [Farewell to the following](#farewell-to-the-following)
@@ -481,6 +482,24 @@ The following integrations are now available via the Home Assistant UI:
 [simplisafe docs]: /integrations/simplisafe/
 [tasmota docs]: /integrations/tasmota/
 
+## Release 0.117.6 - November 11
+
+- Remove unneeded state restoration of the physical device in rpi_gpio_pwm integration ([@soldag] - [#42804]) ([rpi_gpio_pwm docs])
+- Bump pwmled to v1.6.7 ([@soldag] - [#42903]) ([rpi_gpio_pwm docs])
+- Bump gTTS-token to 1.1.4 ([@hmmbob] - [#43015]) ([google_translate docs])
+- Fix Plex auth issues by setting header ([@jjlawren] - [#43081]) ([plex docs])
+
+[#42804]: https://github.com/home-assistant/core/pull/42804
+[#42903]: https://github.com/home-assistant/core/pull/42903
+[#43015]: https://github.com/home-assistant/core/pull/43015
+[#43081]: https://github.com/home-assistant/core/pull/43081
+[@hmmbob]: https://github.com/hmmbob
+[@jjlawren]: https://github.com/jjlawren
+[@soldag]: https://github.com/soldag
+[google_translate docs]: /integrations/google_translate/
+[plex docs]: /integrations/plex/
+[rpi_gpio_pwm docs]: /integrations/rpi_gpio_pwm/
+
 ## 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).

source/hassio/enable_i2c.markdown

@@ -28,7 +28,7 @@ and make sure the first partition is available.
   ```txt
   i2c-dev
   ```
-- In the root of the USB drive edit the file called `config.txt` add two lines
+- In the root of the `hassos-boot` partition, edit the file called `config.txt` add two lines
   to it:
   ```txt
   dtparam=i2c_vc=on

source/hassio/installation.markdown

@@ -14,7 +14,7 @@ The following will take you through the steps required to install Home Assistant
      - [Raspberry Pi 4 Model B (1 GB, 2 GB and 4 GB model) 32-bit][pi4-32] (32-bit is required for GPIO support)
      - [Raspberry Pi 4 Model B (1 GB, 2 GB, 4 GB and 8 GB model) 64-bit][pi4-64] (64-bit is required for 8 GB model)
      - [Tinkerboard][tinker]
-     - [Odroid-C2][odroid-c2], [Odroid-N2][odroid-n2], [Odroid-XU4][odroid-xu4]
+     - [Odroid-C2][odroid-c2], [Odroid-C4 (Beta)][odroid-c4], [Odroid-N2][odroid-n2], [Odroid-XU4][odroid-xu4]
      - [Intel NUC][intel-nuc]
 
    - As a virtual appliance (x86_64/UEFI):
@@ -105,23 +105,24 @@ If you would like to test next release before anyone else, you can install the b
 
 [balenaEtcher]: https://www.balena.io/etcher
 [hassos-network]: https://github.com/home-assistant/operating-system/blob/dev/Documentation/network.md
-[pi0-w]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi0-w-4.15.img.gz
-[pi1]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi-4.15.img.gz
-[pi2]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi2-4.15.img.gz
-[pi3-32]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi3-4.15.img.gz
-[pi3-64]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi3-64-4.15.img.gz
-[pi4-32]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi4-4.15.img.gz
-[pi4-64]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi4-64-4.15.img.gz
-[tinker]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_tinker-4.15.img.gz
-[odroid-c2]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_odroid-c2-4.15.img.gz
-[odroid-n2]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_odroid-n2-4.15.img.gz
-[odroid-xu4]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_odroid-xu4-4.15.img.gz
-[intel-nuc]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_intel-nuc-4.15.img.gz
-[vmdk]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_ova-4.15.vmdk.gz
-[vhdx]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_ova-4.15.vhdx.gz
-[vdi]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_ova-4.15.vdi.gz
-[qcow2]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_ova-4.15.qcow2.gz
-[Virtual Appliance]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_ova-4.15.ova
+[pi0-w]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_rpi0-w-4.16.img.gz
+[pi1]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_rpi-4.16.img.gz
+[pi2]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_rpi2-4.16.img.gz
+[pi3-32]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_rpi3-4.16.img.gz
+[pi3-64]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_rpi3-64-4.16.img.gz
+[pi4-32]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_rpi4-4.16.img.gz
+[pi4-64]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_rpi4-64-4.16.img.gz
+[tinker]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_tinker-4.16.img.gz
+[odroid-c2]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_odroid-c2-4.16.img.gz
+[odroid-c4]: https://github.com/home-assistant/operating-system/releases/download/5.5/hassos_odroid-c4-5.5.img.gz
+[odroid-n2]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_odroid-n2-4.16.img.gz
+[odroid-xu4]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_odroid-xu4-4.16.img.gz
+[intel-nuc]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_intel-nuc-4.16.img.gz
+[vmdk]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_ova-4.16.vmdk.gz
+[vhdx]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_ova-4.16.vhdx.gz
+[vdi]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_ova-4.16.vdi.gz
+[qcow2]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_ova-4.16.qcow2.gz
+[Virtual Appliance]: https://github.com/home-assistant/operating-system/releases/download/4.16/hassos_ova-4.16.ova
 [local]: http://homeassistant.local:8123
 [samba]: /addons/samba/
 [ssh]: /addons/ssh/

source/help/index.markdown

@@ -49,6 +49,8 @@ Looking for [talking points](/help/talking-points/) or [trivia](/help/trivia)?
 
 Don't miss the regular [Home Assistant podcasts](https://hasspodcast.io/).
 
+- [Why I use Home Assistant for open source home automation](https://opensource.com/article/20/11/home-assistant) - November 2020
+- [Thomas-Krenn-Award 2020: Dino, Teckids und Home Assistant](https://www.thomas-krenn.com/de/tkmag/allgemein/gewinner-thomas-krenn-award-2020/) - June 2020
 - [Magical Smart Home Upgrade Lets Muggles Control Their Homes With a Wand Too](https://gizmodo.com/magical-smart-home-upgrade-lets-muggles-control-their-h-1833941228) - April 2019
 - [Thomas-Krenn-Award 2019 – The winners](https://www.thomas-krenn.com/de/tkmag/tk-insights/thomas-krenn-award-2019-gewinner/) - March 2019
 - [How to set up and use Home Assistant: For Dummies edition](https://www.the-ambient.com/how-to/set-up-use-home-assistant-644) - October 2018

source/more-info/unsupported/network_manager.markdown

@@ -41,6 +41,13 @@ backend=journal
 `/etc/NetworkManager/system-connections/default`:
 
 ```txt
+[connection]
+id=Supervisor default
+uuid=b653440a-544a-4e4f-aef5-6c443171c4f8
+type=802-3-ethernet
+llmnr=2
+mdns=2
+
 [ipv4]
 method=auto