From 2e6c65083eaecdc7b943bd4f3e3472b538513de0 Mon Sep 17 00:00:00 2001 From: Spiffo Date: Mon, 19 Jul 2021 10:47:56 +0200 Subject: [PATCH 01/38] Update media_player.markdown (#18549) --- source/_integrations/media_player.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_integrations/media_player.markdown b/source/_integrations/media_player.markdown index 6b1146076f1..bf468537416 100644 --- a/source/_integrations/media_player.markdown +++ b/source/_integrations/media_player.markdown @@ -106,8 +106,8 @@ metadata: Documentation: -- [Google Dev Documentaion MediaData](https://developers.google.com/cast/docs/reference/messages#MediaData) -- [Google Dev Documentaion MediaInformation](https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.messages.MediaInformation) +- [Google Dev Documentation MediaData](https://developers.google.com/cast/docs/reference/messages#MediaData) +- [Google Dev Documentation MediaInformation](https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.messages.MediaInformation) Example of calling media_player service with title and image set: From 0cf55bd88319ac1bbb52040c1fd7aeb42adc9ecd Mon Sep 17 00:00:00 2001 From: Charles Garwood Date: Mon, 19 Jul 2021 05:40:16 -0400 Subject: [PATCH 02/38] Add unmaintained warning to ozw integration (#18546) --- source/_integrations/ozw.markdown | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/source/_integrations/ozw.markdown b/source/_integrations/ozw.markdown index 14506ebf05c..d2b4bbdf816 100644 --- a/source/_integrations/ozw.markdown +++ b/source/_integrations/ozw.markdown @@ -22,7 +22,14 @@ ha_platforms: - switch --- -This integration allows you to utilize OpenZWave's ozwdaemon to control a Z-Wave network over MQTT. If you're starting out with Z-Wave in Home Assistant, we recommend that you use [the Z-Wave JS integration](/integrations/zwave_js). +This integration allows you to utilize OpenZWave's ozwdaemon to control a Z-Wave network over MQTT. + +
+ + As of mid-2021 this integration, as well as the upstream ozwdaemon project, are not currently maintained. If you're starting out with Z-Wave in Home Assistant, we recommend that you use [the Z-Wave JS integration](/integrations/zwave_js). + +
+ ## Requirements From 79d534593ca95414ca5b8808350d5a359efa6be6 Mon Sep 17 00:00:00 2001 From: Roland Beck <7224371+Data-Monkey@users.noreply.github.com> Date: Mon, 19 Jul 2021 22:08:53 +1000 Subject: [PATCH 03/38] updated external broken links (#18551) --- source/_integrations/magicseaweed.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_integrations/magicseaweed.markdown b/source/_integrations/magicseaweed.markdown index 5d2905b08bd..e0d8bcf55b5 100644 --- a/source/_integrations/magicseaweed.markdown +++ b/source/_integrations/magicseaweed.markdown @@ -10,11 +10,11 @@ ha_platforms: - sensor --- -The `magicseaweed` platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/developer/forecast-api) as a source for surf forecasting data for the surf spots of your choice. +The `magicseaweed` platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/docs/developers/59/) as a source for surf forecasting data for the surf spots of your choice. ## Setup -You need an API key which is free but requires [registration](https://magicseaweed.com/developer/sign-up). Magicseaweed is limiting users of the API to 1 spot for the free plan. +You need an API key which is free but requires [registration](https://magicseaweed.com/docs/developers/59/sign-up/9908/). Magicseaweed is limiting users of the API to 1 spot for the free plan. ## Configuration @@ -63,7 +63,7 @@ hours: 12AM: description: Display forecast for 12AM. spot_id: - description: ID of the surf spot. Details for getting spot id available at [Magicseaweed](https://magicseaweed.com/developer/forecast-api) + description: ID of the surf spot. Details for getting spot id available at [Magicseaweed](https://magicseaweed.com/docs/developers/59/) required: true type: string monitored_conditions: @@ -84,4 +84,4 @@ units: type: string {% endconfiguration %} -Details about the API are available in the [Magicseaweed documentation](https://magicseaweed.com/developer/forecast-api). +Details about the API are available in the [Magicseaweed documentation](https://magicseaweed.com/docs/developers/59/). From 7e61bf8222ddf080a4308e4831cdac959ab0fec4 Mon Sep 17 00:00:00 2001 From: jjlawren Date: Mon, 19 Jul 2021 08:26:15 -0500 Subject: [PATCH 04/38] Update to reflect use of Network integration (#18420) --- source/_integrations/sonos.markdown | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/source/_integrations/sonos.markdown b/source/_integrations/sonos.markdown index fc4e5b3135a..e1a5b8485cc 100644 --- a/source/_integrations/sonos.markdown +++ b/source/_integrations/sonos.markdown @@ -269,14 +269,7 @@ sonos: - 192.0.2.27 ``` -If your Home Assistant instance has multiple IP addresses, you can provide the IP address that should be used for Sonos auto-discovery. This is rarely needed since all addresses should be tried by default. - -```yaml -# Example configuration.yaml entry using Sonos discovery on a specific interface -sonos: - media_player: - interface_addr: 192.0.2.1 -``` +If your Home Assistant instance has multiple IP addresses, you can enable the IP address that should be used for Sonos auto-discovery with the [Network](/integrations/network/) integration. This should only be necessary if the Sonos speakers are on a network segment not reachable from the default interface. The Sonos speakers will attempt to connect back to Home Assistant to deliver change events. By default, Home Assistant will listen on port 1400 but will try the next 100 ports above 1400 if it is in use. You can change the IP address that Home Assistant advertises to Sonos speakers. This can help in NAT scenarios such as when _not_ using the Docker option `--net=host`: From 8c39fc4602ec1e51385e904074f743c826acb564 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Hjelseth=20H=C3=B8yer?= Date: Mon, 19 Jul 2021 16:53:53 +0200 Subject: [PATCH 05/38] Update tibber.markdown (#18553) --- source/_integrations/tibber.markdown | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/_integrations/tibber.markdown b/source/_integrations/tibber.markdown index abe099c063e..a248c77d7ee 100644 --- a/source/_integrations/tibber.markdown +++ b/source/_integrations/tibber.markdown @@ -35,7 +35,6 @@ Go to [developer.tibber.com/settings/accesstoken](https://developer.tibber.com/s Tibber can send a notification by calling the [`notify` service](/integrations/notify/). It will send a notification to all devices registered in the Tibber account. -The requirement is that you have setup the [`tibber` component](#setup). To use notifications, please see the [getting started with automation page](/getting-started/automation/). ### Send message @@ -53,7 +52,6 @@ action: The `tibber` sensor provides the current electricity price if you are a [Tibber](https://tibber.com/) customer. If you have a Tibber Pulse it will also show the electricity consumption in real time. -The requirement is that you have setup the [`tibber` component](#setup). The sensor will show once the transfer date to tibber has been confirmed. ## Examples From bc44411ba5e04030e7c65305f756804783b7e3d9 Mon Sep 17 00:00:00 2001 From: Christopher Nethercott Date: Mon, 19 Jul 2021 16:59:20 +0100 Subject: [PATCH 06/38] Update icloud.markdown with section on app specific passwords. (#18407) Co-authored-by: Franck Nijhof --- source/_integrations/icloud.markdown | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/source/_integrations/icloud.markdown b/source/_integrations/icloud.markdown index 1d571a5ae67..be5c4cd38f4 100644 --- a/source/_integrations/icloud.markdown +++ b/source/_integrations/icloud.markdown @@ -33,9 +33,23 @@ You may receive an email and a notification from Apple saying that someone has l For the notification, press "Allow", then "OK". +To prevent excessive battery drainage, a dynamic interval is used for each individual device instead of a fixed interval for all devices linked to one account. The dynamic interval is based on the current zone of a device, the distance towards home and the battery level of the device. + +## Two Factor Authentication + If two-step authentication is enabled for your iCloud account, some time after Home Assistant startup the integration will ask to enter the verification code you receive on your device via a notification in the Home Assistant UI. The duration of this authentication is determined by Apple, so you will need to verify your account every now and then. -To prevent excessive battery drainage, a dynamic interval is used for each individual device instead of a fixed interval for all devices linked to one account. The dynamic interval is based on the current zone of a device, the distance towards home and the battery level of the device. +### App Specific Passwords +Apple allows you to provide an [App Specific Password](https://support.apple.com/en-gb/HT204397), which **don't require two factor authentication**, and one could argue more secure than storing your iCloud password within Home Assistant. +#### How to generate an app-specific password + +1. Sign in to your [Apple ID account page](https://appleid.apple.com/account/home). +2. In the Security section, click Generate Password below App-Specific Passwords. +3. Follow the steps on your screen. + +After you generate your app-specific password, enter or paste it into the password field of the integration. + +Any time you change or reset your primary Apple ID password, all your app-specific passwords are revoked automatically to protect the security of your account. You'll need to generate new app-specific passwords for any apps that you want to continue using. ## In case of troubleshooting From 30ce654e6212e3df94c96f25738d7366230be785 Mon Sep 17 00:00:00 2001 From: CurrentThread <62957822+CurrentThread@users.noreply.github.com> Date: Mon, 19 Jul 2021 18:38:54 +0200 Subject: [PATCH 07/38] Clarify country name configuration MeteoAlarm (#18435) The country name instructions are not clear now and on the given page you cannot find the correctly written country name. For example for the United Kingdom, the country name in the configuration must be `united-kingdom`. --- source/_integrations/meteoalarm.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/meteoalarm.markdown b/source/_integrations/meteoalarm.markdown index 7c89906436f..b239430789f 100644 --- a/source/_integrations/meteoalarm.markdown +++ b/source/_integrations/meteoalarm.markdown @@ -12,7 +12,7 @@ ha_platforms: - binary_sensor --- -The `MeteoAlarm` platform allows one to watch for weather alerts in europe from [MeteoAlarm](https://www.meteoalarm.org) (EUMETNET). To use this binary sensor, you need the name of your country and the province name from [MeteoAlarm](https://www.meteoalarm.org). Please note that you need to write the exact details from the website with capitals. +The `MeteoAlarm` platform allows one to watch for weather alerts in europe from [MeteoAlarm](https://www.meteoalarm.org) (EUMETNET). To use this binary sensor, you need the name of your country and the province name from [MeteoAlarm](https://feeds.meteoalarm.org). Please note that you need to write the exact country name (with hyphens) as at the end of the URL starting with: `https://feeds.meteoalarm.org/feeds/meteoalarm-legacy-atom-`. The binary sensor state shows if applicable the warning message. The details are available as attribute. From 88023a0a26f3c62688de0c3098930dc82d68f7c5 Mon Sep 17 00:00:00 2001 From: gmlupatelli <40525606+gmlupatelli@users.noreply.github.com> Date: Mon, 19 Jul 2021 16:16:47 -0400 Subject: [PATCH 08/38] Update smtp.markdown (#18466) * Update smtp.markdown Replaced the generic smtp server in the Google Mail sample configuration for the right one "smtp.gmail.com", and merged the duplicate Google Mail extra steps paragraphs, clarifying an annoying less secure notification behaviour, where Google just turn this access off if it is not used for an undisclosed period of time. * Updated smtp page according to the feedback Updated the generic Example configuration.yaml entry including the SMTP server, user name, and password fields. Separate the configuration segment from the usage segment by including a USAGE chapter (got the inspiration from the Facebook notification). Moved the provider-specific configuration to the bottom of the page in a new chapter called Specific E-Mail Provider Configuration. * Update source/_integrations/smtp.markdown Co-authored-by: Franck Nijhof * Update source/_integrations/smtp.markdown Co-authored-by: Franck Nijhof * Update source/_integrations/smtp.markdown Co-authored-by: Franck Nijhof * Update source/_integrations/smtp.markdown Co-authored-by: Franck Nijhof * Revert the initial yaml example to the original one without any optional variable Revert the initial yaml example to the original one without any optional variable Co-authored-by: Franck Nijhof --- source/_integrations/smtp.markdown | 58 ++++++++++++++++-------------- 1 file changed, 32 insertions(+), 26 deletions(-) diff --git a/source/_integrations/smtp.markdown b/source/_integrations/smtp.markdown index 8ab77f660c7..588e4962827 100644 --- a/source/_integrations/smtp.markdown +++ b/source/_integrations/smtp.markdown @@ -25,6 +25,8 @@ notify: recipient: "YOUR_RECIPIENT" ``` +Check your e-mail provider configuration or help pages to get the correct SMTP settings. + {% configuration %} name: description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. @@ -78,27 +80,7 @@ debug: default: false {% endconfiguration %} -A sample configuration entry for Google Mail. - -```yaml -# Example configuration.yaml entry -notify: - - name: "NOTIFIER_NAME" - platform: smtp - server: "smtp.example.com" - port: 587 - timeout: 15 - sender: "john@example.com" - encryption: starttls - username: "john@example.com" - password: "thePassword" - recipient: - - "james@example.com" - - "bob@example.com" - sender_name: "My Home Assistant" -``` - -Keep in mind that Google has some extra layers of protection which need special attention (Hint: 'Less secure apps'). If you have 2-step verification enabled on your Google account, you'll need to use [an application-specific password](https://support.google.com/mail/answer/185833?hl=en). +### Usage To use the SMTP notification, refer to it in an automation or script like in this example: @@ -190,11 +172,35 @@ burglar: ``` -This platform is fragile and not able to catch all exceptions in a smart way because of the large number of possible configuration combinations. +To learn more about how to use notifications in your automations, please see the [getting started with automation page](/getting-started/automation/). -A combination that will work properly is port 587 and STARTTLS. It's recommended to enable STARTTLS, if possible. +## Specific E-Mail Provider Configuration -For Google Mail (smtp.gmail.com) an additional step in the setup process is needed. Google has some extra layers of protection -which need special attention. By default, the usage by external applications, especially scripts, is limited. Visit the [Less secure apps](https://www.google.com/settings/security/lesssecureapps) page and enable it. +Check below some configurations examples for specific e-mail providers. +If you are in doubt about the SMTP settings required, check your e-mail provider configuration or help pages for more information about its specific SMTP configuration. -To use notifications, please see the [getting started with automation page](/getting-started/automation/). +### Google Mail + +A sample configuration entry for Google Mail. + +```yaml +# Example configuration.yaml entry for Google Mail. +notify: + - name: "NOTIFIER_NAME" + platform: smtp + server: "smtp.gmail.com" + port: 587 + timeout: 15 + sender: "YOUR_USERNAME@gmail.com" + encryption: starttls + username: "YOUR_USERNAME@gmail.com" + password: "YOUR_PASSWORD" + recipient: + - "RECIPIENT_1@example.com" + - "RECIPIENT_N@example.com" + sender_name: "SENDER_NAME" +``` + +Keep in mind that Google has some extra layers of protection that need special attention. By default, the usage by external applications is limited so you will need to visit the [less secure apps](https://www.google.com/settings/security/lesssecureapps) page and enable it to be able to send e-mails. Be aware that Google will periodically turn it off if it is not used (no e-mail is sent). + +To avoid having your e-mail notifications broken due to the less secure app's behavior, it is recommended that you enable 2-step verification on your Google account, and use [an application-specific password](https://support.google.com/mail/answer/185833?hl=en) in your notification configuration. From 424c2b42cccd8a132cdebd3a6f4aa4df0d783107 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 20 Jul 2021 14:01:11 +0200 Subject: [PATCH 09/38] Add IKEA Tradfri shortcut button limitation note (#18554) --- source/_integrations/tradfri.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/_integrations/tradfri.markdown b/source/_integrations/tradfri.markdown index 70784b52a89..bb63e9c7c92 100644 --- a/source/_integrations/tradfri.markdown +++ b/source/_integrations/tradfri.markdown @@ -74,3 +74,7 @@ Please make sure you have `autoconf` installed (`$ sudo apt-get install autoconf ### Setting the `api_key` Do not use the `api_key` variable in `configuration.yaml`. The API key is only needed once at initial setup and will be stored. + +## Known limitations + +- The TRÅDFRI Shortcut button sends no events to Home Assistant so it cannot be used to automate with; it does report battery status. From 3ba917f628936eb64c598a3d0d325bea182ca84a Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 20 Jul 2021 14:01:22 +0200 Subject: [PATCH 10/38] Add missing Nanoleaf to discovery integration documentation (#18556) --- source/_integrations/discovery.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_integrations/discovery.markdown b/source/_integrations/discovery.markdown index ae848acf55a..2500d735dc9 100644 --- a/source/_integrations/discovery.markdown +++ b/source/_integrations/discovery.markdown @@ -21,6 +21,7 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi * [Linn / Openhome](/integrations/openhome) * [Logitech Harmony Hub](/integrations/harmony) * [Logitech Media Server (Squeezebox)](/integrations/squeezebox) + * [Nanoleaf](/integrations/nanoleaf) * [NETGEAR routers](/integrations/netgear) * [Philips Hue](/integrations/hue) * [SABnzbd downloader](/integrations/sabnzbd) @@ -75,6 +76,7 @@ Valid values for ignore are: * `frontier_silicon`: Frontier Silicon internet radios * `harmony`: Logitech Harmony Hub * `logitech_mediaserver`: Logitech Media Server (Squeezebox) + * `nanoleaf_aurora`: Nanoleaf * `netgear_router`: NETGEAR routers * `octoprint`: Octoprint * `openhome`: Linn / Openhome From 86436ca1a77075b33857f5cc72a4c22f76964eb0 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Tue, 20 Jul 2021 17:24:39 +0200 Subject: [PATCH 11/38] Fix docker command (#18564) --- source/_includes/installation/container/cli.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_includes/installation/container/cli.md b/source/_includes/installation/container/cli.md index d31ca99cb17..5a90ffd2f6f 100644 --- a/source/_includes/installation/container/cli.md +++ b/source/_includes/installation/container/cli.md @@ -4,11 +4,11 @@ content: | ```bash - docker run --init -d \ + docker run -d \ --name homeassistant \ --privileged \ --restart=unless-stopped \ - -v /etc/localtime:/etc/localtime:ro \ + -e TZ=MY_TIME_ZONE \ -v /PATH_TO_YOUR_CONFIG:/config \ --network=host \ {{ include.image | default: site.installation.container.base }}:{{ include.tag | default: 'stable' }} @@ -34,12 +34,12 @@ ```bash # finally, start a new one - docker run --init -d \ + docker run -d \ --name homeassistant \ --restart=unless-stopped \ --privileged \ + -e TZ=MY_TIME_ZONE \ -v /PATH_TO_YOUR_CONFIG:/config \ - -v /etc/localtime:/etc/localtime:ro \ --network=host \ {{ include.image | default: site.installation.container.base }}:{{ include.tag | default: 'stable' }} ``` From 523d1b0f3b15900ec117f18ede2896411369757d Mon Sep 17 00:00:00 2001 From: Yannick Brosseau Date: Tue, 20 Jul 2021 12:43:53 -0400 Subject: [PATCH 12/38] Update prometheus configuration example for version 2.26+ (#18565) * Update prometheus configuration example for version 2.26+ The bearer token configuration entry have changed format in the latest Prometheus (starting at version 2.26). Instead of bearer_token:, it needs a authorization: credentials: entry. * Small tweak Co-authored-by: Franck Nijhof --- source/_integrations/prometheus.markdown | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/source/_integrations/prometheus.markdown b/source/_integrations/prometheus.markdown index 3e541e0aa0b..b75a7403fcb 100644 --- a/source/_integrations/prometheus.markdown +++ b/source/_integrations/prometheus.markdown @@ -173,6 +173,23 @@ You can then configure Prometheus to fetch metrics from Home Assistant by adding - targets: ['HOSTNAME:8123'] ``` +The format to configure the bearer token has changed in Prometheus 2.26, so if you have a newer version, you can use this configuration sample: + +```yaml +# Example Prometheus scrape_configs entry (For version 2.26+ + - job_name: "hass" + scrape_interval: 60s + metrics_path: /api/prometheus + + # Long-Lived Access Token + authorization: + credentials: "your.longlived.token" + + scheme: https + static_configs: + - targets: ['HOSTNAME:8123'] +``` + When looking into the metrics on the Prometheus side, there will be: - All Home Assistant domains, which can be easily found through the common **namespace** prefix, if defined. From a99784324ca7082ced61ec8921a140a061a00387 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Tue, 20 Jul 2021 23:35:22 -0700 Subject: [PATCH 13/38] Add event to binary sensor example (#18567) --- source/_integrations/template.markdown | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/source/_integrations/template.markdown b/source/_integrations/template.markdown index 90a337a6642..6904ba4337a 100644 --- a/source/_integrations/template.markdown +++ b/source/_integrations/template.markdown @@ -299,6 +299,21 @@ curl --header "Content-Type: application/json" \ http://homeassistant.local:8123/api/webhook/my-super-secret-webhook-id ``` +### Turning an event into a binary sensor + +You can use a trigger-based template entity to convert any event or other automation trigger into a binary sensor. The below configuration will turn on a binary sensor for 5 seconds when the automation trigger triggers. + +```yaml +template: + trigger: + platform: event + event_type: my_event + binary_sensor: + - name: Event recently fired + auto_off: 5 + state: "true" +``` + ### Sun Angle This example shows the sun angle in the frontend. From 7def72ba9084327a339bc15ce1206c502c389748 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 21 Jul 2021 08:41:36 +0200 Subject: [PATCH 14/38] Bump ruby/setup-ruby from 1.77.0 to 1.78.0 (#18570) Bumps [ruby/setup-ruby](https://github.com/ruby/setup-ruby) from 1.77.0 to 1.78.0. - [Release notes](https://github.com/ruby/setup-ruby/releases) - [Commits](https://github.com/ruby/setup-ruby/compare/v1.77.0...v1.78.0) --- updated-dependencies: - dependency-name: ruby/setup-ruby dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/test.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 212f8ae0187..07d209935b0 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -57,7 +57,7 @@ jobs: - name: Check out files from GitHub uses: actions/checkout@v2.3.4 - name: Setting up Ruby 2.6 - uses: ruby/setup-ruby@v1.77.0 + uses: ruby/setup-ruby@v1.78.0 with: ruby-version: 2.6 - name: Setup Ruby Gems cache From 0ad91cc0646b2417b2484b691ef344f8b06bdf62 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 21 Jul 2021 08:41:58 +0200 Subject: [PATCH 15/38] Bump actions/setup-node from 2.2.0 to 2.3.0 (#18569) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 2.2.0 to 2.3.0. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](https://github.com/actions/setup-node/compare/v2.2.0...v2.3.0) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/test.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 07d209935b0..76dc3dc6548 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -10,7 +10,7 @@ jobs: - name: Check out files from GitHub uses: actions/checkout@v2.3.4 - name: Setting up Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v2.2.0 + uses: actions/setup-node@v2.3.0 with: node-version: 12.x - name: Setup NPM cache @@ -33,7 +33,7 @@ jobs: - name: Check out files from GitHub uses: actions/checkout@v2.3.4 - name: Setting up Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v2.2.0 + uses: actions/setup-node@v2.3.0 with: node-version: 12.x - name: Setup NPM cache From afa16cf64259d0e66d61bdceac3fbfa0c0c2bfa7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 21 Jul 2021 08:42:16 +0200 Subject: [PATCH 16/38] Bump listen from 3.5.1 to 3.6.0 (#18568) Bumps [listen](https://github.com/guard/listen) from 3.5.1 to 3.6.0. - [Release notes](https://github.com/guard/listen/releases) - [Commits](https://github.com/guard/listen/compare/v3.5.1...v3.6.0) --- updated-dependencies: - dependency-name: listen dependency-type: indirect update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index ed86a87bd51..82d62738ad2 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -66,7 +66,7 @@ GEM kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) liquid (4.0.3) - listen (3.5.1) + listen (3.6.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) mercenary (0.4.0) From 573fc8c9fe4cff861103599085d0b95c0a65b813 Mon Sep 17 00:00:00 2001 From: Carlo Costanzo Date: Wed, 21 Jul 2021 07:50:01 -0400 Subject: [PATCH 17/38] Added in some Words about Battery Drain potential. (#18482) * Added in some Words about Battery Drain potential. Mainly pulled from https://github.com/home-assistant/home-assistant.io/issues/16521 and @mabahj. * Corrected linting error Tesla instead of tesla. * Update source/_integrations/tesla.markdown Co-authored-by: Franck Nijhof * Update source/_integrations/tesla.markdown Co-authored-by: Franck Nijhof * Update source/_integrations/tesla.markdown Co-authored-by: Franck Nijhof * Update source/_integrations/tesla.markdown Co-authored-by: Franck Nijhof * Update source/_integrations/tesla.markdown Co-authored-by: Franck Nijhof * Make the scan_interval phrase clearer. Added in the other option and referred to it as the scan_interval to make the description clearer hopefully. Co-authored-by: Franck Nijhof --- source/_integrations/tesla.markdown | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/source/_integrations/tesla.markdown b/source/_integrations/tesla.markdown index 954253a3117..751e3d353f4 100644 --- a/source/_integrations/tesla.markdown +++ b/source/_integrations/tesla.markdown @@ -50,4 +50,15 @@ This integration provides the following platforms: Tesla options are set via **Configuration** -> **Integrations** -> **Tesla** -> **Options**. +* Seconds between scans - referred to below as the `scan_interval`. + * Wake cars on start - Whether to wake sleeping cars on Home Assistant startup. This allows a user to choose whether cars should continue to sleep (and not update information) or to wake up the cars potentially interrupting long term hibernation and increasing vampire drain. + +## Potential Battery impacts + +Here are some things to consider and understand when implementing the Tesla component and its potential effect on your car's battery. + +- The `scan_interval` determines when to check if the car is awake and new information is available, but the Tesla integration will not wake up a sleeping car during this polling. By default, the polling will occur every 660 seconds. Polling a car too frequently can keep the car awake and drain the battery. Different firmware versions and measurements of Tesla cars can take from 11 to 15 minutes for sleep mode to occur. There is no official information on sleep mode timings so your mileage may vary and you should experiment with different polling times for an optimal experience. +- The car will, however, be woken up when a command is actively sent to the car, such as door unlock or turning on the HVAC. It will then also fetch updated information while the car is awake based on the `scan_interval`. +- The car can intentionally be woken up to fetch recent information by sending a harmless command, for example, a lock command. This can be used in an automation to, for example, ensure that updated information is available every morning. (Note that the command must be valid for that specific car model. So locking the frunk of a Model 3 will not wake up that car). +- You can also toggle the `Update switch` on/off to disable polling of the vehicle completely via automations or the Lovelace UI. From 463e92cdf8d535c0ddf62b8389fac253e620402d Mon Sep 17 00:00:00 2001 From: ryman1 Date: Wed, 21 Jul 2021 14:05:57 -0700 Subject: [PATCH 18/38] Change 'condition' to 'conditions' (#18543) --- source/_docs/scripts/conditions.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/scripts/conditions.markdown b/source/_docs/scripts/conditions.markdown index 5783079f842..4abb59bcac6 100644 --- a/source/_docs/scripts/conditions.markdown +++ b/source/_docs/scripts/conditions.markdown @@ -32,7 +32,7 @@ The following configuration works the same as the one listed above: ```yaml alias: "Paulus home AND temperature below 20" -condition: +conditions: - condition: state entity_id: "device_tracker.paulus" state: "home" From 7e7f1df002e92a6e92dff07a484b63b460ccd02c Mon Sep 17 00:00:00 2001 From: Fredrik Andersson Date: Wed, 21 Jul 2021 23:07:28 +0200 Subject: [PATCH 19/38] Add Silicon Labs SLUSB7000A to the supported list (#18566) --- source/_docs/z-wave/controllers.markdown | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/source/_docs/z-wave/controllers.markdown b/source/_docs/z-wave/controllers.markdown index c572273803a..e806ede7010 100644 --- a/source/_docs/z-wave/controllers.markdown +++ b/source/_docs/z-wave/controllers.markdown @@ -11,18 +11,13 @@ This Z-Wave integration is deprecated and replaced with a [new implementation ba ## Supported Z-Wave USB Sticks & Hardware Modules -You need to have a compatible Z-Wave stick or module installed. This needs to be a *static controller*, which most Z-Wave sticks and modules will be. If yours is a *bridge* device then it won't work with [OpenZWave](http://openzwave.com/), which is what provides Home Assistant's Z-Wave capabilities. USB sticks using the new 700 series Z-Wave platform are not compatible. The following devices have been confirmed to work: +You need to have a compatible Z-Wave stick or module installed. This needs to be a *static controller*, which most Z-Wave sticks and modules will be. If yours is a *bridge* device then it won't work with [OpenZWave](http://openzwave.com/), which is what provides Home Assistant's Z-Wave capabilities. The following devices have been confirmed to work: -
- -There are [known compatibility issues](https://www.raspberrypi.org/forums/viewtopic.php?f=28&t=245031#p1502030) with older hardware versions of the Aeotec stick not working on the Raspberry Pi 4. Aeotec has released a 2020 hardware revision ZW090-A/B/C Gen5+ with Pi 4 compatibility. Both hardware revisions are still being sold, make informed purchasing decisions if using paired with a Pi 4. - -
- -- Aeotec Z-Stick Series 5 +- Aeotec Z-Stick Series 5 (see note below) - Everspring USB stick - Gen 5 - GoControl HUSBZB-1 stick - Sigma Designs UZB stick +- Silicon Labs SLUSB7000A - Vision USB stick - Gen5 - Zooz Z-Wave Plus S2 stick ZST10 - ZWave.me Razberry Board @@ -47,6 +42,12 @@ The alternative to a stick is a hub that supports Z-Wave. Home Assistant support ### Aeotec Stick +
+ +There are [known compatibility issues](https://www.raspberrypi.org/forums/viewtopic.php?f=28&t=245031#p1502030) with older hardware versions of the Aeotec stick not working on the Raspberry Pi 4. Aeotec has released a 2020 hardware revision ZW090-A/B/C Gen5+ with Pi 4 compatibility. Both hardware revisions are still being sold, make informed purchasing decisions if using paired with a Pi 4. + +
+ By default this will turn on "disco lights", which you can turn off by following the instructions in the [device specific page](/docs/z-wave/device-specific/#aeotec-z-stick) ### Razberry Board From 64be71a4b288959915e7c194780318c7fc0a6610 Mon Sep 17 00:00:00 2001 From: Duncan Elliot <42836473+dmelliot@users.noreply.github.com> Date: Thu, 22 Jul 2021 16:33:07 +1000 Subject: [PATCH 20/38] Minor typo updates to integrations/alert doco (#18576) --- source/_integrations/alert.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_integrations/alert.markdown b/source/_integrations/alert.markdown index 7f25ed77d12..4a27181d0f4 100644 --- a/source/_integrations/alert.markdown +++ b/source/_integrations/alert.markdown @@ -11,7 +11,7 @@ ha_domain: alert The `alert` integration is designed to notify you when problematic issues arise. For example, if the garage door is left open, the `alert` integration can be used -remind you of this by sending you repeating notifications at customizable +to remind you of this by sending you repeating notifications at customizable intervals. This is also used for low battery sensors, water leak sensors, or any condition that may need your attention. @@ -27,7 +27,7 @@ State | Description ### Basic Example -The `alert` integration makes use of any of the `notifications` integrations. To +The `alert` integration makes use of any of the `notification` integrations. To setup the `alert` integration, first, you must setup a `notification` integration. Then, add the following to your configuration file: From 0265014bdb7cc494a26a207eaff543b4e9e400ba Mon Sep 17 00:00:00 2001 From: Jan Bouwhuis Date: Thu, 22 Jul 2021 14:25:15 +0200 Subject: [PATCH 21/38] Google Assistant - update fan platform capabilties (#18415) --- source/_integrations/google_assistant.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/google_assistant.markdown b/source/_integrations/google_assistant.markdown index 6582bc98558..7ecb48b7d11 100644 --- a/source/_integrations/google_assistant.markdown +++ b/source/_integrations/google_assistant.markdown @@ -209,7 +209,7 @@ Currently, the following domains are available to be used with Google Assistant, - scene (on) - script (on) - switch (on/off) -- fan (on/off/speed) +- fan (on/off/speed percentage/preset mode) - light (on/off/brightness/rgb color/color temp) - lock - cover (on/off/set position) From 31b08ac4d2a120c206eafbce7365a85b51b65ff0 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Thu, 22 Jul 2021 05:57:47 +0000 Subject: [PATCH 22/38] 2021.7.4 --- _config.yml | 4 +- .../_posts/2021-07-07-release-20217.markdown | 53 +++++++++++++++++++ 2 files changed, 55 insertions(+), 2 deletions(-) diff --git a/_config.yml b/_config.yml index 07aec310a2a..7ad17af55ab 100644 --- a/_config.yml +++ b/_config.yml @@ -105,8 +105,8 @@ social: # Home Assistant release details current_major_version: 2021 current_minor_version: 7 -current_patch_version: 3 -date_released: 2021-07-16 +current_patch_version: 4 +date_released: 2021-07-21 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. diff --git a/source/_posts/2021-07-07-release-20217.markdown b/source/_posts/2021-07-07-release-20217.markdown index ad7a1e91856..82f6130d43c 100644 --- a/source/_posts/2021-07-07-release-20217.markdown +++ b/source/_posts/2021-07-07-release-20217.markdown @@ -53,6 +53,7 @@ Alright, that's it! Enjoy the release! - [Release 2021.7.1 - July 8](#release-202171---july-8) - [Release 2021.7.2 - July 12](#release-202172---july-12) - [Release 2021.7.3 - July 16](#release-202173---july-16) +- [Release 2021.7.4 - July 21](#release-202174---july-21) - [If you need help...](#if-you-need-help) - [Breaking Changes](#breaking-changes) - [All changes](#all-changes) @@ -520,6 +521,58 @@ The following integrations are now available via the Home Assistant UI: [sma docs]: /integrations/sma/ [zha docs]: /integrations/zha/ +## Release 2021.7.4 - July 21 + +- Allow pymodbus to reconnect in running system (not startup) ([@janiversen] - [#53020]) ([modbus docs]) +- Fix groups reporting incorrect supported color modes ([@Kane610] - [#53088]) ([deconz docs]) +- Handle all WeMo ensure_long_press_virtual_device exceptions ([@esev] - [#53094]) ([wemo docs]) +- Fix remote rpi gpio input type ([@jgriff2] - [#53108]) ([remote_rpi_gpio docs]) +- More restrictive state updates of UniFi uptime sensor ([@Kane610] - [#53111]) ([unifi docs]) +- Bump simplisafe-python to 11.0.2 ([@bachya] - [#53121]) ([simplisafe docs]) +- Bump nexia to 0.9.10 to fix asair login ([@bdraco] - [#53122]) ([nexia docs]) +- Bump surepy to 0.7.0 ([@benleb] - [#53123]) ([surepetcare docs]) +- Upgrade pysonos to 0.0.53 ([@amelchio] - [#53137]) ([sonos docs]) +- Correctly detect is not home ([@balloob] - [#53279]) ([device_tracker docs]) +- Upgrade to async-upnp-client==0.19.1 ([@StevenLooman] - [#53288]) ([dlna_dmr docs]) ([ssdp docs]) ([upnp docs]) +- Fix homekit locks not being created from when setup from the UI ([@bdraco] - [#53301]) ([homekit docs]) + +[#53020]: https://github.com/home-assistant/core/pull/53020 +[#53088]: https://github.com/home-assistant/core/pull/53088 +[#53094]: https://github.com/home-assistant/core/pull/53094 +[#53108]: https://github.com/home-assistant/core/pull/53108 +[#53111]: https://github.com/home-assistant/core/pull/53111 +[#53121]: https://github.com/home-assistant/core/pull/53121 +[#53122]: https://github.com/home-assistant/core/pull/53122 +[#53123]: https://github.com/home-assistant/core/pull/53123 +[#53137]: https://github.com/home-assistant/core/pull/53137 +[#53279]: https://github.com/home-assistant/core/pull/53279 +[#53288]: https://github.com/home-assistant/core/pull/53288 +[#53301]: https://github.com/home-assistant/core/pull/53301 +[@Kane610]: https://github.com/Kane610 +[@StevenLooman]: https://github.com/StevenLooman +[@amelchio]: https://github.com/amelchio +[@bachya]: https://github.com/bachya +[@balloob]: https://github.com/balloob +[@bdraco]: https://github.com/bdraco +[@benleb]: https://github.com/benleb +[@esev]: https://github.com/esev +[@janiversen]: https://github.com/janiversen +[@jgriff2]: https://github.com/jgriff2 +[deconz docs]: /integrations/deconz/ +[device_tracker docs]: /integrations/device_tracker/ +[dlna_dmr docs]: /integrations/dlna_dmr/ +[homekit docs]: /integrations/homekit/ +[modbus docs]: /integrations/modbus/ +[nexia docs]: /integrations/nexia/ +[remote_rpi_gpio docs]: /integrations/remote_rpi_gpio/ +[simplisafe docs]: /integrations/simplisafe/ +[sonos docs]: /integrations/sonos/ +[ssdp docs]: /integrations/ssdp/ +[surepetcare docs]: /integrations/surepetcare/ +[unifi docs]: /integrations/unifi/ +[upnp docs]: /integrations/upnp/ +[wemo docs]: /integrations/wemo/ + ## 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). From 5489f1cf2f55e3be487eb13e9a187424ee7dedcb Mon Sep 17 00:00:00 2001 From: Oxan van Leeuwen Date: Fri, 23 Jul 2021 00:07:27 +0200 Subject: [PATCH 23/38] Fix a bunch of typos (#18579) --- sass/inuitcss/README.md | 2 +- sass/inuitcss/generic/_widths.scss | 2 +- sass/inuitcss/objects/_grids.scss | 2 +- sass/inuitcss/objects/_icon-text.scss | 2 +- sass/oscailte/base/_solarized.scss | 2 +- sass/plugins/_plugins.scss | 2 +- source/_docs/asterisk_mbox.markdown | 2 +- source/_docs/automation/templating.markdown | 2 +- source/_docs/mqtt/discovery.markdown | 2 +- source/_docs/z-wave/device-specific.markdown | 8 ++++---- source/_includes/common-tasks/file_access.md | 8 ++++---- source/_includes/installation/container/alternative.md | 2 +- source/_includes/installation/operating_system.md | 2 +- source/_integrations/ads.markdown | 2 +- source/_integrations/arlo.markdown | 4 ++-- source/_integrations/atag.markdown | 2 +- source/_integrations/blink.markdown | 2 +- source/_integrations/bme280.markdown | 2 +- source/_integrations/cast.markdown | 2 +- source/_integrations/cloud.markdown | 2 +- source/_integrations/cover.mqtt.markdown | 2 +- source/_integrations/cups.markdown | 2 +- source/_integrations/danfoss_air.markdown | 4 ++-- source/_integrations/enocean.markdown | 2 +- source/_integrations/envisalink.markdown | 2 +- source/_integrations/fints.markdown | 2 +- source/_integrations/firmata.markdown | 2 +- source/_integrations/flux_led.markdown | 2 +- source/_integrations/heos.markdown | 2 +- source/_integrations/here_travel_time.markdown | 2 +- source/_integrations/homekit.markdown | 2 +- source/_integrations/homematic.markdown | 4 ++-- source/_integrations/hvv_departures.markdown | 4 ++-- source/_integrations/hydrawise.markdown | 2 +- source/_integrations/iammeter.markdown | 2 +- source/_integrations/iqvia.markdown | 2 +- source/_integrations/joaoapps_join.markdown | 2 +- source/_integrations/kaiterra.markdown | 2 +- source/_integrations/keyboard_remote.markdown | 2 +- source/_integrations/lannouncer.markdown | 2 +- source/_integrations/lcn.markdown | 2 +- source/_integrations/light.markdown | 2 +- source/_integrations/mycroft.markdown | 2 +- source/_integrations/neato.markdown | 2 +- source/_integrations/nest.markdown | 2 +- source/_integrations/nfandroidtv.markdown | 2 +- source/_integrations/nilu.markdown | 4 ++-- source/_integrations/onvif.markdown | 2 +- source/_integrations/osramlightify.markdown | 2 +- source/_integrations/plex.markdown | 2 +- source/_integrations/point.markdown | 2 +- source/_integrations/rejseplanen.markdown | 4 ++-- source/_integrations/risco.markdown | 2 +- source/_integrations/roon.markdown | 2 +- source/_integrations/satel_integra.markdown | 2 +- source/_integrations/sensehat.markdown | 2 +- source/_integrations/sma.markdown | 2 +- source/_integrations/smarthab.markdown | 2 +- source/_integrations/synology_dsm.markdown | 2 +- source/_integrations/tado.markdown | 4 ++-- source/_integrations/traccar.markdown | 2 +- source/_integrations/weather.template.markdown | 2 +- source/_integrations/xiaomi_miio.markdown | 6 +++--- source/_integrations/xmpp.markdown | 2 +- source/_integrations/zha.markdown | 2 +- source/_integrations/zwave_js.markdown | 2 +- source/help/reporting_issues.markdown | 2 +- 67 files changed, 82 insertions(+), 82 deletions(-) diff --git a/sass/inuitcss/README.md b/sass/inuitcss/README.md index 77155d091d9..3567be2208e 100644 --- a/sass/inuitcss/README.md +++ b/sass/inuitcss/README.md @@ -177,7 +177,7 @@ variables required for the library to compile without failing. These variables are preset because Sass will error without them, however they are **not** set in stone, and you are encouranged to override and experiment with them. -It is tempting to modify their vaules in the inuit.css submodule but this is +It is tempting to modify their values in the inuit.css submodule but this is **not** the correct method for modifying inuit.css, and in doing so you will prevent yourself from being able to update inuit.css’ core library. The correct procedure is to redefine that variable in `_vars.scss` found in the inuit.css diff --git a/sass/inuitcss/generic/_widths.scss b/sass/inuitcss/generic/_widths.scss index 66d76f1a610..6e2a4b34310 100644 --- a/sass/inuitcss/generic/_widths.scss +++ b/sass/inuitcss/generic/_widths.scss @@ -145,7 +145,7 @@ /** * If you have set the additional `$responsive-extra` variable to ‘true’ in * `_vars.scss` then you now have access to the following class available to - * accomodate much larger screen resolutions. + * accommodate much larger screen resolutions. */ @if $responsive-extra == true{ diff --git a/sass/inuitcss/objects/_grids.scss b/sass/inuitcss/objects/_grids.scss index 9499e5ed612..4fcf51f3e8f 100644 --- a/sass/inuitcss/objects/_grids.scss +++ b/sass/inuitcss/objects/_grids.scss @@ -46,7 +46,7 @@ /** - * Very infrequently occuring grid wrappers as children of grid wrappers. + * Very infrequently occurring grid wrappers as children of grid wrappers. */ .grid > .grid{ margin-left:0; diff --git a/sass/inuitcss/objects/_icon-text.scss b/sass/inuitcss/objects/_icon-text.scss index 0f8250ff3b8..e5cd910d72c 100644 --- a/sass/inuitcss/objects/_icon-text.scss +++ b/sass/inuitcss/objects/_icon-text.scss @@ -11,7 +11,7 @@ Help & support * - * However we will sometimes want a larger, explicity set gap: + * However we will sometimes want a larger, explicitly set gap: Help & support diff --git a/sass/oscailte/base/_solarized.scss b/sass/oscailte/base/_solarized.scss index 086044990ec..7924d26cb7e 100644 --- a/sass/oscailte/base/_solarized.scss +++ b/sass/oscailte/base/_solarized.scss @@ -1,4 +1,4 @@ -// // This file is just a butchered version fo the one included in the default Octopress theme. +// // This file is just a butchered version of the one included in the default Octopress theme. // // It could most definitely do with some cleaning up in the future. // @mixin selection($bg, $color: inherit, $text-shadow: none){ diff --git a/sass/plugins/_plugins.scss b/sass/plugins/_plugins.scss index 3b4ba0b8a80..25af026ba02 100644 --- a/sass/plugins/_plugins.scss +++ b/sass/plugins/_plugins.scss @@ -1,6 +1,6 @@ /* Add plugin stylesheets to this directory and they will be automatically - Imported. Load order is alphabetical and styles can be overriden in + Imported. Load order is alphabetical and styles can be overridden in custom/_style.scss which is loaded after all plugin stylesheets. */ diff --git a/source/_docs/asterisk_mbox.markdown b/source/_docs/asterisk_mbox.markdown index 8b2da063d7b..058d006a549 100644 --- a/source/_docs/asterisk_mbox.markdown +++ b/source/_docs/asterisk_mbox.markdown @@ -56,7 +56,7 @@ Before beginning make sure that you have the following: - `host` (*Optional*): The IP address to listen on for client requests. This defaults to all IP addresses on the server. To listen only locally, choose `127.0.0.1` - `port` (*Optional*): The port to listen on for client requests. Defaults to 12345. - - `password` (*Required*): A password shared between client and server. Use only alpha-numeric characters and spaces + - `password` (*Required*): A password shared between client and server. Use only alphanumeric characters and spaces - `mbox_path` (*Required*): The path to the storage location of mailbox files. This is typically `/var/spool/asterisk/voicemail/default//` - `cache_file` (*Required*): A fully-qualified path to a file that can be written by the server containing transcriptions of voicemails. Example: `/var/spool/asterisk/transcription.cache` - `google_key` (*Required*): Your 40 characters Google API key. diff --git a/source/_docs/automation/templating.markdown b/source/_docs/automation/templating.markdown index 6f1d89e1ab6..de2ba58cd2c 100644 --- a/source/_docs/automation/templating.markdown +++ b/source/_docs/automation/templating.markdown @@ -34,7 +34,7 @@ The following describes trigger data associated with all platforms. | `trigger.platform` | Hardcoded: `mqtt`. | `trigger.topic` | Topic that received payload. | `trigger.payload` | Payload. -| `trigger.payload_json` | Dictonary of the JSON parsed payload. +| `trigger.payload_json` | Dictionary of the JSON parsed payload. | `trigger.qos` | QOS of payload. ### Numeric State diff --git a/source/_docs/mqtt/discovery.markdown b/source/_docs/mqtt/discovery.markdown index 8cd2284fd57..0b481d5e677 100644 --- a/source/_docs/mqtt/discovery.markdown +++ b/source/_docs/mqtt/discovery.markdown @@ -454,7 +454,7 @@ Setting up a device tracker: - State topic: `homeassistant/device_tracker/paulus/state` - Example state payload: `home` or `not_home` or `location name` -If the device supports gps co-ordinates then they can be sent to Home Assistant by specifying an attributes topic (i.e. "json_attributes_topic") in the configuration payload: +If the device supports gps coordinates then they can be sent to Home Assistant by specifying an attributes topic (i.e. "json_attributes_topic") in the configuration payload: - Attributes topic: `homeassistant/device_tracker/paulus/attributes` - Example attributes payload: diff --git a/source/_docs/z-wave/device-specific.markdown b/source/_docs/z-wave/device-specific.markdown index 980a7a12b29..b7f69946a6a 100644 --- a/source/_docs/z-wave/device-specific.markdown +++ b/source/_docs/z-wave/device-specific.markdown @@ -62,7 +62,7 @@ For both processes below you will need to insert your SD card into your PC and o #### Raspberry Pi 4 procedure -Add the following paramaters to the bottom of the `/boot/config.txt` file. +Add the following parameters to the bottom of the `/boot/config.txt` file. ```text dtoverlay=disable-bt @@ -384,7 +384,7 @@ Zen22v2 (Dimmer): - Enables/Disables the double-tap fucntion and assign brightness to single tap. Last level: single tap returns to last brightness level. Full/Max level: single tap returns to full/max level + Enables/Disables the double-tap function and assign brightness to single tap. Last level: single tap returns to last brightness level. Full/Max level: single tap returns to full/max level @@ -708,7 +708,7 @@ Zen30 (Double Switch): - Enable/Disable Double-tap for Dimmer. Enables/Disables the double-tap fucntion and assign brightness to single tap. enabled: single tap turns on to maximum brightness level. disabled (last level): single tap returns to last brightness level. disabled (full/max level): single tap returns to full brightmess. Default: enabled + Enable/Disable Double-tap for Dimmer. Enables/Disables the double-tap function and assign brightness to single tap. enabled: single tap turns on to maximum brightness level. disabled (last level): single tap returns to last brightness level. disabled (full/max level): single tap returns to full brightmess. Default: enabled @@ -899,7 +899,7 @@ Zen34 Remote Switch: - Choose the LED indicator color for the upper paddle remote controle triggers + Choose the LED indicator color for the upper paddle remote controlled triggers diff --git a/source/_includes/common-tasks/file_access.md b/source/_includes/common-tasks/file_access.md index f21403ed590..e28f99d57f5 100644 --- a/source/_includes/common-tasks/file_access.md +++ b/source/_includes/common-tasks/file_access.md @@ -37,9 +37,9 @@ You would then enter the IP address or hostname of your Home Assistant OS instan ### Installing and using the SSH add-on (requires enabling advanced mode for the HA user) -The Terminal & SSH add-on provides access over an SSH connection, and also includes nano and vi editors. It can be installed from the add-on store's Official add-on repository after enabling advanced mode for your Home Assistant user's profile. Addtionally, this add-on provides access to the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring snapshots, and more. (See [Home Assistant via Command Line](https://www.home-assistant.io/hassio/commandline/) for further info). The Terminal & SSH add-on does *not* provide access to the underlying host file system. +The Terminal & SSH add-on provides access over an SSH connection, and also includes nano and vi editors. It can be installed from the add-on store's Official add-on repository after enabling advanced mode for your Home Assistant user's profile. Additionally, this add-on provides access to the Home Assistant Command Line Interface (CLI) which provides custom commands for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring snapshots, and more. (See [Home Assistant via Command Line](https://www.home-assistant.io/hassio/commandline/) for further info). The Terminal & SSH add-on does *not* provide access to the underlying host file system. -To use the add-on, enter a password or public key on its configuration page, then save and start the add-on. +To use the add-on, enter a password or public key on its configuration page, then save and start the add-on. The Terminal & SSH add-on also provides a web terminal which allows you to access a terminal via the Home Assistant user interface. In order to access from an ssh client, a port needs to be entered in the network section of the add-on's configuration page. @@ -49,7 +49,7 @@ The Terminal & SSH add-on also provides a web terminal which allows you to acces The Visual Studio Code add-on provides access through a feature packed web-based version of the Visual Studio Code editor and currently only supports AMD64 and aarch64/ARM64 machines. This add-on can be installed in the add-on store from the Community add-on repository. The add-on also provides access to the Home Assistant Command Line Interface (CLI) using VSC's built in terminal, which allows for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring snapshots, and more. (See [Home Assistant via Command Line](https://www.home-assistant.io/hassio/commandline/) for further info). -There is no configuration required for editing files within your `/config` directory. In order to enable access to other directories, it is necessary to edit the add-on's configuration from its configuration tab. See the add-on documentation for details. +There is no configuration required for editing files within your `/config` directory. In order to enable access to other directories, it is necessary to edit the add-on's configuration from its configuration tab. See the add-on documentation for details. --- @@ -57,4 +57,4 @@ There is no configuration required for editing files within your `/config` direc A more basic and light weight alternative to Visual Studio Code, the File Editor add-on provides access through Hass-Configurator, which is a web-based filesystem-browser and text-editor. YAML files are automatically checked for syntax errors while editing. This add-on can be installed via the add-on store from the official add-on repository. -There is no configuration required for editing files within your `/config` directory. In order to enable access to further directories, editing the add-on configuration is required. See the add-on documentation for details. +There is no configuration required for editing files within your `/config` directory. In order to enable access to further directories, editing the add-on configuration is required. See the add-on documentation for details. diff --git a/source/_includes/installation/container/alternative.md b/source/_includes/installation/container/alternative.md index 549f72836b4..ec9aa89e7e7 100644 --- a/source/_includes/installation/container/alternative.md +++ b/source/_includes/installation/container/alternative.md @@ -22,7 +22,7 @@ The steps would be: If you are using the built-in firewall, you must also add the port 8123 to allowed list. This can be found in "Control Panel -> Security" and then the Firewall tab. Click "Edit Rules" besides the Firewall Profile dropdown box. Create a new rule and select "Custom" for Ports and add 8123. Edit Source IP if you like or leave it at default "All". Action should stay at "Allow". -To use a Z-Wave USB stick for Z-Wave control, the HA Docker container needs extra configuration to access to the USB stick. While there are multiple ways to do this, the least privileged way of granting access can only be performed via the Terminal, at the time of writing. See this page for configuring Terminal acces to your Synology NAS: +To use a Z-Wave USB stick for Z-Wave control, the HA Docker container needs extra configuration to access to the USB stick. While there are multiple ways to do this, the least privileged way of granting access can only be performed via the Terminal, at the time of writing. See this page for configuring Terminal access to your Synology NAS: diff --git a/source/_includes/installation/operating_system.md b/source/_includes/installation/operating_system.md index f33af51dd51..73d00f256ee 100644 --- a/source/_includes/installation/operating_system.md +++ b/source/_includes/installation/operating_system.md @@ -207,7 +207,7 @@ _All these can be extended if your usage calls for more resources._ - title: VMware ESXi/vSphere content: | - Use the “E1001” or “E1001E” virtual network adapater. There are confirmed mDNS/Multicast discovery issues when using VMware’s “VMXnet3” virtual network adapter. + Use the “E1001” or “E1001E” virtual network adapter. There are confirmed mDNS/Multicast discovery issues when using VMware’s “VMXnet3” virtual network adapter. {% endif %} {% if page.installation_type == 'windows' %} - title: Hyper-V diff --git a/source/_integrations/ads.markdown b/source/_integrations/ads.markdown index 395c0926b5a..796e6f481ad 100644 --- a/source/_integrations/ads.markdown +++ b/source/_integrations/ads.markdown @@ -104,7 +104,7 @@ device_class: ## Light -The `ads` light platform allows you to control your connecte ADS lights. +The `ads` light platform allows you to control your connected ADS lights. To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml` file: diff --git a/source/_integrations/arlo.markdown b/source/_integrations/arlo.markdown index bc19851c80d..5da9f285464 100644 --- a/source/_integrations/arlo.markdown +++ b/source/_integrations/arlo.markdown @@ -86,12 +86,12 @@ home_mode_name: required: false type: string away_mode_name: - description: "Arlo base station does not have a built-in away mode. You can map one of your custom modes to Home Assistant's away mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app." + description: "Arlo base station does not have a built-in away mode. You can map one of your custom modes to Home Assistant's away mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match exactly as you set it up in the Arlo app." required: false type: string default: "`Armed` mode in Arlo" night_mode_name: - description: "Arlo base station does not have a built-in night mode. You can map one of your custom modes to Home Assistant's night mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app." + description: "Arlo base station does not have a built-in night mode. You can map one of your custom modes to Home Assistant's night mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match exactly as you set it up in the Arlo app." required: false type: string default: "`Armed` mode in Arlo" diff --git a/source/_integrations/atag.markdown b/source/_integrations/atag.markdown index eef42a145ca..5329226f892 100644 --- a/source/_integrations/atag.markdown +++ b/source/_integrations/atag.markdown @@ -57,7 +57,7 @@ This integration supports the following services (see [Climate](/integrations/cl - `boost` enable fireplace mode
-`HVAC mode Auto` (Weather based) should not be confused with `Preset mode Auto` (Sheduled, thermostat mode). +`HVAC mode Auto` (Weather based) should not be confused with `Preset mode Auto` (Scheduled, thermostat mode). Currently selection of custom timeframes in Extend, Away and boost modes is not supported. The default settings can be changed on the device.
diff --git a/source/_integrations/blink.markdown b/source/_integrations/blink.markdown index fef78a2318e..7bf13851502 100644 --- a/source/_integrations/blink.markdown +++ b/source/_integrations/blink.markdown @@ -50,7 +50,7 @@ Please note that each camera reports two different states: one as `sensor.blink_ ## Services -Any sequential calls to services relating to blink should have a minimum of a 5 second delay in between them to prevent the calls fro being throttled and ignored. +Any sequential calls to services relating to blink should have a minimum of a 5 second delay in between them to prevent the calls from being throttled and ignored. ### `blink.blink_update` diff --git a/source/_integrations/bme280.markdown b/source/_integrations/bme280.markdown index 7f28292c9ea..70448586ef8 100644 --- a/source/_integrations/bme280.markdown +++ b/source/_integrations/bme280.markdown @@ -68,7 +68,7 @@ oversampling_humidity: default: 1 type: integer filter_mode: - description: IIR filter coeficient as described in the sensor datasheet. + description: IIR filter coefficient as described in the sensor datasheet. required: false default: 0 type: integer diff --git a/source/_integrations/cast.markdown b/source/_integrations/cast.markdown index c6ffab8fed7..0352f91d420 100644 --- a/source/_integrations/cast.markdown +++ b/source/_integrations/cast.markdown @@ -280,7 +280,7 @@ Example values to cast [BBC Radio 1](https://www.bbc.co.uk/sounds/play/live:bbc_ This app doesn't retrieve its own metadata, so if you want the cast interface or media player card to show titles and/or images you will have to provide the data yourself. See the examples below. -Note: Media ID is NOT the 8 digit alpha-numeric in the URL, it can be found by right-clicking the playing video. E.g., [this episode](https://www.bbc.co.uk/iplayer/episode/b09w7fd9/bitz-bob-series-1-1-castle-makeover) shows: +Note: Media ID is NOT the 8 digit alphanumeric in the URL, it can be found by right-clicking the playing video. E.g., [this episode](https://www.bbc.co.uk/iplayer/episode/b09w7fd9/bitz-bob-series-1-1-castle-makeover) shows: 2908kbps | dash (mf_cloudfront_dash_https) b09w70r2 | 960x540 diff --git a/source/_integrations/cloud.markdown b/source/_integrations/cloud.markdown index 237401fc592..6b84558902b 100644 --- a/source/_integrations/cloud.markdown +++ b/source/_integrations/cloud.markdown @@ -26,7 +26,7 @@ This integration is by default enabled, unless you've disabled or removed the [` cloud: ``` -Documentation of further configuration possibilites are located at [NabuCasa](https://www.nabucasa.com/config/) +Documentation of further configuration possibilities are located at [NabuCasa](https://www.nabucasa.com/config/) Once activated, go to the configuration panel in Home Assistant and create an account and log in. If you are not seeing the **Configuration** panel, make sure you have the following option enabled in your `configuration.yaml` file. diff --git a/source/_integrations/cover.mqtt.markdown b/source/_integrations/cover.mqtt.markdown index 102e6d8747f..fc10d2fe405 100644 --- a/source/_integrations/cover.mqtt.markdown +++ b/source/_integrations/cover.mqtt.markdown @@ -554,7 +554,7 @@ cover: {% set tilt_value = min(max((tilt + movement), tilt_min), max) %} { - "postition": value, + "position": value, "pos": position, "tilt": tilt, "tilt_value": tilt_value, diff --git a/source/_integrations/cups.markdown b/source/_integrations/cups.markdown index 1737470792c..7c59e690003 100644 --- a/source/_integrations/cups.markdown +++ b/source/_integrations/cups.markdown @@ -12,7 +12,7 @@ ha_platforms: - sensor --- -The `cups` sensor platform is using the open source printing system [CUPS](https://www.cups.org/) to show details about your printers, including the ink levels. It can obtain the informations using a CUPS server or communicating directly with the printer with the Internet Printing Protocol. +The `cups` sensor platform is using the open source printing system [CUPS](https://www.cups.org/) to show details about your printers, including the ink levels. It can obtain the information using a CUPS server or communicating directly with the printer with the Internet Printing Protocol. ## Setup diff --git a/source/_integrations/danfoss_air.markdown b/source/_integrations/danfoss_air.markdown index c83dda15ffa..5245ca10765 100644 --- a/source/_integrations/danfoss_air.markdown +++ b/source/_integrations/danfoss_air.markdown @@ -42,7 +42,7 @@ host: The following binary sensor is supported. -- **Bypass active:** Indicator if heat recovery is currrently bypassed. +- **Bypass active:** Indicator if heat recovery is currently bypassed. ## Sensor @@ -57,7 +57,7 @@ The following sensors are supported. - **Fan step:** Fan step. - **Exhaust fan speed:** Exhausted fan speed. - **Supply fan speed:** Supply fan speed. -- **Dial battery:** Dial bettery level in percent. +- **Dial battery:** Dial battery level in percent. ## Switch diff --git a/source/_integrations/enocean.markdown b/source/_integrations/enocean.markdown index 7148ed5f27f..86b8c35a4da 100644 --- a/source/_integrations/enocean.markdown +++ b/source/_integrations/enocean.markdown @@ -145,7 +145,7 @@ sender_id: required: true type: list name: - description: An identifier for the Ligh in the frontend. + description: An identifier for the light in the frontend. required: false default: EnOcean Light type: string diff --git a/source/_integrations/envisalink.markdown b/source/_integrations/envisalink.markdown index 228d5c1dc1d..6cc1430f60c 100644 --- a/source/_integrations/envisalink.markdown +++ b/source/_integrations/envisalink.markdown @@ -21,7 +21,7 @@ Please visit the [eyezon website](http://www.eyezon.com/) for further informatio There is currently support for the following device types within Home Assistant: - Binary Sensor: Reports on zone status (Check the [type/class](/integrations/binary_sensor/#device-class) list for a possible visualization of your zone.) -- Sensor: Emulates an alpha-numeric keypad attached to the alarm panel +- Sensor: Emulates an alphanumeric keypad attached to the alarm panel - Alarm Control Panel: Reports on partition status, and can be used to arm/disarm the system This is a fully event-based component. Any event sent by the Envisalink device will be immediately reflected within Home Assistant. diff --git a/source/_integrations/fints.markdown b/source/_integrations/fints.markdown index 23d394780ad..7dd5ac15242 100644 --- a/source/_integrations/fints.markdown +++ b/source/_integrations/fints.markdown @@ -55,7 +55,7 @@ accounts: type: list keys: account: - description: The IBAN of the blance account. + description: The IBAN of the balance account. required: true type: string name: diff --git a/source/_integrations/firmata.markdown b/source/_integrations/firmata.markdown index 6a6b14f61b9..45fff0f9c92 100644 --- a/source/_integrations/firmata.markdown +++ b/source/_integrations/firmata.markdown @@ -70,7 +70,7 @@ sleep_tune: required: false type: float sampling_interval: - description: Sampling interval in millseconds sent to Firmata. Most Firmata sketches will ignore any interval less than 10 milliseconds. + description: Sampling interval in milliseconds sent to Firmata. Most Firmata sketches will ignore any interval less than 10 milliseconds. required: false type: integer switches: diff --git a/source/_integrations/flux_led.markdown b/source/_integrations/flux_led.markdown index c5b30bb9d07..9fe9e68cf7f 100644 --- a/source/_integrations/flux_led.markdown +++ b/source/_integrations/flux_led.markdown @@ -172,7 +172,7 @@ The Flux LED light offers a number of effects which are not included in other li | `random` | Chooses a random color by selecting random values for R, G, and B. | | `custom` | Custom effect (if defined, see below). | -Users can define their own custom effect. It consists of three parameters: a list of 1 to 16 colors, speed and type of transition. The controller will transition between the colors in a loop, with sepcified transition and speed. Here is an example of a custom effect that will quickly flash red, yellow, green, cyan, blue, magenta in a loop: +Users can define their own custom effect. It consists of three parameters: a list of 1 to 16 colors, speed and type of transition. The controller will transition between the colors in a loop, with specified transition and speed. Here is an example of a custom effect that will quickly flash red, yellow, green, cyan, blue, magenta in a loop: ```yaml light: diff --git a/source/_integrations/heos.markdown b/source/_integrations/heos.markdown index 8ba06854109..8184209445c 100644 --- a/source/_integrations/heos.markdown +++ b/source/_integrations/heos.markdown @@ -84,7 +84,7 @@ media_content_id: "Awesome Music" #### Play Quick Select -You can play a HEOS Quick Select by nubmer or name with the `media_player.play_media` service. Example service data payload: +You can play a HEOS Quick Select by number or name with the `media_player.play_media` service. Example service data payload: ```yaml entity_id: media_player.office diff --git a/source/_integrations/here_travel_time.markdown b/source/_integrations/here_travel_time.markdown index b019a13aa51..5adeeb0b93f 100644 --- a/source/_integrations/here_travel_time.markdown +++ b/source/_integrations/here_travel_time.markdown @@ -21,7 +21,7 @@ You need to register for an API key (REST & XYZ HUB API/CLI) by following the in HERE offers a Freemium Plan which includes 250,000 free Transactions per month. For the Routing API, one transaction equals one request with one starting point (no multi stop). More information can be found [here](https://developer.here.com/faqs#payment-subscription) -By default HERE will deactivate your account if you exceed the free Transaction limit for the month. You can add payment details to reenable your account as described [here](https://developer.here.com/faqs) +By default HERE will deactivate your account if you exceed the free Transaction limit for the month. You can add payment details to re-enable your account as described [here](https://developer.here.com/faqs) ### Migrate from app_code to api_key diff --git a/source/_integrations/homekit.markdown b/source/_integrations/homekit.markdown index 73792ffbd6b..498f3fc9e29 100644 --- a/source/_integrations/homekit.markdown +++ b/source/_integrations/homekit.markdown @@ -468,7 +468,7 @@ The following home hubs have been reported to have trouble with a large number o 1. Delete the `HomeKit` integration in the **{% my integrations %}** screen. 2. **Restart** Home Assistant. - 3. The configuration will be automaticlly reimported from YAML. + 3. The configuration will be automatically reimported from YAML. 4. [Pair the bridge or accessory](#setup). ### Resetting when created via the **Integrations** screen diff --git a/source/_integrations/homematic.markdown b/source/_integrations/homematic.markdown index 1846d13772b..955bde8d262 100644 --- a/source/_integrations/homematic.markdown +++ b/source/_integrations/homematic.markdown @@ -475,11 +475,11 @@ automation: The important part is the `sensor.time` entity (from time_date component). This will update the binary sensor on every change of the sensor and every minute. If the Homematic sensor does not send any updates anymore, the `sensor.time` will set the binary sensor to `off` 10 minutes after the last sensor update. This will trigger the automation. -- If you have a CCU you can also create a system variable on the CCU, which stores its last reboot time. Since Home Assistant can still refresh system variables from the CCU (even after a reboot) this is another option to call *homematic.reconnect*. Even though this option might look preferrable to many since it does not rely on a sensor, **it is less fail-safe** than checking for updates of a sensor. Since the variable on the CCU is only changed on boot, any problem that causes the connection between Home Assistant and the CCU to break but will not result in a reboot will not be detected (eg. in case of networking issues). This is how this can be done: +- If you have a CCU you can also create a system variable on the CCU, which stores its last reboot time. Since Home Assistant can still refresh system variables from the CCU (even after a reboot) this is another option to call *homematic.reconnect*. Even though this option might look preferable to many since it does not rely on a sensor, **it is less fail-safe** than checking for updates of a sensor. Since the variable on the CCU is only changed on boot, any problem that causes the connection between Home Assistant and the CCU to break but will not result in a reboot will not be detected (eg. in case of networking issues). This is how this can be done: 1. Create a string variable **V_Last_Reboot** on the CCU - 2. Creata a new programm on the CCU **without any conditions**, which executes the following *HM-Script* with a delay of 30 seconds. The Script needs to be implemented within the section `Activity: Then`. + 2. Create a new program on the CCU **without any conditions**, which executes the following *HM-Script* with a delay of 30 seconds. The script needs to be implemented within the section `Activity: Then`. ```javascript var obj = dom.GetObject("V_Last_Reboot"); diff --git a/source/_integrations/hvv_departures.markdown b/source/_integrations/hvv_departures.markdown index 6a86714e9ec..8932d4d2ced 100644 --- a/source/_integrations/hvv_departures.markdown +++ b/source/_integrations/hvv_departures.markdown @@ -1,6 +1,6 @@ --- title: HVV Departures -description: Display the departures of busses, trains and ferries in Hamburg within Home Assistant. +description: Display the departures of buses, trains and ferries in Hamburg within Home Assistant. ha_category: - Transport ha_iot_class: Cloud Polling @@ -14,7 +14,7 @@ ha_platforms: - sensor --- -The `hvv_departures` sensor will display the departures of busses, trains and ferries in Hamburg. +The `hvv_departures` sensor will display the departures of buses, trains and ferries in Hamburg. {% include integrations/config_flow.md %} diff --git a/source/_integrations/hydrawise.markdown b/source/_integrations/hydrawise.markdown index 48054314774..5a0f614ba1a 100644 --- a/source/_integrations/hydrawise.markdown +++ b/source/_integrations/hydrawise.markdown @@ -73,7 +73,7 @@ monitored_conditions: {% endconfiguration %}
-The Hydrawise API removed the ability to read the rain sensor status. Therefore it is no longer suppored by the Hydrawise integration to Home Assistant. +The Hydrawise API removed the ability to read the rain sensor status. Therefore it is no longer supported by the Hydrawise integration to Home Assistant.
## Sensor diff --git a/source/_integrations/iammeter.markdown b/source/_integrations/iammeter.markdown index 77cea09b626..13ad92c7eef 100644 --- a/source/_integrations/iammeter.markdown +++ b/source/_integrations/iammeter.markdown @@ -60,7 +60,7 @@ Sensors available in the library: | wem3080_voltage | V | Voltage. | | wem3080_current | A | current. | | wem3080_power | W | active power. | -| wem3080_importenergy | kWh | Energy consumption from gird | +| wem3080_importenergy | kWh | Energy consumption from grid | | wem3080_exportgrid | kWh | Energy export to grid | ### Three-phase energy meter (WEM3080T) diff --git a/source/_integrations/iqvia.markdown b/source/_integrations/iqvia.markdown index 88669ff5d76..e7771363f15 100644 --- a/source/_integrations/iqvia.markdown +++ b/source/_integrations/iqvia.markdown @@ -17,7 +17,7 @@ The `iqvia` sensor platform collects and displays allergy, asthma and disease information (based on a U.S. ZIP code) from [IQVIA](https://www.iqvia.com/). Data measured includes: -* Indicies for allergies, asthma and cold/flu indices +* Indices for allergies, asthma and cold/flu indices * Trends * Current outlook * more! diff --git a/source/_integrations/joaoapps_join.markdown b/source/_integrations/joaoapps_join.markdown index 8cd85102102..5e836b2ed02 100644 --- a/source/_integrations/joaoapps_join.markdown +++ b/source/_integrations/joaoapps_join.markdown @@ -56,7 +56,7 @@ device_names: required: false type: string name: - description: The name parameter is optional but needed if you want to use multiple notification platforms. The platform will be exposed as service `notify.`. The name will defailt to `notify` if not supplied. See the [Notifications Component](/integrations/notify) for more details. + description: The name parameter is optional but needed if you want to use multiple notification platforms. The platform will be exposed as service `notify.`. The name will default to `notify` if not supplied. See the [Notifications Component](/integrations/notify) for more details. required: false type: string {% endconfiguration %} diff --git a/source/_integrations/kaiterra.markdown b/source/_integrations/kaiterra.markdown index 40161e7c8aa..7a7702f928c 100644 --- a/source/_integrations/kaiterra.markdown +++ b/source/_integrations/kaiterra.markdown @@ -15,7 +15,7 @@ ha_platforms: The `kaiterra` integration allows you to view the readings from your Laser Egg or Sensedge device using the [Kaiterra REST API](https://www.kaiterra.com/dev/). -To use the integration, you need to get the API key by signing up at [Kaiterra dashboard](https://dashboard.kaiterra.cn/), registring the device and create the key under `Settings -> Profile -> Developer`. +To use the integration, you need to get the API key by signing up at [Kaiterra dashboard](https://dashboard.kaiterra.cn/), registering the device and create the key under `Settings -> Profile -> Developer`. ## Configuration diff --git a/source/_integrations/keyboard_remote.markdown b/source/_integrations/keyboard_remote.markdown index b119368b3a8..49a193f1b26 100644 --- a/source/_integrations/keyboard_remote.markdown +++ b/source/_integrations/keyboard_remote.markdown @@ -97,7 +97,7 @@ automation: entity_id: light.all ``` -`device_descriptor` or `device_name` may be specificed in the trigger so the automation will be fired only for that keyboard. This is especially useful if you wish to use several Bluetooth remotes to control different devices. Omit them to ensure the same key triggers the automation for all keyboards/remotes. +`device_descriptor` or `device_name` may be specified in the trigger so the automation will be fired only for that keyboard. This is especially useful if you wish to use several Bluetooth remotes to control different devices. Omit them to ensure the same key triggers the automation for all keyboards/remotes. ## Disconnections diff --git a/source/_integrations/lannouncer.markdown b/source/_integrations/lannouncer.markdown index 6659329cbb4..9c7cf4b5f24 100644 --- a/source/_integrations/lannouncer.markdown +++ b/source/_integrations/lannouncer.markdown @@ -59,7 +59,7 @@ Spoken messages is the default method (`speak`). You just invoke the `notify` se } ``` -The second method is to play notifications (`alarm`). There are 4 build-in sounds (`chime`, `doorbell`, `alarm` and `siren`). +The second method is to play notifications (`alarm`). There are 4 built-in sounds (`chime`, `doorbell`, `alarm` and `siren`). ```json { diff --git a/source/_integrations/lcn.markdown b/source/_integrations/lcn.markdown index 7b165df86b2..09bc96b1ef2 100644 --- a/source/_integrations/lcn.markdown +++ b/source/_integrations/lcn.markdown @@ -627,7 +627,7 @@ data: ```
- Ensure that the LCN module is configured properly to provide acces to the defined variable. + Ensure that the LCN module is configured properly to provide access to the defined variable. Otherwise the module might show unexpected behaviors or return error messages.
diff --git a/source/_integrations/light.markdown b/source/_integrations/light.markdown index a77cf71bb23..03a0f492050 100644 --- a/source/_integrations/light.markdown +++ b/source/_integrations/light.markdown @@ -22,7 +22,7 @@ profile,color_x,color_y,brightness,transition The field transition is optional and can be omitted. -The `.default` suffix should be added to the entity identifier of each light to define a default value, e.g., for `light.ceiling_2` the `profile` field is `light.ceiling_2.default`. To define a default for all lights, the identifier `group.all_lights.default` can be used. Individual settings always supercede the `all_lights` default setting. +The `.default` suffix should be added to the entity identifier of each light to define a default value, e.g., for `light.ceiling_2` the `profile` field is `light.ceiling_2.default`. To define a default for all lights, the identifier `group.all_lights.default` can be used. Individual settings always supersede the `all_lights` default setting.
diff --git a/source/_integrations/mycroft.markdown b/source/_integrations/mycroft.markdown index 5ad0a625be1..4bd8ff58b46 100644 --- a/source/_integrations/mycroft.markdown +++ b/source/_integrations/mycroft.markdown @@ -54,7 +54,7 @@ name: ## Examples -Send a mesage to Mycroft by calling `notify.mycroft` service: +Send a message to Mycroft by calling `notify.mycroft` service: ```yaml message: "Hey Mycroft. Turn on the office light. " diff --git a/source/_integrations/neato.markdown b/source/_integrations/neato.markdown index ba317ac98cb..e56db785c09 100644 --- a/source/_integrations/neato.markdown +++ b/source/_integrations/neato.markdown @@ -125,7 +125,7 @@ Some information about the capabilities might be found on the [Neato Developer P Try to restart the vacuum and wait about 5 minutes to see if it is no longer unavailable. If you are still having issues check the Neato app and make sure your robot is connected and working. If it is not then follow the steps in the app to reset your robot and give it the same name as before then restart Home Assistant. -### My robot is not deteced by Home Assistant +### My robot is not detected by Home Assistant Please check your logs if there are any warnings. When there is a message about your robot being offline, check if it is connected to the internet and available though the app. If there is a message about a bad response, try to reset this robot via your app. diff --git a/source/_integrations/nest.markdown b/source/_integrations/nest.markdown index f7080e34058..e1412846b84 100644 --- a/source/_integrations/nest.markdown +++ b/source/_integrations/nest.markdown @@ -182,7 +182,7 @@ project_id: required: false type: string subscriber_id: - description: Full path for the Pub/sub Subscription ID used to receive events. This is required to use the SDM API. Enter this exactly as it appers under "Subscription name" in the [Pub/Sub console](https://console.cloud.google.com/cloudpubsub/subscription/list). + description: Full path for the Pub/sub Subscription ID used to receive events. This is required to use the SDM API. Enter this exactly as it appears under "Subscription name" in the [Pub/Sub console](https://console.cloud.google.com/cloudpubsub/subscription/list). type: string required: false {% endconfiguration %} diff --git a/source/_integrations/nfandroidtv.markdown b/source/_integrations/nfandroidtv.markdown index ecedc42a4c3..88aadaad5d8 100644 --- a/source/_integrations/nfandroidtv.markdown +++ b/source/_integrations/nfandroidtv.markdown @@ -10,7 +10,7 @@ ha_platforms: - notify --- -Notification platform for [Notifications for Android TV](https://play.google.com/store/apps/details?id=de.cyberdream.androidtv.notifications.google) and [Notifications for FireTV](https://play.google.com/store/apps/details?id=de.cyberdream.firenotifications.google). You can use this plarform to send notifications to your Android TV device. An overlay with the message content will appear for a configurable amount of seconds and then disapper again. Sending images (e.g., security cam) is supported too. +Notification platform for [Notifications for Android TV](https://play.google.com/store/apps/details?id=de.cyberdream.androidtv.notifications.google) and [Notifications for FireTV](https://play.google.com/store/apps/details?id=de.cyberdream.firenotifications.google). You can use this plarform to send notifications to your Android TV device. An overlay with the message content will appear for a configurable amount of seconds and then disappear again. Sending images (e.g., security cam) is supported too. The notifications are in the global scope of your Android TV device. They will be displayed regardless of which application is running. diff --git a/source/_integrations/nilu.markdown b/source/_integrations/nilu.markdown index 5e8c1a0e1aa..3fa338d5d80 100644 --- a/source/_integrations/nilu.markdown +++ b/source/_integrations/nilu.markdown @@ -55,7 +55,7 @@ show_on_map: type: boolean {% endconfiguration %} -## Health risk index explainations +## Health risk index explanations Under the attributes from a NILU station, there will be a `nilu pollution index`. This indicates how polluted the air is in the area around the sensor station. Following is a longer explanation of what the indexes mean. @@ -75,7 +75,7 @@ Health effects may occur in asthmatics and people with other respiratory disease Sensitive groups in the population can have health effects. Respiratory irritation and discomfort may occur in healthy subjects. People with heart or respiratory distress should reduce outdoor activity and not stay in the most polluted areas. -Source: [Explainations in Norwegian](http://www.luftkvalitet.info/home/Varslingsklasser.aspx) +Source: [Explanations in Norwegian](http://www.luftkvalitet.info/home/Varslingsklasser.aspx) ## Available areas diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown index 22ce907a248..7168d78b647 100644 --- a/source/_integrations/onvif.markdown +++ b/source/_integrations/onvif.markdown @@ -77,6 +77,6 @@ If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your ca | `speed` | Speed coefficient. Sets how fast PTZ will be executed. Allowed values: floating point numbers, 0 to 1. Default : 0.5 | | `preset` | PTZ preset profile token. Sets the preset profile token which is executed with GotoPreset. | | `move_mode` | PTZ moving mode. Allowed values: `ContinuousMove`, `RelativeMove`, `AbsoluteMove`, `GotoPreset`, `Stop`. Default :`RelativeMove` | -| `continuous_duration` | Set ContinuousMove delay in seconds before stoping the move. Allowed values: floating point numbers or integer. Default : 0.5 | +| `continuous_duration` | Set ContinuousMove delay in seconds before stopping the move. Allowed values: floating point numbers or integer. Default : 0.5 | If you are running into trouble with this sensor, please refer to the [Troubleshooting section](/integrations/ffmpeg/#troubleshooting). diff --git a/source/_integrations/osramlightify.markdown b/source/_integrations/osramlightify.markdown index 90172db4d11..cefceeee73f 100644 --- a/source/_integrations/osramlightify.markdown +++ b/source/_integrations/osramlightify.markdown @@ -62,7 +62,7 @@ Also for sensors a list of raw values is exposed as `sensor_values` attribute, a in automations, if you know what particular values mean for your sensor. It is suggested to make [scan_interval](/docs/configuration/platform_options/#scan-interval) -(30 seconds by default) less or equal to `interval_lightify_status`, oherwise the latter won't work +(30 seconds by default) less or equal to `interval_lightify_status`, otherwise the latter won't work as expected. Shorter `scan_interval` may improve synchronization speed between individual lights and groups. For example, if you turn on a group, all its lights may be updated to `on` immediately, without querying the bridge. diff --git a/source/_integrations/plex.markdown b/source/_integrations/plex.markdown index 455e1ecb400..b33e71dd3ab 100644 --- a/source/_integrations/plex.markdown +++ b/source/_integrations/plex.markdown @@ -57,7 +57,7 @@ Alternatively, you can manually configure a Plex server connection by selecting **Verify SSL certificate**: Verify the SSL certificate of your Plex server. May be used if connecting with an IP or if using a self-signed certificate. -**Token**: A valid authorization token for your Plex server. If provided without 'Host', a connection URL will be retreived from Plex. +**Token**: A valid authorization token for your Plex server. If provided without 'Host', a connection URL will be retrieved from Plex. ## Sensor diff --git a/source/_integrations/point.markdown b/source/_integrations/point.markdown index d18a7b7e8db..af0e199e6f1 100644 --- a/source/_integrations/point.markdown +++ b/source/_integrations/point.markdown @@ -68,7 +68,7 @@ Each home configured in the Point mobile application will show up as a separate
-The Point only supports a Arm/Disarm action, so it is only `Arm Away` that is implememented. +The Point only supports a Arm/Disarm action, so it is only `Arm Away` that is implemented.
diff --git a/source/_integrations/rejseplanen.markdown b/source/_integrations/rejseplanen.markdown index dec099121d1..471b58da69a 100644 --- a/source/_integrations/rejseplanen.markdown +++ b/source/_integrations/rejseplanen.markdown @@ -162,7 +162,7 @@ The sensor can filter the timetables by one or more routes, directions and types | `type` | Transport type | | `route` | Route code | | `direction` | Destination stop | -| `final_stop` | Final stop (if departure doesn't go all the way to the destionation stop) | +| `final_stop` | Final stop (if departure doesn't go all the way to the destination stop) | | `stop` | Departure stop | | `stop_id` | ID of departure stop | | `track` | Departure track (if available) | @@ -180,6 +180,6 @@ The sensor can filter the timetables by one or more routes, directions and types | `type` | Transport type | | `route` | Route code | | `direction` | Destination stop | -| `final_stop` | Final stop (if departure doesn't go all the way to the destionation stop) | +| `final_stop` | Final stop (if departure doesn't go all the way to the destination stop) | | `stop` | Departure stop | | `track` | Departure track (if available) | diff --git a/source/_integrations/risco.markdown b/source/_integrations/risco.markdown index ff59522dd6d..db4261fa444 100644 --- a/source/_integrations/risco.markdown +++ b/source/_integrations/risco.markdown @@ -94,7 +94,7 @@ This undoes a zone bypass. You can only unbypass a zone when the partitions it b | ---------------------- | -------- | ----------- | | `entity_id` | no | String or list of strings of entity_ids of zones. Use entity_id: all to target all zones. | -## Supported Plaforms: +## Supported Platforms: - [Alarm Control Panel](/integrations/alarm_control_panel/) - [Binary Sensor](/integrations/binary_sensor/) diff --git a/source/_integrations/roon.markdown b/source/_integrations/roon.markdown index 34f11e9ca39..7778baf681b 100644 --- a/source/_integrations/roon.markdown +++ b/source/_integrations/roon.markdown @@ -36,7 +36,7 @@ Roon uses a path based on the roon browser hierarchy to specify which media to p | -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | yes | Target a specific media player. To target all media players, use `all`. | | `media_content_id` | no | A path to specify the media you want to play, see examples below. | -| `media_content_type` | no | Only `music` is suppported | +| `media_content_type` | no | Only `music` is supported | For example to play the album Harvest by Neil Young you should set `media_content_id` to `Library/Artists/Neil Young/Harvest` and to play BBC Radio 4 you would set `media_content_id` to `My Live Radio/BBC Radio 4` diff --git a/source/_integrations/satel_integra.markdown b/source/_integrations/satel_integra.markdown index 21aba110246..5e43e9075cc 100644 --- a/source/_integrations/satel_integra.markdown +++ b/source/_integrations/satel_integra.markdown @@ -27,7 +27,7 @@ The module communicates via Satel's open TCP protocol published on their website ## Setup -Please note that **ETHM-1 module is currently not supported**: it does not provide functionality used by this extension. At the moment only ETHM-1 Plus module is supported. That might change in the future, but no promisses are given. +Please note that **ETHM-1 module is currently not supported**: it does not provide functionality used by this extension. At the moment only ETHM-1 Plus module is supported. That might change in the future, but no promises are given. The library currently doesn't support encrypted connection to your alarm, so you need **to turn off encryption for integration protocol**. In Polish: "koduj integracje" must be unchecked. You will find this setting in your DloadX program. diff --git a/source/_integrations/sensehat.markdown b/source/_integrations/sensehat.markdown index f2adbcc264c..6f7a303f250 100644 --- a/source/_integrations/sensehat.markdown +++ b/source/_integrations/sensehat.markdown @@ -60,7 +60,7 @@ display_options: pressure: description: Pressure name: - description: Change the name of te sensor, for in the frontend. + description: Change the name of the sensor, for in the frontend. required: false type: string is_hat_attached: diff --git a/source/_integrations/sma.markdown b/source/_integrations/sma.markdown index 2d49261db2f..f57ebda9534 100644 --- a/source/_integrations/sma.markdown +++ b/source/_integrations/sma.markdown @@ -98,7 +98,7 @@ The SMA WebConnect module supports a wide variety of sensors, but not all of the | power_l2 | W | Power for phase 2 | | power_l3 | W | Power for phase 3 | -### Batery Inverter +### Battery Inverter | name | Unit | Description | | --- | --- | --- | diff --git a/source/_integrations/smarthab.markdown b/source/_integrations/smarthab.markdown index a915b374f31..2c1df153afe 100644 --- a/source/_integrations/smarthab.markdown +++ b/source/_integrations/smarthab.markdown @@ -27,5 +27,5 @@ Assistant. To prevent being automatically logged out of your SmartHab mobile app, you might want to create a secondary user in the app's settings and grant it access to your home. You can then configure the integration using this account's - credentials. This is also more secure, as this user should be less priviledged. + credentials. This is also more secure, as this user should be less privileged.
diff --git a/source/_integrations/synology_dsm.markdown b/source/_integrations/synology_dsm.markdown index ee9bcff7a68..ca0dc7a18a5 100644 --- a/source/_integrations/synology_dsm.markdown +++ b/source/_integrations/synology_dsm.markdown @@ -28,7 +28,7 @@ The Synology DSM sensor platform provides access to various statistics from your This sensor will wake up your Synology NAS if it's in hibernation mode. -You can change the scan interal within the configuration options (default is 15 min). +You can change the scan interval within the configuration options (default is 15 min). Having cameras or the Home mode toggle from [Surveillance Station](https://www.synology.com/en-us/surveillance) will fetch every 30 seconds. Disable those entities if you don't want your NAS to be fetch as frequently. diff --git a/source/_integrations/tado.markdown b/source/_integrations/tado.markdown index 169f076aebf..d33d93db612 100644 --- a/source/_integrations/tado.markdown +++ b/source/_integrations/tado.markdown @@ -140,7 +140,7 @@ You can use the service `tado.set_water_heater_timer` to set your water heater t ### Service `tado.set_climate_temperature_offset` -You can use the service `tado.set_climate_temperature_offset` to set the temprature offset for Tado climate devices +You can use the service `tado.set_climate_temperature_offset` to set the temperature offset for Tado climate devices. | Service data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------------------------- | @@ -170,7 +170,7 @@ script: {% raw %} ```yaml -# Example automation to set temprature offset based on another thermostat value +# Example automation to set temperature offset based on another thermostat value automation: # Trigger if the state of either thermostat changes trigger: diff --git a/source/_integrations/traccar.markdown b/source/_integrations/traccar.markdown index d421164b881..d3d571bf202 100644 --- a/source/_integrations/traccar.markdown +++ b/source/_integrations/traccar.markdown @@ -70,7 +70,7 @@ max_accuracy: type: integer default: 0 skip_accuracy_filter_on: - description: Skip filter position by "max_accuracy filter" if any of specified attributes are pressent on the traccar message. + description: Skip filter position by "max_accuracy filter" if any of specified attributes are present on the traccar message. required: false type: list monitored_conditions: diff --git a/source/_integrations/weather.template.markdown b/source/_integrations/weather.template.markdown index 50235f8b044..295485397b6 100644 --- a/source/_integrations/weather.template.markdown +++ b/source/_integrations/weather.template.markdown @@ -13,7 +13,7 @@ The `template` integrations creates weather provider that combines integrations There are several powerful ways to use this integration, including localizing your weather provider information with local information from temperature, humidity, pressure sensors that you own. -Another use case could be using temperature and humidity from one weather plaform, with forecasts from a different one. +Another use case could be using temperature and humidity from one weather platform, with forecasts from a different one. ## Configuration diff --git a/source/_integrations/xiaomi_miio.markdown b/source/_integrations/xiaomi_miio.markdown index 05739174f99..09260d7bde8 100644 --- a/source/_integrations/xiaomi_miio.markdown +++ b/source/_integrations/xiaomi_miio.markdown @@ -54,7 +54,7 @@ Please read the linked sections for those devices for more information. It is recommend to supply your Xiaomi cloud credentials during configuration to automatically connect to your devices. You need to specify the cloud server -you used in the Xiaomi Home App (where you initialy setup the device). There are +you used in the Xiaomi Home App (where you initially setup the device). There are 6 servers: `cn`, `de`, `i2`, `ru`, `sg` and `us`; please see [this page](https://www.openhab.org/addons/bindings/miio/#country-servers) for the server to use for each country. @@ -1244,7 +1244,7 @@ Allowed `params` for the `reset_consumable` command: [RRCC](https://github.com/LazyT/rrcc) supports both rooted and non-rooted Vacuums and acts as a mostly fully featured replacement for Mi Home that works locally without the cloud. If you have installed the rooted firmware [Valetudo](https://github.com/Hypfer/Valetudo) you are able to SSH into your Vacuum and enable MQTT plus use map functions with no cloud requirement. -Using the map editor you are able to acquire the co-ordinates required for zoned clean up. Here is an example script for zoned clean up: +Using the map editor you are able to acquire the coordinates required for zoned clean up. Here is an example script for zoned clean up: ```yaml vacuum_kitchen: @@ -1269,7 +1269,7 @@ miiocli vacuum --ip --token get_room_mapp It will return the full mapping of room numbers to user-defined names as a list of (number,name) tuples. Alternatively, one can just test the clean_segment service with a number and see which room it cleans. -It seems to be the case that Numbers 1..15 are used to number the intitial segmentation done by the vacuum cleaner itself. Numbers 16 and upwards numbers rooms from the users manual editing. +It seems to be the case that Numbers 1..15 are used to number the initial segmentation done by the vacuum cleaner itself. Numbers 16 and upwards numbers rooms from the users manual editing. ## Xiaomi Philips Light diff --git a/source/_integrations/xmpp.markdown b/source/_integrations/xmpp.markdown index 84e847e0a94..f5d8b955c67 100644 --- a/source/_integrations/xmpp.markdown +++ b/source/_integrations/xmpp.markdown @@ -204,6 +204,6 @@ Number 6 sends an image from a templated URL. {% endraw %} -The possible source of a file is prioritized and only one will be picked up. `url_template` has the hightest priority; next is `url` then `path_template` and finally if none of them are defined `path` would be used. `path` will be used to eliminate file extension guessing for unknown URL downloads. Only the file extension will be left, as Home Assistant changes the filename to a random string for added privacy. +The possible source of a file is prioritized and only one will be picked up. `url_template` has the highest priority; next is `url` then `path_template` and finally if none of them are defined `path` would be used. `path` will be used to eliminate file extension guessing for unknown URL downloads. Only the file extension will be left, as Home Assistant changes the filename to a random string for added privacy. To find out more about notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown index 7f03fc798da..7dbaa6f43ac 100644 --- a/source/_integrations/zha.markdown +++ b/source/_integrations/zha.markdown @@ -339,7 +339,7 @@ To help resolve any kinks or compatibility problems, report bugs as issues with There is no official compatibility list of supported devices for the simple reason that practically all devices Zigbee Home Automation that are fully compliant with the standards and specifications as set by the [Zigbee Alliance](https://zigbeealliance.org) should technically be compatible with this ZHA integration. The fact remains, however, that some hardware manufacturers do not always fully comply with each set specification, which can cause a few devices to only partially work or not work at all with ZHA, but developers can create workarounds for such issues via a solution for 'ZHA exception and deviation handling' that this implementation features. See that section for more information. -Tip to new users is that, while there is no official list of supported devices, some ZHA users take comfort that blakadder maintains an unofficial Zigbee Device Compatibility Repository which anyone can submit compatibility reports to, it can be found at [zigbee.blakadder.com](https://zigbee.blakadder.com) and currently contains independent compatibility lists and device pairing tips for several home automation gateway/bridge/hub softwares, including but not limited to open source Zigbee implementations such as; ZHA, Tasmota, Zigbee2MQTT, and ZiGate. +Tip to new users is that, while there is no official list of supported devices, some ZHA users take comfort that blakadder maintains an unofficial Zigbee Device Compatibility Repository which anyone can submit compatibility reports to, it can be found at [zigbee.blakadder.com](https://zigbee.blakadder.com) and currently contains independent compatibility lists and device pairing tips for several home automation gateway/bridge/hub software, including but not limited to open source Zigbee implementations such as; ZHA, Tasmota, Zigbee2MQTT, and ZiGate. ### ZHA exception and deviation handling diff --git a/source/_integrations/zwave_js.markdown b/source/_integrations/zwave_js.markdown index 3641ba228d0..e7a955f1930 100644 --- a/source/_integrations/zwave_js.markdown +++ b/source/_integrations/zwave_js.markdown @@ -613,7 +613,7 @@ Z-Wave JS keeps a database of all devices it supports, including any special tre ### I get a lot of sensor entities for my device that I'm probably never going to use -The integration will add as many useable entities for you as possible from the information it retrieves from your Z-Wave devices. Entities that you don't want/like, can be disabled within the Home Assistant interface. +The integration will add as many usable entities for you as possible from the information it retrieves from your Z-Wave devices. Entities that you don't want/like, can be disabled within the Home Assistant interface. ### I renamed my devices in Z-Wave JS 2 MQTT but those names are not visible in Home Assistant diff --git a/source/help/reporting_issues.markdown b/source/help/reporting_issues.markdown index 9c2aa22eb1b..b8fb0de1f50 100644 --- a/source/help/reporting_issues.markdown +++ b/source/help/reporting_issues.markdown @@ -48,7 +48,7 @@ Make sure that you don't post your username, password, API key, access token or ### Traceback (if applicable) -If things go wrong there will be a so-called traceback or an error message in other words in your log. Please include this. It starts with **Traceback** and can contain informations where the error was triggered in the code. +If things go wrong there will be a so-called traceback or an error message in other words in your log. Please include this. It starts with **Traceback** and can contain information where the error was triggered in the code. ```bash Traceback (most recent call last): From b559539b531b5987a3f8443c9c1692addcddae6c Mon Sep 17 00:00:00 2001 From: starkillerOG Date: Sat, 24 Jul 2021 00:44:45 +0200 Subject: [PATCH 24/38] Add Brel Home to supported brands for motion blinds (#18591) --- source/_integrations/motion_blinds.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/motion_blinds.markdown b/source/_integrations/motion_blinds.markdown index fefba158ed2..41a39649190 100644 --- a/source/_integrations/motion_blinds.markdown +++ b/source/_integrations/motion_blinds.markdown @@ -21,6 +21,7 @@ Additionally the following brands have been reported to also work with this inte - [Motion Blinds](https://motion-blinds.com) - [Dooya](http://www.dooya.com/) - [Bloc Blinds](https://www.blocblinds.com/) +- [Brel Home](https://www.brel-home.nl/) {% include integrations/config_flow.md %} From adafb29f8da5e1088aad02f94958342d799252e5 Mon Sep 17 00:00:00 2001 From: Raman Gupta <7243222+raman325@users.noreply.github.com> Date: Sat, 24 Jul 2021 15:46:22 -0400 Subject: [PATCH 25/38] Add how to disable auto polling to google and waze travel docs (#18597) --- source/_integrations/google_travel_time.markdown | 4 ++++ source/_integrations/waze_travel_time.markdown | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/source/_integrations/google_travel_time.markdown b/source/_integrations/google_travel_time.markdown index 15c9e41feef..2e567249ef8 100644 --- a/source/_integrations/google_travel_time.markdown +++ b/source/_integrations/google_travel_time.markdown @@ -23,6 +23,10 @@ A quota can be set against the API to avoid exceeding the free credit amount. Se {% include integrations/config_flow.md %} +## Manual Polling + +Using automatic polling can lead to calls that exceed your API limit, especially when you are tracking multiple travel times using the same API key. To use more granular polling, disable automated polling in your config entry's System Options. To manually trigger a polling request, call the [`homeassistant.update_entity` service](/integrations/homeassistant/#service-homeassistantupdate_entity) as needed, either manually or via automations. + ## Dynamic Configuration Tracking can be setup to track entities of type `device_tracker`, `zone`, `sensor` and `person`. If an entity is placed in the Origin or Destination then every 5 minutes when the platform updates it will use the latest location of that entity. diff --git a/source/_integrations/waze_travel_time.markdown b/source/_integrations/waze_travel_time.markdown index 55cb247b429..88e1e177185 100644 --- a/source/_integrations/waze_travel_time.markdown +++ b/source/_integrations/waze_travel_time.markdown @@ -22,6 +22,10 @@ Notes: - The string inputs for `Substring *` allow you to force the integration to use a particular route or avoid a particular route in its time travel calculation. These inputs are case insensitive matched against the description of the route. - When using the `Avoid Toll Roads?`, `Avoid Subscription Roads?` and `Avoid Ferries?` options be aware that Waze will sometimes still route you over toll roads or ferries if a valid vignette/subscription is assumed. Default behavior is that Waze will route you over roads having subscription options, so best is to set both `Avoid Toll Roads?` and `Avoid Subscription Roads?` or `Avoid Ferries?` if needed and experiment to ensure the desired outcome. +## Manual Polling + +Some users will want to have more control over polling frequencies. To use more granular polling, disable automated polling in your config entry's System Options. To manually trigger a polling request, call the [`homeassistant.update_entity` service](/integrations/homeassistant/#service-homeassistantupdate_entity) as needed, either manually or via automations. + ## Example using dynamic destination Using the flexible option to set a sensor value to the `Destination`, you can setup a single Waze integration that will calculate travel time to multiple optional locations on demand. From 0da413743c04983286f9b397c7f9544116443ebd Mon Sep 17 00:00:00 2001 From: Allen Porter Date: Sat, 24 Jul 2021 13:13:29 -0700 Subject: [PATCH 26/38] Improvements for nest documentation based on recent user issues (#18599) Co-authored-by: Franck Nijhof --- source/_integrations/nest.markdown | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/source/_integrations/nest.markdown b/source/_integrations/nest.markdown index e1412846b84..e70ae145fee 100644 --- a/source/_integrations/nest.markdown +++ b/source/_integrations/nest.markdown @@ -35,6 +35,10 @@ There is currently support for the following device types within Home Assistant: This integration supports two Nest APIs. The SDM API is the new primary API that accepts new users. The Legacy Works With Nest API is not accepting new users, but the documentation still exists at the bottom of the page so existing users can keep using it. +Google applies strict [Redirect URI validation +rules](https://developers.google.com/identity/protocols/oauth2/web-server#uri-validation) to keep your login +credentials secure. In practice, this means that you must access Home Assistant *over SSL* and a *public top-level domain*. See the documentation on [Securing](/docs/configuration/securing/) or [Troubleshooting](#troubleshooting), and note that you don't need actually need to enable remote access. + ## Overview: Supported Devices Home Assistant is integrated with the following devices through the SDM API: @@ -247,8 +251,8 @@ everything, however, you can leave out any feature you do not wish to use with H domain (such as .com or .org)* or *must use a valid domain that is a valid top private domain*. This means that you may need to change the URL you use to access Home Assistant in order to access your devices. - - A convienent solution is to use [Nabu Casa](https://www.nabucasa.com/) - - There are subtle rules for what types of URLs are allowed, namely that they must use a publicly known hostname, though your Home Assistant ports do not need to be exposed to the internet. + - See [Securing](https://www.home-assistant.io/docs/configuration/securing/) Home Assistant for convient solutions e.g. [Nabu Casa](https://www.nabucasa.com/) or Duck DNS. + - There are subtle [rules](https://developers.google.com/identity/protocols/oauth2/web-server#uri-validation) for what types of URLs are allowed, namely that they must use SSL and a publicly known hostname, though your Home Assistant ports do not need to be exposed to the internet. - You can use any publicly known hostname you own - As a hack, you can use hosts tricks to temporarily assign a public hostname to your Home Assistant IP address. @@ -275,13 +279,14 @@ logger: homeassistant.components.nest.climate_sdm: debug homeassistant.components.nest.camera_sdm: debug homeassistant.components.nest.sensor_sdm: debug + homeassistant.helpers.config_entry_flow: debug + homeassistant.helpers.config_entry_oauth2_flow: debug google_nest_sdm: debug google_nest_sdm.device: debug google_nest_sdm.device_manager: debug google_nest_sdm.google_nest_subscriber: debug google_nest_sdm.event: debug google.cloud.pubsub_v1: debug - google.cloud.pubsub_v1.subscriber._protocol.streaming_pull_manager: debug ``` ## Camera From 30b59ccf5f8f2120f052ae8157fa0542c8c03ed6 Mon Sep 17 00:00:00 2001 From: avee87 Date: Sat, 24 Jul 2021 21:52:47 +0100 Subject: [PATCH 27/38] Fixed typo in Select entity documentation (#18601) --- source/_integrations/select.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/select.markdown b/source/_integrations/select.markdown index 59b80505e94..25f44253ab0 100644 --- a/source/_integrations/select.markdown +++ b/source/_integrations/select.markdown @@ -16,7 +16,7 @@ a limited set of selectable options for the entity. ### Services -The Number entities registers the following services: +The Select entities registers the following services: | Service | Data | Description | | ------- | ---- | ----------- | From d6053287e993a8c660613dc24096f57b9629abc2 Mon Sep 17 00:00:00 2001 From: Josh Moore Date: Sun, 25 Jul 2021 21:28:22 -0600 Subject: [PATCH 28/38] Added header for "Reverse proxies" section (#18614) Having a dedicated header for information on reverse proxies will aid users who may have missed the breaking change in 2021.7 (see https://github.com/home-assistant/core/pull/51839). I also put mimicked the `trusted_proxies` list from the sample config for clarity, and left comments for users who may still be unsure. --- source/_integrations/http.markdown | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/_integrations/http.markdown b/source/_integrations/http.markdown index 8c09417060d..2578418472a 100644 --- a/source/_integrations/http.markdown +++ b/source/_integrations/http.markdown @@ -105,13 +105,16 @@ http: The [Set up encryption using Let's Encrypt](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) blog post gives you details about the encryption of your traffic using free certificates from [Let's Encrypt](https://letsencrypt.org/). +## Reverse proxies + When using a reverse proxy, you will need to enable the `use_x_forwarded_for` and `trusted_proxies` options. Requests from reverse proxies will be blocked if these options are not set. ```yaml http: use_x_forwarded_for: true trusted_proxies: - - 172.30.33.0/24 # Add the IP address of the proxy server + - 10.0.0.200 # Add the IP address of the proxy server + - 172.30.33.0/24 # You may also provide the subnet mask ``` ## APIs From 9bd32c7567d177c4812651ede6b408403eddb34a Mon Sep 17 00:00:00 2001 From: Chris Browet Date: Mon, 26 Jul 2021 10:23:41 +0200 Subject: [PATCH 29/38] Fix webhook trigger.json example (#18613) As it is, the curl sample, without data, actually generates a ``` json.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0) ``` --- source/_docs/automation/trigger.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown index 575940fb076..50fc254e8c1 100644 --- a/source/_docs/automation/trigger.markdown +++ b/source/_docs/automation/trigger.markdown @@ -667,7 +667,7 @@ automation: You can run this automation by sending an HTTP POST request to `http://your-home-assistant:8123/api/webhook/some_hook_id`. Here is an example using the **curl** command line program, with an empty data payload: ```shell -curl -X POST https://your-home-assistant:8123/api/webhook/some_hook_id +curl -X POST -d '{ "key": "value"}' https://your-home-assistant:8123/api/webhook/some_hook_id ``` Webhook endpoints don't require authentication, other than knowing a valid webhook ID. You can send a data payload, either as encoded form data or JSON data. The payload is available in an automation template as either `trigger.json` or `trigger.data`. URL query parameters are available in the template as `trigger.query`. Remember to use an HTTPS URL if you've secured your Home Assistant installation with SSL/TLS. From b4efa02eb03f4ea9660adbe1b8d14e86b455b4a9 Mon Sep 17 00:00:00 2001 From: quaec Date: Mon, 26 Jul 2021 10:52:43 +0200 Subject: [PATCH 30/38] Fixed small errors in cast.markdown (#18609) Added a missing comma and a type in the script example. --- source/_integrations/cast.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_integrations/cast.markdown b/source/_integrations/cast.markdown index 0352f91d420..30f8f2b07ac 100644 --- a/source/_integrations/cast.markdown +++ b/source/_integrations/cast.markdown @@ -32,14 +32,14 @@ Ignore CEC: ## Home Assistant Cast -Home Assistant has its own Cast application to show the Home Assistant UI on any Chromecast device. You can use it by adding the [Cast entity row](/lovelace/entities/#cast) to your Lovelace UI, or by calling the `cast.show_lovelace_view` service. The service takes the path of a Lovelace view and an entity ID of a Cast device to show the view on. A `path` has to be defined in your Lovelace YAML for each view, as outlined in the [views documentation](/lovelace/views/#path). The `dashboard_path` is the part of the Lovelace UI URL that follows the defined `base_url` Typically "lovelace". The following is a full configuration for a script that starts casting the `downstairs` tab of the `lovelace-cast` path (note that `entity_id` is specified under `data` and not for the service call): +Home Assistant has its own Cast application to show the Home Assistant UI on any Chromecast device. You can use it by adding the [Cast entity row](/lovelace/entities/#cast) to your Lovelace UI, or by calling the `cast.show_lovelace_view` service. The service takes the path of a Lovelace view and an entity ID of a Cast device to show the view on. A `path` has to be defined in your Lovelace YAML for each view, as outlined in the [views documentation](/lovelace/views/#path). The `dashboard_path` is the part of the Lovelace UI URL that follows the defined `base_url`, typically "lovelace". The following is a full configuration for a script that starts casting the `downstairs` tab of the `lovelace-cast` path (note that `entity_id` is specified under `data` and not for the service call): ```yaml cast_downstairs_on_kitchen: alias: "Show Downstairs on kitchen" sequence: - data: - dashboard_path: lovelace + dashboard_path: lovelace-cast entity_id: media_player.kitchen view_path: downstairs service: cast.show_lovelace_view From a302a8948214305203623531959e803a434611fc Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Mon, 26 Jul 2021 11:13:55 +0200 Subject: [PATCH 31/38] Clean up device vs entity mixup in older documentation (#18555) --- source/_docs/configuration/devices.markdown | 29 ++++++++++++--------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/source/_docs/configuration/devices.markdown b/source/_docs/configuration/devices.markdown index 61e10fce226..e042d212dd7 100644 --- a/source/_docs/configuration/devices.markdown +++ b/source/_docs/configuration/devices.markdown @@ -3,16 +3,16 @@ title: "Adding devices to Home Assistant" description: "Steps to help you get your devices in Home Assistant." --- -Home Assistant will be able to automatically discover many devices and services available on your network if you have [the discovery component](/integrations/discovery/) enabled (the default setting). +Home Assistant will be able to automatically discover many devices and services +available on your network. -See the [integrations overview page](/integrations/) to find installation instructions for your devices and services. If you can't find support for your favorite device or service, [consider adding support](/developers/add_new_platform/). +See the [integrations overview page](/integrations/) to find installation +instructions for your devices and services. Most integration can be +fully configured via the user interface these days; however, some older or +more complex integrations may need to be configured manually using YAML. -Classification for the available integrations: - -- [IoT class](/blog/2016/02/12/classifying-the-internet-of-things): Classifier for the device's behavior. -- [Quality scale](/docs/quality_scale/): Representation of the integration's quality. - -Usually every entity needs its own entry in the `configuration.yaml` file. There are two styles for multiple entries: +For some of these integrations, every entity needs its own entry in the +`configuration.yaml` file. There are two styles for multiple entity entries: ## Style 1: Collect every entity under the "parent" @@ -32,9 +32,10 @@ switch: - platform: vera ``` -## Style 2: List each device separately +## Style 2: List each entity separately -You need to append numbers or strings to differentiate the entries, as in the example below. The appended number or string must be unique. +You need to append numbers or strings to differentiate the entries, as in the +example below. The appended number or string must be unique. ```yaml sensor bedroom: @@ -59,10 +60,12 @@ switch 2: platform: vera ``` -## Grouping devices +## Grouping entities -Once you have several devices set up, it is time to organize them into groups. -Each group consists of a name and a list of entity IDs. Entity IDs can be retrieved from the web interface by using the {% my developer_states title="States page in the Developer Tools" %}. +Once you have several entities set up, it is time to organize them into groups. +Each group consists of a name and a list of entity IDs. Entity IDs can be +retrieved from the web interface by using the +{% my developer_states title="States page in the Developer Tools" %}. ```yaml # Example configuration.yaml entry From 0c7bb747f72696dd246391bbccedf7b666c3e6e0 Mon Sep 17 00:00:00 2001 From: Christopher Loessl Date: Tue, 27 Jul 2021 11:16:51 +0200 Subject: [PATCH 32/38] docs(automation): clarify the importance of cross (#18628) --- source/_docs/automation/trigger.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown index 50fc254e8c1..df337556c4f 100644 --- a/source/_docs/automation/trigger.markdown +++ b/source/_docs/automation/trigger.markdown @@ -173,7 +173,7 @@ automation: ## Numeric state trigger -Fires when the numeric value of an entity's state (or attribute's value if using the `attribute` property) crosses a given threshold. On state change of a specified entity, attempts to parse the state as a number and fires if the value is changing from above to below or from below to above the given threshold. +Fires when the numeric value of an entity's state (or attribute's value if using the `attribute` property) **crosses** (and only when crossing) a given threshold. On state change of a specified entity, attempts to parse the state as a number and fires if the value is changing from above to below or from below to above the given threshold. {% raw %} From fc6aa38558cdf81a1f1c4b7c81ddbb34f5a51781 Mon Sep 17 00:00:00 2001 From: Milan Meulemans Date: Tue, 27 Jul 2021 14:15:50 +0200 Subject: [PATCH 33/38] Add select platform back to Rituals Perfume Genie (#18630) --- source/_integrations/rituals_perfume_genie.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/rituals_perfume_genie.markdown b/source/_integrations/rituals_perfume_genie.markdown index 8c09ff58b22..e750e7cfc45 100644 --- a/source/_integrations/rituals_perfume_genie.markdown +++ b/source/_integrations/rituals_perfume_genie.markdown @@ -16,6 +16,7 @@ ha_domain: rituals_perfume_genie ha_platforms: - binary_sensor - number + - select - sensor - switch --- From cccf1252ed400d96b336d9b3152bcd3953495386 Mon Sep 17 00:00:00 2001 From: Ofek Date: Wed, 28 Jul 2021 12:47:10 +0300 Subject: [PATCH 34/38] More recent Google Home linking instructions (#18589) This step took me a lot of time to understand, in "Set up a device" screen I was looking under `New device` rather than in `Works with Google` --- source/_integrations/google_assistant.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_integrations/google_assistant.markdown b/source/_integrations/google_assistant.markdown index 7ecb48b7d11..ce3d0b0e473 100644 --- a/source/_integrations/google_assistant.markdown +++ b/source/_integrations/google_assistant.markdown @@ -61,8 +61,8 @@ To use Google Assistant, your Home Assistant configuration has to be [externally 3. Select the `Develop` tab at the top of the page, then in the upper right hand corner select the `Test` button to generate the draft version Test App. If you don't see this option, go to the `Test` tab instead, click on the `Settings` button in the top right below the header, and ensure `On device testing` is enabled (if it isn't, enable it). 4. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#configuration) below. 5. Add services in the Google Home App (Note that app versions may be slightly different.) - 1. Open the Google Home app and go to `Settings`. - 2. Click `Add...`, `+ Set up or add`, `+ Set up device`, and click `Have something already setup?`. You should have `[test] your app name` listed under 'Add new'. Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms and nicknames for your devices if you wish. + 1. Open the Google Home app. + 2. Click the `+` button on the top left corner, click `Set up device`, in the "Set up a device" screen click "Works with Google". You should have `[test] ` listed under 'Add new'. Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms and nicknames for your devices if you wish.
From 24457f0055725684b87d6481872500c395774810 Mon Sep 17 00:00:00 2001 From: TheDK Date: Wed, 28 Jul 2021 11:55:04 +0200 Subject: [PATCH 35/38] Update bluetooth_tracker.markdown (#18433) Added info about conflicting entities, see this thread for more info: https://community.home-assistant.io/t/new-97-2-setup-bluetooth-device-tracker-does-nothing/133921/7 --- source/_integrations/bluetooth_tracker.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/_integrations/bluetooth_tracker.markdown b/source/_integrations/bluetooth_tracker.markdown index fc1c5cfb1e1..449eeeffaed 100644 --- a/source/_integrations/bluetooth_tracker.markdown +++ b/source/_integrations/bluetooth_tracker.markdown @@ -43,7 +43,9 @@ device_id: default: "`-1` (The first available Bluetooth adapter)" {% endconfiguration %} -In some cases it can be that your device is not discovered. In that case let your phone scan for Bluetooth devices while you restart Home Assistant. Just hit `Scan` on your phone all the time until Home Assistant is fully restarted and the device should appear in `known_devices.yaml`. +In some cases it can be that your device is not discovered. In that case let your phone scan for Bluetooth devices while you restart Home Assistant. Just hit `Scan` on your phone all the time (or keep the Bluetooth device view open on an iOS device) until Home Assistant is fully restarted and the device should appear in `known_devices.yaml`. + +The integration will try to create an entity using the device name that is detected. If such an entity already exists (for example because you are already using the [Companion App](https://companion.home-assistant.io/) for this device) no entity will be created and the log file will show an error that the `The see service is not supported for this entity device_tracker.device` (as it is not a `device_tracker` entity). You can rename the other conflicting entity, next time the device is detected a new entity with the same name will be created. For additional configuration variables check the [Device tracker page](/integrations/device_tracker/). From 955c9621e4ee259eaca0a250adbe546b71e2770b Mon Sep 17 00:00:00 2001 From: rishabmehta7 <45841886+rishabmehta7@users.noreply.github.com> Date: Wed, 28 Jul 2021 15:25:24 +0530 Subject: [PATCH 36/38] Update tuya.markdown (#18392) Doesn't support Bluetooth Hub as well --- source/_integrations/tuya.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/tuya.markdown b/source/_integrations/tuya.markdown index 2bceda32d1b..e6dfff48a5f 100644 --- a/source/_integrations/tuya.markdown +++ b/source/_integrations/tuya.markdown @@ -25,7 +25,7 @@ ha_platforms: ha_dhcp: true --- -The `tuya` integration is the main integration to integrate [Tuya Smart](https://www.tuya.com) related platforms, except the Zigbee hub. This includes devices linked with the Tuya, Smart Life, and Jinvoo Smart apps. You will need your account information (username, password and account country code) from one of these apps to discover and control devices which related to your account. +The `tuya` integration is the main integration to integrate [Tuya Smart](https://www.tuya.com) related platforms, except the Zigbee and Bluetooth(BLE) hub. This includes devices linked with the Tuya, Smart Life, and Jinvoo Smart apps. You will need your account information (username, password and account country code) from one of these apps to discover and control devices which related to your account. **Important**: Not all Tuya devices are supported by the `tuya API` used by this integration. For more details refer to [TuyaHA Library](https://github.com/PaulAnnekov/tuyaha). From 7bc737d1acf4ba786070da33a31f7595260f21fa Mon Sep 17 00:00:00 2001 From: J M H <81658305+jay-em-Ach@users.noreply.github.com> Date: Wed, 28 Jul 2021 02:57:28 -0700 Subject: [PATCH 37/38] Update the "I'm Locked Out" documentation for using a container CLI (#18109) * Update the "I'm Locked Out" documentation for using a container CLI ## Proposed change Added steps to change a lost password through the command line when Home Assistant is running in a container. Also added a note that the "Change Password" button does not always show up, but switching to another interface will likely show it (I learned that _after_ figuring out this whole `hass` process). Follow-up to unfinished #14477 by @hadim and https://community.home-assistant.io/t/reset-password-from-ha-docker-container/215537 ## Type of change * [ ] Spelling, grammar or other readability improvements (`current` branch). * [x] Adjusted missing or incorrect information in the current documentation (`current` branch). * [ ] Added documentation for a new integration I'm adding to Home Assistant (`next` branch). * [ ] I've opened up a PR to add logo's and icons in [Brands repository](https://github.com/home-assistant/brands). * [ ] Added documentation for a new feature I'm adding to Home Assistant (`next` branch). * [ ] Removed stale or deprecated documentation. ## Additional information * Link to parent pull request in the codebase: * Link to parent pull request in the Brands repository: * This PR fixes or closes issue: ## Checklist * [x] This PR uses the correct branch, based on one of the following: * [x] I made a change to the existing documentation and used the `current` branch. * [ ] I made a change that is related to an upcoming version of Home Assistant and used the `next` branch. * [x] The documentation follows the Home Assistant documentation [standards](https://developers.home-assistant.io/docs/documenting/standards). * Update instructions for a forgotten password - Moved the container command line instructions under the console instructions. - Used wording from the section introduction to rename the authentication reset instructions. - Removed mention of using a password manager since the user obviously did not (and HA has not been compatible with some password managers in some browser configurations recently). This is why I did not use one and why I had to figure out how to reset my password, then share the instructions with the community. --- source/_docs/locked_out.md | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index d2fba55b095..c1f0e47df63 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -21,15 +21,27 @@ Connect a keyboard and monitor to your device. `auth reset --username existing_user --password new_password` +#### To reset a user's password, via the container command line + +If you are running Home Assistant in a container, you can use the command line in the container with the `hass` command to change your password. The steps below refer to a Home Assistant container in Docker named `ha`. Note that while working in the container, commands will take a few moments to execute. + +1. `docker exec -it ha bash` to open to the container command line +2. `hass` to create a default user, if this is your first time using the tool +3. `hass --script auth --config /config change_password existing_user new_password` to change the password +4. `exit` to exit the container command line +5. `docker restart ha` to restart the container + #### To reset a user's password, as an administrator via the web interface -1. Click "Configuration" in the sidebar. -2. Scroll down to "Users", and click in to that section. -3. Click on the user, this should bring up a dialog box. -4. At the bottom of the dialog box, click "Change Password". -5. Enter the new password, and then click "OK". -6. Confirm the new password by entering it again, and then click "OK" again. -7. A confirmation box will be displayed with the text "Password was changed successfully". +1. Confirm that you have "Advanced Mode" activated on your "Profile" page. +2. Click "Configuration" in the sidebar. +3. Scroll down to "Users", and click in to that section. +4. Click on the user, this should bring up a dialog box. +5. At the bottom of the dialog box, click "Change Password". + - If you do not see the "Change Password" button, try using another interface, such as the mobile version. +6. Enter the new password, and then click "OK". +7. Confirm the new password by entering it again, and then click "OK" again. +8. A confirmation box will be displayed with the text "Password was changed successfully". #### To delete a user, as an administrator via the web interface @@ -40,9 +52,9 @@ Connect a keyboard and monitor to your device. 5. A confirmation dialog box will be displayed, asking "Are you sure you want to delete "? 6. Click "OK". -### Home Assistant Core and Home Assistant Container +#### Start a new onboarding process -While you should hopefully be storing your passwords in a password manager, if you lose the password associated with the owner account the only way to resolve this is to delete *all* the authentication data. You do this by shutting down Home Assistant and deleting the following files from the `.storage/` folder in your [configuration folder](/docs/configuration/): +If you lose the password associated with the owner account and the steps above do not work to reset the password, the only way to resolve this is to delete *all* the authentication data. You do this by shutting down Home Assistant and deleting the following files from the `.storage/` folder in your [configuration folder](/docs/configuration/): - `auth` - `auth_provider.homeassistant` From 8afee38e3e84feb8ed0f33818d871332ef780f8d Mon Sep 17 00:00:00 2001 From: RadekHvizdos <10856567+RadekHvizdos@users.noreply.github.com> Date: Wed, 28 Jul 2021 11:59:02 +0200 Subject: [PATCH 38/38] Add missing suggested_area information (#18477) Add missing information regarding suggested_area to MQTT number and select integrations --- source/_integrations/number.mqtt.markdown | 4 ++++ source/_integrations/select.mqtt.markdown | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/source/_integrations/number.mqtt.markdown b/source/_integrations/number.mqtt.markdown index 3b04612926f..0ad640b7af5 100644 --- a/source/_integrations/number.mqtt.markdown +++ b/source/_integrations/number.mqtt.markdown @@ -79,6 +79,10 @@ device: description: The name of the device. required: false type: string + suggested_area: + description: 'Suggest an area if the device isn’t in one yet.' + required: false + type: string sw_version: description: The firmware version of the device. required: false diff --git a/source/_integrations/select.mqtt.markdown b/source/_integrations/select.mqtt.markdown index b85c4417325..73229ce0eb0 100644 --- a/source/_integrations/select.mqtt.markdown +++ b/source/_integrations/select.mqtt.markdown @@ -83,6 +83,10 @@ device: description: The name of the device. required: false type: string + suggested_area: + description: 'Suggest an area if the device isn’t in one yet.' + required: false + type: string sw_version: description: The firmware version of the device. required: false