From 64cb50619d162fa4b7dba3cbac63ca71dbae69e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Tue, 19 Oct 2021 11:27:08 +0200 Subject: [PATCH 01/39] Rename unsupported reason container to software (#19857) --- source/_redirects | 1 + source/more-info/unhealthy/docker.markdown | 2 +- source/more-info/unsupported/container.markdown | 17 ----------------- source/more-info/unsupported/software.markdown | 14 ++++++++++++++ 4 files changed, 16 insertions(+), 18 deletions(-) delete mode 100644 source/more-info/unsupported/container.markdown create mode 100644 source/more-info/unsupported/software.markdown diff --git a/source/_redirects b/source/_redirects index e5ebf1c7564..59755bccdea 100644 --- a/source/_redirects +++ b/source/_redirects @@ -2124,6 +2124,7 @@ /cookbook /examples /common-tasks/os/#snapshots /common-tasks/os/#backups /common-tasks/supervised/#snapshots /common-tasks/supervised/#backups +/more-info/unsupported/container /more-info/unsupported/software # Migrated Community Guides /cookbook/apache_configuration https://community.home-assistant.io/t/reverse-proxy-with-apache/196942 diff --git a/source/more-info/unhealthy/docker.markdown b/source/more-info/unhealthy/docker.markdown index 8050c6255ca..dbef8e317d0 100644 --- a/source/more-info/unhealthy/docker.markdown +++ b/source/more-info/unhealthy/docker.markdown @@ -7,7 +7,7 @@ Docker is at the core of most operations that the Supervisor does, it is importa The Supervisor will be marked as unhealthy if any of these requirements are not met: -- [Running containers known to cause issues](/more-info/unsupported/container) +- [Running unsupported software](/more-info/unsupported/software) - [Running an unsupported Docker version](/more-info/unsupported/docker_version) - [Running the Supervisor under LXC](/more-info/unsupported/lxc) - [Not running the Supervisor as privileged](/more-info/unsupported/privileged) diff --git a/source/more-info/unsupported/container.markdown b/source/more-info/unsupported/container.markdown deleted file mode 100644 index 570f0ed747f..00000000000 --- a/source/more-info/unsupported/container.markdown +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "Containers known to cause issues" -description: "More information on why certain containers marks the installation as unsupported." ---- - -## The issue - -The Supervisor needs to be the only manager of the containers that it manages, unfortunately, some other containers also take on this role. Worst case, those will auto-update the existing containers to development builds without consideration of the channel you have chosen. Because of this, a few containers known to cause issues, have been added to a denylist that will flag your installation as unsupported. - -As stated in [ADR-0014](https://github.com/home-assistant/architecture/blob/master/adr/0014-home-assistant-supervised.md), running additional software on the host is not supported, -and more containers or other software can be added to the denylist without any notice. - -## The solution - -You will find a list of offending containers in your Supervisor log. - -If you remove all offending containers from your host and then reload the Supervisor, it will no longer be marked as unsupported for this reason. diff --git a/source/more-info/unsupported/software.markdown b/source/more-info/unsupported/software.markdown new file mode 100644 index 00000000000..0de0fcb1d60 --- /dev/null +++ b/source/more-info/unsupported/software.markdown @@ -0,0 +1,14 @@ +--- +title: "Unsupported software" +description: "More information on why running unsupported software marks the installation as unsupported." +--- + +## The issue + +As stated in [ADR-0014](https://github.com/home-assistant/architecture/blob/master/adr/0014-home-assistant-supervised.md), no additional software, outside of the Home Assistant ecosystem, is installed. This includes but are not limited to standalone containers running on the same host. + +Some containers will also conflict with the operations of the Supervisor, if you run any of those your system will also be marked as unhealthy. These containers will be shown in the Supervisor log as errors. + +## The solution + +Remove any additional software (including standalone containers) you have installed on your host and restart the Supervisor. From 62ea9800b1d9018cdef3e03cb45434b82b898b18 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Tue, 19 Oct 2021 11:54:28 +0200 Subject: [PATCH 02/39] Use configuration_basic for Glossary (#19839) --- source/_docs/glossary.markdown | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/source/_docs/glossary.markdown b/source/_docs/glossary.markdown index d6373656913..806a9d011f6 100644 --- a/source/_docs/glossary.markdown +++ b/source/_docs/glossary.markdown @@ -7,10 +7,11 @@ description: "Home Assistant's Glossary." The glossary covers terms which are used around Home Assistant. - + +{% endconfiguration_basic %} From 51d022420e7f89c451110493245653e16fbd2dc3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Tue, 19 Oct 2021 11:55:13 +0200 Subject: [PATCH 03/39] Add OS-agent to diagnostics (#19859) --- source/_integrations/analytics.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/analytics.markdown b/source/_integrations/analytics.markdown index 34ca991779c..0fdc177fa73 100644 --- a/source/_integrations/analytics.markdown +++ b/source/_integrations/analytics.markdown @@ -162,7 +162,7 @@ If your system includes the Supervisor, this will also contain: If enabled, a crash report will be collected when an unexpected error occurs and uploaded to [Sentry](https://sentry.io). These reports will help fix bugs and improve performance and stability. -Crash reports are only visible to the Home Assistant Core developers. This feature is currently limited to the Supervisor. +Crash reports are only visible to the Home Assistant Core developers. This feature is currently limited to the [Supervisor](/docs/glossary/#home-assistant-supervisor) and [OS-Agent]([/docs/glossary/#os-agein-supervisor](https://github.com/home-assistant/os-agent)). ## Data storage & processing From 49dc10b3e3fd9ce5bc6c5c25a68c3801979988ca Mon Sep 17 00:00:00 2001 From: Matheson Steplock Date: Tue, 19 Oct 2021 06:27:32 -0400 Subject: [PATCH 04/39] Added links to Compare Installation Methods (#19827) --- source/installation/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/installation/index.html b/source/installation/index.html index f2ab7eefba5..008a6ee5169 100644 --- a/source/installation/index.html +++ b/source/installation/index.html @@ -220,7 +220,7 @@ toc: true ✅✅❌✅ - Supervisor + Supervisor ✅❌❌✅ @@ -228,7 +228,7 @@ toc: true ✅❌❌✅ - Backups + Backups ✅❌❌✅ From 37d25fb79af7851b10bc8c75f98636022c422306 Mon Sep 17 00:00:00 2001 From: Teemu R Date: Tue, 19 Oct 2021 12:29:12 +0200 Subject: [PATCH 05/39] improve kasa provisioning doc (#19855) --- source/_integrations/tplink.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_integrations/tplink.markdown b/source/_integrations/tplink.markdown index 442d200aae3..e2a4ce487e2 100644 --- a/source/_integrations/tplink.markdown +++ b/source/_integrations/tplink.markdown @@ -22,7 +22,8 @@ ha_quality_scale: platinum --- The `tplink` integration allows you to control your [TP-Link Smart Home Devices](https://www.tp-link.com/kasa-smart/) such as plugs, power strips, wall switches and bulbs. -In some instances it might be required to add the plug to the Kasa app before trying to add them to Home Assistant, if you cannot see your newly purchased device via the integration, please add it to the Kasa app first (do not upgrade the firmware if it presents the option). + +You need to provision your newly purchased device to connect to your network before it can be added via the integration. This can be done either by using [kasa command-line tool](https://python-kasa.readthedocs.io/en/latest/cli.html#provisioning) or by adding it to the official Kasa app before trying to add them to Home Assistant. If you use the app, do not upgrade the firmware if it presents the option to avoid blocking the local access by potential firmware updates. There is currently support for the following device types within Home Assistant: From e3e1f8bb99ce092e30f01acaa8d075ecb72a874f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 20 Oct 2021 10:46:21 +0200 Subject: [PATCH 06/39] Bump racc from 1.5.2 to 1.6.0 (#19869) 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 213fe35b77b..7c40e594591 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -82,7 +82,7 @@ GEM pathutil (0.16.2) forwardable-extended (~> 2.6) public_suffix (4.0.6) - racc (1.5.2) + racc (1.6.0) rack (2.2.3) rack-protection (2.1.0) rack From 251c6f9414b835bbfe6b48acbbdf5fbfd0f89394 Mon Sep 17 00:00:00 2001 From: Aladin Date: Thu, 21 Oct 2021 15:07:58 +0000 Subject: [PATCH 07/39] - TX LF37E30 ( can't power on) (#19890) Co-authored-by: Franck Nijhof --- source/_integrations/panasonic_viera.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/panasonic_viera.markdown b/source/_integrations/panasonic_viera.markdown index aa4ce2b22f1..0b1427aae63 100644 --- a/source/_integrations/panasonic_viera.markdown +++ b/source/_integrations/panasonic_viera.markdown @@ -152,6 +152,7 @@ The list with all known valid keys can be found [here](https://github.com/floria - TX-65FX720W - TX-L42ET50 - TX-L47ET60E (can't power on) +- TX LF37E30 (can't power on) - TX-P42STW50 - TX-P42VT30E - TX-P50GT30Y From 60dc4e7c0d11925217aaa38e602a6045577a29bc Mon Sep 17 00:00:00 2001 From: Megachip Date: Fri, 22 Oct 2021 10:48:19 +0200 Subject: [PATCH 08/39] Update bh1750.markdown (#19894) --- source/_integrations/bh1750.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/_integrations/bh1750.markdown b/source/_integrations/bh1750.markdown index 3b74c81cef4..7060bab6caa 100644 --- a/source/_integrations/bh1750.markdown +++ b/source/_integrations/bh1750.markdown @@ -82,6 +82,10 @@ sensor: scan_interval: 25 ``` +## Directions for enabling I2C interface on the Home Assistant Operating System + +Follow the instructions here to [enable I2C here.](/hassio/enable_i2c/). + ## Directions for installing smbus support on Raspberry Pi Enable I2c interface with the Raspberry Pi configuration utility: From c8833ca5c2968193982704c9aad6a8da36f8cf34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren?= Date: Fri, 22 Oct 2021 11:19:50 +0200 Subject: [PATCH 09/39] Updated Link to Raspberry Pi documentation (#19899) --- source/installation/raspberrypi.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/installation/raspberrypi.markdown b/source/installation/raspberrypi.markdown index 78117169291..dc3f3a1f5a9 100644 --- a/source/installation/raspberrypi.markdown +++ b/source/installation/raspberrypi.markdown @@ -12,7 +12,7 @@ Included sections for this page is located under source/_includes/installation
-Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/documentation/faqs/#pi-power) with your Raspberry Pi. Mobile chargers may not be suitable, since some are designed to only provide the full power with that manufacturer's handsets. USB ports on your computer also will not supply enough power and must not be used. +Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#power-supply) with your Raspberry Pi. Mobile chargers may not be suitable, since some are designed to only provide the full power with that manufacturer's handsets. USB ports on your computer also will not supply enough power and must not be used.
From f0d0522a49e14cbfe180219df6140c4a4fdf1fdd Mon Sep 17 00:00:00 2001 From: Stefan <37924749+stefanroelofs@users.noreply.github.com> Date: Fri, 22 Oct 2021 11:23:56 +0200 Subject: [PATCH 10/39] Fix markdownlint / spelling issues #1 (#19900) --- source/_integrations/acmeda.markdown | 7 +++-- source/_integrations/adax.markdown | 1 - source/_integrations/agent_dvr.markdown | 10 +++---- source/_integrations/air_quality.markdown | 4 +-- source/_integrations/airthings.markdown | 1 - source/_integrations/airvisual.markdown | 26 +++++++++---------- .../alarm_control_panel.ifttt.markdown | 1 + source/_integrations/alarmdecoder.markdown | 1 - source/_integrations/alert.markdown | 3 ++- .../_integrations/alexa.smart_home.markdown | 9 ++++--- source/_integrations/amberelectric.markdown | 2 +- source/_integrations/androidtv.markdown | 16 ++++++------ source/_integrations/anthemav.markdown | 9 +++---- source/_integrations/apns.markdown | 8 +++--- source/_integrations/apple_tv.markdown | 3 ++- 15 files changed, 49 insertions(+), 52 deletions(-) diff --git a/source/_integrations/acmeda.markdown b/source/_integrations/acmeda.markdown index d787f59ac66..79cc391e0a3 100644 --- a/source/_integrations/acmeda.markdown +++ b/source/_integrations/acmeda.markdown @@ -17,18 +17,17 @@ ha_platforms: The Rollease Acmeda Automate integration allows you to control and monitor covers via your Rolelase Acmeda Automate hub. The integrations communicates directly with hubs on the local network, rather than connecting via the cloud or via RS-485. Devices are represented as a cover for monitoring and control as well as a sensor for monitoring battery condition. -### Supported devices +## Supported devices - Automate Pulse Hub v1 - {% include integrations/config_flow.md %} -### Multiple hubs +## Multiple hubs Multiple hubs work transparently with discovery, so you don't have to do anything special to set them up. -### Caveats +## Caveats If the IP address for the hub changes, you will need to re-register it with Home Assistant again. To avoid this, you may set up a DHCP reservation on your router for your hub so that it always has the same IP address. diff --git a/source/_integrations/adax.markdown b/source/_integrations/adax.markdown index 9f325672b96..6e8a9ed2b2c 100644 --- a/source/_integrations/adax.markdown +++ b/source/_integrations/adax.markdown @@ -22,5 +22,4 @@ You'll need the Account ID (which can be found in the Adax Wifi app, pressing 'A 3. Select “Add Credential” 4. Give some name to the created credential and copy the generated password. - {% include integrations/config_flow.md %} diff --git a/source/_integrations/agent_dvr.markdown b/source/_integrations/agent_dvr.markdown index 6b9acc5f522..ba5c39a4f6f 100644 --- a/source/_integrations/agent_dvr.markdown +++ b/source/_integrations/agent_dvr.markdown @@ -38,7 +38,7 @@ Available services: `start_recording`, `stop_recording`, `turn_on`, `turn_off`, `toggle`, `enable_motion_detection`,`disable_motion_detection` -#### Service `enable_alerts`/`disable_alerts` +### Service `enable_alerts`/`disable_alerts` These services enable or disable the device's alert events within Agent DVR. @@ -46,7 +46,7 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -#### Service `start_recording`/`stop_recording` +### Service `start_recording`/`stop_recording` These services start or stop the device recording. @@ -54,7 +54,7 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -#### Service `turn_on`/`turn_off`/`toggle` +### Service `turn_on`/`turn_off`/`toggle` These services turn on, off or toggle the device enabled state within Agent DVR @@ -62,9 +62,9 @@ Service data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. - ## IFrame - - Using the Webpage Card you can embed the Agent DVR viewer directly in Home Assistant. Just point it to https://www.ispyconnect.com/app/ + +- Using the Webpage Card you can embed the Agent DVR viewer directly in Home Assistant. Just point it to

diff --git a/source/_integrations/air_quality.markdown b/source/_integrations/air_quality.markdown index d47370ea19d..2474e450b40 100644 --- a/source/_integrations/air_quality.markdown +++ b/source/_integrations/air_quality.markdown @@ -6,9 +6,7 @@ ha_domain: air_quality ha_quality_scale: internal --- -The `air_quality` base platform allows other integrations to process information -about air quality and pollution details. It is used by integrations that provide -an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health). +The `air_quality` base platform allows other integrations to process information about air quality and pollution details. It is used by integrations that provide an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health). The platforms cover the following levels (if they are available): diff --git a/source/_integrations/airthings.markdown b/source/_integrations/airthings.markdown index cf7da18d164..c6f34bd2f33 100644 --- a/source/_integrations/airthings.markdown +++ b/source/_integrations/airthings.markdown @@ -18,7 +18,6 @@ Integrates Airthings sensors into Home Assistant. [Airthings](https://www.airthings.com/) provide different sensors for measuring the air quality. The focus specially on Radon sensors. - Login [here](https://dashboard.airthings.com/integrations/api-integration) to find your credentials. {% include integrations/config_flow.md %} diff --git a/source/_integrations/airvisual.markdown b/source/_integrations/airvisual.markdown index 06b652520cf..d205b439b6d 100644 --- a/source/_integrations/airvisual.markdown +++ b/source/_integrations/airvisual.markdown @@ -35,7 +35,7 @@ For example: ## Using an AirVisual Node/Pro Unit -The integration can communicate to Node/Pro units over the local network. You will need the IP address/hostname of the unit and its Samba password (which can be found on the unit; instructions here: https://support.iqair.com/en/articles/3029331-download-the-airvisual-node-pro-s-data-using-samba). +The integration can communicate to Node/Pro units over the local network. You will need the IP address/hostname of the unit and its Samba password (which can be found on the unit; [instructions here](https://support.iqair.com/en/articles/3029331-download-the-airvisual-node-pro-s-data-using-samba)). {% include integrations/config_flow.md %} @@ -45,9 +45,9 @@ In addition to using latitude and longitude, the AirVisual integration may be co For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo > Sao Paulo`. Thus, the values to use in the UI would be: -* City: `Sao Paulo` -* State: `Sao Paulo` -* Country: `Brazil` +- City: `Sao Paulo` +- State: `Sao Paulo` +- Country: `Brazil` ## Sensor Types @@ -96,12 +96,12 @@ Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](http Node/Pro units will create a variety of sensors: -* Air Quality Index (AQI) -* Battery Level -* Carbon Dioxide (CO2) -* Humidity -* Particulate (<= 0.1 μm) (PM0.1) -* Particulate (<= 2.5 μm) (PM2.5) -* Particulate (<= 10 μm) (PM10) -* Temperature -* Volatile Organic Compounds (VOC) +- Air Quality Index (AQI) +- Battery Level +- Carbon Dioxide (CO2) +- Humidity +- Particulate (<= 0.1 μm) (PM0.1) +- Particulate (<= 2.5 μm) (PM2.5) +- Particulate (<= 10 μm) (PM10) +- Temperature +- Volatile Organic Compounds (VOC) diff --git a/source/_integrations/alarm_control_panel.ifttt.markdown b/source/_integrations/alarm_control_panel.ifttt.markdown index 903f8b46156..6973ff7a648 100644 --- a/source/_integrations/alarm_control_panel.ifttt.markdown +++ b/source/_integrations/alarm_control_panel.ifttt.markdown @@ -88,6 +88,7 @@ Next, you will need to set up the required IFTTT applets as listed below. This platform supports the services `alarm_disarm`, `alarm_arm_away`, `alarm_arm_home` and `alarm_arm_night`. For each of these services, an IFTTT webhook will be triggered. For this system to operate correctly, the following IFTTT applets have to be setup. Obviously, if your alarm device does not support some states, no applets have to be provided for those. + * **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** disarm the alarm system. * **IF** Webhook event `YOUR_ARM_HOME_EVENT` is called, **THEN** set the alarm system to armed home. * **IF** Webhook event `YOUR_ARM_NIGHT_EVENT` is called, **THEN** set the alarm system to armed away. diff --git a/source/_integrations/alarmdecoder.markdown b/source/_integrations/alarmdecoder.markdown index 32e8edcf9c1..db34c2eb4f0 100644 --- a/source/_integrations/alarmdecoder.markdown +++ b/source/_integrations/alarmdecoder.markdown @@ -191,7 +191,6 @@ The `chr(4)` and `chr(5)` sequences below are equivalent to pressing the Sta - | Mode | Key Sequence | | ------------------------------------------------------- | ------------------------------ | | `alarm_arm_home` | `chr(4)` + `chr(4)` + `chr(4)` | diff --git a/source/_integrations/alert.markdown b/source/_integrations/alert.markdown index 4a27181d0f4..fb017346fa1 100644 --- a/source/_integrations/alert.markdown +++ b/source/_integrations/alert.markdown @@ -243,7 +243,7 @@ alert: The resulting message could be `Plant Officeplant needs help (moisture low)`. -### Additional parameters for notifiers +### Additional parameters for notifiers Some notifiers support more parameters (e.g., to set text color or action buttons). These can be supplied via the `data` parameter: @@ -269,6 +269,7 @@ alert: notifiers: - frank_telegram ``` + This particular example relies on the `inline_keyboard` functionality of Telegram, where the user is presented with buttons to execute certain actions. diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown index 41baf3a8651..92a7d583216 100644 --- a/source/_integrations/alexa.smart_home.markdown +++ b/source/_integrations/alexa.smart_home.markdown @@ -101,7 +101,7 @@ First thing you need to do after sing in [AWS console](https://console.aws.amazo Next you need create a Lambda function. - Click `Services` in top navigation bar, expand the menu to display all AWS services, click `Lambda` under `Compute` section to navigate to Lambda console. Or you may use this [link](https://console.aws.amazon.com/lambda/home) -- **IMPORTANT - Alexa Skills are only supported in certain AWS reigons** Your current server location will be displayed on the top right corner (for example, Ohio), make sure you select the server closest to your location / region based on your Amazon account's country, whilst also ensuring that it is within one of the supported reigons for Alexa Skills otherwise this will not work! +- **IMPORTANT - Alexa Skills are only supported in certain AWS regions** Your current server location will be displayed on the top right corner (for example, Ohio), make sure you select the server closest to your location / region based on your Amazon account's country, whilst also ensuring that it is within one of the supported regions for Alexa Skills otherwise this will not work! - **US East (N.Virginia)** region for English (US) or English (CA) skills - **EU (Ireland)** region for English (UK), English (IN), German (DE), Spanish (ES) or French (FR) skills - **US West (Oregon)** region for Japanese and English (AU) skills. @@ -163,6 +163,7 @@ After your Home Assistant has restarted, go back to `AWS Lambda Console`, you ar } } ``` + - Click `Create` in the bottom right hand corner. This test event is a `Discovery` directive, your Home Assistant instance will respond with a list of devices Alexa can interact with. This test data is lack of `token` in `payload.scope`, your Lambda function will read the `LONG_LIVED_ACCESS_TOKEN` from environment variable. @@ -796,7 +797,7 @@ The following table lists the possible friendly name synonyms available for a In ### Light -Control lights with _"turn on"_ and _"turn off"_ utterances, adjust brightness, color, and temperature. +Control lights with _"turn on"_ and _"turn off"_ utterances, adjust brightness, color, and temperature. - _"Alexa, turn on the bathroom light."_ - _"Alexa, turn off the patio light."_ @@ -938,11 +939,11 @@ Support _"turn on"_ and _"turn off"_ utterances. ### Timer -Start a timer with using the _"turn on"_ utterance. +Start a timer with using the _"turn on"_ utterance. - _"Alexa, turn on the laundry."_ -Cancel a timer using the _"turn off"_ utterance. +Cancel a timer using the _"turn off"_ utterance. - _"Alexa, turn off the laundry."_ diff --git a/source/_integrations/amberelectric.markdown b/source/_integrations/amberelectric.markdown index e4686310f3a..bc91f7cdb5c 100644 --- a/source/_integrations/amberelectric.markdown +++ b/source/_integrations/amberelectric.markdown @@ -23,7 +23,7 @@ Using this integration, customers can go a step further - setting up devices to To use this integration, you will need to generate an API key. -1. Login to your Amber account at: https://app.amber.com.au +1. Login to your Amber account at: 2. Click _Settings_ 3. Enable _Developer Mode_ 4. Click _Generate API Key_ diff --git a/source/_integrations/androidtv.markdown b/source/_integrations/androidtv.markdown index f9109d4da63..f37d3ac9145 100644 --- a/source/_integrations/androidtv.markdown +++ b/source/_integrations/androidtv.markdown @@ -278,8 +278,8 @@ When sending commands like UP, DOWN, HOME, etc. via ADB, the device can be slow | ---------------------- | -------- | ----------- | | `entity_id` | no | Name(s) of Android TV / Fire TV entities. -1. Call the `androidtv.learn_sendevent` service. -2. Within 8 seconds, hit a single button on your Android TV / Fire TV remote. +1. Call the `androidtv.learn_sendevent` service. +2. Within 8 seconds, hit a single button on your Android TV / Fire TV remote. 3. After 8 seconds, a persistent notification will appear that contains the equivalent command that can be sent via the `androidtv.adb_command` service. This command can also be found in the `adb_response` attribute of the media player in Home Assistant, and it will be logged at the INFO level. As an example, a service call in a [script](/docs/scripts) could be changed from this: @@ -306,7 +306,7 @@ to this: ### `androidtv.download` and `androidtv.upload` -You can use the `androidtv.download` service to download a file from your Android TV / Fire TV device to your Home Assistant instance. +You can use the `androidtv.download` service to download a file from your Android TV / Fire TV device to your Home Assistant instance. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | @@ -328,13 +328,13 @@ The Android TV integration works by polling the Android TV / Fire TV device at a The solution to this problem is the `state_detection_rules` configuration parameter, which allows you to provide your own rules for state detection. The keys are app IDs, and the values are lists of rules that are evaluated in order. Valid rules are: -* `'standby'`, `'playing'`, `'paused'`, `'idle'`, or `'off'` - * If this is not a map, then this state will always be reported when this app is the current app - * If this is a map, then its entries are conditions that will be checked. If all of the conditions are true, then this state will be reported. Valid conditions pertain to 3 properties (see the example configuration above): +- `'standby'`, `'playing'`, `'paused'`, `'idle'`, or `'off'` + - If this is not a map, then this state will always be reported when this app is the current app + - If this is a map, then its entries are conditions that will be checked. If all of the conditions are true, then this state will be reported. Valid conditions pertain to 3 properties (see the example configuration above): 1. ``'media_session_state'`` 2. ``'audio_state'`` 3. ``'wake_lock_size'`` -* `'media_session_state'` = try to use the `media_session_state` property to determine the state -* `'audio_state'` = try to use the `audio_state` property to determine the state +- `'media_session_state'` = try to use the `media_session_state` property to determine the state +- `'audio_state'` = try to use the `audio_state` property to determine the state To determine what these rules should be, you can use the `androidtv.adb_command` service with the command `GET_PROPERTIES`, as described in the [androidtv.adb_command](#androidtvadb_command) section. diff --git a/source/_integrations/anthemav.markdown b/source/_integrations/anthemav.markdown index fbe3ca36a04..38e4b082863 100644 --- a/source/_integrations/anthemav.markdown +++ b/source/_integrations/anthemav.markdown @@ -19,10 +19,9 @@ Both [Anthem]'s current and last generation of A/V Receivers and Processors supp Support is provided through the Python [anthemav] module. Older, RS-232 serial-based units like the [D2v series](https://www.anthemav.com/products-archived/model=d2v/page=overview) use a different protocol entirely and are not currently supported. -[Anthem]: https://www.anthemav.com/ +[Anthem]: https://www.anthemav.com/ [anthemav]: https://github.com/nugget/python-anthemav - To use your Anthem A/V Receiver in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -50,9 +49,9 @@ name: ## Notes and Limitations -- The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls. -- Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant. -- Only Zone 1 is currently supported. +* The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls. +* Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant. +* Only Zone 1 is currently supported.

diff --git a/source/_integrations/apns.markdown b/source/_integrations/apns.markdown index 9d786f171d9..ba847c78c41 100644 --- a/source/_integrations/apns.markdown +++ b/source/_integrations/apns.markdown @@ -66,7 +66,7 @@ This service will send messages to a registered device. The following parameters - **target**: The desired state of the device, only devices that match the state will receive messages. To enable state tracking a registered device must have a `tracking_device_id` attribute added to the `[NOTIFIER_NAME]_apns.yaml` file. If this ID matches a device in `known_devices.yaml` the device state will be tracked. - **data**: - * **badge**: The number to display as the badge of the app icon. - * **sound**: The name of a sound file in the app bundle or in the Library/Sounds folder. - * **category**: Provide this key with a string value that represents the identifier property of the `UIMutableUserNotificationCategory`. - * **content_available**: Provide this key with a value of 1 to indicate that new content is available. + - **badge**: The number to display as the badge of the app icon. + - **sound**: The name of a sound file in the app bundle or in the Library/Sounds folder. + - **category**: Provide this key with a string value that represents the identifier property of the `UIMutableUserNotificationCategory`. + - **content_available**: Provide this key with a value of 1 to indicate that new content is available. diff --git a/source/_integrations/apple_tv.markdown b/source/_integrations/apple_tv.markdown index 4c475b85972..f2c6ba34636 100644 --- a/source/_integrations/apple_tv.markdown +++ b/source/_integrations/apple_tv.markdown @@ -25,6 +25,7 @@ There is currently support for the following entities within the Apple TV device - [Remote](#remote) {% include integrations/config_flow.md %} + ## Media Player The Apple TV media player platform will create a Media Player entity for each @@ -63,7 +64,7 @@ The following commands are currently available: | `num_repeats` | yes | Number of times to repeat the commands | | `delay_secs` | yes | Interval in seconds between one send and another
This is a `float` value e.g. 1, 1.2 etc. | -**Examples** +### Examples Create a script to invoke the Netflix application based on the application icon being in a fixed place on the home screen: From 87b84afd47fa032ea51eb9e6ea36b5f2775d0e9a Mon Sep 17 00:00:00 2001 From: Stefan <37924749+stefanroelofs@users.noreply.github.com> Date: Fri, 22 Oct 2021 12:32:47 +0200 Subject: [PATCH 11/39] Spell check dict update (#19730) Co-authored-by: Franck Nijhof --- .vscode/cSpell.json | 60 ++++++++++++++++--- .../_docs/energy/individual-devices.markdown | 6 +- 2 files changed, 56 insertions(+), 10 deletions(-) diff --git a/.vscode/cSpell.json b/.vscode/cSpell.json index dd008c8be38..5425d0788b8 100644 --- a/.vscode/cSpell.json +++ b/.vscode/cSpell.json @@ -1,46 +1,92 @@ // cSpell Settings // Contains additional words for our project { - "version": "0.1", + "version": "0.2", "language": "en", "words": [ + "aeotec", + "Alexa", "arest", + "autodiscovery", + "autoheal", "automations", + "balloob", "bloomsky", - "bluesound", + "Bluesound", "BTLE", + "CEST", + "Chromecast", + "deCONZ", "Denon", + "DSMR", + "elif", + "endcomment", "endconfiguration", + "endfor", "endraw", + "esphome", "Etekcity", - "fitbit", + "EventStream", + "Everspring", + "Fibaro", + "Fitbit", "Flexit", + "Frenck", + "geolocation", + "GPSLogger", "Harman", "hass", "Hass.io", "HassOS", "hcitool", "heos", - "hikvision", + "Hikvision", + "HomeKit", "Homematic", + "HVAC", "IBAN", "icloud", + "IFTTT", "kardon", + "Lutron", "macos", + "Meteobridge", "Modbus", "Mosquitto", + "Nabu Casa", "nginx", + "Nijhof", + "Nmap", "ohmconnect", "Onkyo", - "paulus", + "OpenZWave", + "OwnTracks", + "Paulus", + "Powerwall", + "Pushbullet", + "Schoutsen", + "SmartThings", + "statestream", "templating", + "timedelta", + "TRÅDFRI", + "Tuya", + "UART", + "utcnow", + "wakeup", "waqi", - "Webhook" + "WLED", + "worldclock", + "Xiaomi", + "Zigbee" ], // flagWords - list of words to be always considered incorrect // This is useful for offensive words and common spelling errors. // For example "hte" should be "the" - "flagWords": ["hte", "asssistant"], + "flagWords": [ + "hte", + "asssistant" + ], "enabledLanguageIds": [ "asciidoc", "c", diff --git a/source/_docs/energy/individual-devices.markdown b/source/_docs/energy/individual-devices.markdown index c84939cd5e3..b522c45725b 100644 --- a/source/_docs/energy/individual-devices.markdown +++ b/source/_docs/energy/individual-devices.markdown @@ -3,7 +3,7 @@ title: "Integrating individual device energy usage" description: "Learn how to add information about individual device energy usage to Home Assistant home energy management." --- -Home Assistant can integrate the energy usage of individual devices into Home Assistant. That way you can see the impact of individual devices on your total enery consumption. +Home Assistant can integrate the energy usage of individual devices into Home Assistant. That way you can see the impact of individual devices on your total energy consumption. ## Hardware @@ -20,8 +20,8 @@ Smart relays sit behind your "normal" switches and make them smart. It allows yo {% comment %} We recommend the Shelly brand because they have a local API that updates Home Assistant as soon as something happens and it has a high quality integration: - - [Shelly 1PM](https://shop.shelly.cloud/shelly-1pm-wifi-smart-home-automation-1?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq) - - [Shelly 2.5](https://shop.shelly.cloud/shelly-2.5-ce-ul-wifi-smart-home-automation?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq) +- [Shelly 1PM](https://shop.shelly.cloud/shelly-1pm-wifi-smart-home-automation-1?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq) +- [Shelly 2.5](https://shop.shelly.cloud/shelly-2.5-ce-ul-wifi-smart-home-automation?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq) {% endcomment %} Graphic showing energy flowing from the home to individual devices. From a417e7d82babc287ba55a6ff6fb0db27e2097ee0 Mon Sep 17 00:00:00 2001 From: Stefan <37924749+stefanroelofs@users.noreply.github.com> Date: Fri, 22 Oct 2021 12:50:06 +0200 Subject: [PATCH 12/39] Fix markdownlint / spelling issues #2 (#19903) --- source/_integrations/apprise.markdown | 10 ++++++---- source/_integrations/aquostv.markdown | 6 ++++-- source/_integrations/arcam_fmj.markdown | 11 ++++------- source/_integrations/arris_tg2492lg.markdown | 1 + source/_integrations/aten_pe.markdown | 3 ++- source/_integrations/august.markdown | 13 +++++++------ source/_integrations/avea.markdown | 2 +- source/_integrations/awair.markdown | 16 ++++++++-------- source/_integrations/aws.markdown | 2 +- source/_integrations/azure_event_hub.markdown | 2 +- source/_integrations/bbb_gpio.markdown | 4 ++-- .../_integrations/binary_sensor.group.markdown | 1 - .../_integrations/bmw_connected_drive.markdown | 6 +++--- source/_integrations/bond.markdown | 2 +- source/_integrations/braviatv.markdown | 5 ++--- 15 files changed, 43 insertions(+), 41 deletions(-) diff --git a/source/_integrations/apprise.markdown b/source/_integrations/apprise.markdown index 0bbed7e822b..dc5f4843f65 100644 --- a/source/_integrations/apprise.markdown +++ b/source/_integrations/apprise.markdown @@ -14,6 +14,8 @@ ha_platforms: The [Apprise service](https://github.com/caronc/apprise/) is an all-in-one solution to open up Home Assistant to _just about_ every Notification platform (such as Amazon SNS, Discord, Telegram, Slack, MSTeams, Twilio, etc.) +## Configuration + To use Apprise supported notifications, add the following to your `configuration.yaml` file: ```yaml @@ -59,7 +61,7 @@ config: type: string {% endconfiguration %} -#### Example service call +## Example service call ```yaml - service: notify.apprise @@ -80,11 +82,11 @@ If you're using configuration files to store your Apprise URLs in, then you have The tag `all` is reserved to notify absolutely everything, whether you have a tag associated with a URL or not. -### Notes +## Notes There are over 50 supported Notification services supported by Apprise. Each has their own tweaks and customizations you can leverage. - For instructions on how to construct the URLs, visit [here](https://github.com/caronc/apprise/wiki#notification-services). - For instructions on how you can customize your own Apprise configuration files (referenced through the `config` directive), check out the following: - - [Text Formatted URLs](https://github.com/caronc/apprise/wiki/config_text) - - [YAML Formatted URLs](https://github.com/caronc/apprise/wiki/config_yaml) + - [Text Formatted URLs](https://github.com/caronc/apprise/wiki/config_text) + - [YAML Formatted URLs](https://github.com/caronc/apprise/wiki/config_yaml) diff --git a/source/_integrations/aquostv.markdown b/source/_integrations/aquostv.markdown index b7e5190993b..a316fd0af0e 100644 --- a/source/_integrations/aquostv.markdown +++ b/source/_integrations/aquostv.markdown @@ -14,6 +14,8 @@ The `aquostv` platform allows you to control a [Sharp Aquos TV](http://www.sharp When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication. +## Configuration + To add a TV to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -62,7 +64,7 @@ Also, with **power_on_enabled** as True, the Aquos logo on your TV will stay on
-Currently known supported models: +## Currently known supported models - LC-40LE830U - LC-46LE830U @@ -78,4 +80,4 @@ Currently known supported models: - LC-70LE650U - LC-70LE747E (no volume control) -If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.io/blob/current/source/_integrations/aquostv.markdown). +If your model is not on the list, give it a test. If everything works correctly, then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.io/blob/current/source/_integrations/aquostv.markdown). diff --git a/source/_integrations/arcam_fmj.markdown b/source/_integrations/arcam_fmj.markdown index a999b0a44a4..65d6ff2ebd5 100644 --- a/source/_integrations/arcam_fmj.markdown +++ b/source/_integrations/arcam_fmj.markdown @@ -26,19 +26,16 @@ Supported devices: ## Power state -Arcam FMJ receivers turn off their network port when in standby, the component will try to -reconnect to the receiver every 5 seconds. This mean powering on the first zone is not -possible over the builtin network connection. Two options for complete power control -exists: IR or Serial gateway. +Arcam FMJ receivers turn off their network port when in standby, the component will try to reconnect to the receiver every 5 seconds. This means powering on the first zone is not possible over the built-in network connection. Two options for complete power control exists: IR or Serial gateway. ### IR command Use an IR blaster to send a command to turn the device on using these discrete codes: - - Zone 1: Protocol: RC5 Device: 16 Function: 123 - - Zone 2: Protocol: RC5 Device: 23 Function: 123 +- Zone 1: Protocol: RC5 Device: 16 Function: 123 +- Zone 2: Protocol: RC5 Device: 23 Function: 123 -Turn on sometime requires two IR codes to be sent. You can generate the raw, broadlink or other IR format string using [irgen](https://github.com/elupus/irgen) tool like: +Turn on sometime requires two IR codes to be sent. You can generate the raw, broadlink or other IR format string using [irgen](https://github.com/elupus/irgen) tool like: ```shell irgen -i rc5 -d 16 0 123 -o broadlink_base64 -r 2 diff --git a/source/_integrations/arris_tg2492lg.markdown b/source/_integrations/arris_tg2492lg.markdown index 5cb92346119..4308be14e0f 100644 --- a/source/_integrations/arris_tg2492lg.markdown +++ b/source/_integrations/arris_tg2492lg.markdown @@ -16,6 +16,7 @@ ha_platforms: This platform allows you to detect presence by looking at connected devices to an Arris TG2492LG router. This is one of the routers provided by: + * [Ziggo](https://www.ziggo.nl/), a cable operator in the Netherlands, to their customers as the Ziggo Connectbox. * [Virgin Media](https://www.virginmedia.com/), a cable operator in the United Kingdom, to their customers as the Hub 3. diff --git a/source/_integrations/aten_pe.markdown b/source/_integrations/aten_pe.markdown index 73fd2539c3a..532ffe11e72 100644 --- a/source/_integrations/aten_pe.markdown +++ b/source/_integrations/aten_pe.markdown @@ -17,7 +17,8 @@ The `aten_pe` integration lets you control [ATEN Rack PDUs](https://www.aten.com In order to use it, SNMP must be enabled on your PDU. It is recommended to use SNMPv3 to protect your credentials from eavesdropping. Tested devices: - * [PE8324G](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/pe8324/) + +* [PE8324G](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/pe8324/) To set it up, add the following information to your `configuration.yaml` file: diff --git a/source/_integrations/august.markdown b/source/_integrations/august.markdown index 3d06a581a74..97ef248fdcb 100644 --- a/source/_integrations/august.markdown +++ b/source/_integrations/august.markdown @@ -25,7 +25,7 @@ The `august` integration allows you to integrate your [August](https://august.co {% include integrations/config_flow.md %} -### Known Working Devices +## Known Working Devices - August Wi-Fi Smart Lock (Gen 4) - August Smart Lock Pro (Gen 3) @@ -46,12 +46,13 @@ There is currently support for the following device types within Home Assistant: August Lock 2nd Gen will need either August Connect or Doorbell to connect to Home Assistant. -### Known Unsupported Devices +## Known Unsupported Devices + - The Yale Doorman L3 Other devices not listed above have not been tested and may not function as expected. -### Binary Sensor +## Binary Sensor If you have an August Doorbell, once you have enabled the August component, you should see following sensors: @@ -63,11 +64,11 @@ If you have an August Smart Lock with DoorSense, once you have enabled the Augus - Door sensor -### Camera +## Camera The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](https://august.com/) device in Home Assistant. -### Sensor +## Sensor If you have an August Doorbell with a battery, once you have enabled the August component, you should see the following sensors: @@ -82,7 +83,7 @@ If you have an August Keypad, once you have enabled the August component, you sh - Keypad Battery -### Presence Detection with Lock Operation +## Presence Detection with Lock Operation Using the lock operation sensors, you can detect when a user operates a lock and is physically present (not remote). The below automation example (added to `automations.yaml`) will trigger when the user named “John Doe” in August locks or unlocks the door from the keypad (if present), via Bluetooth from their phone, or by auto-unlock. The state of the sensor will be the name of the party operating the lock as returned by August. diff --git a/source/_integrations/avea.markdown b/source/_integrations/avea.markdown index 3c2f199d528..b6e4b2ce71d 100644 --- a/source/_integrations/avea.markdown +++ b/source/_integrations/avea.markdown @@ -14,7 +14,7 @@ ha_platforms: [Elgato Avea](https://www.evehome.com/en/news/elgato-avea-transform-your-home) is a Bluetooth light bulb that is no longer supported by the manufacturer. The `avea` integration allows you to control all your Avea bulbs with Home Assistant. -### Configuration +## Configuration To enable Avea, add the following lines to your `configuration.yaml` file: diff --git a/source/_integrations/awair.markdown b/source/_integrations/awair.markdown index 6f8fb76e2e6..6e992450d78 100644 --- a/source/_integrations/awair.markdown +++ b/source/_integrations/awair.markdown @@ -24,14 +24,14 @@ You will need to request access to the Awair API and obtain an access token from The integration will fetch data from each device linked to your Awair developer account. The following sensors are supported: - * Temperature - * Humidity - * Carbon dioxide - * Total volatile organic compounds - * PM2.5 density - * PM10 density - * Sound level - * Luminescence +* Temperature +* Humidity +* Carbon dioxide +* Total volatile organic compounds +* PM2.5 density +* PM10 density +* Sound level +* Luminescence Not all devices support all sensors; consult Awair's documentation to find out what sensors are present on your device. For first-generation Awair devices with a "dust" sensor, the integration will create identical PM2.5 and PM10 sensors (which reflects the capabilities of the sensor - it can detect dust between PM2.5 and PM10 but cannot differentiate between them). diff --git a/source/_integrations/aws.markdown b/source/_integrations/aws.markdown index 096502b8261..c1eb43d8505 100644 --- a/source/_integrations/aws.markdown +++ b/source/_integrations/aws.markdown @@ -138,7 +138,7 @@ If one exists, the SNS Subject will be set to the title. All attributes from the ### Setting up SNS within AWS - Log into your AWS console and under "Security and Identity", select "Identity & Access Management". -- On the left-hand side, select "Users" then click "Create New Users". Enter a name here and then click "Create". +- On the left-hand side, select "Users" then click "Create New Users". Enter a name here and then click "Create". - You can either download the credentials or click the arrow to display them one time.
diff --git a/source/_integrations/azure_event_hub.markdown b/source/_integrations/azure_event_hub.markdown index e8989741c74..5d35e1715b2 100644 --- a/source/_integrations/azure_event_hub.markdown +++ b/source/_integrations/azure_event_hub.markdown @@ -10,7 +10,7 @@ ha_codeowners: ha_domain: azure_event_hub --- -The `Azure Event Hub` integration allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to an [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin). +The `Azure Event Hub` integration allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to an [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin). ## First time setup diff --git a/source/_integrations/bbb_gpio.markdown b/source/_integrations/bbb_gpio.markdown index 6b69e78a84b..ba1bb16140c 100644 --- a/source/_integrations/bbb_gpio.markdown +++ b/source/_integrations/bbb_gpio.markdown @@ -20,7 +20,7 @@ There is no setup needed for the integration itself. The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). -## Configuration +### Configuration To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: @@ -73,7 +73,7 @@ For more details about the GPIO layout, visit the [article](https://elinux.org/B The `bbb_gpio` switch platform allows you to control the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). -## Configuration +### Configuration To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_integrations/binary_sensor.group.markdown b/source/_integrations/binary_sensor.group.markdown index 2061b560596..01a3b181b12 100644 --- a/source/_integrations/binary_sensor.group.markdown +++ b/source/_integrations/binary_sensor.group.markdown @@ -50,4 +50,3 @@ device_class: required: true type: string {% endconfiguration %} - diff --git a/source/_integrations/bmw_connected_drive.markdown b/source/_integrations/bmw_connected_drive.markdown index e99397894a4..e1b1f519707 100644 --- a/source/_integrations/bmw_connected_drive.markdown +++ b/source/_integrations/bmw_connected_drive.markdown @@ -49,9 +49,9 @@ The preferred way to enable the `bmw_connected_drive` integration is via **Confi | Setting | Description | |---------|-------------| | Read-only | No execution of services to the vehicle. Still possible to send messages and POIs via `notify` and to request a status update via `bmw_connected_drive.update_state`. -| Use Home Assistant location for car location polls | Older cars (non i3/i8 build before 7/2014) require the phone to be close to the car to get location updates. Enable this option to use the location of your Home Assistant instance for these queries, so updates are available when your car is in the surrounding of your home. | +| Use Home Assistant location for car location polls | Older cars (non i3/i8 build before 7/2014) require the phone to be close to the car to get location updates. Enable this option to use the location of your Home Assistant instance for these queries, so updates are available when your car is in the surrounding of your home. | -The following settings in your `configuration.yaml` file are considered legacy. They will be imported into **Configuration** > **Integrations** and you can set the options from above. Changes to `configuration.yaml` after the first import will be ignored. +The following settings in your `configuration.yaml` file are considered legacy. They will be imported into **Configuration** > **Integrations** and you can set the options from above. Changes to `configuration.yaml` after the first import will be ignored. ### Legacy configuration @@ -133,7 +133,7 @@ action: ## Services -The `bmw_connected_drive` integration offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN as attribute of all enties, e.g. (binary) sensors or the device tracker. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`. +The `bmw_connected_drive` integration offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN as attribute of all entities, e.g. (binary) sensors or the device tracker. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`. Using these services will impact the state of your vehicle. So use these services with care! diff --git a/source/_integrations/bond.markdown b/source/_integrations/bond.markdown index 17ad3701a7d..308d9d1e7d2 100644 --- a/source/_integrations/bond.markdown +++ b/source/_integrations/bond.markdown @@ -114,7 +114,7 @@ Calling this service will change the tracked power state of any bond light but n ### Service `bond.set_light_brightness_tracked_state` -Sets the tracked brightness state of a bond light +Sets the tracked brightness state of a bond light Calling this service will change the tracked brightness state of any bond light but not transmit any signal to make the device change its state. | Service data attribute | Optional | Description | diff --git a/source/_integrations/braviatv.markdown b/source/_integrations/braviatv.markdown index c6748992c01..cb7ace9d353 100644 --- a/source/_integrations/braviatv.markdown +++ b/source/_integrations/braviatv.markdown @@ -33,11 +33,11 @@ To ensure a clean re-configuration, please perform the following steps: - Perform the [TV does not generate new pin](#tv-does-not-generate-new-pin) steps. - Retry [configuration](#configuration). -### TV does not generate new pin: +### TV does not generate new pin If you have previously set up your TV with any Home Assistant instances, you must remove Home Assistant from your TV in order for your TV to generate a new pin. To do this, you must do **one** of the following: -- On your TV, go to: **Settings** -> **Network** -> **Remote device settings** -> **Deregister remote device**. Disable and re-enable the **Control remotely** after. Menu titles may differ slightly between models. If needed, refer to your specific model's [manual](https://www.sony.com/electronics/support/manuals) for additional guidiance. +- On your TV, go to: **Settings** -> **Network** -> **Remote device settings** -> **Deregister remote device**. Disable and re-enable the **Control remotely** after. Menu titles may differ slightly between models. If needed, refer to your specific model's [manual](https://www.sony.com/electronics/support/manuals) for additional guidance. - Reset your TV to factory condition. ## Remote @@ -182,7 +182,6 @@ Users of TVs older than 2013 have another option for controlling their TV via Ho If you have a Raspberry Pi connected to your TV: - {% raw %} ```yaml From 61fecfdf7381d8b228a1821fcf372f1aa1833494 Mon Sep 17 00:00:00 2001 From: Aaron Bach Date: Fri, 22 Oct 2021 04:57:51 -0600 Subject: [PATCH 13/39] Add docs re: disabled-by-default RainMachine entities (#19759) --- source/_integrations/rainmachine.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_integrations/rainmachine.markdown b/source/_integrations/rainmachine.markdown index 2ae524d8809..fbcb1cbdaa8 100644 --- a/source/_integrations/rainmachine.markdown +++ b/source/_integrations/rainmachine.markdown @@ -28,6 +28,8 @@ There is currently support for the following device types within Home Assistant: - Sensor - [Switch](#switch) +Note that some entities are disabled by default. If you are missing a sensor or binary sensor, check the configured integration! + {% include integrations/config_flow.md %} ## Services From 000d95408056dc694daa0c9510afaaa2c272517b Mon Sep 17 00:00:00 2001 From: Hedda Date: Fri, 22 Oct 2021 14:00:16 +0200 Subject: [PATCH 14/39] Update zha.markdown to mention and explain binding and unbinding (#16336) Co-authored-by: Franck Nijhof Co-authored-by: Alexei Chetroi --- source/_integrations/zha.markdown | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown index 57adddd5976..83ba11d5866 100644 --- a/source/_integrations/zha.markdown +++ b/source/_integrations/zha.markdown @@ -53,7 +53,7 @@ There is currently support for the following device types within Home Assistant: - Sensor - Switch -There is also support for grouping of lights, switches, and fans (i.e. support for commanding device groups as entities). At least two entities must be added to a group before the group entity is created. +There is also support for grouping of lights, switches, and fans (i.e. support for commanding device groups as entities). At least two entities must be added to a group before the group entity is created. As well as support for binding/unbinding (i.e. bind a remote to a lightbulb or group). ## Compatible hardware @@ -362,6 +362,17 @@ An example using the default CC2531 coordinator firmware + two CC2531 routers; Y - Router two: + 21 devices - Total device limit = **55 devices** +### Binding and unbinding + +ZHA support for binding and unbinding. Binding is an action in Zigbee which defines relations between two Zigbee devices, specific endpoints, and cluster id. It provides a mechanism for attaching an endpoint on one Zigbee node to one or more endpoints on another Zigbee node or Zigbee group (a group of Zigbee devices). + +Binding is a "target destination" in form of a device address or group ID, endpoint, and cluster. For example, binding a Zigbee device like a remote to a Zigbee lightbulb, switch or group of lightbulbs allows direct control of the "target" device (light, switch, shade) from the "remote" Zigbee device, bypassing ZHA. This means that the remote can control the lightbulb/group of lightbulbs even when the Zigbee coordinator is not available. +Binding is only supported between the same cluster, for example, "output cluster id 6" (on/off cluster) of a remote, can be only bound to an "input cluster id 6" on the target device -- light, switch. + +Note that not all devices support binding as it depends on the Zigbee implementation of the device itself. Also, by default ZHA bind remotes to the coordinator, so the coordinator could receive ZCL commands from the remotes and originate zha_events. However, some remotes, for example, the Philips RWL021 can only be bound to a single destination and it is not possible to make this switch to bind to other destinations like a device or groups unless you first unbind the remote from the coordinator. After you unbind the remote from the ZHA coordinator you can then bind it directly to any other Zigbee device or a group. + +Binding a remote directly to a bulb or group has the benefit of faster response time and smoother control. This greatly improves user feedback experience functions like dimming as the remote then directly dims the lightbulb and thus does not have to make the software roundtrip via the ZHA coordinator. + ## Troubleshooting To help resolve any kinks or compatibility problems, report bugs as issues with debug logs. Please follow the instructions in this troubleshooting section. From 218ca9178dc1b6dcdab9b6f6071ea88da6c333a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=2E=20=C3=81rkosi=20R=C3=B3bert?= Date: Fri, 22 Oct 2021 14:36:05 +0200 Subject: [PATCH 15/39] Add some clarification to Fronius integration docs (#18888) Co-authored-by: Franck Nijhof Co-authored-by: Matthias Alphart --- source/_integrations/fronius.markdown | 29 +++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/source/_integrations/fronius.markdown b/source/_integrations/fronius.markdown index f115d5af5f3..3c837bbd1fa 100644 --- a/source/_integrations/fronius.markdown +++ b/source/_integrations/fronius.markdown @@ -13,7 +13,11 @@ ha_platforms: - sensor --- -The `fronius` sensor polls a [Fronius](https://www.fronius.com/) solar inverter, battery system or smart meter and present the values as sensors in Home Assistant. +The `fronius` sensor polls a [Fronius](https://www.fronius.com/) solar inverter, battery system or smart meter and presents the values as sensors in Home Assistant. Data is gathered directly from a Fronius device connected to your local network, this integration doesn't access the cloud. + +## Prerequisites + +You will need to either set a static IP on the Fronius device or assign a static DHCP lease for it, or alternatively access it through the local DNS name if your network is properly configured for this. ## Configuration @@ -22,7 +26,7 @@ To enable this sensor, add the following lines to your `configuration.yaml` file ```yaml sensor: - platform: fronius - resource: FRONIUS_URL + resource: FRONIUS_URL_OR_IP monitored_conditions: - sensor_type: logger_info - sensor_type: inverter @@ -33,7 +37,7 @@ sensor: {% configuration %} resource: - description: "The URL of the Fronius device (e.g., `http://192.0.2.0` or `http://fronius.local`)" + description: "The hostname or IP address of the Fronius device (e.g., `192.0.2.0` or `http://fronius.local`)" required: true type: string monitored_conditions: @@ -51,7 +55,7 @@ monitored_conditions: type: string default: "device" device: - description: "The id of the device to poll" + description: "The ID of the device to poll" required: false default: "\"1\" for inverters and \"0\" for other devices such as storages in compliance with Fronius Specs" {% endconfiguration %} @@ -102,6 +106,19 @@ there might be no sensor providing photovoltaic related data. This does not need to be problematic as the values will be added on sunrise, when the Fronius devices begins providing the needed data. +## Finding out devices IDs + +To find out the device ID of the inverter visit the URL: +`http://FRONIUS_IP/solar_api/v1/GetPowerFlowRealtimeData.fcgi` +In the returned JSON, under the key Body > Data > Inverters you should see your inverters listed with IDs starting from 1. + +To find out the device ID of the meter visit the URL: +`http://FRONIUS_IP/solar_api/v1/GetMeterRealtimeData.cgi?Scope=System` +In the returned JSON, under the key Body > Data you should see your meters listed with IDs starting from 0. + +To find out which API version your system runs, visit the URL: +`http://FRONIUS_IP/solar_api/GetAPIVersion.cgi` + ## Examples When including more of the components that one Fronius device offers, @@ -121,3 +138,7 @@ sensor: device: 0 - sensor_type: power_flow ``` + +## Note + +Fronius often provides firmware updates for the datamanager interfaces and the devices in their system, it's recommended to check and apply them regularly. This integration relies on functionality present in rather recent firmware. From 704ace2254e89737ad97a7d179eb41265d2a93b5 Mon Sep 17 00:00:00 2001 From: Hedda Date: Fri, 22 Oct 2021 18:19:08 +0200 Subject: [PATCH 16/39] Update zha.markdown with note about changing Zigbee channel (#18865) Co-authored-by: Franck Nijhof Co-authored-by: Alexei Chetroi --- source/_integrations/zha.markdown | 3 +++ 1 file changed, 3 insertions(+) diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown index 83ba11d5866..842e0e2abef 100644 --- a/source/_integrations/zha.markdown +++ b/source/_integrations/zha.markdown @@ -229,6 +229,9 @@ Note: `cluster_id: 25` may also be `cluster_id: 0x0019`. The two are synonymous. ### Defining Zigbee channel to use +ZHA prefers to use Zigbee channel 15 by default. You can change this using YAML configuration, but this only works +if there's no existing network. To change the channel for an existing network, radio has to be factory reset and a new network to be formed. This requires re-pairing of all the devices. + ```yaml zha: zigpy_config: From 174044ee9ce70b61f7a133d2358060218f1cb920 Mon Sep 17 00:00:00 2001 From: "Antti K. Koskela" Date: Fri, 22 Oct 2021 22:44:57 +0300 Subject: [PATCH 17/39] Improve documentation for history-graph #19893 (#19895) Co-authored-by: Franck Nijhof --- source/_lovelace/history-graph.markdown | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/source/_lovelace/history-graph.markdown b/source/_lovelace/history-graph.markdown index d77a4dd437f..7ca5ec6a2b3 100644 --- a/source/_lovelace/history-graph.markdown +++ b/source/_lovelace/history-graph.markdown @@ -59,7 +59,7 @@ name: type: string {% endconfiguration %} -## Example +## Examples Alternatively, the card can be configured using YAML: @@ -71,3 +71,17 @@ entities: - entity: media_player.lounge_room name: Main player ``` + +Or with longer time frame, and multiple entities (as long as they share the same unit_of_measurement) in one graph: + +```yaml +type: history-graph +title: "Temperatures in the last 48 hours" +hours_to_show: 48 +entities: + - sensor.outside_temperature + - entity: sensor.lounge_temperature + name: "Lounge" + - entity: sensor.attic_temperature + name: "Attic" +``` From 7d48aaa402d15d1f15e0ba6f5d0f10ee5dca13db Mon Sep 17 00:00:00 2001 From: SNoof85 Date: Fri, 22 Oct 2021 21:46:13 +0200 Subject: [PATCH 18/39] Solaredge, update template sensors examples (#19909) --- source/_integrations/solaredge.markdown | 9 ++++----- source/_integrations/solaredge_local.markdown | 13 ++++++------- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/source/_integrations/solaredge.markdown b/source/_integrations/solaredge.markdown index 8b0ea95a485..6c3ada5f94e 100644 --- a/source/_integrations/solaredge.markdown +++ b/source/_integrations/solaredge.markdown @@ -33,11 +33,10 @@ In case you would like to convert the values for example to kWh instead of the d ```yaml # Example configuration.yaml entry for template platform -sensor: - platform: template - sensors: - solaredge_energy_this_year_template: - value_template: "{{ (states('sensor.solaredge_energy_this_year') | float / 1000) | round(2) }}" +template: + - sensor: + - name: solaredge_energy_this_year_template: + state: "{{ (states('sensor.solaredge_energy_this_year') | float / 1000) | round(2) }}" ``` {% endraw %} diff --git a/source/_integrations/solaredge_local.markdown b/source/_integrations/solaredge_local.markdown index 620760f7361..c42cdd73dc3 100644 --- a/source/_integrations/solaredge_local.markdown +++ b/source/_integrations/solaredge_local.markdown @@ -69,13 +69,12 @@ In case you would like to convert the values for example to kWh instead of the d ```yaml # Example configuration.yaml entry for sensor template platform -sensor: - - platform: template - sensors: - solaredge_energy_this_year_template: - value_template: "{{ (states('sensor.solaredge_energy_this_year') | float / 1000) | round(2) }}" - unit_of_measurement: "KWh" - icon_template: "mdi:solar-power" +template: + - sensor: + - name: solaredge_energy_this_year_template: + state: "{{ (states('sensor.solaredge_energy_this_year') | float / 1000) | round(2) }}" + unit_of_measurement: "KWh" + icon: "mdi:solar-power" ``` {% endraw %} From 09de52d6dd96f569eb37c3f6ea0cbd93158ac3c9 Mon Sep 17 00:00:00 2001 From: erffrfez Date: Sat, 23 Oct 2021 05:39:20 +0800 Subject: [PATCH 19/39] add reference Riemann integral in "Understanding Home Energy Management" (#19251) --- source/_docs/energy.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/_docs/energy.markdown b/source/_docs/energy.markdown index ce40c1d5625..6ff760cabda 100644 --- a/source/_docs/energy.markdown +++ b/source/_docs/energy.markdown @@ -17,4 +17,6 @@ Home Assistant is an open platform and so home energy management is not restrict - [Integrate your gas consumption](/docs/energy/gas/) - [Integrate individual devices](/docs/energy/individual-devices/) +If you have a sensor that returns instantaneous power readings (W or kW), then to add a sensor that returns energy usage or generation (kWh) refer to [Riemann sum integral integration](/docs/integrations/integration/#energy) + Visual representation of how all different energy forms relate. From 0ef7acfc19e07bf6b8c978aad488c4144888fc76 Mon Sep 17 00:00:00 2001 From: jjlawren Date: Fri, 22 Oct 2021 16:48:19 -0500 Subject: [PATCH 20/39] Improve Plex library sensor description and add automation example (#19740) --- source/_integrations/plex.markdown | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/source/_integrations/plex.markdown b/source/_integrations/plex.markdown index b33e71dd3ab..6347beaac64 100644 --- a/source/_integrations/plex.markdown +++ b/source/_integrations/plex.markdown @@ -65,6 +65,29 @@ The activity sensor provides a count of users currently watching media from the The library sensors show a count of items in each library. Depending on the library contents, the sensor will show extra detail in its attributes. For example, a library sensor for TV shows will represent the total number of episodes in the library and its attributes will also report the number of shows and seasons it contains. +In addition to the item count, the last added media item (movie, album, or episode) and a timestamp showing when it was added are also provided with each library sensor. + +Example automation to use the `last_added_item` attribute on library sensors to notify when new media has been added: +```yaml +alias: Plex - New media added +trigger: + - platform: state + entity_id: sensor.plex_library_movies + id: movie + - platform: state + entity_id: sensor.plex_library_music + id: album + - platform: state + entity_id: sensor.plex_library_tv_shows + id: episode + +action: + - service: notify.mobile_app_phone + data: + title: "New {{ trigger.id }} added" + message: "{{ trigger.to_state.attributes.last_added_item }}" +``` +
The library sensors are disabled by default, but can be enabled via the Plex integration page. From f7e1c45dfd3325be21bb805fd6d7341cd221d26e Mon Sep 17 00:00:00 2001 From: Snailboy2 <39415121+Snailboy2@users.noreply.github.com> Date: Sat, 23 Oct 2021 08:59:02 +0000 Subject: [PATCH 21/39] Updated links (#19915) --- source/_integrations/wled.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_integrations/wled.markdown b/source/_integrations/wled.markdown index 108ec900173..3d5e7a6a34a 100644 --- a/source/_integrations/wled.markdown +++ b/source/_integrations/wled.markdown @@ -20,7 +20,7 @@ ha_platforms: - switch --- -[WLED](https://github.com/Aircoookie/WLED) is a fast and feature-rich +[WLED](https://kno.wled.ge) is a fast and feature-rich implementation of an ESP8266/ESP32 webserver to control NeoPixel (WS2812B, WS2811, SK6812, APA102, and similar) LED's. @@ -87,7 +87,7 @@ Can be configured on the WLED itself under settings > LED Preferences > Timed li Toggles the synchronization between multiple WLED devices. Can be configured on the WLED itself under settings > Sync Interfaces > WLED Broadcast. -[WLED Sync documentation](https://github.com/Aircoookie/WLED/wiki/Sync-WLED-devices-(UDP-Notifier)) +[WLED Sync documentation](https://kno.wled.ge/interfaces/udp-realtime/) {% include integrations/option_flow.md %} @@ -115,7 +115,7 @@ This service allows for controlling the WLED effect. | `reverse` | no | Reverse the effect. Either `true` to reverse or `false` otherwise. | A list of all available effects (and the behavior of the intensity for each -effect) [is documented in the WLED Wiki](https://github.com/Aircoookie/WLED/wiki/List-of-effects-and-palettes#effects). +effect) [is documented in the WLED Knowledge base](https://kno.wled.ge/features/effects-palettes/). ## Example Automations @@ -141,7 +141,7 @@ Activating a random palette is a bit more complicated as there is currently no w To go around this issue, one solution is to leverage the fact that palettes can be activated by their IDs. As the IDs are based on an incrementing counter, picking a random number between zero and the number of palettes minus one works. -To do this, the first step is to use [WLED's JSON API](https://github.com/Aircoookie/WLED/wiki/JSON-API) find out how many palettes the device supports: +To do this, the first step is to use [WLED's JSON API](https://kno.wled.ge/interfaces/json-api) find out how many palettes the device supports: ```bash $ curl --silent http:///json | jq ".palettes | length" From e1ec2888e829507c154f5ac641a0aac9ff95ac4b Mon Sep 17 00:00:00 2001 From: Daniel Rheinbay Date: Sat, 23 Oct 2021 11:01:35 +0200 Subject: [PATCH 22/39] Fix IP address typo in cast.markdown (#19916) --- source/_integrations/cast.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/cast.markdown b/source/_integrations/cast.markdown index b2d71fda26a..d9179ee1e37 100644 --- a/source/_integrations/cast.markdown +++ b/source/_integrations/cast.markdown @@ -54,7 +54,7 @@ Home Assistant Cast requires your Home Assistant installation to be accessible v
-Chromecasts generally ignore DNS servers from DHCP and will instead use Google's DNS servers, 8.8.8.8 and 8.8.4.4. This means media URLs must either be specifying the IP-address of the server directly, e.g. `http://192.168.1.1:8123/movie.mp4`, or be publicly resolvable, e.g. `http://homeassistant.internal.mydomain.com:8123/movie.mp4` where `homeassistant.internal.mydomain.com` resolves to `129.168.1.1`. A hostname which can't be publicly resolved, e.g. `http://homeassistant.local:8123/movie.mp4` will fail to play. +Chromecasts generally ignore DNS servers from DHCP and will instead use Google's DNS servers, 8.8.8.8 and 8.8.4.4. This means media URLs must either be specifying the IP-address of the server directly, e.g. `http://192.168.1.1:8123/movie.mp4`, or be publicly resolvable, e.g. `http://homeassistant.internal.mydomain.com:8123/movie.mp4` where `homeassistant.internal.mydomain.com` resolves to `192.168.1.1`. A hostname which can't be publicly resolved, e.g. `http://homeassistant.local:8123/movie.mp4` will fail to play. This is important when casting TTS or local media sources; the cast integration will cast such media from the `external_url` if [configured](/docs/configuration/basic), otherwise from the Home Assistant Cloud if configured, otherwise from the [`internal_url`](/docs/configuration/basic). Note that the Home Assistant Cloud will not be used if an `external_url` is configured. From 5d2180d4f4a8551c0b97ea8f634795f72590394f Mon Sep 17 00:00:00 2001 From: M-J-W-H <91224286+M-J-W-H@users.noreply.github.com> Date: Sat, 23 Oct 2021 20:20:00 +0200 Subject: [PATCH 23/39] changes BLTE to BTLE (#19927) --- source/_integrations/switchbot.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/switchbot.markdown b/source/_integrations/switchbot.markdown index 52066f45b7c..80a82ba2bb3 100644 --- a/source/_integrations/switchbot.markdown +++ b/source/_integrations/switchbot.markdown @@ -29,7 +29,7 @@ In order to set up this integration, you need to get the BTLE MAC address of you 1. Open the SwitchBot app. 2. Open device settings. 3. Click on "Device Info". -4. Write down the BLTE MAC address of your device. +4. Write down the BTLE MAC address of your device. Please note, device names configured in the SwitchBot app are not transferred into Home Assistant. From 5e8e672ae962c3eb1bd5c8ab5c0c9b84132f0239 Mon Sep 17 00:00:00 2001 From: htcheroportugal Date: Sat, 23 Oct 2021 19:21:48 +0100 Subject: [PATCH 24/39] Update epsonworkforce.markdown (#19926) --- source/_integrations/epsonworkforce.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/epsonworkforce.markdown b/source/_integrations/epsonworkforce.markdown index b4e99f0cb18..fb5d6f4a440 100644 --- a/source/_integrations/epsonworkforce.markdown +++ b/source/_integrations/epsonworkforce.markdown @@ -61,6 +61,7 @@ Supported devices: Tested devices: +- Epson WF2630 - Epson WF2660 - Epson WF3540 - Epson WF3620 From de7aca4c6394950ce6ffea38455496a9b8e75cf0 Mon Sep 17 00:00:00 2001 From: erlendmoland <56839803+erlendmoland@users.noreply.github.com> Date: Sun, 24 Oct 2021 10:56:32 +0200 Subject: [PATCH 25/39] Removed hassio link reference, clarified text (#19938) --- source/_data/glossary.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_data/glossary.yml b/source/_data/glossary.yml index 623c7560bc4..e27bb5ab748 100644 --- a/source/_data/glossary.yml +++ b/source/_data/glossary.yml @@ -37,7 +37,7 @@ - topic: Home Assistant Core description: Home Assistant Core is a Python program. It can be run on various operating systems and is the basis for Home Assistant. When people are talking about Home Assistant Core they usually refer to a standalone installation method that can be installed using a Virtual Environment or Docker. Home Assistant Core does not use the Home Assistant Supervisor. - topic: Home Assistant Supervised (Previously Hass.io) - description: "[Home Assistant](/hassio/) is a full UI managed home automation ecosystem that runs Home Assistant, the Home Assistant Supervisor and add-ons. It comes pre-installed on Home Assistant OS, but can be installed on any Linux system. It leverages Docker, which is managed by the Home Assistant Supervisor." + description: "Home Assistant Supervised is a full UI managed home automation ecosystem that runs Home Assistant, the Home Assistant Supervisor and add-ons. It comes pre-installed on Home Assistant OS, but can be installed on any Linux system. It leverages Docker, which is managed by the Home Assistant Supervisor." - topic: Home Assistant Supervisor description: "The Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, add-ons, itself and, if used, updating the Home Assistant Operating System." - topic: Home Assistant Operating System From 4ed1a5b6f696d356a359df4dc2d25c9c1281319f Mon Sep 17 00:00:00 2001 From: erlendmoland <56839803+erlendmoland@users.noreply.github.com> Date: Sun, 24 Oct 2021 11:00:54 +0200 Subject: [PATCH 26/39] Updated link from /hassio/ to /getting-started/ (#19937) --- source/docs/index.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/docs/index.markdown b/source/docs/index.markdown index a95282fdbb6..8c385a46f11 100644 --- a/source/docs/index.markdown +++ b/source/docs/index.markdown @@ -7,7 +7,7 @@ feedback: false The documentation covers beginner to advanced topics around the installation, setup, configuration, and usage of Home Assistant.
- +
From b9941ce4eacfa08981cc0c0250ce282d8002212a Mon Sep 17 00:00:00 2001 From: erlendmoland <56839803+erlendmoland@users.noreply.github.com> Date: Sun, 24 Oct 2021 11:05:12 +0200 Subject: [PATCH 27/39] Updated outdated links on troubleshooting page (#19939) --- source/_docs/configuration/troubleshooting.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown index d1df80a77b4..a19d25c3f32 100644 --- a/source/_docs/configuration/troubleshooting.markdown +++ b/source/_docs/configuration/troubleshooting.markdown @@ -27,9 +27,9 @@ One of the most common problems with Home Assistant is an invalid `configuration - The configuration files, including `configuration.yaml` must be UTF-8 encoded. If you see error like `'utf-8' codec can't decode byte`, edit the offending configuration and re-save it as UTF-8. - You can verify your configuration's YAML structure using [this online YAML parser](https://yaml-online-parser.appspot.com/) or [YAML Validator](https://codebeautify.org/yaml-validator/). -- To learn more about the quirks of YAML, read [YAML IDIOSYNCRASIES](https://docs.saltstack.com/en/latest/topics/troubleshooting/yaml_idiosyncrasies.html) by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well). +- To learn more about the quirks of YAML, read [YAML IDIOSYNCRASIES](https://docs.saltproject.io/en/latest/topics/troubleshooting/yaml_idiosyncrasies.html) by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well). -`configuration.yaml` does not allow multiple sections to have the same name. If you want to load multiple platforms for one component, you can append a [number or string](/getting-started/devices/#style-2-list-each-device-separately) to the name or nest them using [this style](/getting-started/devices/#style-1-collect-every-entity-under-the-parent): +`configuration.yaml` does not allow multiple sections to have the same name. If you want to load multiple platforms for one component, you can append a [number or string](/docs/configuration/devices/#style-2-list-each-entity-separately) to the name or nest them using [this style](/docs/configuration/devices/#style-1-collect-every-entity-under-the-parent): ```yaml sensor: @@ -49,11 +49,11 @@ If you find any errors or want to expand the documentation, please [let us know] Almost all integrations have external dependencies to communicate with your devices and services. Sometimes Home Assistant is unable to install the necessary dependencies. If this is the case, it should show up in `home-assistant.log`. -The first step is trying to restart Home Assistant and see if the problem persists. If it does, look at the log to see what the error is. If you can't figure it out, please [report it](https://github.com/home-assistant/home-assistant/issues) so we can investigate what is going on. +The first step is trying to restart Home Assistant and see if the problem persists. If it does, look at the log to see what the error is. If you can't figure it out, please [report it](https://github.com/home-assistant/core/issues) so we can investigate what is going on. #### Problems with integrations -It can happen that some integrations either do not work right away or stop working after Home Assistant has been running for a while. If this happens to you, please [report it](https://github.com/home-assistant/home-assistant/issues) so that we can have a look. +It can happen that some integrations either do not work right away or stop working after Home Assistant has been running for a while. If this happens to you, please [report it](https://github.com/home-assistant/core/issues) so that we can have a look. #### Multiple files From a54878684d104d7dd1d510d387f93bcd19452ebe Mon Sep 17 00:00:00 2001 From: Shawn Date: Sun, 24 Oct 2021 03:14:15 -0600 Subject: [PATCH 28/39] add "car" to Traccar categories (#19930) --- source/_integrations/traccar.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/traccar.markdown b/source/_integrations/traccar.markdown index d3d571bf202..f19228d8561 100644 --- a/source/_integrations/traccar.markdown +++ b/source/_integrations/traccar.markdown @@ -3,6 +3,7 @@ title: Traccar description: Instructions how to use Traccar GPS tracker to track devices in Home Assistant. ha_release: 0.83 ha_category: + - Car - Presence Detection ha_iot_class: Local Polling ha_config_flow: true From 1a7e3f5426bb9cf5d9993a28cbd852dab996d037 Mon Sep 17 00:00:00 2001 From: Ketil Moland Olsen Date: Sun, 24 Oct 2021 11:18:07 +0200 Subject: [PATCH 29/39] Corrected dead link (#19929) --- source/_docs/automation/editor.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/automation/editor.markdown b/source/_docs/automation/editor.markdown index 6f5cb4d303e..a56deb7b1cf 100644 --- a/source/_docs/automation/editor.markdown +++ b/source/_docs/automation/editor.markdown @@ -5,7 +5,7 @@ description: "Instructions on how to use the automation editor." The automation editor is an easy way of creating and editing automations from the UI. This page uses the [Random sensor](/integrations/random#sensor) as an example, though any other sensor with a numeric value, can be used as well. -From the UI choose **{% my config %}** which is located in the sidebar, then click on **{% my automations %}** to go to the automation editor. Press the **+** sign in the lower right corner to get started. You will be presented with options to create the automation from a description or from a [blueprint](/automation/using_blueprints/). +From the UI choose **{% my config %}** which is located in the sidebar, then click on **{% my automations %}** to go to the automation editor. Press the **+** sign in the lower right corner to get started. You will be presented with options to create the automation from a description or from a [blueprint](/docs/automation/using_blueprints/).

From d9fa2053d4e7a0787dba6a0a34c7c2960a59c2d5 Mon Sep 17 00:00:00 2001 From: Ketil Moland Olsen Date: Sun, 24 Oct 2021 11:26:22 +0200 Subject: [PATCH 30/39] Corrected typo in link to integrations (#19928) Co-authored-by: Franck Nijhof --- source/_docs/energy.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/energy.markdown b/source/_docs/energy.markdown index 6ff760cabda..31f1b58e8be 100644 --- a/source/_docs/energy.markdown +++ b/source/_docs/energy.markdown @@ -17,6 +17,6 @@ Home Assistant is an open platform and so home energy management is not restrict - [Integrate your gas consumption](/docs/energy/gas/) - [Integrate individual devices](/docs/energy/individual-devices/) -If you have a sensor that returns instantaneous power readings (W or kW), then to add a sensor that returns energy usage or generation (kWh) refer to [Riemann sum integral integration](/docs/integrations/integration/#energy) +If you have a sensor that returns instantaneous power readings (W or kW), then to add a sensor that returns energy usage or generation (kWh) refer to [Riemann sum integral integration](/integrations/integration/#energy) Visual representation of how all different energy forms relate. From 86c192bfbbf89edb5645e975947d8e2443fc0314 Mon Sep 17 00:00:00 2001 From: EgonMarmol <56889319+EgonMarmol@users.noreply.github.com> Date: Sun, 24 Oct 2021 17:43:34 +0200 Subject: [PATCH 31/39] Updated outdated URLs on Authentication Providers page (#19942) --- source/_docs/authentication/providers.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_docs/authentication/providers.markdown b/source/_docs/authentication/providers.markdown index 9c70b599ac7..4ee47ec59c0 100644 --- a/source/_docs/authentication/providers.markdown +++ b/source/_docs/authentication/providers.markdown @@ -144,7 +144,7 @@ Assuming you have only the owner created though onboarding process, no other use The Command Line auth provider executes a configurable shell command to perform user authentication. Two environment variables, `username` and `password`, are passed to the command. Access is granted when the command exits successfully (with exit code 0). -This provider can be used to integrate Home Assistant with arbitrary external authentication services, from plaintext databases over LDAP to RADIUS. A compatible script for LDAP authentication is [this one](https://github.com/efficiosoft/ldap-auth-sh), for instance. Please note, this will only work when using the Home Assistant Core installation type. +This provider can be used to integrate Home Assistant with arbitrary external authentication services, from plaintext databases over LDAP to RADIUS. A compatible script for LDAP authentication is [this one](https://github.com/bob1de/ldap-auth-sh), for instance. Please note, this will only work when using the Home Assistant Core installation type. Here is a configuration example: @@ -202,6 +202,6 @@ If you don't specify any `auth_providers` section in the `configuration.yaml` fi

-[Issue 16441](https://github.com/home-assistant/home-assistant/issues/16441): the legacy API password auth provider, won't be automatically configured if your API password is located in a package. This is because Home Assistant processes the `auth_provider` during the `core` section loading, which is earlier than the `packages` processing. +[Issue 16441](https://github.com/home-assistant/core/issues/16441): the legacy API password auth provider, won't be automatically configured if your API password is located in a package. This is because Home Assistant processes the `auth_provider` during the `core` section loading, which is earlier than the `packages` processing.
From 5973cb929b884bc44a95dbb6be8a4f093cd1e361 Mon Sep 17 00:00:00 2001 From: Ketil Moland Olsen Date: Sun, 24 Oct 2021 17:46:54 +0200 Subject: [PATCH 32/39] Gas: Updated SlimmeLezer and link to SlimmeLezer+ (#19944) --- source/_docs/energy/gas.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/energy/gas.markdown b/source/_docs/energy/gas.markdown index fd9898bb9d7..3abe5cf7877 100644 --- a/source/_docs/energy/gas.markdown +++ b/source/_docs/energy/gas.markdown @@ -19,7 +19,7 @@ The best way to get this data is directly from your gas meter that sits between The P1 port is a standardized port on electricity meters in the Netherlands, Belgium and Luxembourg which also provides gas consumption information. A P1 reader can connect to this port and receive real-time information. -We have worked with creator [Marcel Zuidwijk](https://www.zuidwijk.com) to develop [SlimmeLezer](https://www.slimmelezer.nl). It's an affordable P1 reader powered by [ESPHome](https://esphome.io) that will seamlessly integrate this information in Home Assistant. It is being sold on [his website](https://www.slimmelezer.nl) and the firmware is open source [on GitHub](https://github.com/zuidwijk/dsmr). +We have worked with creator [Marcel Zuidwijk](https://www.zuidwijk.com) to develop [SlimmeLezer+](https://www.zuidwijk.com/product/slimmelezer-plus/). It's an affordable P1 reader powered by [ESPHome](https://esphome.io) that will seamlessly integrate this information in Home Assistant. It is being sold on [his website](https://www.zuidwijk.com/product/slimmelezer-plus/) and the firmware is open source [on GitHub](https://github.com/zuidwijk/dsmr). ![Photo of SlimmeLezer attached to a smart electricity meter](/images/docs/energy/slimmelezer.jpg) From 76cb078c294c88cd07dbcd47b4314e13ffee7666 Mon Sep 17 00:00:00 2001 From: erlendmoland <56839803+erlendmoland@users.noreply.github.com> Date: Sun, 24 Oct 2021 17:47:32 +0200 Subject: [PATCH 33/39] Updated Arilux repo reference (#19945) --- source/_docs/mqtt/discovery.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/mqtt/discovery.markdown b/source/_docs/mqtt/discovery.markdown index 1d96eaba255..286ef972f35 100644 --- a/source/_docs/mqtt/discovery.markdown +++ b/source/_docs/mqtt/discovery.markdown @@ -303,7 +303,7 @@ Supported abbreviations for device registry configuration: The following software has built-in support for MQTT discovery: -- [Arilux AL-LC0X LED controllers](https://github.com/mertenats/Arilux_AL-LC0X) +- [Arilux AL-LC0X LED controllers](https://github.com/smrtnt/Arilux_AL-LC0X) - [ecowitt2mqtt](https://github.com/bachya/ecowitt2mqtt) - [ESPHome](https://esphome.io) - [ESPurna](https://github.com/xoseperez/espurna) From 3cc6a3ab9b24607178536100f51dabf8bc44c8c3 Mon Sep 17 00:00:00 2001 From: Ketil Moland Olsen Date: Sun, 24 Oct 2021 21:08:17 +0200 Subject: [PATCH 34/39] Electricity grid: Updated SlimmeLezer and link to SlimmeLezer+ (#19951) --- source/_docs/energy/electricity-grid.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/energy/electricity-grid.markdown b/source/_docs/energy/electricity-grid.markdown index e9b229bac2b..24ace334bcd 100644 --- a/source/_docs/energy/electricity-grid.markdown +++ b/source/_docs/energy/electricity-grid.markdown @@ -27,7 +27,7 @@ The best way to get this data is directly from your electricity meter that sits The P1 port is a standardized port in the Netherlands, Belgium and Luxembourg. A P1 reader can connect to this port and receive real-time information. -We have worked with creator [Marcel Zuidwijk](https://www.zuidwijk.com) to develop [SlimmeLezer](https://www.slimmelezer.nl). It's an affordable P1 reader powered by [ESPHome](https://esphome.io) that will seamlessly integrate this information in Home Assistant. It is being sold on [his website](https://www.slimmelezer.nl) and the firmware is open source [on GitHub](https://github.com/zuidwijk/dsmr). +We have worked with creator [Marcel Zuidwijk](https://www.zuidwijk.com) to develop [SlimmeLezer+](https://www.zuidwijk.com/product/slimmelezer-plus/). It's an affordable P1 reader powered by [ESPHome](https://esphome.io) that will seamlessly integrate this information in Home Assistant. It is being sold on [his website](https://www.zuidwijk.com/product/slimmelezer-plus/) and the firmware is open source [on GitHub](https://github.com/zuidwijk/dsmr). ![Photo of SlimmeLezer attached to a smart electricity meter](/images/docs/energy/slimmelezer.jpg) From 7bb19c2e3c82a256d3c0615e9dc813c8e47313a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ab=C3=ADlio=20Costa?= Date: Mon, 25 Oct 2021 07:51:42 +0100 Subject: [PATCH 35/39] Update Whirlpool supported ACs list (#19954) --- source/_integrations/whirlpool.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_integrations/whirlpool.markdown b/source/_integrations/whirlpool.markdown index 8bd8edba16e..24cd813b816 100644 --- a/source/_integrations/whirlpool.markdown +++ b/source/_integrations/whirlpool.markdown @@ -23,7 +23,8 @@ There is currently support for the following device types within Home Assistant: The following air conditioners are confirmed to be working, but other models that use the 6th Sense Live application may also work: -- SPIW312A2WF +- SPIW309A2WF/SPIW312A2WF +- SPIW409A2WF {% include integrations/config_flow.md %} From 8f554c2afcc852478beaa2673a08cb67eeb8a2b7 Mon Sep 17 00:00:00 2001 From: EgonMarmol <56889319+EgonMarmol@users.noreply.github.com> Date: Mon, 25 Oct 2021 12:03:58 +0200 Subject: [PATCH 36/39] Refereshed links (#19950) --- source/_docs/configuration/securing.markdown | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/source/_docs/configuration/securing.markdown b/source/_docs/configuration/securing.markdown index a1ef98ed580..77e49f4600f 100644 --- a/source/_docs/configuration/securing.markdown +++ b/source/_docs/configuration/securing.markdown @@ -16,8 +16,9 @@ Here's the summary of what you *must* do to secure your Home Assistant system: If you want secure remote access, the easiest option is to use [Home Assistant cloud](/cloud/) by which you also [support](https://www.nabucasa.com/about) the founders of Home Assistant. -Other options are to use TLS/SSL via the add-ons [Duck DNS integrating Let's Encrypt](/integrations/duckdns/) or [Let’s Encrypt](/docs/ecosystem/certificates/lets_encrypt/). -To expose your instance to the internet, use a [VPN](https://pivpn.dev/), or an [SSH tunnel](/blog/2017/11/02/secure-shell-tunnel/). Make sure to expose the used port in your router. +Another option is to use TLS/SSL via the add-on [Duck DNS](/integrations/duckdns/) integrating Let's Encrypt. + +To expose your instance to the internet, use a [VPN](https://pivpn.io), or an [SSH tunnel](/blog/2017/11/02/secure-shell-tunnel/). Make sure to expose the used port in your router. ### Extras for manual installations @@ -26,4 +27,4 @@ As well as the above we advise that you consider the following to improve securi - For systems that use SSH set `PermitRootLogin no` in your sshd configuration (usually `/etc/ssh/sshd_config`) and to use SSH keys for authentication instead of passwords. This is particularly important if you enable remote access to your SSH services. - Lock down the host following good practice guidance, for example: * [Securing Debian Manual](https://www.debian.org/doc/manuals/securing-debian-manual/index.en.html) (this also applies to Raspberry Pi OS) - * [Red Hat Enterprise Linux 7 Security Guide](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/security_guide/index), [CIS Red Hat Enterprise Linux 7 Benchmark](https://benchmarks.cisecurity.org/tools2/linux/CIS_Red_Hat_Enterprise_Linux_7_Benchmark_v1.0.0.pdf) + * [Red Hat Enterprise Linux 7 Security Guide](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/security_guide/index), [CIS Red Hat Enterprise Linux 7 Benchmark](https://www.cisecurity.org/cis-benchmarks/) From 21130f6cc0b690e126177a18f90f6f611490d90b Mon Sep 17 00:00:00 2001 From: Stefan <37924749+stefanroelofs@users.noreply.github.com> Date: Mon, 25 Oct 2021 13:46:58 +0200 Subject: [PATCH 37/39] Fix broken link (#19958) --- source/_integrations/analytics.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/analytics.markdown b/source/_integrations/analytics.markdown index 0fdc177fa73..e639838001c 100644 --- a/source/_integrations/analytics.markdown +++ b/source/_integrations/analytics.markdown @@ -162,7 +162,7 @@ If your system includes the Supervisor, this will also contain: If enabled, a crash report will be collected when an unexpected error occurs and uploaded to [Sentry](https://sentry.io). These reports will help fix bugs and improve performance and stability. -Crash reports are only visible to the Home Assistant Core developers. This feature is currently limited to the [Supervisor](/docs/glossary/#home-assistant-supervisor) and [OS-Agent]([/docs/glossary/#os-agein-supervisor](https://github.com/home-assistant/os-agent)). +Crash reports are only visible to the Home Assistant Core developers. This feature is currently limited to the [Supervisor](/docs/glossary/#home-assistant-supervisor) and [OS-Agent](https://github.com/home-assistant/os-agent). ## Data storage & processing From 135275ac92bd5ccb97c05034495c77969a828818 Mon Sep 17 00:00:00 2001 From: QbaF <57077178+QbaF@users.noreply.github.com> Date: Mon, 25 Oct 2021 13:47:37 +0200 Subject: [PATCH 38/39] Update netatmo.markdown (#19959) --- source/_integrations/netatmo.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index 6f5da99d714..70d4cea4e2f 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -38,7 +38,7 @@ There is currently support for the following device types within Home Assistant: ### Extra configuration of the integration -Configuration of Netatmo public weather stations is offered from the front end. Enter the Netatmo integration and press the cogwheel. +Configuration of Netatmo public weather stations is offered from the front end. Enter the Netatmo integration and press the "CONFIGURE", then set "Area name" for new area. In the dialog, it is possible to create, edit and remove public weather sensors. For each area a unique name has to be set along with an area to be covered and whether to display average or maximum values. From 46cf657c89220c032117a7ded13531e8f35e25b7 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 26 Oct 2021 09:21:08 +0200 Subject: [PATCH 39/39] Fix forum top Blueprint URLs (#19979) --- Rakefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Rakefile b/Rakefile index 19100afcf4a..8a247672e94 100644 --- a/Rakefile +++ b/Rakefile @@ -220,7 +220,7 @@ end desc "Download data from the blueprint exchange @ community.home-assistant.io" task :blueprint_exchange_data do - uri = URI('https://community.home-assistant.io/c/blueprints-exchange/53/l/top/all.json') + uri = URI('https://community.home-assistant.io/c/blueprints-exchange/53/l/top.json?period=all') remote_data = JSON.parse(Net::HTTP.get(uri))