Bump version to v1.17.0
@ -37,5 +37,5 @@
|
|||||||
"stage": "experimental",
|
"stage": "experimental",
|
||||||
"uart": true,
|
"uart": true,
|
||||||
"url": "https://beta.esphome.io/",
|
"url": "https://beta.esphome.io/",
|
||||||
"version": "1.17.0b1"
|
"version": "1.17.0"
|
||||||
}
|
}
|
Before Width: | Height: | Size: 2.4 KiB After Width: | Height: | Size: 2.9 KiB |
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 11 KiB |
81
esphome/DOCS.md
Normal file
@ -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.
|
@ -32,91 +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>
|
<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 follow those steps:
|
|
||||||
|
|
||||||
1. Go to the "Add-on store" tab in the "Supervisor" panel.
|
|
||||||
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
|
[discord-shield]: https://img.shields.io/discord/429907082951524364.svg
|
||||||
[dht22]: https://esphome.io/components/sensor/dht.html
|
[dht22]: https://esphome.io/components/sensor/dht.html
|
||||||
[discord]: https://discord.gg/KhAMKrd
|
[discord]: https://discord.gg/KhAMKrd
|
||||||
|
@ -36,5 +36,5 @@
|
|||||||
"slug": "esphome",
|
"slug": "esphome",
|
||||||
"uart": true,
|
"uart": true,
|
||||||
"url": "https://esphome.io/",
|
"url": "https://esphome.io/",
|
||||||
"version": "1.16.2"
|
"version": "1.17.0"
|
||||||
}
|
}
|
BIN
esphome/icon.png
Before Width: | Height: | Size: 2.4 KiB After Width: | Height: | Size: 2.9 KiB |
BIN
esphome/logo.png
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 11 KiB |
@ -50,7 +50,7 @@ esphome-beta:
|
|||||||
<<: *base
|
<<: *base
|
||||||
directory: esphome-beta
|
directory: esphome-beta
|
||||||
name: ESPHome (beta)
|
name: ESPHome (beta)
|
||||||
version: '1.17.0b1' # BETA
|
version: '1.17.0' # BETA
|
||||||
slug: esphome-beta
|
slug: esphome-beta
|
||||||
description: "Beta version of ESPHome Hass.io add-on."
|
description: "Beta version of ESPHome Hass.io add-on."
|
||||||
url: https://beta.esphome.io/
|
url: https://beta.esphome.io/
|
||||||
@ -61,7 +61,7 @@ esphome-stable:
|
|||||||
<<: *base
|
<<: *base
|
||||||
directory: esphome
|
directory: esphome
|
||||||
name: ESPHome
|
name: ESPHome
|
||||||
version: '1.16.2' # STABLE
|
version: '1.17.0' # STABLE
|
||||||
slug: esphome
|
slug: esphome
|
||||||
description: "ESPHome Hass.io add-on for intelligently managing all your ESP8266/ESP32 devices."
|
description: "ESPHome Hass.io add-on for intelligently managing all your ESP8266/ESP32 devices."
|
||||||
image: esphome/esphome-hassio-{arch}
|
image: esphome/esphome-hassio-{arch}
|
||||||
|