Bump version to v1.17.1

Bump pyyaml from 5.3.1 to 5.4 in /script

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Issue Tracker
+    url: https://github.com/esphome/issues
+    about: Please create bug reports in the dedicated issue tracker.
+  - name: Feature Request Tracker
+    url: https://github.com/esphome/feature-requests
+    about: Please create feature requests in the dedicated feature request tracker.
+  - name: Frequently Asked Question
+    url: https://esphome.io/guides/faq.html
+    about: Please view the FAQ for common questions and what to include in a bug report.

.github/workflows/bump-version.yml

@@ -21,7 +21,7 @@ jobs:
       id: commit_version
       run: |
         git config user.name esphomebot
-        git config user.email contact@esphome.io
+        git config user.email esphome@nabucasa.com
         git add .
         git commit -m "Bump version to v${{ github.event.inputs.version }}"
         git push
@@ -37,7 +37,7 @@ jobs:
         release_name: ${{ github.event.inputs.version }}
         body: 'See https://beta.esphome.io/changelog/index.html'
         prerelease: true
-        commitish: ${{ steps.commit_version.outputs.commit_sha }}  
+        commitish: ${{ steps.commit_version.outputs.commit_sha }}
     - if: ${{ !contains(github.event.inputs.version, 'b') }}
       name: Create Stable Release
       uses: actions/create-release@v1
@@ -48,15 +48,13 @@ jobs:
         release_name: ${{ github.event.inputs.version }}
         body: 'See https://esphome.io/changelog/index.html'
         prerelease: false
-        commitish: ${{ steps.commit_version.outputs.commit_sha }} 
-
+        commitish: ${{ steps.commit_version.outputs.commit_sha }}
 
   deploy-community-addons:
     runs-on: ubuntu-latest
     needs: [create-release]
     steps:
-    - if: ${{ contains(github.event.inputs.version, 'b') }}
-      name: Publish beta release to community-addons repository
+    - name: Publish beta release to community-addons repository
       run: |
         docker run --rm hassioaddons/repository-updater:latest \
           --repository hassio-addons/repository-beta \

esphome-beta/DOCS.md

@@ -0,0 +1,81 @@
+# Home Assistant Community Add-on: ESPHome
+
+## Installation
+
+The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on.
+
+1. Search for the “ESPHome” add-on in the Supervisor add-on store.
+2. Press install to download the add-on and unpack it on your machine. This can take some time.
+3. Optional: If you're using SSL/TLS certificates and want to encrypt your communication to this add-on, please enter `true` into the `ssl` field and set the `fullchain` and `certfile` options accordingly.
+4. Start the add-on, check the logs of the add-on to see if everything went well.
+5. Click "OPEN WEB UI" to open the ESPHome dashboard. You will be asked for your Home Assistant credentials - ESPHome uses Home Assistant's authentication system to log you in.
+
+You can view the ESPHome documentation at https://esphome.io/
+
+## Configuration
+
+**Note**: _Remember to restart the add-on when the configuration is changed._
+
+Example add-on configuration:
+
+```json
+{
+  "ssl": false,
+  "certfile": "fullchain.pem",
+  "keyfile": "privkey.pem"
+}
+```
+
+### Option: `ssl`
+
+Enables or disables encrypted SSL/TLS (HTTPS) connections to the web server of this add-on.
+Set it to `true` to encrypt communications, `false` otherwise.
+Please note that if you set this to `true` you must also generate the key and certificate
+files for encryption. For example using [Let's Encrypt](https://www.home-assistant.io/addons/lets_encrypt/)
+or [Self-signed certificates](https://www.home-assistant.io/docs/ecosystem/certificates/tls_self_signed_certificate/).
+
+### Option: `certfile`
+
+The certificate file to use for SSL. If this file doesn't exist, the add-on start will fail.
+
+**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
+
+### Option: `keyfile`
+
+The private key file to use for SSL. If this file doesn't exist, the add-on start will fail.
+
+**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
+
+### Option: `leave_front_door_open`
+
+Adding this option to the add-on configuration allows you to disable
+authentication by setting it to `true`.
+
+### Option: `esphome_version`
+
+Manually override which ESPHome version to use in the add-on.
+For example to install the latest development version, use `"esphome_version": "dev"`,
+or for version 1.14.0: `"esphome_version": "v1.14.0""`.
+
+Please note that this does not always work and is only meant for testing, usually the
+ESPHome add-on and dashboard version must match to guarantee a working system.
+
+### Option: `relative_url`
+
+Host the ESPHome dashboard under a relative URL, so that it can be integrated
+into existing web proxies like NGINX under a relative URL. Defaults to `/`.
+
+### Option: `status_use_ping`
+
+By default the dashboard uses mDNS to check if nodes are online. This does
+not work across subnets unless your router supports mDNS forwarding or avahi.
+
+Setting this to `true` will make ESPHome use ICMP ping requests to get the node status. Use this if all nodes always have offline status even when they're connected.
+
+### Option: `streamer_mode`
+
+If set to `true`, this will enable streamer mode, which makes ESPHome hide all
+potentially private information. So for example WiFi (B)SSIDs (which could be
+used to find your location), usernames, etc. Please note that you need to use
+the `!secret` tag in your YAML file to also prevent these from showing up
+while editing and validating.

esphome-beta/README.md

@@ -32,92 +32,6 @@ Then just click UPLOAD and the sensor will magically appear in Home Assistant:
 
 <img title="ESPHome Home Assistant MQTT discovery" src="https://raw.githubusercontent.com/esphome/hassio/master/esphome-dev/images/temperature-humidity.png" width="600px"></img>
 
-## Installation
-
-To install this Home Assistant add-on you need to add the ESPHome add-on repository
-first:
-
-1. Add the ESPHome add-ons repository to your Home Assistant instance. You can do this by navigating to the "Add-on store" tab in the Supervisor panel and then entering https://github.com/esphome/hassio in the "Add repository" field after selecting "Repositories" from the top-right menu.
-2. Now scroll down and select the "ESPHome" add-on.
-3. Press install to download the add-on and unpack it on your machine. This can take some time.
-4. Optional: If you're using SSL/TLS certificates and want to encrypt your communication to this add-on, please enter `true` into the `ssl` field and set the `fullchain` and `certfile` options accordingly.
-5. Start the add-on, check the logs of the add-on to see if everything went well.
-6. Click "OPEN WEB UI" to open the ESPHome dashboard. You will be asked for your Home Assistant credentials - ESPHome uses Home Assistant's authentication system to log you in.
-
-You can view the ESPHome documentation at https://esphome.io/
-
-## Configuration
-
-**Note**: _Remember to restart the add-on when the configuration is changed._
-
-Example add-on configuration:
-
-```json
-{
-  "ssl": false,
-  "certfile": "fullchain.pem",
-  "keyfile": "privkey.pem"
-}
-```
-
-### Option: `ssl`
-
-Enables or disables encrypted SSL/TLS (HTTPS) connections to the web server of this add-on.
-Set it to `true` to encrypt communications, `false` otherwise.
-Please note that if you set this to `true` you must also generate the key and certificate
-files for encryption. For example using [Let's Encrypt](https://www.home-assistant.io/addons/lets_encrypt/)
-or [Self-signed certificates](https://www.home-assistant.io/docs/ecosystem/certificates/tls_self_signed_certificate/).
-
-### Option: `certfile`
-
-The certificate file to use for SSL. If this file doesn't exist, the add-on start will fail.
-
-**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
-
-### Option: `keyfile`
-
-The private key file to use for SSL. If this file doesn't exist, the add-on start will fail.
-
-**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
-
-### Option: `leave_front_door_open`
-
-Adding this option to the add-on configuration allows you to disable
-authentication by setting it to `true`.
-
-### Option: `esphome_version`
-
-Manually override which ESPHome version to use in the add-on.
-For example to install the latest development version, use `"esphome_version": "dev"`,
-or for version 1.14.0: `"esphome_version": "v1.14.0"`.
-
-This can also be used to specify a branch of a fork of the esphome repository.
-For example to install the test_new_component branch of a fork made by user123, use `"user123:test_new_component"`.
-This usage assumes the forked repository is named `esphome`.
-
-Please note that this does not always work and is only meant for testing, usually the
-ESPHome add-on and dashboard version must match to guarantee a working system.
-
-### Option: `relative_url`
-
-Host the ESPHome dashboard under a relative URL, so that it can be integrated
-into existing web proxies like NGINX under a relative URL. Defaults to `/`.
-
-### Option: `status_use_ping`
-
-By default the dashboard uses mDNS to check if nodes are online. This does
-not work across subnets unless your router supports mDNS forwarding or avahi.
-
-Setting this to `true` will make ESPHome use ICMP ping requests to get the node status. Use this if all nodes always have offline status even when they're connected.
-
-### Option: `streamer_mode`
-
-If set to `true`, this will enable streamer mode, which makes ESPHome hide all
-potentially private information. So for example WiFi (B)SSIDs (which could be
-used to find your location), usernames, etc. Please note that you need to use
-the `!secret` tag in your YAML file to also prevent these from showing up
-while editing and validating.
-
 [discord-shield]: https://img.shields.io/discord/429907082951524364.svg
 [dht22]: https://esphome.io/components/sensor/dht.html
 [discord]: https://discord.gg/KhAMKrd

esphome-beta/config.json

@@ -37,5 +37,5 @@
   "stage": "experimental",
   "uart": true,
   "url": "https://beta.esphome.io/",
-  "version": "1.16.2"
+  "version": "1.17.1"
 }

esphome-dev/DOCS.md

@@ -0,0 +1,81 @@
+# Home Assistant Community Add-on: ESPHome
+
+## Installation
+
+The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on.
+
+1. Search for the “ESPHome” add-on in the Supervisor add-on store.
+2. Press install to download the add-on and unpack it on your machine. This can take some time.
+3. Optional: If you're using SSL/TLS certificates and want to encrypt your communication to this add-on, please enter `true` into the `ssl` field and set the `fullchain` and `certfile` options accordingly.
+4. Start the add-on, check the logs of the add-on to see if everything went well.
+5. Click "OPEN WEB UI" to open the ESPHome dashboard. You will be asked for your Home Assistant credentials - ESPHome uses Home Assistant's authentication system to log you in.
+
+You can view the ESPHome documentation at https://esphome.io/
+
+## Configuration
+
+**Note**: _Remember to restart the add-on when the configuration is changed._
+
+Example add-on configuration:
+
+```json
+{
+  "ssl": false,
+  "certfile": "fullchain.pem",
+  "keyfile": "privkey.pem"
+}
+```
+
+### Option: `ssl`
+
+Enables or disables encrypted SSL/TLS (HTTPS) connections to the web server of this add-on.
+Set it to `true` to encrypt communications, `false` otherwise.
+Please note that if you set this to `true` you must also generate the key and certificate
+files for encryption. For example using [Let's Encrypt](https://www.home-assistant.io/addons/lets_encrypt/)
+or [Self-signed certificates](https://www.home-assistant.io/docs/ecosystem/certificates/tls_self_signed_certificate/).
+
+### Option: `certfile`
+
+The certificate file to use for SSL. If this file doesn't exist, the add-on start will fail.
+
+**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
+
+### Option: `keyfile`
+
+The private key file to use for SSL. If this file doesn't exist, the add-on start will fail.
+
+**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
+
+### Option: `leave_front_door_open`
+
+Adding this option to the add-on configuration allows you to disable
+authentication by setting it to `true`.
+
+### Option: `esphome_version`
+
+Manually override which ESPHome version to use in the add-on.
+For example to install the latest development version, use `"esphome_version": "dev"`,
+or for version 1.14.0: `"esphome_version": "v1.14.0""`.
+
+Please note that this does not always work and is only meant for testing, usually the
+ESPHome add-on and dashboard version must match to guarantee a working system.
+
+### Option: `relative_url`
+
+Host the ESPHome dashboard under a relative URL, so that it can be integrated
+into existing web proxies like NGINX under a relative URL. Defaults to `/`.
+
+### Option: `status_use_ping`
+
+By default the dashboard uses mDNS to check if nodes are online. This does
+not work across subnets unless your router supports mDNS forwarding or avahi.
+
+Setting this to `true` will make ESPHome use ICMP ping requests to get the node status. Use this if all nodes always have offline status even when they're connected.
+
+### Option: `streamer_mode`
+
+If set to `true`, this will enable streamer mode, which makes ESPHome hide all
+potentially private information. So for example WiFi (B)SSIDs (which could be
+used to find your location), usernames, etc. Please note that you need to use
+the `!secret` tag in your YAML file to also prevent these from showing up
+while editing and validating.

esphome-dev/FILES ARE GENERATED DO NOT EDIT

@@ -0,0 +1 @@
+Any edits should be made to the files in the 'template' directory

esphome-dev/README.md

@@ -32,92 +32,6 @@ Then just click UPLOAD and the sensor will magically appear in Home Assistant:
 
 <img title="ESPHome Home Assistant MQTT discovery" src="https://raw.githubusercontent.com/esphome/hassio/master/esphome-dev/images/temperature-humidity.png" width="600px"></img>
 
-## Installation
-
-To install this Home Assistant add-on you need to add the ESPHome add-on repository
-first:
-
-1. Add the ESPHome add-ons repository to your Home Assistant instance. You can do this by navigating to the "Add-on store" tab in the Supervisor panel and then entering https://github.com/esphome/hassio in the "Add repository" field after selecting "Repositories" from the top-right menu.
-2. Now scroll down and select the "ESPHome" add-on.
-3. Press install to download the add-on and unpack it on your machine. This can take some time.
-4. Optional: If you're using SSL/TLS certificates and want to encrypt your communication to this add-on, please enter `true` into the `ssl` field and set the `fullchain` and `certfile` options accordingly.
-5. Start the add-on, check the logs of the add-on to see if everything went well.
-6. Click "OPEN WEB UI" to open the ESPHome dashboard. You will be asked for your Home Assistant credentials - ESPHome uses Home Assistant's authentication system to log you in.
-
-You can view the ESPHome documentation at https://esphome.io/
-
-## Configuration
-
-**Note**: _Remember to restart the add-on when the configuration is changed._
-
-Example add-on configuration:
-
-```json
-{
-  "ssl": false,
-  "certfile": "fullchain.pem",
-  "keyfile": "privkey.pem"
-}
-```
-
-### Option: `ssl`
-
-Enables or disables encrypted SSL/TLS (HTTPS) connections to the web server of this add-on.
-Set it to `true` to encrypt communications, `false` otherwise.
-Please note that if you set this to `true` you must also generate the key and certificate
-files for encryption. For example using [Let's Encrypt](https://www.home-assistant.io/addons/lets_encrypt/)
-or [Self-signed certificates](https://www.home-assistant.io/docs/ecosystem/certificates/tls_self_signed_certificate/).
-
-### Option: `certfile`
-
-The certificate file to use for SSL. If this file doesn't exist, the add-on start will fail.
-
-**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
-
-### Option: `keyfile`
-
-The private key file to use for SSL. If this file doesn't exist, the add-on start will fail.
-
-**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
-
-### Option: `leave_front_door_open`
-
-Adding this option to the add-on configuration allows you to disable
-authentication by setting it to `true`.
-
-### Option: `esphome_version`
-
-Manually override which ESPHome version to use in the add-on.
-For example to install the latest development version, use `"esphome_version": "dev"`,
-or for version 1.14.0: `"esphome_version": "v1.14.0"`.
-
-This can also be used to specify a branch of a fork of the esphome repository.
-For example to install the test_new_component branch of a fork made by user123, use `"user123:test_new_component"`.
-This usage assumes the forked repository is named `esphome`.
-
-Please note that this does not always work and is only meant for testing, usually the
-ESPHome add-on and dashboard version must match to guarantee a working system.
-
-### Option: `relative_url`
-
-Host the ESPHome dashboard under a relative URL, so that it can be integrated
-into existing web proxies like NGINX under a relative URL. Defaults to `/`.
-
-### Option: `status_use_ping`
-
-By default the dashboard uses mDNS to check if nodes are online. This does
-not work across subnets unless your router supports mDNS forwarding or avahi.
-
-Setting this to `true` will make ESPHome use ICMP ping requests to get the node status. Use this if all nodes always have offline status even when they're connected.
-
-### Option: `streamer_mode`
-
-If set to `true`, this will enable streamer mode, which makes ESPHome hide all
-potentially private information. So for example WiFi (B)SSIDs (which could be
-used to find your location), usernames, etc. Please note that you need to use
-the `!secret` tag in your YAML file to also prevent these from showing up
-while editing and validating.
-
 [discord-shield]: https://img.shields.io/discord/429907082951524364.svg
 [dht22]: https://esphome.io/components/sensor/dht.html
 [discord]: https://discord.gg/KhAMKrd

esphome-dev/build.json

@@ -1,7 +1,7 @@
 {
   "build_from": {
-    "aarch64": "esphome/esphome-hassio-base-aarch64:2.5.0",
-    "amd64": "esphome/esphome-hassio-base-amd64:2.5.0",
-    "armv7": "esphome/esphome-hassio-base-armv7:2.5.0"
+    "aarch64": "esphome/esphome-hassio-base-aarch64:3.0.0",
+    "amd64": "esphome/esphome-hassio-base-amd64:3.0.0",
+    "armv7": "esphome/esphome-hassio-base-armv7:3.0.0"
   }
 }

esphome-dev/config.json

@@ -5,7 +5,6 @@
     "aarch64"
   ],
   "auth_api": true,
-  "uart": true,
   "description": "Development Version! Manage and program ESP8266/ESP32 microcontrollers through YAML configuration files",
   "hassio_api": true,
   "host_network": true,
@@ -38,6 +37,7 @@
   },
   "slug": "esphome-dev",
   "stage": "experimental",
+  "uart": true,
   "url": "https://next.esphome.io/",
   "version": "dev"
 }

esphome/DOCS.md

@@ -0,0 +1,81 @@
+# Home Assistant Community Add-on: ESPHome
+
+## Installation
+
+The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on.
+
+1. Search for the “ESPHome” add-on in the Supervisor add-on store.
+2. Press install to download the add-on and unpack it on your machine. This can take some time.
+3. Optional: If you're using SSL/TLS certificates and want to encrypt your communication to this add-on, please enter `true` into the `ssl` field and set the `fullchain` and `certfile` options accordingly.
+4. Start the add-on, check the logs of the add-on to see if everything went well.
+5. Click "OPEN WEB UI" to open the ESPHome dashboard. You will be asked for your Home Assistant credentials - ESPHome uses Home Assistant's authentication system to log you in.
+
+You can view the ESPHome documentation at https://esphome.io/
+
+## Configuration
+
+**Note**: _Remember to restart the add-on when the configuration is changed._
+
+Example add-on configuration:
+
+```json
+{
+  "ssl": false,
+  "certfile": "fullchain.pem",
+  "keyfile": "privkey.pem"
+}
+```
+
+### Option: `ssl`
+
+Enables or disables encrypted SSL/TLS (HTTPS) connections to the web server of this add-on.
+Set it to `true` to encrypt communications, `false` otherwise.
+Please note that if you set this to `true` you must also generate the key and certificate
+files for encryption. For example using [Let's Encrypt](https://www.home-assistant.io/addons/lets_encrypt/)
+or [Self-signed certificates](https://www.home-assistant.io/docs/ecosystem/certificates/tls_self_signed_certificate/).
+
+### Option: `certfile`
+
+The certificate file to use for SSL. If this file doesn't exist, the add-on start will fail.
+
+**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
+
+### Option: `keyfile`
+
+The private key file to use for SSL. If this file doesn't exist, the add-on start will fail.
+
+**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
+
+### Option: `leave_front_door_open`
+
+Adding this option to the add-on configuration allows you to disable
+authentication by setting it to `true`.
+
+### Option: `esphome_version`
+
+Manually override which ESPHome version to use in the add-on.
+For example to install the latest development version, use `"esphome_version": "dev"`,
+or for version 1.14.0: `"esphome_version": "v1.14.0""`.
+
+Please note that this does not always work and is only meant for testing, usually the
+ESPHome add-on and dashboard version must match to guarantee a working system.
+
+### Option: `relative_url`
+
+Host the ESPHome dashboard under a relative URL, so that it can be integrated
+into existing web proxies like NGINX under a relative URL. Defaults to `/`.
+
+### Option: `status_use_ping`
+
+By default the dashboard uses mDNS to check if nodes are online. This does
+not work across subnets unless your router supports mDNS forwarding or avahi.
+
+Setting this to `true` will make ESPHome use ICMP ping requests to get the node status. Use this if all nodes always have offline status even when they're connected.
+
+### Option: `streamer_mode`
+
+If set to `true`, this will enable streamer mode, which makes ESPHome hide all
+potentially private information. So for example WiFi (B)SSIDs (which could be
+used to find your location), usernames, etc. Please note that you need to use
+the `!secret` tag in your YAML file to also prevent these from showing up
+while editing and validating.

esphome/README.md

@@ -32,92 +32,6 @@ Then just click UPLOAD and the sensor will magically appear in Home Assistant:
 
 <img title="ESPHome Home Assistant MQTT discovery" src="https://raw.githubusercontent.com/esphome/hassio/master/esphome-dev/images/temperature-humidity.png" width="600px"></img>
 
-## Installation
-
-To install this Home Assistant add-on you need to add the ESPHome add-on repository
-first:
-
-1. Add the ESPHome add-ons repository to your Home Assistant instance. You can do this by navigating to the "Add-on store" tab in the Supervisor panel and then entering https://github.com/esphome/hassio in the "Add repository" field after selecting "Repositories" from the top-right menu.
-2. Now scroll down and select the "ESPHome" add-on.
-3. Press install to download the add-on and unpack it on your machine. This can take some time.
-4. Optional: If you're using SSL/TLS certificates and want to encrypt your communication to this add-on, please enter `true` into the `ssl` field and set the `fullchain` and `certfile` options accordingly.
-5. Start the add-on, check the logs of the add-on to see if everything went well.
-6. Click "OPEN WEB UI" to open the ESPHome dashboard. You will be asked for your Home Assistant credentials - ESPHome uses Home Assistant's authentication system to log you in.
-
-You can view the ESPHome documentation at https://esphome.io/
-
-## Configuration
-
-**Note**: _Remember to restart the add-on when the configuration is changed._
-
-Example add-on configuration:
-
-```json
-{
-  "ssl": false,
-  "certfile": "fullchain.pem",
-  "keyfile": "privkey.pem"
-}
-```
-
-### Option: `ssl`
-
-Enables or disables encrypted SSL/TLS (HTTPS) connections to the web server of this add-on.
-Set it to `true` to encrypt communications, `false` otherwise.
-Please note that if you set this to `true` you must also generate the key and certificate
-files for encryption. For example using [Let's Encrypt](https://www.home-assistant.io/addons/lets_encrypt/)
-or [Self-signed certificates](https://www.home-assistant.io/docs/ecosystem/certificates/tls_self_signed_certificate/).
-
-### Option: `certfile`
-
-The certificate file to use for SSL. If this file doesn't exist, the add-on start will fail.
-
-**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
-
-### Option: `keyfile`
-
-The private key file to use for SSL. If this file doesn't exist, the add-on start will fail.
-
-**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
-
-### Option: `leave_front_door_open`
-
-Adding this option to the add-on configuration allows you to disable
-authentication by setting it to `true`.
-
-### Option: `esphome_version`
-
-Manually override which ESPHome version to use in the add-on.
-For example to install the latest development version, use `"esphome_version": "dev"`,
-or for version 1.14.0: `"esphome_version": "v1.14.0"`.
-
-This can also be used to specify a branch of a fork of the esphome repository.
-For example to install the test_new_component branch of a fork made by user123, use `"user123:test_new_component"`.
-This usage assumes the forked repository is named `esphome`.
-
-Please note that this does not always work and is only meant for testing, usually the
-ESPHome add-on and dashboard version must match to guarantee a working system.
-
-### Option: `relative_url`
-
-Host the ESPHome dashboard under a relative URL, so that it can be integrated
-into existing web proxies like NGINX under a relative URL. Defaults to `/`.
-
-### Option: `status_use_ping`
-
-By default the dashboard uses mDNS to check if nodes are online. This does
-not work across subnets unless your router supports mDNS forwarding or avahi.
-
-Setting this to `true` will make ESPHome use ICMP ping requests to get the node status. Use this if all nodes always have offline status even when they're connected.
-
-### Option: `streamer_mode`
-
-If set to `true`, this will enable streamer mode, which makes ESPHome hide all
-potentially private information. So for example WiFi (B)SSIDs (which could be
-used to find your location), usernames, etc. Please note that you need to use
-the `!secret` tag in your YAML file to also prevent these from showing up
-while editing and validating.
-
 [discord-shield]: https://img.shields.io/discord/429907082951524364.svg
 [dht22]: https://esphome.io/components/sensor/dht.html
 [discord]: https://discord.gg/KhAMKrd

esphome/config.json

@@ -36,5 +36,5 @@
   "slug": "esphome",
   "uart": true,
   "url": "https://esphome.io/",
-  "version": "1.16.2"
+  "version": "1.17.1"
 }

repository.json

@@ -1,5 +1,5 @@
 {
   "name": "ESPHome Home Assistant Add-Ons",
   "url": "https://github.com/esphome/hassio",
-  "maintainer": "ESPHome <contact@esphome.io>"
+  "maintainer": "ESPHome <esphome@nabucasa.com>"
 }

script/NOTES.md

@@ -7,7 +7,7 @@ the Hassio config for each type of install: latest, beta and dev.
 - `beta` points to the most recent full release or beta release (whichever is newer). This is so that beta image users automatically get upgraded to the stable install once it gets released.
 - `dev` is an image that Hassio builds itself and contains the latest ESPHome version straigt from dev branch.
 
-The config.json files are all automatically written with the script in this directory and the `template/config.yaml` file.
+The config.json files are all automatically written with the script in this directory and the `template/addon_config.yaml` file.
 
 To update one of the images: use
 

script/bump-version.py

@@ -60,7 +60,7 @@ def write_version(target: str, version: Version):
     #  version: '1.14.5'  # BETA
     #  version: '1.14.5'  # STABLE
     sub(
-        'template/config.yaml',
+        'template/addon_config.yaml',
         r"  version: '[^']+'  # {}".format(target.upper()),
         f"  version: '{version}'  # {target.upper()}"
     )

script/generate.py

@@ -22,7 +22,7 @@ def main(args):
     root = Path(__file__).parent.parent
     templ = root / 'template'
 
-    with open(templ / "config.yaml", 'r') as f:
+    with open(templ / "addon_config.yaml", 'r') as f:
         config = yaml.safe_load(f)
 
     copyf = config['copy_files']

script/requirements.txt

@@ -1 +1 @@
-PyYAML==5.3.1
+PyYAML==5.4

template/DOCS.md

@@ -0,0 +1,81 @@
+# Home Assistant Community Add-on: ESPHome
+
+## Installation
+
+The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on.
+
+1. Search for the “ESPHome” add-on in the Supervisor add-on store.
+2. Press install to download the add-on and unpack it on your machine. This can take some time.
+3. Optional: If you're using SSL/TLS certificates and want to encrypt your communication to this add-on, please enter `true` into the `ssl` field and set the `fullchain` and `certfile` options accordingly.
+4. Start the add-on, check the logs of the add-on to see if everything went well.
+5. Click "OPEN WEB UI" to open the ESPHome dashboard. You will be asked for your Home Assistant credentials - ESPHome uses Home Assistant's authentication system to log you in.
+
+You can view the ESPHome documentation at https://esphome.io/
+
+## Configuration
+
+**Note**: _Remember to restart the add-on when the configuration is changed._
+
+Example add-on configuration:
+
+```json
+{
+  "ssl": false,
+  "certfile": "fullchain.pem",
+  "keyfile": "privkey.pem"
+}
+```
+
+### Option: `ssl`
+
+Enables or disables encrypted SSL/TLS (HTTPS) connections to the web server of this add-on.
+Set it to `true` to encrypt communications, `false` otherwise.
+Please note that if you set this to `true` you must also generate the key and certificate
+files for encryption. For example using [Let's Encrypt](https://www.home-assistant.io/addons/lets_encrypt/)
+or [Self-signed certificates](https://www.home-assistant.io/docs/ecosystem/certificates/tls_self_signed_certificate/).
+
+### Option: `certfile`
+
+The certificate file to use for SSL. If this file doesn't exist, the add-on start will fail.
+
+**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
+
+### Option: `keyfile`
+
+The private key file to use for SSL. If this file doesn't exist, the add-on start will fail.
+
+**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
+
+### Option: `leave_front_door_open`
+
+Adding this option to the add-on configuration allows you to disable
+authentication by setting it to `true`.
+
+### Option: `esphome_version`
+
+Manually override which ESPHome version to use in the add-on.
+For example to install the latest development version, use `"esphome_version": "dev"`,
+or for version 1.14.0: `"esphome_version": "v1.14.0""`.
+
+Please note that this does not always work and is only meant for testing, usually the
+ESPHome add-on and dashboard version must match to guarantee a working system.
+
+### Option: `relative_url`
+
+Host the ESPHome dashboard under a relative URL, so that it can be integrated
+into existing web proxies like NGINX under a relative URL. Defaults to `/`.
+
+### Option: `status_use_ping`
+
+By default the dashboard uses mDNS to check if nodes are online. This does
+not work across subnets unless your router supports mDNS forwarding or avahi.
+
+Setting this to `true` will make ESPHome use ICMP ping requests to get the node status. Use this if all nodes always have offline status even when they're connected.
+
+### Option: `streamer_mode`
+
+If set to `true`, this will enable streamer mode, which makes ESPHome hide all
+potentially private information. So for example WiFi (B)SSIDs (which could be
+used to find your location), usernames, etc. Please note that you need to use
+the `!secret` tag in your YAML file to also prevent these from showing up
+while editing and validating.

template/README.md

@@ -32,92 +32,6 @@ Then just click UPLOAD and the sensor will magically appear in Home Assistant:
 
 <img title="ESPHome Home Assistant MQTT discovery" src="https://raw.githubusercontent.com/esphome/hassio/master/esphome-dev/images/temperature-humidity.png" width="600px"></img>
 
-## Installation
-
-To install this Home Assistant add-on you need to add the ESPHome add-on repository
-first:
-
-1. Add the ESPHome add-ons repository to your Home Assistant instance. You can do this by navigating to the "Add-on store" tab in the Supervisor panel and then entering https://github.com/esphome/hassio in the "Add repository" field after selecting "Repositories" from the top-right menu.
-2. Now scroll down and select the "ESPHome" add-on.
-3. Press install to download the add-on and unpack it on your machine. This can take some time.
-4. Optional: If you're using SSL/TLS certificates and want to encrypt your communication to this add-on, please enter `true` into the `ssl` field and set the `fullchain` and `certfile` options accordingly.
-5. Start the add-on, check the logs of the add-on to see if everything went well.
-6. Click "OPEN WEB UI" to open the ESPHome dashboard. You will be asked for your Home Assistant credentials - ESPHome uses Home Assistant's authentication system to log you in.
-
-You can view the ESPHome documentation at https://esphome.io/
-
-## Configuration
-
-**Note**: _Remember to restart the add-on when the configuration is changed._
-
-Example add-on configuration:
-
-```json
-{
-  "ssl": false,
-  "certfile": "fullchain.pem",
-  "keyfile": "privkey.pem"
-}
-```
-
-### Option: `ssl`
-
-Enables or disables encrypted SSL/TLS (HTTPS) connections to the web server of this add-on.
-Set it to `true` to encrypt communications, `false` otherwise.
-Please note that if you set this to `true` you must also generate the key and certificate
-files for encryption. For example using [Let's Encrypt](https://www.home-assistant.io/addons/lets_encrypt/)
-or [Self-signed certificates](https://www.home-assistant.io/docs/ecosystem/certificates/tls_self_signed_certificate/).
-
-### Option: `certfile`
-
-The certificate file to use for SSL. If this file doesn't exist, the add-on start will fail.
-
-**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
-
-### Option: `keyfile`
-
-The private key file to use for SSL. If this file doesn't exist, the add-on start will fail.
-
-**Note**: The file MUST be stored in `/ssl/`, which is the default for Home Assistant
-
-### Option: `leave_front_door_open`
-
-Adding this option to the add-on configuration allows you to disable
-authentication by setting it to `true`.
-
-### Option: `esphome_version`
-
-Manually override which ESPHome version to use in the add-on.
-For example to install the latest development version, use `"esphome_version": "dev"`,
-or for version 1.14.0: `"esphome_version": "v1.14.0"`.
-
-This can also be used to specify a branch of a fork of the esphome repository.
-For example to install the test_new_component branch of a fork made by user123, use `"user123:test_new_component"`.
-This usage assumes the forked repository is named `esphome`.
-
-Please note that this does not always work and is only meant for testing, usually the
-ESPHome add-on and dashboard version must match to guarantee a working system.
-
-### Option: `relative_url`
-
-Host the ESPHome dashboard under a relative URL, so that it can be integrated
-into existing web proxies like NGINX under a relative URL. Defaults to `/`.
-
-### Option: `status_use_ping`
-
-By default the dashboard uses mDNS to check if nodes are online. This does
-not work across subnets unless your router supports mDNS forwarding or avahi.
-
-Setting this to `true` will make ESPHome use ICMP ping requests to get the node status. Use this if all nodes always have offline status even when they're connected.
-
-### Option: `streamer_mode`
-
-If set to `true`, this will enable streamer mode, which makes ESPHome hide all
-potentially private information. So for example WiFi (B)SSIDs (which could be
-used to find your location), usernames, etc. Please note that you need to use
-the `!secret` tag in your YAML file to also prevent these from showing up
-while editing and validating.
-
 [discord-shield]: https://img.shields.io/discord/429907082951524364.svg
 [dht22]: https://esphome.io/components/sensor/dht.html
 [discord]: https://discord.gg/KhAMKrd

template/addon_config.yaml

@@ -32,7 +32,7 @@ base: &base
     streamer_mode: bool?
     relative_url: str?
     status_use_ping: bool?
-  base_image: esphome/esphome-hassio-base-{arch}:2.5.0
+  base_image: esphome/esphome-hassio-base-{arch}:3.0.0
 
 esphome-dev:
   <<: *base
@@ -50,7 +50,7 @@ esphome-beta:
   <<: *base
   directory: esphome-beta
   name: ESPHome (beta)
-  version: '1.16.2'  # BETA
+  version: '1.17.1'  # BETA
   slug: esphome-beta
   description: "Beta version of ESPHome Hass.io add-on."
   url: https://beta.esphome.io/
@@ -61,7 +61,7 @@ esphome-stable:
   <<: *base
   directory: esphome
   name: ESPHome
-  version: '1.16.2'  # STABLE
+  version: '1.17.1'  # STABLE
   slug: esphome
   description: "ESPHome Hass.io add-on for intelligently managing all your ESP8266/ESP32 devices."
   image: esphome/esphome-hassio-{arch}
@@ -70,3 +70,4 @@ copy_files:
   icon.png:
   logo.png:
   README.md:
+  DOCS.md: