diff --git a/source/_integrations/firmata.markdown b/source/_integrations/firmata.markdown
index 8a963fa8cec..dfb6eb4bdbc 100644
--- a/source/_integrations/firmata.markdown
+++ b/source/_integrations/firmata.markdown
@@ -20,7 +20,7 @@ ha_platforms:
ha_integration_type: integration
---
-[Firmata](https://github.com/firmata/protocol) can be used to add analog and digital inputs and outputs to Home Assistant. This allows for buttons, switches, motion detectors, relay control, sensors, potentiometers, dimmers, etc. The component can currently connect to a Firmata board via serial or serial over USB.
+[Firmata](https://github.com/firmata/protocol) can be used to add analog and digital inputs and outputs to Home Assistant. This allows for buttons, switches, motion detectors, relay control, sensors, potentiometers, dimmers, etc. The integration can currently connect to a Firmata board via serial or serial over USB.
The Firmata protocol is a standard protocol for microcontrollers. Most of these boards support digital and analog inputs and outputs. [Arduino](https://www.arduino.cc/) and Arduino-compatible microcontroller development boards are the most popular boards to use with Firmata.
diff --git a/source/_integrations/fleetgo.markdown b/source/_integrations/fleetgo.markdown
index ddc3596c142..3929cdc2012 100644
--- a/source/_integrations/fleetgo.markdown
+++ b/source/_integrations/fleetgo.markdown
@@ -15,7 +15,7 @@ The `fleetgo` device tracker platform allows you to integrate your vehicles equi
## Setup
-To use this component, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key).
+To use this integration, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key).
## Configuration
diff --git a/source/_integrations/folder_watcher.markdown b/source/_integrations/folder_watcher.markdown
index 97788e9ffa3..e658d5b5808 100644
--- a/source/_integrations/folder_watcher.markdown
+++ b/source/_integrations/folder_watcher.markdown
@@ -1,6 +1,6 @@
---
title: Folder Watcher
-description: Component for monitoring changes within the filesystem.
+description: Integration for monitoring changes within the filesystem.
ha_category:
- System Monitor
ha_iot_class: Local Polling
diff --git a/source/_integrations/frontend.markdown b/source/_integrations/frontend.markdown
index 867d96ad78d..54b9d7e3cf9 100644
--- a/source/_integrations/frontend.markdown
+++ b/source/_integrations/frontend.markdown
@@ -65,7 +65,7 @@ frontend:
accent-color: darkred
```
-The example above defines two themes named `happy` and `sad`. For each theme, you can set values for CSS variables. If you want to provide hex color values, wrap those in apostrophes, since otherwise, YAML would consider them a comment (`primary-color: "#123456"`).
+The example above defines two themes named `happy` and `sad`. For each theme, you can set values for CSS variables. If you want to provide hex color values, wrap those in quotation marks, since otherwise, YAML would consider them a comment (`primary-color: "#123456"`).
### Supported theme variables
diff --git a/source/_integrations/generic.markdown b/source/_integrations/generic.markdown
index d4a4dfe70bf..2bdfc163de5 100644
--- a/source/_integrations/generic.markdown
+++ b/source/_integrations/generic.markdown
@@ -86,12 +86,12 @@ To access a camera which is only available via HTTP, you must turn off SSL verif
### Live stream
-To access a camera that has both a snapshot and live stream URL, utilizing the [stream](/integrations/stream/) component.
+To access a camera that has both a snapshot and live stream URL, utilizing the [stream](/integrations/stream/) integration.
- Still Image URL: `http://194.218.96.92/jpg/image.jpg`
- Stream Source: `rtsp://user:pass@194.218.96.92:554`
-If a camera only has a live stream URL and no snapshot URL, the [stream](/integrations/stream/) component can also generate still images from the live stream URL.
+If a camera only has a live stream URL and no snapshot URL, the [stream](/integrations/stream/) integration can also generate still images from the live stream URL.
- Stream Source: `rtsp://user:pass@194.218.96.92:554`
diff --git a/source/_integrations/geofency.markdown b/source/_integrations/geofency.markdown
index fd5555528b0..4b61198552d 100644
--- a/source/_integrations/geofency.markdown
+++ b/source/_integrations/geofency.markdown
@@ -43,4 +43,4 @@ geofency:
When you enter a geofence or stationary beacon, your location name in Home Assistant will be set to the name of the geofence or beacon location in Geofency. When you exit a geofence or stationary beacon, your location name in Home Assistant will be set to `not home`. For mobile beacons, the location name will be `not_home` whenever the beacon is entered or exited outside of a [zone](/integrations/zone/), otherwise, it will be set to the name of the zone.
-To make Geofency work better with the [proximity](/integrations/proximity/) component, you should enable the 'Send Current Location' feature in the Webhook configuration screen. This ensures that the _current_ GPS coordinates are included in exit events instead of the coordinates of the (center of) the zone that was exited.
+To make Geofency work better with the [proximity](/integrations/proximity/) integration, you should enable the 'Send Current Location' feature in the Webhook configuration screen. This ensures that the _current_ GPS coordinates are included in exit events instead of the coordinates of the (center of) the zone that was exited.
diff --git a/source/_integrations/google_assistant.markdown b/source/_integrations/google_assistant.markdown
index 524bd77e605..3fdba659654 100644
--- a/source/_integrations/google_assistant.markdown
+++ b/source/_integrations/google_assistant.markdown
@@ -15,17 +15,17 @@ ha_platforms:
- diagnostics
---
-The `google_assistant` integration allows you to control your Home Assistant devices via Google Assistant on your mobile, tablet or Google Home device.
+The `google_assistant` integration allows you to control your Home Assistant devices via Google Assistant on your mobile, tablet, or Google Home device.
If you want to send commands to Google Assistant to control devices supported by Google Assistant but not by Home Assistant, or broadcast messages to Google Assistant speakers and displays without interrupting music/video playback, take a look at the [Google Assistant SDK](/integrations/google_assistant_sdk) integration.
## Automatic setup via Home Assistant Cloud
-With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instance in a few simple clicks to Google Assistant. With Home Assistant Cloud you don't have to deal with dynamic DNS, SSL certificates or opening ports on your router. Just log in via the user interface and a secure connection with the cloud will be established. Home Assistant Cloud requires a paid subscription after a 30-day free trial.
+With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instance in a few simple clicks to Google Assistant. With Home Assistant Cloud you don't have to deal with dynamic DNS, SSL certificates, or opening ports on your router. Just log in via the user interface and a secure connection with the cloud will be established. Home Assistant Cloud requires a paid subscription after a 30-day free trial.
-For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/google_assistant/).
+For Home Assistant Cloud users, documentation can be found [here](https://www.nabucasa.com/config/google_assistant/).
-## Manual setup
+## Manual setup (if you don't have Home Assistant Cloud)
The Google Assistant integration (without Home Assistant Cloud) requires a bit more setup than most due to the way Google requires Assistant Apps to be set up.
@@ -38,60 +38,60 @@ To use Google Assistant, your Home Assistant configuration has to be [externally
### Google Cloud Platform configuration
1. Create a new project in the [Actions on Google console](https://console.actions.google.com/).
- 1. Click `New Project` and give your project a name.
- 2. Click on the `Smart Home` card, then click the `Start Building` button.
- 3. Click `Name your Smart Home action` under `Quick Setup` to give your Action a name - Home Assistant will appear in the Google Home app as `[test] 
-3. Select the `Develop` tab at the top of the page, then in the upper right hand corner select the `Test` button to generate the draft version Test App. If you don't see this option, go to the `Test` tab instead, click on the `Settings` button in the top right below the header, and ensure `On device testing` is enabled (if it isn't, enable it).
+3. Select the **Develop** tab at the top of the page, then, in the upper right hand corner, select the **Test** button to generate the draft version Test App. If you don't see this option, go to the **Test** tab instead, select the **Settings** button in the top right below the header, and ensure **On device testing** is enabled (if it isn't, enable it).
4. Go to [Google Cloud Platform](https://console.cloud.google.com/).
- 1. Go to `Select a project`.
+ 1. Go to **Select a project**.
2. In the window that popped up, select your newly created project from step 1.
- 3. Go to the menu and select `APIs and Services`and next `Credentials`.
- 4. In the Credentials view, select `Create credentials` and next `Service account`.
- 1. `Service account name`: Give your account a self-selected name.
- 2. Click `Create`.
- 3. `Select a role`: `Service Accounts` and `Service Account Token Creator`.
- 4. Click `Continue`.
- 5. Click on `Done`.
- 5. Under `Service Accounts` there should now be an account called [name from 4.1]@[projectname].iam.gserviceaccount.com.
+ 3. Go to the menu and select **APIs and Services** and next **Credentials**.
+ 4. In the **Credentials** view, select **Create credentials** and next **Service account**.
+ 1. **Service account name**: Give your account a self-selected name.
+ 2. Select **Create and Continue**.
+ 3. **Select a role**: **Service Accounts** and **Service Account Token Creator**.
+ 4. Select **Continue**.
+ 5. Select **Done**.
+ 5. Under **Service Accounts** there should now be an account called [name from 4.1]@[projectname].iam.gserviceaccount.com.
6. Click on the pencil button of that service account.
- 7. Go to `Keys` and `ADD KEY`.
+ 7. Go to **Keys** and **ADD KEY**.
8. Create a private key, make sure it is in JSON format.
9. This will start a download of a JSON file.
1. Rename the file to `SERVICE_ACCOUNT.JSON`.
2. Add this file to your config-folder. This will be the same folder as your `configuration.yaml`.
- 12. Go back to [Google Cloud Platform](https://console.cloud.google.com/) and click `Close`.
- 13. Then click `SAVE`.
- 14. Go to the `Search products and resources` and search for `Homegraph API` and select it.
+ 12. Go back to [Google Cloud Platform](https://console.cloud.google.com/) and select **Close**.
+ 13. Then select **SAVE**.
+ 14. Go to the **Search products and resources** and search for **Homegraph API** and select it.
15. Enable the HomeGraph API.
5. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#yaml-configuration) below.
6. Add services in the Google Home App (note that app versions may be slightly different).
1. Open the Google Home app.
- 2. Click the `+` button on the top left corner, click `Set up device`, in the "Set up a device" screen click "Works with Google". You should have `[test]
@@ -104,15 +104,15 @@ If you've added Home Assistant to your phone's home screen, you have to first re
If you want to allow other household users to control the devices:
1. Open the project you created in the [Actions on Google console](https://console.actions.google.com/).
-2. Click `Test` on the top of the page, then click `Simulator` located to the page left, then click the three little dots (more) icon in the upper right corner of the console.
-3. Click Manage user access. This redirects you to the Google Cloud Platform IAM permissions page.
-4. Click ADD at the top of the page.
+2. Select **Test** on the top of the page, then select **Simulator** located to the page left, then click the three little dots (more) icon in the upper right corner of the console.
+3. Select **Manage user access**. This redirects you to the Google Cloud Platform IAM permissions page.
+4. Select **GRANT ACCESS** at the top of the page.
1. Enter the email address of the user you want to add.
- 2. Click Select a role and choose Project < Viewer.
- 3. Click SAVE
+ 2. Select **Select a role** and choose **Project** > **Viewer**.
+ 3. Select **SAVE**.
4. Copy and share the Actions project link (`https://console.actions.google.com/project/YOUR_PROJECT_ID/simulator`) with the new user.
-5. Have the new user open the link with their own Google account, agree to the Terms of Service popup, then select "Start Testing", select VERSION - Draft in the dropdown, and click "Done".
-6. Have the new user go to their `Google Assistant` app to add `[test] your app name` to their account.
+5. Have the new user open the link with their own Google account, agree to the Terms of Service popup. Then select **Start Testing**, select **VERSION - Draft** in the dropdown, and select **Done**.
+6. Have the new user go to their **Google Assistant** app to add `[test] your app name` to their account.
### Enable Device Sync
@@ -121,19 +121,19 @@ If you want to support active reporting of state to Google's server (configurati
1. Service Account
1. In the Google Cloud Platform Console, go to the [Create Service account key](https://console.cloud.google.com/iam-admin/serviceaccounts/create) page.
2. At the top left of the page next to "Google Cloud Platform" logo, select your project created in the Actions on Google console. Confirm this by reviewing the project ID and it ensure it matches.
- 3. From the Service account list, select `CREATE SERVICE ACCOUNT`.
- 4. In the Service account name field, enter a name.
- 5. In the Service account ID field, enter an ID.
- 6. From the Role list, select `Service Accounts` > `Service Account Token Creator`.
- 7. Click `CONTINUE` and then `DONE`. You are returned to the service account list, and your new account is shown.
- 8. Click the three dots menu under `Actions` next to your new account, and click `Manage keys`. You are taken to a `Keys` page.
- 9. Click `ADD KEY` then `Create new key`. Leave the `key type` as `JSON` and click `CREATE`. A JSON file that contains your key downloads to your computer.
+ 3. From the Service account list, select **CREATE SERVICE ACCOUNT**.
+ 4. In the **Service account name** field, enter a name.
+ 5. In the **Service account ID** field, enter an ID.
+ 6. From the **Role** list, select **Service Accounts** > **Service Account Token Creator**.
+ 7. Select **CONTINUE** and then **DONE**. You are returned to the service account list, and your new account is shown.
+ 8. Select the three dots menu under **Actions** next to your new account, and select **Manage keys**. You are taken to a **Keys** page.
+ 9. Select **ADD KEY** then **Create new key**. Leave the **key type** as **JSON** and select **CREATE**. A JSON file that contains your key downloads to your computer.
10. Use the information in this file or the file directly to add to the `service_account` key in the configuration.
- 11. Click `Close`.
+ 11. Select **Close**.
2. HomeGraph API
1. Go to the [Google API Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview).
2. At the top left of the page next to "Google Cloud Platform" logo, select your project created in the Actions on Google console. Confirm this by reviewing the project ID and it ensure it matches.
- 3. Click Enable HomeGraph API.
+ 3. Select **Enable HomeGraph API**.
3. Try "OK Google, sync my devices" - the Google Home app should import your exposed Home Assistant devices and prompt you to assign them to rooms.
### Enable Local Fulfillment
@@ -143,6 +143,7 @@ Google Assistant devices can send their commands locally to Home Assistant allow
Your Home Assistant instance needs to be connected to the same network as the Google Assistant device that you’re talking to so that it can be discovered via mDNS discovery (UDP broadcasts).
Your Google Assistant devices will still communicate via the internet to:
+
- Get credentials to establish a local connection.
- Send commands that involve a [secure device](#secure-devices).
- Send commands if local fulfillment fails.
@@ -158,16 +159,16 @@ For secure remote access, use a reverse proxy such as the {% my supervisor_addon
1. Open the project you created in the [Actions on Google console](https://console.actions.google.com/).
-2. Click `Develop` on the top of the page, then click `Actions` located in the hamburger menu on the top left.
-3. Upload `app.js` from [here](https://github.com/NabuCasa/home-assistant-google-assistant-local-sdk/releases/latest) for both Node and Chrome by clicking the `Upload JavaScript files` button.
+2. Select **Develop** on the top of the page, then select **Actions** located in the hamburger menu on the top left.
+3. Upload `app.js` from [here](https://github.com/NabuCasa/home-assistant-google-assistant-local-sdk/releases/latest) for both Node and Chrome by selecting the **Upload JavaScript files** button.
4. Add device scan configuration:
- 1. Click `+ New scan config` if no configuration exists
- 2. Select `MDNS`
- 3. Set `MDNS service name` to `_home-assistant._tcp.local`
- 4. Click `Add field`, then under `Select a field` choose `Name`
- 5. Enter a new `Value` field set to `.*\._home-assistant\._tcp\.local`
-5. Check the box `Support local query` under `Add capabilities`.
-6. `Save` your changes.
+ 1. Select **+ New scan config** if no configuration exists
+ 2. Select **MDNS**.
+ 3. Set **MDNS service name** to `_home-assistant._tcp.local`
+ 4. Select **Add field**, then under **Select a field**, choose **Name**.
+ 5. Enter a new **Value** field set to `.*\._home-assistant\._tcp\.local`
+5. Check the box **Support local query** under **Add capabilities**.
+6. Save your changes.
7. Either wait for 30 minutes, or restart all your Google Assistant devices.
8. Restart Home Assistant Core.
9. With a Google Assistant device, try saying "OK Google, sync my devices." This can be helpful to avoid issues, especially if you are enabling local fulfillment sometime after adding cloud Google Assistant support.
@@ -297,11 +298,11 @@ Some of these devices may not display correctly in the Google Home app, such as
### Secure Devices
-Certain devices are considered secure, including anything in the `lock` domain, `alarm_control_panel` domain and `covers` with device types `door`, `garage` or `gate`.
+Certain devices are considered secure. This includes devices in the `lock` domain, the `alarm_control_panel` domain, as well as `covers` with device types `door`, `garage`, or `gate`.
-By default these cannot be opened by Google Assistant unless a `secure_devices_pin` is set up. To allow opening, set the `secure_devices_pin` to something and you will be prompted to speak the pin when opening the device. Closing or locking these devices does not require a pin.
+By default, secure devices cannot be opened by Google Assistant unless a `secure_devices_pin` code is set up. To allow opening, set the `secure_devices_pin` to something. You will then be prompted to speak the pin when opening the device. Closing or locking these devices does not require a pin.
-For the Alarm Control Panel if a code is set it must be the same as the `secure_devices_pin`. If `code_arm_required` is set to `false` the system will arm without prompting for the pin.
+If a code is set for the Alarm Control Panel, it must be the same as the `secure_devices_pin`. If `code_arm_required` is set to `false`, the system will arm without prompting for the pin.
### Room/Area support
diff --git a/source/_integrations/google_translate.markdown b/source/_integrations/google_translate.markdown
index 05876d93297..dc8d30b8eae 100644
--- a/source/_integrations/google_translate.markdown
+++ b/source/_integrations/google_translate.markdown
@@ -16,29 +16,29 @@ The `google_translate` text-to-speech platform uses the unofficial [Google Trans
{% include integrations/config_flow.md %}
-Check the [complete list of supported languages](https://translate.google.com/intl/en_ALL/about/languages/) (languages where "Talk" feature is enabled in Google Translate) for allowed values.
+Check the [complete list of supported languages](https://cloud.google.com/translate/docs/languages) (languages where "Talk" feature is enabled in Google Translate) for allowed values.
Use the 2-digit language code which you can find at the end of the URL when you click on the language name.
-Check the [complete list of supported tld](https://www.google.com/supported_domains) for allowed TLD values. This is used to force the dialect used when multiple fall into the same 2-digit language code(i.e., *US, UK, AU*)
+Check the [complete list of supported tld](https://www.google.com/supported_domains) for allowed TLD values. This is used to force the dialect used when multiple fall into the same 2-digit language code(i.e., _US, UK, AU_)
You can also use supported BCP 47 tags like the below or the 2-2 digit format for your supported dialect(`en-gb` or `en-us`). Below is a list of the currently implemented mappings:
-| Dialect | Language | TLD |
-|---------|----------|-----|
-|en-us|en|com|
-|en-gb|en|co.uk|
-|en-uk|en|co.uk|
-|en-au|en|com.au|
-|en-ca|en|ca|
-|en-in|en|co.in|
-|en-ie|en|ie|
-|en-za|en|co.za|
-|fr-ca|fr|ca|
-|fr-fr|fr|fr|
-|pt-br|pt|com.br|
-|pt-pt|pt|pt|
-|es-es|es|es|
-|es-us|es|com|
+| Dialect | Language | TLD |
+| ------- | -------- | ------ |
+| en-us | en | com |
+| en-gb | en | co.uk |
+| en-uk | en | co.uk |
+| en-au | en | com.au |
+| en-ca | en | ca |
+| en-in | en | co.in |
+| en-ie | en | ie |
+| en-za | en | co.za |
+| fr-ca | fr | ca |
+| fr-fr | fr | fr |
+| pt-br | pt | com.br |
+| pt-pt | pt | pt |
+| es-es | es | es |
+| es-us | es | com |
## Service say
diff --git a/source/_integrations/google_wifi.markdown b/source/_integrations/google_wifi.markdown
index 18d13773294..84514d908ff 100644
--- a/source/_integrations/google_wifi.markdown
+++ b/source/_integrations/google_wifi.markdown
@@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `google_wifi` sensor platform is displaying the exposed status of a [Google Wifi](https://madeby.google.com/wifi/) (or OnHub) router.
+The `google_wifi` sensor platform is displaying the exposed status of a Google Wifi (or OnHub) router.
The sensor is able to report network status, up-time, current IP address and firmware versions.
diff --git a/source/_integrations/graphite.markdown b/source/_integrations/graphite.markdown
index de9aaebe95a..bfe32219780 100644
--- a/source/_integrations/graphite.markdown
+++ b/source/_integrations/graphite.markdown
@@ -11,7 +11,7 @@ ha_integration_type: integration
The `graphite` integration records all events and state changes and feeds the data to a [graphite](http://graphiteapp.org/) instance.
-To enable this component, add the following lines to your `configuration.yaml`:
+To enable this integration, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/history_stats.markdown b/source/_integrations/history_stats.markdown
index 82d1d249d73..b535e1d5aec 100644
--- a/source/_integrations/history_stats.markdown
+++ b/source/_integrations/history_stats.markdown
@@ -129,7 +129,7 @@ duration:
- If the duration exceeds the number of days of history stored by the `recorder` component (`purge_keep_days`), the history statistics sensor will not have all the information it needs to look at the entire duration. For example, if `purge_keep_days` is set to 7, a history statistics sensor with a duration of 30 days will only report a value based on the last 7 days of history.
+ If the duration exceeds the number of days of history stored by the `recorder` integration (`purge_keep_days`), the history statistics sensor will not have all the information it needs to look at the entire duration. For example, if `purge_keep_days` is set to 7, a history statistics sensor with a duration of 30 days will only report a value based on the last 7 days of history.
diff --git a/source/_integrations/homekit.markdown b/source/_integrations/homekit.markdown
index 42cee647fc6..48bca8beded 100644
--- a/source/_integrations/homekit.markdown
+++ b/source/_integrations/homekit.markdown
@@ -284,7 +284,7 @@ To enable the HomeKit integration in Home Assistant, add the following to your c
homekit:
```
-After Home Assistant has started, the entities (depending on the filter) are exposed to HomeKit if they are [supported](#supported-components). To add them:
+After Home Assistant has started, the entities (depending on the filter) are exposed to HomeKit if they are [supported](#supported-integrations). To add them:
1. Open the Home Assistant frontend. A new card will display the pairing QR code and the `pin code` as seen in the example below. Note: If pin code is not displayed, check "Notifications" (the bell icon) in the lower-left of the Home Assistant UI.
2. Open the Apple `Home` app.
@@ -346,7 +346,7 @@ To add a single entity in accessory mode:
## Configure Filter
-By default, all entities except categorized entities (config, diagnostic, and system entities) are included. To limit which entities are being exposed to `HomeKit`, you can use the `filter` parameter. Keep in mind only [supported components](#supported-components) can be added.
+By default, all entities except categorized entities (config, diagnostic, and system entities) are included. To limit which entities are being exposed to `HomeKit`, you can use the `filter` parameter. Keep in mind only [supported integrations](#supported-integrations) can be added.
```yaml
# Example filter to include specified domains and exclude specified entities
@@ -387,11 +387,11 @@ If you have a firewall configured on your Home Assistant system, make sure you o
- UDP: 5353
- TCP: 21063 (or the configured/used `port` in the integration settings).
-## Supported Components
+## Supported integrations
The following integrations are currently supported:
-| Component | Type Name | Description |
+| Integration | Type Name | Description |
| --------- | --------- | ----------- |
| alarm_control_panel | SecuritySystem | All security systems. |
| automation / input_boolean / remote / scene / script / vacuum | Switch | All represented as switches. |
@@ -573,7 +573,7 @@ Pairing works fine when the filter is set to only include `demo.demo`, but fails
#### Pairing hangs - no error
-1. Make sure that you don't try to add more than 150 accessories, see [device limit](#device-limit). In rare cases, one of your entities doesn't work with the HomeKit component. Use the [filter](#configure-filter) to find out which one. Feel free to open a new issue in the `home-assistant` repository, so we can resolve it.
+1. Make sure that you don't try to add more than 150 accessories, see [device limit](#device-limit). In rare cases, one of your entities doesn't work with the HomeKit integration. Use the [filter](#configure-filter) to find out which one. Feel free to open a new issue in the `home-assistant` repository, so we can resolve it.
2. Check logs, and search for `Starting accessory Home Assistant Bridge on address`. Make sure Home Assistant Bridge connected to a correct interface. If it did not, explicitly set `homekit.ip_address` configuration variable.
### Issues during normal use
@@ -584,7 +584,7 @@ Multiple users have reported that iOS 12 and earlier devices will spontaneously
#### My entity doesn't show up
-Check if the domain of your entity is [supported](#supported-components). If it is, check your [filter](#configure-filter) settings. Make sure the spelling is correct, especially if you use `include_entities`.
+Check if the domain of your entity is [supported](#supported-integrations). If it is, check your [filter](#configure-filter) settings. Make sure the spelling is correct, especially if you use `include_entities`.
#### HomeKit doesn't work on second Home Assistant instance
diff --git a/source/_integrations/homekit_controller.markdown b/source/_integrations/homekit_controller.markdown
index 7e3f0239dec..0031f04f0fe 100644
--- a/source/_integrations/homekit_controller.markdown
+++ b/source/_integrations/homekit_controller.markdown
@@ -19,8 +19,8 @@ ha_iot_class: Local Push
ha_bluetooth: true
ha_config_flow: true
ha_codeowners:
- - '@Jc2k'
- - '@bdraco'
+ - "@Jc2k"
+ - "@bdraco"
ha_domain: homekit_controller
ha_zeroconf: true
ha_platforms:
@@ -45,7 +45,7 @@ ha_integration_type: integration
The [HomeKit](https://developer.apple.com/apple-home/) Device integration allows you to connect accessories with the "Works with HomeKit" logo to Home Assistant. This integration should not be confused with the [HomeKit](/integrations/homekit/) integration, which allows you to control Home Assistant devices via HomeKit.
-The integration will automatically detect HomeKit compatible devices that are ready to pair if the [`zeroconf`](/integrations/zeroconf/) integration is enabled. This is enabled by default on new installations via the [`default_config`](/integrations/default_config/) component.
+The integration will automatically detect HomeKit compatible devices that are ready to pair if the [`zeroconf`](/integrations/zeroconf/) integration is enabled. This is enabled by default on new installations via the [`default_config`](/integrations/default_config/) integration.
To see which devices have been discovered see the "Integrations" page in your Home Assistant dashboard. When you click on "Configure" you can enter your HomeKit PIN and the device should be added to your Home Assistant instance. If your device is currently paired with an Apple device via HomeKit, you will need to reset it in order to pair it with Home Assistant. Once Home Assistant is configured to work with the device, you can export it back to Siri and Apple Home with the [`HomeKit`](/integrations/homekit/) integration.
@@ -68,7 +68,7 @@ There is currently support for the following device types within Home Assistant:
- If your device is not on this list then you may still be able to pair it, and it will be visible in the Device Registry. But Home Assistant may not create entities for it.
+If your device is not on this list then you may still be able to pair it, and it will be visible in the Device Registry. But Home Assistant may not create entities for it.
@@ -79,17 +79,95 @@ HomeKit IP accessories for these device types may work with some caveats:
The integration will poll your devices, but it will also automatically enable push updates for accessories that support it.
-## Bluetooth device support
+## Adding a HomeKit device through Bluetooth
The integration will automatically discover Bluetooth devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional. Bluetooth devices may take significantly longer to pair than IP devices. Battery-powered devices may require pressing a button on the device to wake it before pairing can be successful.
-## Thread device support
+### Prerequisites
-In order to use HomeKit over Thread you need a working border router (like a HomePod mini). Your Home Assistant instance will need to be on the same VLAN as the border router.
+- If your Home Assistant instance does not natively support Bluetooth, use an ESPHome Bluetooth proxy.
+ - A proxy can also be helpful if your Home Assistant device is too far away from the device you are trying to pair.
+- If your HomeKit device has been used with Thread before, or is still paired with iOS, reset the device.
+ - HomeKit devices can only be paired to a single controller at once.
+ - If it has been in a Thread network before, the device might remember the Thread credentials of a different network. A reset makes sure the device is not connected to any Thread network.
-The integration will automatically discover supported Thread devices using the [Zeroconf](/integrations/zeroconf) integration. Battery powered devices may go to sleep and require a button pressing to wake them up before pairing works.
+## To add a HomeKit device through Bluetooth
-In order to provision a Thread device onto a mesh network using a HomePod as a border router, first pair it with an iOS device. Then unpair it from the Home app. Don't reset it. This will leave the Thread network details on the device. Home Assistant can now pair with it over Thread.
+1. Power up your HomeKit device.
+ - If you have Bluetooth enabled, the device should be discovered under **{% my integrations title="Settings > Devices & Services" %}**.
+1. Under **{% my integrations title="Settings > Devices & Services" %}**, on the HomeKit integration, select **Configure**.
+ 
+1. To pair the device, enter the HomeKit pairing code. The code is on the device itself or the packaging.
+ - To pair a battery-powered device, you may need to press a button on the device to wake it.
+ - Bluetooth devices may take significantly longer to pair than IP devices.
+ - Add the device to a room and **Finish**.
+
+## Adding a HomeKit device to a Thread network via Home Assistant
+
+There are two methods to add a HomeKit device to a Thread network:
+
+- via Home Assistant's preferred Thread network
+- via [Apple Thread border router](#adding-a-homekit-device-to-home-assistant-via-apple-thread-border-router)
+
+This section describes how to add it via Home Assistant's preferred Thread network.
+
+### Prerequisites
+
+- A HomeKit device which supports Thread. This is indicated by the Thread label on the packaging.
+- Make sure the HomeKit device has been [joined using Bluetooth](#adding-a-homekit-device-through-bluetooth).
+- **Thread network**: In order to use HomeKit over Thread, you need a working border router.
+ - Make sure your Home Assistant device is on the same network (LAN) as the border router.
+ - Make sure the Thread network you'd like to use is known by Home Assistant and marked as **Preferred network** in the Thread configuration.
+ - If you have a Home Assistant Yellow or SkyConnect, you can enable multiprotocol to set up an Open Thread border router and with that a Thread network.
+ - Documentation on [enabling multiprotocol on Yellow](https://yellow.home-assistant.io/guides/enable-multiprotocol/)
+ - Documentation on [enabling multiprotocol on SkyConnect](https://skyconnect.home-assistant.io/procedures/enable-multiprotocol/)
+
+### To add a HomeKit device to a Thread network via Home Assistant
+
+1. To open the device configuration page, on the **HomeKit** integration, select the **device**.
+1. Under **Diagnostic**, you can see the **Thread Status** as **Disabled**.
+ 
+1. To enable Thread, under **Configuration**, select **Press**. This will provision the preferred Thread credentials.
+ - The status has now changed:
+ - Depending on the device type, the mesh size and health, the Thread status can be **Child**, **Router**, or **Leader**.
+ 
+ - That's it. Your HomeKit device now communicates via Thread.
+
+## Adding a HomeKit device to Home Assistant via Apple Thread border router
+
+There are two methods to add a HomeKit device to a Thread network:
+
+- via [Home Assistant's preferred Thread network](#adding-a-homekit-device-to-a-thread-network-via-home-assistant)
+- via Apple Thread border router
+
+This section describes how to add a HomeKit device using an Apple Thread border router device such as a HomePod mini.
+
+### Prerequisites
+
+- An Apple device that can act as a Thread border router, such as a HomePod mini.
+- A HomeKit device which supports Thread. This is indicated by the Thread label on the packaging.
+- Make sure your Home Assistant instance is on the same network (LAN) as the border router.
+- Make sure the HomeKit device has been paired in the Apple Home app (using the iOS Home app).
+
+### To add a HomeKit device to Home Assistant via Apple Thread border router
+
+1. Remove the HomeKit device from the Apple Home app. Don't reset the device.
+ - This leaves the Thread network details on the HomeKit device.
+ - The device will be automatically discovered by the HomeKit controller integration in Home Assistant.
+ - It will appear as a discovered device over Thread.
+1. Under **{% my integrations title="Settings > Devices & Services" %}**, on the HomeKit integration, select **Configure**.
+
+ 
+
+1. To pair the device, enter the HomeKit pairing code. The code is on the device itself or the packaging.
+ - To pair a battery-powered device, you may need to press a button on the device to wake it.
+ - Bluetooth devices may take significantly longer to pair than IP devices.
+ - Add the device to a room and **Finish**.
+1. To open the device configuration page, on the **HomeKit** integration, select the **device**.
+1. Under **Diagnostic**, check the status:
+ - Depending on the device type, the mesh size and health, the Thread status can be **Child**, **Router**, or **Leader**.
+ 
+ - That's it. Your HomeKit device now communicates via Thread.
## 'Stateless' switches and sensors
diff --git a/source/_integrations/homematic.markdown b/source/_integrations/homematic.markdown
index 08e6cf9d11b..f1dd050a153 100644
--- a/source/_integrations/homematic.markdown
+++ b/source/_integrations/homematic.markdown
@@ -58,7 +58,7 @@ You can manually rename the created entities by using Home Assistant's [Customiz
## Configuration
-To set up the component, add the following information to your `configuration.yaml` file:
+To set up the integration, add the following information to your `configuration.yaml` file:
```yaml
homematic:
@@ -201,7 +201,7 @@ homematic:
We use three approaches to fetch the names of devices. Each assumes you have properly named your devices in your existing Homematic setup. As a general advice: Use ASCII for your devices names. Home Assistant won't include non-ASCII characters in entity-names.
-1. `json`: The CCU allows to fetch details of the paired devices via JSON-RPC. For this to work you need to add valid credentials to your component-configuration. Guest-access is sufficient to query for device names.
+1. `json`: The CCU allows to fetch details of the paired devices via JSON-RPC. For this to work, you need to add valid credentials to your integration configuration. Guest-access is sufficient to query for device names.
2. `xml`: If you use a CCU, there is an add-on called the "XML-API". With it installed, you are able to fetch all kinds of information from you CCU using XML-RPC. We can leverage this and fetch the names of devices set within the CCU. We don't support authentication with this method. The `json` method should be preferred over `xml`. Support for the XML-API is only available for downwards compatibility and may be disabled in a future release.
3. `metadata`: Homegear provides device-names through the metadata devices internally have. When using an HM-CFG-LAN interface, you typically use a configuration software ("HomeMatic-Komponenten konfigurieren" is the name of the shortcut on your desktop by default) to pair and configure your devices. If you have paired devices, you'll see them listed in a table. The leftmost column (Name) is prefilled with default names. You can click such a name and enter whatever you like.
@@ -215,7 +215,7 @@ This does *not* affect the entities in Home Assistant. They all use their own co
### Reading attributes of entities
-Most devices have, besides their state, additional attributes like their battery state or valve position. These can be accessed using templates in automations, or even as their own entities using the [template sensor](/integrations/template) component. Here's an example of a template sensor that exposes the valve position of a thermostat.
+Most devices have, besides their state, additional attributes like their battery state or valve position. These can be accessed using templates in automations, or even as their own entities using the [template sensor](/integrations/template) integration. Here's an example of a template sensor that exposes the valve position of a thermostat.
{% raw %}
@@ -498,7 +498,7 @@ automation:
{% endraw %}
- The important part is the `sensor.time` entity (from time_date component). This will update the binary sensor on every change of the sensor and every minute. If the Homematic sensor does not send any updates anymore, the `sensor.time` will set the binary sensor to `off` 10 minutes after the last sensor update. This will trigger the automation.
+ The important part is the `sensor.time` entity (from time_date integration). This will update the binary sensor on every change of the sensor and every minute. If the Homematic sensor does not send any updates anymore, the `sensor.time` will set the binary sensor to `off` 10 minutes after the last sensor update. This will trigger the automation.
- If you have a CCU you can also create a system variable on the CCU, which stores its last reboot time. Since Home Assistant can still refresh system variables from the CCU (even after a reboot) this is another option to call *homematic.reconnect*. Even though this option might look preferable to many since it does not rely on a sensor, **it is less fail-safe** than checking for updates of a sensor. Since the variable on the CCU is only changed on boot, any problem that causes the connection between Home Assistant and the CCU to break but will not result in a reboot will not be detected (eg. in case of networking issues). This is how this can be done:
diff --git a/source/_integrations/humidifier.mqtt.markdown b/source/_integrations/humidifier.mqtt.markdown
index 62075a23aa6..3c682ef5a5f 100644
--- a/source/_integrations/humidifier.mqtt.markdown
+++ b/source/_integrations/humidifier.mqtt.markdown
@@ -84,7 +84,7 @@ command_topic:
required: true
type: string
device:
- description: "Information about the device this humidifier is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
+ description: "Information about the device this humidifier is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
required: false
type: map
keys:
diff --git a/source/_integrations/hydrawise.markdown b/source/_integrations/hydrawise.markdown
index 0a50068d60f..02eefaaff7a 100644
--- a/source/_integrations/hydrawise.markdown
+++ b/source/_integrations/hydrawise.markdown
@@ -53,7 +53,7 @@ To get your API access token log into your [Hydrawise account](https://app.hydra
## Binary Sensor
-Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file:
+Once you have enabled the `hydrawise` integration, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -87,7 +87,7 @@ The limit is 3 calls to start/stop/suspend a zone per 30 seconds and an addition
## Sensor
-Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file:
+Once you have enabled the `hydrawise` integration, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -110,7 +110,7 @@ monitored_conditions:
## Switch
-Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file:
+Once you have enabled the `hydrawise` integration, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/ifttt.markdown b/source/_integrations/ifttt.markdown
index 7e9e44f9f08..41cceed9735 100644
--- a/source/_integrations/ifttt.markdown
+++ b/source/_integrations/ifttt.markdown
@@ -12,7 +12,7 @@ ha_platforms:
ha_integration_type: integration
---
-[IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so-called "Applets". With the IFTTT component, you can trigger applets through the **"Webhooks"** service (which was previously the **"Maker"** channel).
+[IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so-called "Applets". With the IFTTT integration, you can trigger applets through the **"Webhooks"** service (which was previously the **"Maker"** channel).
## Prerequisites
diff --git a/source/_integrations/ihc.markdown b/source/_integrations/ihc.markdown
index 537b30ad234..87ecd0b16f2 100644
--- a/source/_integrations/ihc.markdown
+++ b/source/_integrations/ihc.markdown
@@ -59,7 +59,7 @@ auto_setup:
type: boolean
default: true
info:
- description: Shows the IHC "name", "note" and "position" attributes of each component. This will make it easier to identify the IHC products within Home Assistant.
+ description: Shows the IHC "name", "note" and "position" attributes of each integration. This will make it easier to identify the IHC products within Home Assistant.
required: false
type: boolean
default: true
@@ -85,7 +85,7 @@ See the manual of each device type for configuration options.
## Binary Sensor
-Before you can use the IHC Binary Sensor platform, you must setup the IHC Component.
+Before you can use the IHC Binary Sensor platform, you must setup the IHC integration.
When auto setup is enabled the following products will be found in the IHC project and setup as binary sensors:
@@ -154,7 +154,7 @@ The resource id should be an id of a boolean IHC resource. For more information
## Sensor
-Before you can use the IHC Sensor platform, you must setup the IHC Component.
+Before you can use the IHC Sensor platform, you must setup the IHC integration.
When auto setup is enabled the following products will be found in the IHC project and setup as sensors:
@@ -212,7 +212,7 @@ The resource id should be a IHC float resource. For more information about IHC r
## Light
-Before you can use the IHC Light platform, you must setup the IHC Component.
+Before you can use the IHC Light platform, you must setup the IHC integration.
When auto setup is enabled the following products will be found in the IHC project and setup as light devices:
@@ -265,7 +265,7 @@ light:
required: false
type: integer
name:
- description: The name of the component
+ description: The name of the integration
required: false
type: string
note:
@@ -282,7 +282,7 @@ In the example above 12345 is ihc resource id and "tablelight" is the name. The
## Switch
-Before you can use the IHC Switch platform, you must setup the IHC Component.
+Before you can use the IHC Switch platform, you must setup the IHC integration.
When auto setup is enabled the following products will be found in the ihc project and setup as switch devices:
@@ -323,7 +323,7 @@ switch:
required: false
type: integer
name:
- description: The name of the component
+ description: The name of the integration
required: false
type: string
note:
diff --git a/source/_integrations/influxdb.markdown b/source/_integrations/influxdb.markdown
index f9201749b40..9c20f787987 100644
--- a/source/_integrations/influxdb.markdown
+++ b/source/_integrations/influxdb.markdown
@@ -173,7 +173,7 @@ ignore_attributes:
component_config:
type: string
required: false
- description: This attribute contains component-specific override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format.
+ description: This attribute contains integration-specific override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format.
keys:
override_measurement:
type: string
@@ -199,7 +199,7 @@ component_config_domain:
component_config_glob:
type: string
required: false
- description: This attribute contains component-specific override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format.
+ description: This attribute contains integration-specific override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format.
keys:
override_measurement:
type: string
@@ -294,11 +294,11 @@ influxdb:
## Sensor
-The `influxdb` sensor allows you to use values from an [InfluxDB](https://influxdb.com/) database to populate a sensor state. This can be used to present statistics as Home Assistant sensors, if used with the `influxdb` history component. It can also be used with an external data source.
+The `influxdb` sensor allows you to use values from an [InfluxDB](https://influxdb.com/) database to populate a sensor state. This can be used to present statistics as Home Assistant sensors, if used with the `influxdb` history integration. It can also be used with an external data source.
- You must configure the `influxdb` history component in order to create `influxdb` sensors. If you just want to create sensors for an external InfluxDB database and you don't want Home Assistant to write any data to it you can exclude all entities like this:
+ You must configure the `influxdb` history integration in order to create `influxdb` sensors. If you just want to create sensors for an external InfluxDB database and you don't want Home Assistant to write any data to it you can exclude all entities like this:
```yaml
influxdb:
@@ -567,7 +567,7 @@ sensor:
{% endraw %}
-Note that when working with Flux queries, the resultset is broken into tables, you can see how this works in the Data Explorer of the UI. If you are operating on data created by the InfluxDB history component, this means by default, you will have a table for each entity and each attribute of each entity (other then `unit_of_measurement` and any others you promoted to tags).
+Note that when working with Flux queries, the resultset is broken into tables, you can see how this works in the Data Explorer of the UI. If you are operating on data created by the InfluxDB history integration, this means by default, you will have a table for each entity and each attribute of each entity (other then `unit_of_measurement` and any others you promoted to tags).
This is a lot more tables compared to 1.xx queries, where you essentially had one table per `unit_of_measurement` across all entities. You can still create aggregate metrics across multiple sensors though. As you can see in the example above, a good way to do this is with the [keep](https://v2.docs.influxdata.com/v2.0/reference/flux/stdlib/built-in/transformations/keep/) or [drop](https://v2.docs.influxdata.com/v2.0/reference/flux/stdlib/built-in/transformations/drop/) filters. When you remove key columns Influx merges tables, allowing you to make many tables that share a schema for `_value` into one.
diff --git a/source/_integrations/intent_script.markdown b/source/_integrations/intent_script.markdown
index f1abef3a097..157cb28bbe5 100644
--- a/source/_integrations/intent_script.markdown
+++ b/source/_integrations/intent_script.markdown
@@ -18,7 +18,7 @@ The `intent_script` integration allows users to configure actions and responses
intent_script:
GetTemperature: # Intent type
speech:
- text: We have {{ states.sensor.temperature }} degrees
+ text: We have {{ states('sensor.temperature') }} degrees
action:
service: notify.notify
data:
diff --git a/source/_integrations/intesishome.markdown b/source/_integrations/intesishome.markdown
index 6c064d614f5..14cec3519bb 100644
--- a/source/_integrations/intesishome.markdown
+++ b/source/_integrations/intesishome.markdown
@@ -44,8 +44,8 @@ device:
type: string
{% endconfiguration %}
-This component opens a TCP connection with the IntesisHome API to receive temperature and status updates, and to issue commands.
-By default, the component will be named using the friendly device name from the IntesisHome website or application.
+This integration opens a TCP connection with the IntesisHome API to receive temperature and status updates, and to issue commands.
+By default, the integration will be named using the friendly device name from the IntesisHome website or application.
If internet connectivity is lost, the device will be marked as unavailable after 5 minutes.
### Supported services
diff --git a/source/_integrations/isy994.markdown b/source/_integrations/isy994.markdown
index abccaa4d568..8a7b5a1c9cb 100644
--- a/source/_integrations/isy994.markdown
+++ b/source/_integrations/isy994.markdown
@@ -122,7 +122,7 @@ All `isy994_control` events will have an `entity_id` and `control` parameter in
### Insteon Scenes & Keypad/Remote Buttons
-All Insteon scenes configured in the ISY Admin Console will show up as a `switch` in Home Assistant, as they do not support dimming or setting specific brightness settings as Home Assistant's `light` component.
+All Insteon scenes configured in the ISY Admin Console will show up as a `switch` in Home Assistant, as they do not support dimming or setting specific brightness settings as Home Assistant's `light` integration.
Insteon Secondary Keypad buttons and Remote buttons are added to Home Assistant to allow support for using Control Events in Automations. These devices are added as `sensors` since they cannot be directly controlled (turned on/off); their state is the last ON level command they sent, in a range from `0` (Off) to `255` (On 100%). Note: these devices may report incorrect states before being used after a reboot of the ISY. Secondary Keypad buttons may be turned on or off using ISY Scenes (refer to ISY Documentation for more details).
diff --git a/source/_integrations/izone.markdown b/source/_integrations/izone.markdown
index 40ee910e3d3..02209993c04 100644
--- a/source/_integrations/izone.markdown
+++ b/source/_integrations/izone.markdown
@@ -107,7 +107,7 @@ type: history-graph
## Debugging
-If you're trying to track down issues with the component, set up logging for it:
+If you're trying to track down issues with the integration, set up logging for it:
```yaml
# Example configuration.yaml with logging for iZone
diff --git a/source/_integrations/joaoapps_join.markdown b/source/_integrations/joaoapps_join.markdown
index b0d498782af..035aa874b8e 100644
--- a/source/_integrations/joaoapps_join.markdown
+++ b/source/_integrations/joaoapps_join.markdown
@@ -13,10 +13,10 @@ ha_integration_type: integration
---
The `joaoapps_join` integration exposes services from
-[Join](https://joaoapps.com/join). In Home Assistant, the Join features are
-divided up in two locations, the Join component, and the Join notify platform.
-The notify platform allows us to send messages to Join devices, the component
-allows us to access the other special features that Join offers. When in doubt, you can reference the [API documentation](https://joaoapps.com/join/api/) this is based on.
+[Join](https://joaoapps.com/join). In Home Assistant, the Joaoapps Join features are
+divided up in two locations, the Join integration, and the Joaoapps Join notify platform.
+The notify platform allows us to send messages to Joaoapps Join devices, the integration
+allows us to access the other special features that Joaoapps Join offers. When in doubt, you can reference the [API documentation](https://joaoapps.com/join/api/) this is based on.
In the `configuration.yaml` file you need to provide the API key and device id
or name of the target device. You can find your device id and API key
@@ -57,7 +57,7 @@ device_names:
required: false
type: string
name:
- description: The name parameter is optional but needed if you want to use multiple notification platforms. The platform will be exposed as service `notify.`. The name will default to `notify` if not supplied. See the [Notifications integration](/integrations/notify) for more details.
+ description: The name parameter is optional but needed if you want to use multiple notification platforms. The platform will be exposed as service `notify.`. The name will default to `notify` if not supplied. See the [Notifications integration](/integrations/notify) for more details.
required: false
type: string
{% endconfiguration %}
diff --git a/source/_integrations/kaiterra.markdown b/source/_integrations/kaiterra.markdown
index 371423480a2..7e866d0cd7e 100644
--- a/source/_integrations/kaiterra.markdown
+++ b/source/_integrations/kaiterra.markdown
@@ -14,7 +14,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `kaiterra` integration allows you to view the readings from your Laser Egg or Sensedge device using the [Kaiterra REST API](https://www.kaiterra.com/dev/).
+The `kaiterra` integration allows you to view the readings from your Laser Egg or Sensedge device using the [Kaiterra REST API](https://dev.kaiterra.com/).
To use the integration, you need to get the API key by signing up at [Kaiterra dashboard](https://dashboard.kaiterra.cn/), registering the device and create the key under `Settings -> Profile -> Developer`.
diff --git a/source/_integrations/keba.markdown b/source/_integrations/keba.markdown
index 8b7d066eb28..beef3a9e2ca 100644
--- a/source/_integrations/keba.markdown
+++ b/source/_integrations/keba.markdown
@@ -21,7 +21,7 @@ ha_integration_type: integration
The `keba` integrates your Keba charging station/BMW Wallbox into your Home Assistant instance using the UDP Smart Home Interface ([manual](https://www.keba.com/web/downloads/e-mobility/KeContact_P20_P30_UDP_ProgrGuide_en.pdf)). The fetching interval to the charging station is set to 5 seconds, same as in the official mobile app. In order to use the integration, enable the UDP Smart Home Interface by adjusting the DIP switches within the charging station according to the [installation manual](https://www.keba.com/file/downloads/e-mobility/KeContact_KCP20_30_ih_en.pdf).
-This component provides the following platforms:
+This integration provides the following platforms:
- Binary Sensors: Online state, plug state, Charging state and failsafe mode state.
- Lock: Authorization (like with the RFID card).
@@ -31,7 +31,7 @@ This component provides the following platforms:
## Configuration
-To enable this component in your installation, add at least the following to your `configuration.yaml` file:
+To enable this integration in your installation, add at least the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -83,11 +83,11 @@ keba:
## Services
-The `keba` component offers several services. Using these services will change the state of your charging station. So use these services with care!
+The `keba` integration offers several services. Using these services will change the state of your charging station. So use these services with care!
### Authorizing and Deauthorizing `keba.authorize` and `keba.deauthorize`
-The charging station can be authorized and deauthorized via service calls (`keba.authorize` and `keba.deauthorize`) or via the lock component that is created automatically for the charging station. In both cases the RFID tag from the configuration is used.
+The charging station can be authorized and deauthorized via service calls (`keba.authorize` and `keba.deauthorize`) or via the lock integration that is created automatically for the charging station. In both cases the RFID tag from the configuration is used.
### Start and Stop `keba.start` and `keba.stop`
diff --git a/source/_integrations/knx.markdown b/source/_integrations/knx.markdown
index 7039cb87752..ceb55c72fe6 100644
--- a/source/_integrations/knx.markdown
+++ b/source/_integrations/knx.markdown
@@ -1,6 +1,7 @@
---
title: KNX
description: Instructions on how to integrate KNX components with Home Assistant.
+featured: true
ha_category:
- Binary Sensor
- Button
diff --git a/source/_integrations/konnected.markdown b/source/_integrations/konnected.markdown
index f476d369bc9..eea8ec363ef 100644
--- a/source/_integrations/konnected.markdown
+++ b/source/_integrations/konnected.markdown
@@ -342,7 +342,7 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use
The `konnected` binary sensor allows you to monitor wired door sensors, window sensors, motion sensors, smoke detectors, CO detectors, glass-break sensors, water leak sensors or any other simple wired open/close circuit attached to a NodeMCU ESP8266 Wi-Fi module running the [open source Konnected software](https://github.com/konnected-io/konnected-security).
-This integration supports all of the built-in device classes of the generic [Binary Sensor](/integrations/binary_sensor/) component.
+This integration supports all of the built-in device classes of the generic [Binary Sensor](/integrations/binary_sensor/) integration.
## Switch
diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown
index 408e577d9c6..f831dfde6e5 100644
--- a/source/_integrations/light.mqtt.markdown
+++ b/source/_integrations/light.mqtt.markdown
@@ -138,7 +138,7 @@ command_topic:
required: true
type: string
device:
- description: 'Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.'
+ description: 'Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.'
required: false
type: map
keys:
@@ -581,7 +581,7 @@ command_topic:
required: true
type: string
device:
- description: 'Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.'
+ description: 'Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.'
required: false
type: map
keys:
@@ -950,7 +950,7 @@ command_topic:
required: true
type: string
device:
- description: 'Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.'
+ description: 'Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.'
required: false
type: map
keys:
diff --git a/source/_integrations/light.template.markdown b/source/_integrations/light.template.markdown
index 2d7e2482499..05b65ff2055 100644
--- a/source/_integrations/light.template.markdown
+++ b/source/_integrations/light.template.markdown
@@ -105,11 +105,6 @@ light:
required: false
type: template
default: optimistic
- white_value_template:
- description: Defines a template to get the white value of the light.
- required: false
- type: template
- default: optimistic
color_template:
description: Defines a template to get the color of the light. Must render a tuple (hue, saturation)
required: false
@@ -150,31 +145,27 @@ light:
type: template
default: true
turn_on:
- description: Defines an action to run when the light is turned on.
+ description: Defines an action to run when the light is turned on. May receive variables `brightness` and/or `transition`.
required: true
type: action
turn_off:
- description: Defines an action to run when the light is turned off.
+ description: Defines an action to run when the light is turned off. May receive variable `transition`.
required: true
type: action
set_level:
- description: Defines an action to run when the light is given a brightness command. The script will only be called if the `turn_on` call only has brightness, and optionally transition.
+ description: Defines an action to run when the light is given a brightness command. The script will only be called if the `turn_on` call only has brightness, and optionally transition. Receives variables `brightness` and optionally `transition`.
required: false
type: action
set_temperature:
- description: Defines an action to run when the light is given a color temperature command.
- required: false
- type: action
- set_white_value:
- description: Defines an action to run when the light is given a white value command.
+ description: Defines an action to run when the light is given a color temperature command. Receives variable `color_temp`. May also receive variables `brightness` and/or `transition`.
required: false
type: action
set_color:
- description: Defines an action to run when the light is given a color command.
+ description: Defines an action to run when the light is given a color command. Receives variables `h`, `s`, and `hs` (which is equivalent to `(h, s)`). May also receive variables `brightness` and/or `transition`.
required: false
type: action
set_effect:
- description: Defines an action to run when the light is given an effect command.
+ description: Defines an action to run when the light is given an effect command. Receives variable `effect`. May also receive variables `brightness` and/or `transition`.
required: inclusive
type: action
{% endconfiguration %}
@@ -205,9 +196,9 @@ In this section you will find some real-life examples of how to use this light.
### Theater Volume Control
This example shows a light that is actually a home theater's volume. This
-component gives you the flexibility to provide whatever you'd like to send as
+integration gives you the flexibility to provide whatever you'd like to send as
the payload to the consumer including any scale conversions you may need to
-make; the [Media Player component](/integrations/media_player/) needs a floating
+make; the [Media Player integration](/integrations/media_player/) needs a floating
point percentage value from `0.0` to `1.0`.
{% raw %}
diff --git a/source/_integrations/lock.mqtt.markdown b/source/_integrations/lock.mqtt.markdown
index 34126f945c8..9d72786e64b 100644
--- a/source/_integrations/lock.mqtt.markdown
+++ b/source/_integrations/lock.mqtt.markdown
@@ -82,7 +82,7 @@ command_topic:
required: true
type: string
device:
- description: 'Information about the device this lock is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.'
+ description: 'Information about the device this lock is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.'
required: false
type: map
keys:
diff --git a/source/_integrations/logbook.markdown b/source/_integrations/logbook.markdown
index 3d0d711e922..d1b54d2c2d6 100644
--- a/source/_integrations/logbook.markdown
+++ b/source/_integrations/logbook.markdown
@@ -154,7 +154,7 @@ exclude them in `recorder` instead.
### Custom Entries
It is possible to add custom entries to the logbook by using the script
-component to fire an event.
+integration to fire an event.
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/logger.markdown b/source/_integrations/logger.markdown
index edd69d1c10f..6186d807cda 100644
--- a/source/_integrations/logger.markdown
+++ b/source/_integrations/logger.markdown
@@ -25,7 +25,7 @@ logger:
The log severity level is `warning` if the logger integration is not enabled in `configuration.yaml`.
To log all messages and ignore events lower than critical for specified
-components:
+integrations:
```yaml
# Example configuration.yaml entry
@@ -37,7 +37,7 @@ logger:
```
To ignore all messages lower than critical and log event for specified
-components:
+integrations:
```yaml
# Example configuration.yaml entry
@@ -59,7 +59,7 @@ logger:
# log level for SmartThings lights
homeassistant.components.smartthings.light: info
- # log level for a custom component
+ # log level for a custom integration
custom_components.my_integration: debug
# log level for the `aiohttp` Python package
@@ -85,7 +85,7 @@ where **namespace** is the ** currently logging.
type: map
keys:
'<component_namespace>':
- description: Logger namespace of the component. See [log_level](#log-levels).
+ description: Logger namespace of the integration. See [log_level](#log-levels).
type: string
filters:
description: Regular Expression logging filters.
@@ -93,7 +93,7 @@ where **namespace** is the ** currently logging.
type: map
keys:
'<component_namespace>':
- description: Logger namespace of the component and a list of Regular Expressions. See [Log Filters](#log-filters).
+ description: Logger namespace of the integration and a list of Regular Expressions. See [Log Filters](#log-filters).
type: list
{% endconfiguration %}
diff --git a/source/_integrations/logi_circle.markdown b/source/_integrations/logi_circle.markdown
index 340b7766810..fadce1c5bd0 100644
--- a/source/_integrations/logi_circle.markdown
+++ b/source/_integrations/logi_circle.markdown
@@ -98,7 +98,7 @@ logi_circle:
- streaming
```
-By default, all sensors available from your Logi Circle devices will be monitored. Leave `monitored_conditions` blank to disable all sensors for the Logi Circle component. Devices without an internal battery will not expose a `battery_level` sensor.
+By default, all sensors available from your Logi Circle devices will be monitored. Leave `monitored_conditions` blank to disable all sensors for the Logi Circle integration. Devices without an internal battery will not expose a `battery_level` sensor.
{% configuration %}
sensor:
diff --git a/source/_integrations/lutron_caseta.markdown b/source/_integrations/lutron_caseta.markdown
index ab278dd3fba..5e23df3a031 100644
--- a/source/_integrations/lutron_caseta.markdown
+++ b/source/_integrations/lutron_caseta.markdown
@@ -45,7 +45,7 @@ Supports Bridges:
- QSX Processor (HQP7)
- RadioRA 3 All-in-One Processor (RR-PROC3)
-For the RadioRA 2 and HomeWorks QS product lines, see the [Lutron component](/integrations/lutron/).
+For the RadioRA 2 and HomeWorks QS product lines, see the [Lutron integration](/integrations/lutron/).
The currently supported devices are:
@@ -118,7 +118,7 @@ To get Lutron Caseta roller, honeycomb shades, lights, scene and switch working
After setup, shades will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a shade called 'Living Room Window' will appear in Home Assistant as `cover.living_room_window`.
-For more information on working with shades in Home Assistant, see the [Covers component](/integrations/cover/).
+For more information on working with shades in Home Assistant, see the [Covers integration](/integrations/cover/).
Available services: `cover.open_cover`, `cover.close_cover`, `cover.stop_cover` and `cover.set_cover_position`. Cover `position` ranges from `0` for fully closed to `100` for fully open.
@@ -128,7 +128,7 @@ After setup, dimmable lights including wall and plug-in dimmers will appear in H
For non-dimmable lights or switched loads, see the switch section on this page.
-For more information on working with lights in Home Assistant, see the [Lights component](/integrations/light/).
+For more information on working with lights in Home Assistant, see the [Lights integration](/integrations/light/).
## Scene
@@ -136,7 +136,7 @@ The Lutron Caseta scene platform allows you to control your Smart Bridge Scenes
After setup, scenes will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a scene called 'Entertain' will appear in Home Assistant as `scene.entertain`.
-For more information on working with scenes in Home Assistant, see the [Scenes component](/integrations/scene/).
+For more information on working with scenes in Home Assistant, see the [Scenes integration](/integrations/scene/).
Scenes are not directly supported on RA3 and QSX models, however the button platform (see below) can be used to activate scenes for these systems.
@@ -146,13 +146,13 @@ After setup, switches will appear in Home Assistant using an `entity_id` based o
For dimmable lights including wall and plug-in dimmers, see the light section on this page.
-For more information on working with switches in Home Assistant, see the [Switches component](/integrations/switch/).
+For more information on working with switches in Home Assistant, see the [Switches integration](/integrations/switch/).
## Fan
After setup, fans will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a light switch called 'Master Bedroom Ceiling Fan' will appear in Home Assistant as `fan.master_bedroom_ceiling_fan`.
-For more information on working with fans in Home Assistant, see the [Fans component](/components/fan/).
+For more information on working with fans in Home Assistant, see the [Fans integration](/integrations/fan/).
## Sensor
@@ -166,7 +166,7 @@ Lutron Caseta occupancy sensors support 4 different timeouts and 3 different sen
Because Lutron Caseta devices automatically report state to Home Assistant (rather than relying on polling), occupancy status updates occur almost instantaneously.
-For more information on working with binary sensors in Home Assistant, see the [Binary Sensors Component](/components/binary_sensor/)
+For more information on working with binary sensors in Home Assistant, see the [Binary Sensors integration](/integrations/binary_sensor/)
## Button
diff --git a/source/_integrations/lyric.markdown b/source/_integrations/lyric.markdown
index 390bb30e636..52069813ff8 100644
--- a/source/_integrations/lyric.markdown
+++ b/source/_integrations/lyric.markdown
@@ -22,7 +22,7 @@ The Honeywell Lyric integration integrates the Lyric thermostat platform into Ho
## Setup
-To set up this component, you first **must** set up a developer account with Honeywell:
+To set up this integration, you first **must** set up a developer account with Honeywell:
1. Go to the [developer site](https://developer.honeywellhome.com) and register with an account.
1. Next, create a [new app](https://developer.honeywellhome.com/user/me/apps/add) via the `My Apps` section.
diff --git a/source/_integrations/matter.markdown b/source/_integrations/matter.markdown
index 793c3230a99..9dbed911bd0 100644
--- a/source/_integrations/matter.markdown
+++ b/source/_integrations/matter.markdown
@@ -253,11 +253,11 @@ Tasmota supports Matter over IP on all ESP32 based devices (in experimental phas
This button will only be visible within the Home Assistant Companion App (so not in the browser) and your device meets all requirements for Matter support.
- For iOS, minimum version is iOS 16 (minimal 16.3 is preferred) and the most recent version of the HA companion app.
-- For Android, minimum version is 8.1 and the most recent version of both the Google Home app and the (full) HA Companion app, downloaded from the app store.
+- For Android, minimum version is 8.1 and the most recent version of the (full) HA Companion app, downloaded from the Play Store.
### When I'm trying to commission using the Android app, I get an error stating "Matter is currently unavailable"
-See above, make sure your device meets all requirements to support Matter. Update Android to the latest version and the Google Home and Home Assistant Companion app. To quickly verify if your device meets all requirements to support Matter, on your Android device, go to **Settings** > **Google** > **Devices & Sharing**. There should be an entry there for **Matter devices**.
+See above, make sure your device meets all requirements to support Matter. Update Android to the latest version and the Home Assistant Companion app. To quickly verify if your device meets all requirements to support Matter, on your Android device, go to **Settings** > **Google** > **Devices & Sharing**. There should be an entry there for **Matter devices**.
Some users have reported that uninstalling and reinstalling the Google Home app fixed this issue for them.
Also see this [extended troubleshooting guide](https://developers.home.google.com/matter/verify-services) from Google.
diff --git a/source/_integrations/microsoft_face.markdown b/source/_integrations/microsoft_face.markdown
index 9a8ac714e33..95d9412e8e0 100644
--- a/source/_integrations/microsoft_face.markdown
+++ b/source/_integrations/microsoft_face.markdown
@@ -26,7 +26,7 @@ Please note that all keys on cognitive services must be recreated every 90 days.
## Configuration
-To enable the Microsoft Face component,
+To enable the Microsoft Face integration,
add the following to your `configuration.yaml` file:
```yaml
diff --git a/source/_integrations/mochad.markdown b/source/_integrations/mochad.markdown
index b2e89d5219b..a7f7985d4dd 100644
--- a/source/_integrations/mochad.markdown
+++ b/source/_integrations/mochad.markdown
@@ -58,7 +58,7 @@ mochad:
The `mochad` light platform lets you control an X10 enabled dimmer/light device.
-To enable this sensor, you first have to set up the [mochad component](#configuration) and then add the following to your `configuration.yaml` file:
+To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -95,7 +95,7 @@ brightness_levels:
The `mochad` switch platform lets you control an X10 enabled switch device.
-To enable this sensor, you first have to set up the [mochad component](#configuration) and then add the following to your `configuration.yaml` file:
+To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/motioneye.markdown b/source/_integrations/motioneye.markdown
index fa6f25f865a..6e44a7bb7e0 100644
--- a/source/_integrations/motioneye.markdown
+++ b/source/_integrations/motioneye.markdown
@@ -404,7 +404,7 @@ An automation to cast stored movie clips to a TV as they arrive.
### Debug Logging
-To enable debug logging for both the component and the underlying client library,
+To enable debug logging for both the integration and the underlying client library,
enable the following in your `configuration.yaml` and then restart:
```yaml
diff --git a/source/_integrations/mqtt.markdown b/source/_integrations/mqtt.markdown
index 6924ec6ce70..0836fb8c700 100644
--- a/source/_integrations/mqtt.markdown
+++ b/source/_integrations/mqtt.markdown
@@ -192,7 +192,7 @@ mosquitto_sub -h 127.0.0.1 -v -t "homeassistant/#"
The discovery of MQTT devices will enable one to use MQTT devices with only minimal configuration effort on the side of Home Assistant. The configuration is done on the device itself and the topic used by the device. Similar to the [HTTP binary sensor](/integrations/http/#binary-sensor) and the [HTTP sensor](/integrations/http/#sensor). To prevent multiple identical entries if a device reconnects, a unique identifier is necessary. Two parts are required on the device side: The configuration topic which contains the necessary device type and unique identifier, and the remaining device configuration without the device type.
-{% details "Entity components supported by MQTT discovery" %}
+{% details "Entity integrations supported by MQTT discovery" %}
- [Alarm control panel](/integrations/alarm_control_panel.mqtt/)
- [Binary sensor](/integrations/binary_sensor.mqtt/)
@@ -235,7 +235,7 @@ The discovery topic needs to follow a specific format:
```
- ``: The Discovery Prefix defaults to `homeassistant`. This prefix can be [changed](#discovery-options).
-- ``: One of the supported MQTT components, eg. `binary_sensor`.
+- ``: One of the supported MQTT integrations, eg. `binary_sensor`.
- `` (*Optional*): ID of the node providing the topic, this is not used by Home Assistant but may be used to structure the MQTT topic. The ID of the node must only consist of characters from the character class `[a-zA-Z0-9_-]` (alphanumerics, underscore and hyphen).
- ``: The ID of the device. This is only to allow for separate topics for each device and is not used for the `entity_id`. The ID of the device must only consist of characters from the character class `[a-zA-Z0-9_-]` (alphanumerics, underscore and hyphen).
@@ -245,7 +245,7 @@ Best practice for entities with a `unique_id` is to set `` to `unique
#### Discovery payload
-The payload must be a serialized JSON dictionary and will be checked like an entry in your `configuration.yaml` file if a new device is added, with the exception that unknown configuration keys are allowed but ignored. This means that missing variables will be filled with the component's default values. All configuration variables which are *required* must be present in the payload. The reason for allowing unknown documentation keys is allow some backwards compatibility, software generating MQTT discovery messages can then be used with older Home Assistant versions which will simply ignore new features.
+The payload must be a serialized JSON dictionary and will be checked like an entry in your `configuration.yaml` file if a new device is added, with the exception that unknown configuration keys are allowed but ignored. This means that missing variables will be filled with the integration's default values. All configuration variables which are *required* must be present in the payload. The reason for allowing unknown documentation keys is allow some backwards compatibility, software generating MQTT discovery messages can then be used with older Home Assistant versions which will simply ignore new features.
Subsequent messages on a topic where a valid payload has been received will be handled as a configuration update, and a configuration update with an empty payload will cause a previously discovered device to be deleted.
@@ -660,7 +660,7 @@ Setting up a [light that takes JSON payloads](/integrations/light.mqtt/#json-sch
#### Use object_id to influence the entity id
-The entity id is automatically generated from the entity's name. All MQTT components optionally support providing an `object_id` which will be used instead if provided.
+The entity id is automatically generated from the entity's name. All MQTT integrations optionally support providing an `object_id` which will be used instead if provided.
- Configuration topic: `homeassistant/sensor/device1/config`
- Example configuration payload:
@@ -677,9 +677,9 @@ In the example above, the entity_id will be `sensor.my_super_device` instead of
## Manual configured MQTT items
-For most components it is also possible to manual set up MQTT items in `configuration.yaml`. Read more [about configuration in YAML](/docs/configuration/yaml).
+For most integrations, it is also possible to manually set up MQTT items in `configuration.yaml`. Read more [about configuration in YAML](/docs/configuration/yaml).
-{% details "MQTT components that support setup via YAML" %}
+{% details "MQTT integrations that support setup via YAML" %}
- [Alarm control panel](/integrations/alarm_control_panel.mqtt/)
- [Binary sensor](/integrations/binary_sensor.mqtt/)
@@ -714,7 +714,7 @@ The MQTT integration supports templating. Read more [about using templates with
## MQTT Notifications
-The MQTT notification support is different than for the other [notification](/integrations/notify/) components. It is a service. This means you need to provide more details when calling the service.
+The MQTT notification support is different than for the other [notification](/integrations/notify/) integrations. It is a service. This means you need to provide more details when calling the service.
**Call Service** section from **Developer Tools** -> **Services** allows you to send MQTT messages. Choose *mqtt.publish* from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**.
diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown
index 0d7d25fdd14..e9f4c0e2936 100644
--- a/source/_integrations/netatmo.markdown
+++ b/source/_integrations/netatmo.markdown
@@ -228,7 +228,7 @@ Example:
## Development / Testing with your own client ID
-To enable the Netatmo component with your own development credentials, you have
+To enable the Netatmo integration with your own development credentials, you have
to declare a new application in the [Netatmo Developer Page](https://dev.netatmo.com/).
Sign in using your username and password from your regular Netatmo account.
diff --git a/source/_integrations/notify_events.markdown b/source/_integrations/notify_events.markdown
index cf44b9db351..b51bf8bce00 100644
--- a/source/_integrations/notify_events.markdown
+++ b/source/_integrations/notify_events.markdown
@@ -16,7 +16,7 @@ ha_integration_type: integration
## Description
-The [Notify.Events service](https://notify.events/) is a platform for the **notify** component.
+The [Notify.Events service](https://notify.events/) is a platform for the **notify** integration.
This platform allows you to quickly configure the distribution of messages between different recipients, no matter how they are used to receiving notifications:
diff --git a/source/_integrations/notion.markdown b/source/_integrations/notion.markdown
index bc3f7e6e4d9..7b6181a7a7b 100644
--- a/source/_integrations/notion.markdown
+++ b/source/_integrations/notion.markdown
@@ -18,7 +18,7 @@ ha_platforms:
ha_integration_type: hub
---
-The `Notion` component retrieves data from [Notion](https://getnotion.com) wireless
+The Notion integration retrieves data from [Notion](https://getnotion.com) wireless
home monitoring sensor kits.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/number.mqtt.markdown b/source/_integrations/number.mqtt.markdown
index 81f2a883c96..68a1681b7ee 100644
--- a/source/_integrations/number.mqtt.markdown
+++ b/source/_integrations/number.mqtt.markdown
@@ -61,7 +61,7 @@ command_topic:
required: true
type: string
device:
- description: "Information about the device this Number is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
+ description: "Information about the device this Number is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
required: false
type: map
keys:
diff --git a/source/_integrations/nzbget.markdown b/source/_integrations/nzbget.markdown
index 9144c44bee9..f892ad62a8e 100644
--- a/source/_integrations/nzbget.markdown
+++ b/source/_integrations/nzbget.markdown
@@ -16,13 +16,13 @@ ha_platforms:
ha_integration_type: integration
---
-The `nzbget` platform will allow you to monitor and control your downloads with [NZBGet](https://nzbget.net/) from within Home Assistant and setup automation based on the information.
+The NZBGet integration allows you to monitor and control your downloads with [NZBGet](https://nzbget.net/) from within Home Assistant. It also allows you to setup automation based on the information.
{% include integrations/config_flow.md %}
## Sensor
-This component will create these sensors:
+This integration will create these sensors:
- `nzbget_article_cache`: Article cache size in MB.
- `nzbget_average_speed`: Average download rate since server start in MB/s.
diff --git a/source/_integrations/ombi.markdown b/source/_integrations/ombi.markdown
index 7cb3c788e08..d0e3014bb18 100644
--- a/source/_integrations/ombi.markdown
+++ b/source/_integrations/ombi.markdown
@@ -13,11 +13,11 @@ ha_platforms:
ha_integration_type: integration
---
-The `Ombi` integration monitors data from your [Ombi](https://ombi.io) instance.
+The Ombi integration monitors data from your [Ombi](https://ombi.io) instance.
## Setup
-This component needs to authenticate to your Ombi instance with either a user `password` or an `api_key`.
+This integration needs to authenticate to your Ombi instance with either a user `password` or an `api_key`.
To find your `api_key` open the Ombi web interface. Navigate to **Settings** and then to **Ombi**, you should then be able to see your `api_key`.
diff --git a/source/_integrations/onewire.markdown b/source/_integrations/onewire.markdown
index 899a2998dea..a21cb464c6d 100644
--- a/source/_integrations/onewire.markdown
+++ b/source/_integrations/onewire.markdown
@@ -19,15 +19,7 @@ ha_platforms:
ha_integration_type: hub
---
-
-# Configuration
-
{% include integrations/config_flow.md %}
The following configuration options are available:
diff --git a/source/_integrations/openuv.markdown b/source/_integrations/openuv.markdown
index 19c104b0b8f..56c1537ef5b 100644
--- a/source/_integrations/openuv.markdown
+++ b/source/_integrations/openuv.markdown
@@ -18,17 +18,17 @@ ha_platforms:
ha_integration_type: service
---
-The `openuv` integration displays UV and Ozone data from [openuv.io](https://www.openuv.io/).
+The OpenUV integration displays UV and Ozone data from [openuv.io](https://www.openuv.io/).
-
-Using this integration via the SysBus is deprecated and will be removed in Home Assistant Core 2022.6.
-
-For more information see: [Architectural Decision Record 0019](https://github.com/home-assistant/architecture/blob/master/adr/0019-GPIO.md).
-
-
-
-The `onewire` platform supports sensors which that using the One wire (1-wire) bus for communication.
+The Onewire integration supports sensors that use the 1-wire bus for communication.
Every 1-wire device has a (globally) unique ID that identifies the device on the bus. The first two digits identify a device family and the last 14 digits are a globally unique number given to it during manufacturing.
diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown
index a584fcd51ee..971b257ee5f 100644
--- a/source/_integrations/onvif.markdown
+++ b/source/_integrations/onvif.markdown
@@ -20,7 +20,7 @@ ha_integration_type: integration
ha_dhcp: true
---
-The `onvif` camera platform allows you to use an [ONVIF](https://www.onvif.org/) Profile S conformant device in Home Assistant. This requires the [`ffmpeg` integration](/integrations/ffmpeg/) to be already configured.
+The ONVIF camera integration allows you to use an [ONVIF](https://www.onvif.org/) Profile S conformant device in Home Assistant. This requires the [`ffmpeg` integration](/integrations/ffmpeg/) to be already configured.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/openalpr_cloud.markdown b/source/_integrations/openalpr_cloud.markdown
index ee2598b6d36..c7b6989a2a3 100644
--- a/source/_integrations/openalpr_cloud.markdown
+++ b/source/_integrations/openalpr_cloud.markdown
@@ -9,12 +9,12 @@ ha_domain: openalpr_cloud
ha_integration_type: integration
---
-[OpenALPR](https://www.openalpr.com/) integration for Home Assistant allows you
-to process license plates from a camera. You can use them to open a garage door
-or trigger any other [automation](/integrations/automation/).
+The [OpenALPR](https://www.openalpr.com/) integration for Home Assistant allows you
+to process license plates from a camera. This allows you to open a garage door
+or trigger any other [automation](/integrations/automation/) based on a license plate.
For using the result inside an automation rule,
-take a look at the [component](/integrations/image_processing/) page.
+take a look at the [integration](/integrations/image_processing/) page.
### Configuration
diff --git a/source/_integrations/opentherm_gw.markdown b/source/_integrations/opentherm_gw.markdown
index 496a80496d5..dcec979bf1b 100644
--- a/source/_integrations/opentherm_gw.markdown
+++ b/source/_integrations/opentherm_gw.markdown
@@ -33,8 +33,6 @@ This integration will add a single `climate` entity to Home Assistant for each c
The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.
-The guidelines within this documentation constitute estimates and are intended to help
-informed decision making. They should not replace analysis, advice or diagnosis from a
+The guidelines within this documentation constitute estimates which are intended to help
+informed decision making. They should not replace analysis, advice, or diagnosis from a
trained medical professional.
## Generating an API Key
-To generate an API key, simply log in at [the OpenUV website](https://www.openuv.io/).
+To generate an API key, log in at [the OpenUV website](https://www.openuv.io/).
{% include integrations/config_flow.md %}
@@ -57,7 +57,7 @@ update data via the `homeassistant.update_entity` service.
Beginning February 1, 2019, the "Limited" plan (which is what new users are given by
default) is limited to 50 API requests per day. Because different API plans and
-locations will have different requirements, the `openuv` component does not automatically
+locations will have different requirements, the OpenUV integration does not automatically
query the API for new data after it initially loads. To request new data, the
`homeassistant.update_entity` service should be used.
diff --git a/source/_integrations/owntracks.markdown b/source/_integrations/owntracks.markdown
index 2e5bb2335bf..83546ac5a07 100644
--- a/source/_integrations/owntracks.markdown
+++ b/source/_integrations/owntracks.markdown
@@ -1,6 +1,6 @@
---
title: OwnTracks
-description: Instructions on how to use Owntracks to track devices in Home Assistant.
+description: Instructions on how to use OwnTracks to track devices in Home Assistant.
ha_category:
- Presence Detection
ha_iot_class: Local Push
@@ -12,42 +12,47 @@ ha_platforms:
ha_integration_type: integration
---
-[OwnTracks](https://owntracks.org/) is a free and open source application for iOS and Android that allow you to track your location and send it directly to Home Assistant. It can be set up via the integrations panel in the configuration screen.
+[OwnTracks](https://owntracks.org/) is a free and open source application for iOS and Android that allows you to track your location and send it directly to Home Assistant. OwnTracks can be set up via **{% my integrations title="Settings > Devices & Services" %}**.
-By default the integration will listen for incoming messages from OwnTracks via HTTP. It will also listen for MQTT messages if Home Assistant is configured to use MQTT. When a location is submitted via HTTP, Home Assistant will return all [Persons](/integrations/person/)' last known locations and they will be displayed within the OwnTracks app.
+By default, the integration listens for incoming messages from OwnTracks via HTTP. If Home Assistant is configured to use MQTT instead, it listens for MQTT messages. When a location is submitted via HTTP, Home Assistant returns all [Persons](/integrations/person/)' last known locations. Their location will be displayed within the OwnTracks app.
-Owntracks v2.0.0 removes support for iBeacons on Android.
+OwnTracks v2.0.0 removes support for iBeacons on Android.
-When run in the usual *significant changes mode* (which is kind to your phone battery), Owntracks sometimes doesn't update your location as quickly as you'd like when you arrive at a zone. This can be annoying if you want to trigger an automation when you get home. You can improve the situation using iBeacons.
+When run in the usual *significant changes mode* (which is kind to your phone battery), OwnTracks sometimes doesn't update your location as quickly as you'd like when you arrive at a zone. This can be annoying if you want to trigger an automation when you get home. You can improve the situation using iBeacons.
-iBeacons are simple Bluetooth devices that send out an "I'm here" message. They are supported by iOS and some Android devices. Owntracks explain more [here](https://owntracks.org/booklet/guide/beacons/).
+iBeacons are simple Bluetooth devices that send out an "I'm here" message. They are supported by iOS and some Android devices. OwnTracks explain more [here](https://owntracks.org/booklet/guide/beacons/).
-When you enter an iBeacon region, Owntracks will send a `region enter` message to HA as described above. So if you want to have an event triggered when you arrive home, you can put an iBeacon outside your front door. If you set up an OwnTracks iBeacon region called `home` then getting close to the beacon will trigger an update to HA that will set your zone to be `home`.
+When you enter an iBeacon region, OwnTracks will send a `region enter` message to HA as described above. So if you want to have an event triggered when you arrive home, you can put an iBeacon outside your front door. If you set up an OwnTracks iBeacon region called `home` then getting close to the beacon will trigger an update to HA that will set your zone to be `home`.
When you exit an iBeacon region HA will switch back to using GPS to determine your location. Depending on the size of your zone, and the accuracy of your GPS location this may change your HA zone.
-Sometimes Owntracks will lose connection with an iBeacon for a few seconds. If you name your beacon starting with `-` Owntracks will wait longer before deciding it has exited the beacon zone. HA will ignore the `-` when it matches the Owntracks region with Zones. So if you call your Owntracks region `-home` then HA will recognize it as `home`, but you will have a more stable iBeacon connection.
+Sometimes OwnTracks will lose connection with an iBeacon for a few seconds. If you name your beacon starting with `-` OwnTracks will wait longer before deciding it has exited the beacon zone. HA will ignore the `-` when it matches the OwnTracks region with Zones. So if you call your OwnTracks region `-home` then HA will recognize it as `home`, but you will have a more stable iBeacon connection.
-## Using Owntracks iBeacons to track devices
+## Using OwnTracks iBeacons to track devices
iBeacons don't need to be stationary. You could put one on your key ring, or in your car.
@@ -148,9 +153,9 @@ This allows you to write zone automations for devices that can't track themselve
You can use iBeacons of both types together, so if you have a Zone `drive` with an iBeacon region called `-drive` and you arrive home with a mobile iBeacon called `-car`, then `device_tracker.beacon_car` will be set to a state of `drive`.
-## Importing Owntracks waypoints as zones
+## Importing OwnTracks waypoints as zones
-By default, any Owntracks user connected to Home Assistant can export their waypoint definitions (from the *Export - Export to Endpoint* menu item) which will then be translated to zone definitions in Home Assistant. The zones will be named `
-This integration relies on raw TCP commands to PulseAudio. In order for PulseAudio to accept commands with this component, `module-native-protocol-tcp auth-ip-acl=` must be loaded on the PulseAudio server.
+This integration relies on raw TCP commands to PulseAudio. In order for PulseAudio to accept commands with this integration, `module-native-protocol-tcp auth-ip-acl=` must be loaded on the PulseAudio server.
diff --git a/source/_integrations/purpleair.markdown b/source/_integrations/purpleair.markdown
index 3efe64059b8..3ca6f27dda2 100644
--- a/source/_integrations/purpleair.markdown
+++ b/source/_integrations/purpleair.markdown
@@ -94,7 +94,8 @@ guidelines.
{% raw %}
```yaml
-sensor:
+template:
+ - sensor:
- name: "Local Outdoor Air Quality"
state: >
{% set pm2_5_avg = states("sensor.average_outdoor_pm2_5_24h") | int %}
diff --git a/source/_integrations/pushover.markdown b/source/_integrations/pushover.markdown
index 906bf186f5d..a9a357eb55c 100644
--- a/source/_integrations/pushover.markdown
+++ b/source/_integrations/pushover.markdown
@@ -14,11 +14,11 @@ ha_codeowners:
- '@engrbm87'
---
-The [Pushover service](https://pushover.net/) is a platform for the notify component. This allows integrations to send messages to the user using Pushover.
+The [Pushover service](https://pushover.net/) is a platform for the notify integration. This allows integrations to send messages to the user using Pushover.
## Configuration
-In order to get an API key you need to [register an application](https://pushover.net/apps/clone/home_assistant) on the Pushover website. Your Pushover user key can be found on the [Pushover dashboard](https://pushover.net/dashboard).
+In order to get an API key, you need to [register an application](https://pushover.net/apps/clone/home_assistant) on the Pushover website. Your Pushover user key can be found on the [Pushover dashboard](https://pushover.net/dashboard).
{% include integrations/config_flow.md %}
@@ -36,7 +36,7 @@ Example Automation:
attachment: "local/image.png"
```
-Component specific values in the nested `data` section are optional.
+Integration-specific values in the nested `data` section are optional.
Image attachments can be added using the `attachment` parameter, which can either be a local file reference (ex: `/tmp/image.png`).
diff --git a/source/_integrations/pushsafer.markdown b/source/_integrations/pushsafer.markdown
index 96c8cc7de49..8e638c5ce84 100644
--- a/source/_integrations/pushsafer.markdown
+++ b/source/_integrations/pushsafer.markdown
@@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
-The [Pushsafer service](https://www.pushsafer.com/) is a platform for the notify component. This allows you to send messages to the user using Pushsafer.
+The [Pushsafer service](https://www.pushsafer.com/) is a platform for the notify integration. This allows you to send messages to the user using Pushsafer.
In order to get a private or alias key you need to go to the [Pushsafer website](https://www.pushsafer.com) and register.
diff --git a/source/_integrations/qvr_pro.markdown b/source/_integrations/qvr_pro.markdown
index 6d2a48f0178..093c2e72398 100644
--- a/source/_integrations/qvr_pro.markdown
+++ b/source/_integrations/qvr_pro.markdown
@@ -14,8 +14,8 @@ ha_integration_type: integration
---
[QVR Pro](https://www.qnap.com/en/software/qvr-pro) allows you to create
-an independent and expandable surveillance environment on your QNAP NAS. The
-`qvr_pro` component allows you to view your QVR Pro channels in Home Assistant.
+an independent and expandable surveillance environment on your QNAP NAS. The
+`qvr_pro` integration allows you to view your QVR Pro channels in Home Assistant.
Currently, only cameras are supported by this integration.
diff --git a/source/_integrations/raincloud.markdown b/source/_integrations/raincloud.markdown
index 3e811b06b02..0659514399e 100644
--- a/source/_integrations/raincloud.markdown
+++ b/source/_integrations/raincloud.markdown
@@ -73,7 +73,7 @@ monitored_conditions:
## Sensor
-Once you have enabled the [Raincloud component](#configuration), add the following to your `configuration.yaml` file:
+Once you have enabled the [Raincloud integration](#configuration), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -100,7 +100,7 @@ monitored_conditions:
## Switch
-Once you have enabled the [Raincloud component](#configuration), add the following to your `configuration.yaml` file:
+Once you have enabled the [Raincloud integration](#configuration), add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -122,5 +122,5 @@ monitored_conditions:
auto_watering:
description: Toggle the watering scheduled per zone.
manual_watering:
- description: Toggle manually the watering per zone. It will inherent the value in minutes specified on the RainCloud hub component.
+ description: Toggle manually the watering per zone. It will inherent the value in minutes specified on the RainCloud hub integration.
{% endconfiguration %}
diff --git a/source/_integrations/reolink.markdown b/source/_integrations/reolink.markdown
index 856f48a475b..35460af859d 100644
--- a/source/_integrations/reolink.markdown
+++ b/source/_integrations/reolink.markdown
@@ -170,6 +170,7 @@ The following models have been tested and confirmed to work:
- C2 Pro
- E1 Zoom
- E1 Outdoor
+- E1 Outdoor Pro
- RLC-410
- RLC-410W
- RLC-411
@@ -203,18 +204,37 @@ However, these cameras can work with this integration through an NVR in which th
- E1 Pro
- E1
+- Reolink Lumus
## Initial Setup
-You'll need to configure your new camera/doorbell for your network. If you're using a wired LAN, this is simple enough. Simply plug it in and let it use DHCP to set itself up. Once it's recognized by your network, you can access its configuration with a web browser.
+A brand new Reolink camera first needs to be connected to the network and initialized. During initialization, the credentials for the camera need to be set.
+There are serveral ways to achieve this.
-If you prefer to use Wi-Fi, especially if you want to restrict it to a local IoT network, [here's a quick way to get it connected](https://www.reddit.com/r/reolink/comments/hjn5be/how_to_connect_wifi_without_an_app/). Simply create a QR code with the following XML string:
+### Reolink app/client
+
+The recommended way is to use the [Reolink mobile app, Windows, or Mac client](https://reolink.com/software-and-manual/). Follow the on-screen instructions. In Home Assistant, use the credentials you just configured in the Reolink app/client.
+
+### Web browser
+
+When your camera has a LAN port (most Wi-Fi cameras also have a LAN port), first connect the camera to your network using a LAN cable.
+Find the IP address of the camera (for example by checking in your router) and go to the IP address in a web browser.
+Follow the on-screen instructions to first setup the credentials (use the same credentials in Home Assistant).
+If it is a Wi-Fi camera, go to **settings** (gear icon) > **Network** and fill in your Wi-Fi SSID and password. After that you can disconnect the LAN cable and the camera will automatically switch to the Wi-Fi connection.
+Now set up the Reolink Home Assistant integration using the credentials you just specified.
+
+### QR code
+
+You can also connect a Wi-Fi camera using a self-made QR code. Once connected, follow the instructions under **Web browser**.
+Create a QR code using ISO-8859-1 character encoding (not UTF-8) with the following XML string:
password
-This component does NOT allow for live viewing of your Ring camera within Home Assistant. +This integration does NOT allow for live viewing of your Ring camera within Home Assistant.
{% include integrations/config_flow.md %} diff --git a/source/_integrations/roborock.markdown b/source/_integrations/roborock.markdown index f20bcbd2693..f79972c0732 100644 --- a/source/_integrations/roborock.markdown +++ b/source/_integrations/roborock.markdown @@ -57,7 +57,7 @@ We plan to make the process simpler in the future, but for now, it is a multi-st 4) Go to **Developer Tools** > **Services** > **Vacuum: Send Command**. Select your vacuum as the entity and 'get_room_mapping' as the command. 5) Go back to your logs and look at the response to `get_room_mapping`. This is a list of the 6-digit IDs you saw earlier to 2-digit IDs. In your original list of room names and 6-digit IDs, replace the 6-digit ID with its pairing 2-digit ID. 6) Now, you have the 2-digit ID that your vacuum uses to describe a room. -7) Go back to **Developer Tools** > **Services** > **Vacuum: Send Command** then type `app_segment_clean` as your command and 'segments' with a list of the 2-digit IDs you want to clean. Then, add `repeats` with a number (ranging from 1 to 3) to determine how many times you want to clean these areas. +7) Go back to **Developer Tools** > **Services** > **Vacuum: Send Command** then type `app_segment_clean` as your command and 'segments' with a list of the 2-digit IDs you want to clean. Then, add `repeat` with a number (ranging from 1 to 3) to determine how many times you want to clean these areas. Example: ```yaml @@ -68,7 +68,7 @@ data: - segments: - 22 - 23 - - repeats: 1 + - repeat: 1 target: entity_id: vacuum.s7_roborock diff --git a/source/_integrations/sabnzbd.markdown b/source/_integrations/sabnzbd.markdown index f0309f6101a..1cc6ba6c2cc 100644 --- a/source/_integrations/sabnzbd.markdown +++ b/source/_integrations/sabnzbd.markdown @@ -15,7 +15,7 @@ ha_platforms: ha_integration_type: integration --- -The `sabnzbd` integration will allow you to monitor and control your downloads with [SABnzbd](https://sabnzbd.org) from within Home Assistant and setup automations based on the information. +The SABnzbd integration will allow you to monitor and control your downloads with [SABnzbd](https://sabnzbd.org) from within Home Assistant and setup automations based on the information. ## Prerequisites @@ -29,7 +29,7 @@ You need to grab your API key from your SABnzbd instance in order to configure t ## Sensor -This component will create these sensors: +This integration will create these sensors: - `status`: The current status of SABnzbd. (Idle, Paused, etc.) - `speed`: The current download speed. diff --git a/source/_integrations/satel_integra.markdown b/source/_integrations/satel_integra.markdown index a3eb14af581..4935ea269f0 100644 --- a/source/_integrations/satel_integra.markdown +++ b/source/_integrations/satel_integra.markdown @@ -34,7 +34,7 @@ The library currently doesn't support encrypted connection to your alarm, so you A list of all partition, zone and output IDs can be acquired by running DloadX program and connecting to your alarm. -For the Binary Sensor check the [type/class](/integrations/binary_sensor/) list for a possible visualization of your zones. Note: If no zones or outputs are specified, Home Assistant will not load any binary_sensor components." +For the Binary Sensor, check the [type/class](/integrations/binary_sensor/) list for a possible visualization of your zones. Note: If no zones or outputs are specified, Home Assistant will not load any binary_sensor integrations." ## Configuration diff --git a/source/_integrations/scrape.markdown b/source/_integrations/scrape.markdown index e9569d0d073..1fc50d91491 100644 --- a/source/_integrations/scrape.markdown +++ b/source/_integrations/scrape.markdown @@ -181,7 +181,7 @@ scrape: ### Available implementations -Get the counter for all our implementations from the [Component overview](/integrations/) page. +Get the counter for all our implementations from the integrations page under {% my integrations title="**Settings** > **Devices & Services**" %}. {% raw %} diff --git a/source/_integrations/select.mqtt.markdown b/source/_integrations/select.mqtt.markdown index 15e403902e6..9cc2fc46b3d 100644 --- a/source/_integrations/select.mqtt.markdown +++ b/source/_integrations/select.mqtt.markdown @@ -73,7 +73,7 @@ command_topic: required: true type: string device: - description: "Information about the device this Select is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device." + description: "Information about the device this Select is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device." required: false type: map keys: diff --git a/source/_integrations/sensor.markdown b/source/_integrations/sensor.markdown index af4d721bd1f..637cde66f96 100644 --- a/source/_integrations/sensor.markdown +++ b/source/_integrations/sensor.markdown @@ -11,7 +11,7 @@ ha_codeowners: ha_integration_type: entity --- -Sensors are a basic platform component in Home Assistant. They monitor the states and conditions of a variety of entities. An entity can be many things. This can include a physical device like a motion sensor that reports the battery level, a web service that retrieves the weather temperature, a built-in function that calculates the sun's elevation relative to your GPS position, or even a custom sensor you may have created to report the free space on your laptop. These are all _things_ reporting different types of information. +Sensors are a basic integration in Home Assistant. They monitor the states and conditions of a variety of entities. An entity can be many things. This can include a physical device like a motion sensor that reports the battery level, a web service that retrieves the weather temperature, a built-in function that calculates the sun's elevation relative to your GPS position, or even a custom sensor you may have created to report the free space on your laptop. These are all _things_ reporting different types of information. Some of these sensors are built-in to Home Assistant, some are created automatically when you add an integration (see this [list](/integrations/#sensor)), and some can be created manually. The [Statistics](/integrations/statistics) and [Template](/integrations/template) sensors are two examples of the last case. diff --git a/source/_integrations/sensor.mqtt.markdown b/source/_integrations/sensor.mqtt.markdown index 1b4a21e5935..efe8f65c543 100644 --- a/source/_integrations/sensor.mqtt.markdown +++ b/source/_integrations/sensor.mqtt.markdown @@ -61,7 +61,7 @@ availability_topic: required: false type: string device: - description: "Information about the device this sensor is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/device_registry_index/). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device." + description: "Information about the device this sensor is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/device_registry_index/). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device." required: false type: map keys: diff --git a/source/_integrations/sentry.markdown b/source/_integrations/sentry.markdown index febe05e1878..c066e1e0d0e 100644 --- a/source/_integrations/sentry.markdown +++ b/source/_integrations/sentry.markdown @@ -15,11 +15,11 @@ ha_integration_type: service
- The free Sentry account allows 5000 events per month. Depending on the amount of events sent to Sentry you will either have to upgrade your Sentry account or have a period without data flowing from Home Assistant to Sentry.
+ The free Sentry account allows 5000 events per month. Depending on the amount of events sent to Sentry, you will either have to upgrade your Sentry account or have a period without data flowing from Home Assistant to Sentry.
-The `sentry` integration integrates with [Sentry](https://sentry.io/) to capture both logged errors as well as unhandled exceptions in Home Assistant.
+The Sentry integration in Home Assistant integrates with [Sentry](https://sentry.io/) to capture both logged errors as well as unhandled exceptions in Home Assistant.
## Preparation
@@ -27,11 +27,11 @@ Before configuring the Sentry integration, you'll need to get Sentry account and
Follow these steps to get the DSN:
-- Go to **Projects**.
-- Click **Create project**.
-- Fill out **Give your project a name** and **choose Assign a Team** fields and click Create project button.
-- Click **Get your DSN** link in top of the page.
-- Your DSN is now visible and looks like
+
+Firmware 1.0.0 or later is required.
+
+
## Light transition
diff --git a/source/_integrations/shiftr.markdown b/source/_integrations/shiftr.markdown
index 2f93ceccc8c..d80698f67c6 100644
--- a/source/_integrations/shiftr.markdown
+++ b/source/_integrations/shiftr.markdown
@@ -13,7 +13,7 @@ The `shiftr` integration makes it possible to transfer details collected with Ho
## Configuration
-Create a new [namespace](https://shiftr.io/new) and generate a new token. You will need to use `Key (Username)` and `Secret (Password)` to setup the component.
+Create a new [namespace](https://shiftr.io/new) and generate a new token. You will need to use `Key (Username)` and `Secret (Password)` to setup the integration.
To use the `shiftr` integration in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_integrations/sigfox.markdown b/source/_integrations/sigfox.markdown
index e0c9cd498cc..4557896abaa 100644
--- a/source/_integrations/sigfox.markdown
+++ b/source/_integrations/sigfox.markdown
@@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
-[SigFox](https://www.sigfox.com/en) integration adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)).
+[SigFox](https://www.sigfox.com/) integration adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)).
## Setup
diff --git a/source/_integrations/sighthound.markdown b/source/_integrations/sighthound.markdown
index e41b84a3890..5b4a776870c 100644
--- a/source/_integrations/sighthound.markdown
+++ b/source/_integrations/sighthound.markdown
@@ -17,7 +17,7 @@ This integration adds an image processing entity where the state of the entity i
If `save_file_folder` is configured, on each new detection of a person, an annotated image with the name `sighthound_{camera_name}_latest.jpg` is saved in the configured folder if it doesn't already exist, and overwritten if it does exist. The saved image shows the bounding box around detected people and can be displayed on the Home Assistant front end using a [Local File](/integrations/local_file/) camera, and used in notifications. If `save_timestamped_file` is configured as `true`, then the annotated image is saved with a file name that includes the time of detection.
-**Note** that by default the component will not automatically scan images, but requires you to call the `image_processing.scan` service, e.g., using an automation triggered by motion.
+**Note** that by default the integration will not automatically scan images, but requires you to call the `image_processing.scan` service, e.g., using an automation triggered by motion.
## Configuration
diff --git a/source/_integrations/simulated.markdown b/source/_integrations/simulated.markdown
index cb97e78906d..3f64b38dcf7 100644
--- a/source/_integrations/simulated.markdown
+++ b/source/_integrations/simulated.markdown
@@ -1,6 +1,6 @@
---
title: Simulated
-description: Component for simulating a numerical sensor.
+description: Integration for simulating a numerical sensor.
ha_category:
- Sensor
- Utility
diff --git a/source/_integrations/siren.mqtt.markdown b/source/_integrations/siren.mqtt.markdown
index fcb7f9515a5..96d4e53900f 100644
--- a/source/_integrations/siren.mqtt.markdown
+++ b/source/_integrations/siren.mqtt.markdown
@@ -84,7 +84,7 @@ command_topic:
required: false
type: string
device:
- description: "Information about the device this siren is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
+ description: "Information about the device this siren is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
required: false
type: map
keys:
diff --git a/source/_integrations/sisyphus.markdown b/source/_integrations/sisyphus.markdown
index e718243c658..21ef39cb4cd 100644
--- a/source/_integrations/sisyphus.markdown
+++ b/source/_integrations/sisyphus.markdown
@@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant:
The Light and Media players will be automatically added for each of your Sisyphus tables, if the Sisyphus integration is configured.
-There are two ways to configure this component. For the automatic discovery of your table(s), simply add the following to your `configuration.yaml`:
+There are two ways to configure this integration. For the automatic discovery of your table(s), add the following to your `configuration.yaml`:
```yaml
# This will auto-detect all Sisyphus tables on your local network.
diff --git a/source/_integrations/snapcast.markdown b/source/_integrations/snapcast.markdown
index 05afca13697..ccb63f7006c 100644
--- a/source/_integrations/snapcast.markdown
+++ b/source/_integrations/snapcast.markdown
@@ -20,7 +20,7 @@ The Snapcast integration allows you to control [Snapcast](https://github.com/bad
## Services
-The snapcast components provides a few services registered under the media_player component.
+The snapcast integration provides a few services registered under the media_player integration.
### Service `snapcast.snapshot`
diff --git a/source/_integrations/snips.markdown b/source/_integrations/snips.markdown
index 822d105f98c..dd16994f07f 100644
--- a/source/_integrations/snips.markdown
+++ b/source/_integrations/snips.markdown
@@ -141,7 +141,7 @@ Alternatively, MQTT can be configured to bridge messages between servers if usin
### Triggering actions
-In Home Assistant, we trigger actions based on intents produced by Snips using the [`intent_script`](/integrations/intent_script) component. For instance, the following block handles a `ActivateLightColor` intent to change light colors:
+In Home Assistant, we trigger actions based on intents produced by Snips using the [`intent_script`](/integrations/intent_script) integration. For instance, the following block handles a `ActivateLightColor` intent to change light colors:
Note: If your Snips action is prefixed with a username (e.g., `john:playmusic` or `john__playmusic`), the Snips integration in Home Assistant will try and strip off the username. Bear this in mind if you get the error `Received unknown intent` even when what you see on the MQTT bus looks correct. Internally the Snips integration is trying to match the non-username version of the intent (i.e., just `playmusic`).
diff --git a/source/_integrations/solaredge.markdown b/source/_integrations/solaredge.markdown
index 6ed953b1202..84c7d9791d0 100644
--- a/source/_integrations/solaredge.markdown
+++ b/source/_integrations/solaredge.markdown
@@ -18,7 +18,7 @@ ha_integration_type: device
The SolarEdge integration allows you to get details from your SolarEdge solar power setup and integrate these in your Home Assistant installation.
-To integrate it, you need your installation ID and an API key. You can get these by logging in to your [SolarEdge web portal](https://www.solaredge.com). Note: if your portal is not in English, the labels will be different.
+To integrate it, you need your installation ID and an API key. You can get these by logging in to your [SolarEdge web portal](https://monitoring.solaredge.com/). Note: if your portal is not in English, the labels will be different.
- Click on Admin and scroll down to API Access
- Click on "Generate key"
diff --git a/source/_integrations/solaredge_local.markdown b/source/_integrations/solaredge_local.markdown
index cea483ca19f..4dd0ffef1ac 100644
--- a/source/_integrations/solaredge_local.markdown
+++ b/source/_integrations/solaredge_local.markdown
@@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `solaredge_local` platform uses the local API available on some SolarEdge Inverters to allow you to get details from your SolarEdge solar power setup and integrate these into your Home Assistant installation.
+The `solaredge_local` integration uses the local API available on some SolarEdge Inverters to allow you to get details from your SolarEdge solar power setup and integrate these into your Home Assistant installation.
Only specific models support the local API. The local API is available on inverters that do not have an LCD character screen. You can also check the datasheets if in the section "Additional Features", sub-section "Inverter Commissioning" is present the following line "With the SetApp mobile application using built-in Wi-Fi access point for local connection". These inverters also have a part number that ends with a 4. For example: SEXXK-XXXXXBXX4 or SEXXXXH-XXXXXBXX4
@@ -23,7 +23,7 @@ You can check if the local API works by finding the IP address of your inverter
-Recent firmware updates have disabled the local API on many inverters. Please enter the IP address of your inverter in a browser before attempting to use this component. If the local API is enabled, you'll see a web page with the SolarEdge logo and a "Commissioning" menu. See [this issue](https://github.com/jbuehl/solaredge/issues/124) and [this issue](https://github.com/drobtravels/solaredge-local/issues/24) for additional details.
+Recent firmware updates have disabled the local API on many inverters. Please enter the IP address of your inverter in a browser before attempting to use this integration. If the local API is enabled, you'll see a web page with the SolarEdge logo and a "Commissioning" menu. See [this issue](https://github.com/jbuehl/solaredge/issues/124) and [this issue](https://github.com/drobtravels/solaredge-local/issues/24) for additional details.
If your inverter does not support the local API, you can use the [cloud based version](/integrations/solaredge/)
diff --git a/source/_integrations/spaceapi.markdown b/source/_integrations/spaceapi.markdown
index 8305882ed54..b9abfbd4804 100644
--- a/source/_integrations/spaceapi.markdown
+++ b/source/_integrations/spaceapi.markdown
@@ -264,7 +264,7 @@ The list of sensors can be any sensor, not just temperature or humidity.
## Examples
-In this section you find some real-life examples of how to use this component.
+In this section you find some real-life examples of how to use this integration.
### Eastermundigen
diff --git a/source/_integrations/speedtestdotnet.markdown b/source/_integrations/speedtestdotnet.markdown
index a8c18a0d19f..43abb8a4a4f 100644
--- a/source/_integrations/speedtestdotnet.markdown
+++ b/source/_integrations/speedtestdotnet.markdown
@@ -39,7 +39,7 @@ Please be aware of the potential [inconsistencies](https://github.com/sivel/spee
## Examples
-In this section you will find some real-life examples of how to use this component.
+In this section you will find some real-life examples of how to use this integration.
### Using as a trigger in an automation
{% raw %}
diff --git a/source/_integrations/stiebel_eltron.markdown b/source/_integrations/stiebel_eltron.markdown
index 31fdfa890da..566f8f9c85c 100644
--- a/source/_integrations/stiebel_eltron.markdown
+++ b/source/_integrations/stiebel_eltron.markdown
@@ -48,7 +48,7 @@ The following preset modes are supported. The STIEBEL ELTRON modes are mapped an
## Configuration
-To enable this component, add the following lines to your `configuration.yaml` file:
+To enable this integration, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/stream.markdown b/source/_integrations/stream.markdown
index 179ad0d18cf..7130b2cb7bc 100644
--- a/source/_integrations/stream.markdown
+++ b/source/_integrations/stream.markdown
@@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: system
---
-The stream integration provides a way to proxy live streams through Home Assistant. Most users should not need to configure anything or interface with the component directly since it is an internal component used by the [camera integration](/integrations/camera).
+The stream integration provides a way to proxy live streams through Home Assistant. Most users should not need to configure anything or interface with the integration directly since it is an internal integration used by the [camera integration](/integrations/camera).
## Configuration
diff --git a/source/_integrations/surepetcare.markdown b/source/_integrations/surepetcare.markdown
index d89110fd529..7b25d8f5f85 100644
--- a/source/_integrations/surepetcare.markdown
+++ b/source/_integrations/surepetcare.markdown
@@ -19,7 +19,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `surepetcare` component allows you to get information on your Sure Petcare Connect Pet or Cat Flap.
+The Sure Petcare integration allows you to get information on your Sure Petcare Connect Pet or Cat Flap.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/switch.mqtt.markdown b/source/_integrations/switch.mqtt.markdown
index d1cf316b185..d4d75b48cad 100644
--- a/source/_integrations/switch.mqtt.markdown
+++ b/source/_integrations/switch.mqtt.markdown
@@ -71,7 +71,7 @@ command_topic:
required: false
type: string
device:
- description: "Information about the device this switch is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
+ description: "Information about the device this switch is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
required: false
type: map
keys:
diff --git a/source/_integrations/system_log.markdown b/source/_integrations/system_log.markdown
index 558c64c85ac..c14ddca5756 100644
--- a/source/_integrations/system_log.markdown
+++ b/source/_integrations/system_log.markdown
@@ -59,7 +59,7 @@ Errors and warnings are posted as the event `system_log_event`, so it is possibl
| `source` | File that triggered the error, e.g., `core.py` or `media_player/yamaha.py`. |
| `exception` | Full stack trace if available, an empty string otherwise. |
| `message` | Descriptive message of the error, e.g., "Error handling request". |
-| `name` | Name of the component, e.g., `homeassistant.components.device_tracker` |
+| `name` | Name of the integration, e.g., `homeassistant.components.device_tracker` |
| `timestamp` | Unix timestamp with as a double, e.g., 1517241010.237416. |
Live examples of these events can be found in the Home Assistant log file (`home-assistant.log`) or by just looking in the system log. An example could, for instance, look like this:
diff --git a/source/_integrations/tado.markdown b/source/_integrations/tado.markdown
index 8ca2f81407f..43f55c7d0fd 100644
--- a/source/_integrations/tado.markdown
+++ b/source/_integrations/tado.markdown
@@ -42,7 +42,7 @@ There is currently support for the following device types within Home Assistant:
The Tado thermostats are internet connected thermostats. There exists an unofficial API at [my.tado.com](https://my.tado.com/), which is used by their website and now by this component.
-It currently supports presenting the current temperature, the setting temperature and the current operation mode. The operation mode can be set to manual, auto and off. If no user is at home anymore, all Tado zones show the away-state (Only with Tado assist mode). Manually switching between home-mode and away-mode is also supported. Any Tado climate card can be switched between these presence modes, this changes the setting for the entire home.
+It currently supports presenting the current temperature, the setting temperature and the current operation mode. The operation mode can be set to manual, auto and off. If no user is at home anymore, all Tado zones show the away-state (Only with Tado assist mode). Manually switching between home-mode and away-mode is also supported. Manually switching to auto-mode is only supported with Tado assist mode. Any Tado climate card can be switched between these presence modes, this changes the setting for the entire home.
## Presence Detection
diff --git a/source/_integrations/tank_utility.markdown b/source/_integrations/tank_utility.markdown
index f3e79d2cd68..f9f6afca980 100644
--- a/source/_integrations/tank_utility.markdown
+++ b/source/_integrations/tank_utility.markdown
@@ -54,7 +54,7 @@ The device item value is the last segment of the URL path, e.g., the URL
## Configuration
-To enable the component, add the following lines to your `configuration.yaml` file:
+To enable the integration, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/telegram.markdown b/source/_integrations/telegram.markdown
index 5663552211b..19361b8fb79 100644
--- a/source/_integrations/telegram.markdown
+++ b/source/_integrations/telegram.markdown
@@ -11,15 +11,65 @@ ha_platforms:
ha_integration_type: integration
---
-The `telegram` platform uses [Telegram](https://www.telegram.org) to deliver notifications from Home Assistant to your Telegram application(s).
+The `telegram` integration uses [Telegram](https://www.telegram.org) to deliver notifications from Home Assistant to your Telegram application(s).
-## Setup
+## Setup example
-The requirements are:
+To create your first [Telegram bot](https://core.telegram.org/bots#how-do-i-create-a-bot), follow these steps:
-- You need a [Telegram bot](https://core.telegram.org/bots). Please follow those [instructions](https://core.telegram.org/bots#6-botfather) to create one and get the token for your bot. Keep in mind that bots are not allowed to contact users. You need to make the first contact with your user. Meaning that you need to send a message to the bot from your user.
-- You need to configure a [Telegram bot in Home Assistant](/integrations/telegram_bot) and define there your API key and the allowed chat ids to interact with.
-- The `chat_id` of an allowed user or group to which the bot is added.
+ * Bots are not allowed to contact users. You need to make the first contact from the user for which you want to set up the bot.
+
+1. Tell Telegram to create a bot for you:
+ * In Telegram, open a chat with @BotFather and enter `/newbot`.
+ * Follow the instructions on screen and give your bot a name.
+ * BotFather will give you a link to your new bot and an HTTP API token.
+ * Store the token somewhere safe.
+1. To get a chat ID, send any message to the [GetIDs bot](https://t.me/getidsbot).
+ * Then, enter `/start`.
+ * The bot will return your chat ID and the user name.
+1. Create a [Telegram bot in Home Assistant](/integrations/telegram_bot):
+ * Paste this into your configuration file:
+ * Replace the `api_key` and the `allowed_chat_ids` with your data.
+
+ ```yaml
+ # Telegram Bot
+ telegram_bot:
+ - platform: polling
+ api_key: "1117774004:EABQulCACdgkQOTN3hS_5HZwSwxDlekCixr"
+ allowed_chat_ids:
+ - 44441111
+ ```
+
+1. Create a notifier:
+ * Paste this into your configuration file:
+ * Replace the `name` and the `chat_id` with your data.
+
+ ```yaml
+ # Notifier
+ notify:
+ - platform: telegram
+ name: "sarah"
+ chat_id: 44441111
+ ```
+
+1. From the conversation with BotFather, select the link to open a chat with your new bot.
+1. In the chat with the new bot, enter `/start`.
+1. Test the service:
+ * Go to [**Developer tools** > **Services** > **YAML mode**](https://my.home-assistant.io/redirect/developer_call_service/?service=homeassistant.turn_on).
+ * Paste this into the YAML file:
+ * Replace the `service` and the `message` with your data.
+
+ ```yaml
+ service: notify.sarah
+ data:
+ message: "Yay! A message from Home Assistant."
+ ```
+ * Select **Call service**. You should now get a message.
+
+1. You can do more with this. Check out the configuration descriptions and examples below.
+
+
+## Methods to retrieve a `chat_id`
**Method 1:** You can get your `chat_id` by sending any message to the [GetIDs bot](https://t.me/getidsbot).
diff --git a/source/_integrations/template.markdown b/source/_integrations/template.markdown
index 413a89db447..b544e558962 100644
--- a/source/_integrations/template.markdown
+++ b/source/_integrations/template.markdown
@@ -429,7 +429,7 @@ template:
### State based sensor modifying another sensor's output
-If you don't like the wording of a sensor output, then the Template Sensor can help too. Let's rename the output of the [Sun component](/integrations/sun/) as a simple example:
+If you don't like the wording of a sensor output, then the Template Sensor can help too. Let's rename the output of the [Sun integration](/integrations/sun/) as a simple example:
{% raw %}
@@ -804,7 +804,7 @@ sensor:
required: true
type: template
availability_template:
- description: Defines a template to get the `available` state of the component. If the template returns `true`, the device is `available`. If the template returns any other value, the device will be `unavailable`. If `availability_template` is not configured, the component will always be `available`.
+ description: Defines a template to get the `available` state of the integration. If the template returns `true`, the device is `available`. If the template returns any other value, the device will be `unavailable`. If `availability_template` is not configured, the integration will always be `available`.
required: false
type: template
default: true
diff --git a/source/_integrations/text.mqtt.markdown b/source/_integrations/text.mqtt.markdown
index e22d7125d84..028c49f8791 100644
--- a/source/_integrations/text.mqtt.markdown
+++ b/source/_integrations/text.mqtt.markdown
@@ -67,7 +67,7 @@ command_topic:
required: true
type: string
device:
- description: "Information about the device this of text capability is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
+ description: "Information about the device this of text capability is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
required: false
type: map
keys:
diff --git a/source/_integrations/thethingsnetwork.markdown b/source/_integrations/thethingsnetwork.markdown
index 8935f20a248..cafd148021f 100644
--- a/source/_integrations/thethingsnetwork.markdown
+++ b/source/_integrations/thethingsnetwork.markdown
@@ -52,7 +52,7 @@ Access keys
## Configuration
-To enable this component, add the following lines to your `configuration.yaml`:
+To enable this integration, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
@@ -76,7 +76,7 @@ access_key:
The `thethingsnetwork` sensor platform allows you to get data from a [The Things Network Storage Integration](https://www.thethingsnetwork.org/docs/applications/storage/).
-This platform requires that the [The Things Network component](#configuration) is set up and the [The Things Network Storage Integration](https://www.thethingsnetwork.org/docs/applications/storage/) as well.
+This platform requires that the [The Things Network integration](#configuration) is set up and the [The Things Network Storage Integration](https://www.thethingsnetwork.org/docs/applications/storage/) as well.
### Prerequisites
diff --git a/source/_integrations/thingspeak.markdown b/source/_integrations/thingspeak.markdown
index c133c894cec..df5b0b5d95c 100644
--- a/source/_integrations/thingspeak.markdown
+++ b/source/_integrations/thingspeak.markdown
@@ -10,7 +10,7 @@ ha_integration_type: integration
---
The `thingspeak` integrations makes Home Assistant communicate with the [ThingSpeak API](https://thingspeak.com/).
-For now, it records exactly one entity at once, which is great for testing purposes. For long-time storage you should rely on the [InfluxDB component](/integrations/influxdb/).
+For now, it records exactly one entity at once, which is great for testing purposes. For long-time storage you should rely on the [InfluxDB integration](/integrations/influxdb/).
## Configuration
diff --git a/source/_integrations/thread.markdown b/source/_integrations/thread.markdown
index 6bc0f888cdf..45bd10d434a 100644
--- a/source/_integrations/thread.markdown
+++ b/source/_integrations/thread.markdown
@@ -21,7 +21,7 @@ Thread-based consumer devices use one of the two Home Automation standards: Matt
| Logo | Home Assistant integration |
| :-------------------------------------------------------------------------: | :--------------------------------:|
| 
| [Matter](/integrations/Matter/) |
-| 
| [HomeKit](/integrations/homekit/) |
+| | [HomeKit](/integrations/homekit_controller/) |
## Thread — A communication protocol
diff --git a/source/_integrations/tomorrowio.markdown b/source/_integrations/tomorrowio.markdown
index ccca0e11491..360574f4f88 100644
--- a/source/_integrations/tomorrowio.markdown
+++ b/source/_integrations/tomorrowio.markdown
@@ -23,9 +23,11 @@ The Tomorrow.io integration allows you to obtain weather, air quality, pollen, a
## Obtain an API key
-You can obtain a free API key by signing up with [Tomorrow.io](https://www.tomorrow.io/weather-api/).
+You can obtain a free API key by signing up with [Tomorrow.io](https://www.tomorrow.io/weather-api/). The integration assumes that your API key is associated with a free Tomorrow.io account. Free accounts include a limited number of daily API requests and the number of daily API requests included varies by account. Login to Tomorrow.io to view the number of daily API requests included with your account.
-The integration will automatically set the refresh interval based on the number of Tomorrow.io integrations that are using the same API key for a given Home Assistant instance. The integration currently assumes you are using a free account so the max requests per day is 100 (the refresh interval is calculated such that you should only use up around 90% of the quota).
+The refresh interval defaults to a time period that is compatible with an account limited to 100 daily API requests and this integration should use around 90% of the available daily requests.
+
+When using a free account, the information provided by Tomorrow.io is limited to the [Core layer](https://docs.tomorrow.io/reference/data-layers-core). It does not include the Air Quality layer or other layers. A paid Tomorrow.io account is required to retrieve those layers.
## Supported Forecast Types
diff --git a/source/_integrations/toon.markdown b/source/_integrations/toon.markdown
index 4cdb9ceeb84..0d1b8118c21 100644
--- a/source/_integrations/toon.markdown
+++ b/source/_integrations/toon.markdown
@@ -46,7 +46,7 @@ There is currently support for the following device types within Home Assistant:
## Setting up a developer account
-In order to be able to use this component, you'll need to sign up for a free Toon API developer account.
+In order to be able to use this integration, you'll need to sign up for a free Toon API developer account.
1. Visit the [Toon API developers website](https://developer.toon.eu/), and [sign in](https://developer.toon.eu/user/login). [Create an account](https://developer.toon.eu/user/register) if you don’t have one already.
2. Open the "[My Apps](https://developer.toon.eu/user/me/apps)" page and click on "Add a new App" button on the top right.
diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown
index 2c438a3c097..75a76442822 100644
--- a/source/_integrations/totalconnect.markdown
+++ b/source/_integrations/totalconnect.markdown
@@ -68,7 +68,7 @@ automation:
{% details "Notes for Home Assistant Core Installations" %}
-If you have issues running this component, you may require `libxml2-dev` and `libxmlsec1-dev` packages. To install these on Raspbian, run the command:
+If you have issues running this integration, you may require `libxml2-dev` and `libxmlsec1-dev` packages. To install these on Raspbian, run the command:
```bash
sudo apt install libxml2-dev libxmlsec1-dev
diff --git a/source/_integrations/tplink_lte.markdown b/source/_integrations/tplink_lte.markdown
index a1488286125..cf063e03057 100644
--- a/source/_integrations/tplink_lte.markdown
+++ b/source/_integrations/tplink_lte.markdown
@@ -18,7 +18,7 @@ The integration provides a notification service that will send an SMS.
## Configuration
-To enable the component, add the following lines to your `configuration.yaml` file:
+To enable the integration, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/tradfri.markdown b/source/_integrations/tradfri.markdown
index 9b8101a342d..c2dc09c22e8 100644
--- a/source/_integrations/tradfri.markdown
+++ b/source/_integrations/tradfri.markdown
@@ -23,7 +23,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `tradfri` integration allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified Zigbee Light Link products) connected to it. Home Assistant will automatically discover the gateway's presence on your local network if `discovery:` is present in your `configuration.yaml` file.
+The IKEA TRÅDFRI integration allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified Zigbee Light Link products) connected to it. Home Assistant will automatically discover the gateway's presence on your local network if `discovery:` is present in your `configuration.yaml` file.
{% include integrations/config_flow.md %}
@@ -57,7 +57,7 @@ Then restart Home Assistant. When prompted, enter the security key and click *co
This does not apply to Home Assistant running in Docker Containers, including the default Home Assistant install.
-Please make sure you have `autoconf` installed (`$ sudo apt-get install autoconf`) if you want to use this component. Also, installing some dependencies might take considerable time (more than one hour) on slow devices.
+Please make sure you have `autoconf` installed (`$ sudo apt-get install autoconf`) if you want to use this integration. Also, installing some dependencies might take considerable time (more than one hour) on slow devices.
## Known limitations
diff --git a/source/_integrations/tuya.markdown b/source/_integrations/tuya.markdown
index 0cb0cca1fe8..06c37a739f9 100644
--- a/source/_integrations/tuya.markdown
+++ b/source/_integrations/tuya.markdown
@@ -66,8 +66,8 @@ This is a separate account from the one you made for the app. You cannot log in
4. In the `Create Cloud Project` dialog box, configure `Project Name`, `Description`, `Industry`, and `Data Center`. For the `Development Method` field, select `Smart Home` from the dropdown list. For the `Data Center` field, select the zone you are located in. Refer to the country/data center mapping list [here](https://github.com/tuya/tuya-home-assistant/blob/main/docs/regions_dataCenters.md) to choose the right data center for the country you are in.
5. Click `Create` to continue with the project configuration.
-6. In Configuration Wizard, make sure you add `Device Status Notification` API. The list of API should look like this:
- 
+6. In Configuration Wizard, make sure you add `Industry Basic Service`, `Smart Home Basic Service` and `Device Status Notification` APIs. The list of API should look like this:
+ 
7. Click `Authorize`.
### Link devices by app account
@@ -134,9 +134,7 @@ If no devices show up in Home Assistant:
- Incorrect username or password: Enter the correct account and password of the Tuya Smart or Smart Life app in the **Account** and **Password** fields (social login, which the Tuya Smart app allows, may not work, and thus should be avoided for use with the Home Assistant integration). Note that the app account depends on which app (Tuya Smart or Smart Life) you used to link devices on the [Tuya IoT Platform](https://iot.tuya.com/cloud/).
- - Incorrect country. You must select the region of your account of the Tuya Smart app or Smart Life app.
-
- - Some users still experience the **Permission denied** error after adding the correct app account credentials in a correctly configured project. A workaround involves adding a custom user under **Cloud** > **Development** > **Users**.
+ - Incorrect country. You must select the region of your account of the Tuya Smart app or Smart Life app.
"1100: param is empty":
description: Empty parameter of username or app. Please fill the parameters refer to the **Configuration** part above.
@@ -154,6 +152,10 @@ If no devices show up in Home Assistant:
Some APIs are not authorized, please [Subscribe](https://developer.tuya.com/docs/iot/applying-for-api-group-permissions?id=Ka6vf012u6q76#title-2-Subscribe%20to%20APIs) then [Authorize](https://developer.tuya.com/docs/iot/applying-for-api-group-permissions?id=Ka6vf012u6q76#title-3-Grant%20a%20project%20access%20to%20API%20calls). The following APIs must be subscribed for this tutorial:
- Device Status Notification
+
+ - Industry Basic Service
+
+ - Smart Home Basic Service
- Authorization
diff --git a/source/_integrations/twilio.markdown b/source/_integrations/twilio.markdown
index 1182330881f..1047912769d 100644
--- a/source/_integrations/twilio.markdown
+++ b/source/_integrations/twilio.markdown
@@ -39,7 +39,7 @@ auth_token:
### Usage
-After configuring the base Twilio component, add and configure either or both of the [Twilio SMS](/integrations/twilio_sms) and [Twilio Phone](/integrations/twilio_call) integrations to utilize the notification functionality.
+After configuring the base Twilio integration, add and configure either or both of the [Twilio SMS](/integrations/twilio_sms) and [Twilio Phone](/integrations/twilio_call) integrations to utilize the notification functionality.
To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/docs/configuration/basic) in Home Assistant.
diff --git a/source/_integrations/ubus.markdown b/source/_integrations/ubus.markdown
index f2cec962300..01240032804 100644
--- a/source/_integrations/ubus.markdown
+++ b/source/_integrations/ubus.markdown
@@ -13,7 +13,7 @@ ha_integration_type: integration
This is a presence detection scanner for [OpenWrt](https://openwrt.org/) using [ubus](https://wiki.openwrt.org/doc/techref/ubus). It scans for changes in `hostapd.*`, which will detect and report changes in devices connected to the access point on the router.
-Before this scanner can be used you have to install the ubus RPC packages on OpenWrt (versions older than 18.06.x do not require the `uhttpd-mod-ubus` package):
+Before this scanner can be used, you have to install the ubus RPC packages on OpenWrt (versions older than 18.06.x do not require the `uhttpd-mod-ubus` package):
```bash
opkg update
@@ -90,7 +90,7 @@ If you find that this never creates `known_devices.yaml`, or if you need more in
### Increase Log Level
1. On your Home Assistant device, stop Home Assistant
-2. Adjust `configuration.yaml` to log more detail for the `device_tracker` component
+2. Adjust `configuration.yaml` to log more detail for the `device_tracker` integration.
```yaml
logger:
diff --git a/source/_integrations/update.mqtt.markdown b/source/_integrations/update.mqtt.markdown
index 62ce2a0fc90..f79f6c67425 100644
--- a/source/_integrations/update.mqtt.markdown
+++ b/source/_integrations/update.mqtt.markdown
@@ -64,7 +64,7 @@ command_topic:
required: false
type: string
device:
- description: "Information about the device this Update is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
+ description: "Information about the device this Update is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
required: false
type: map
keys:
diff --git a/source/_integrations/vacuum.markdown b/source/_integrations/vacuum.markdown
index a493e3625fd..de3155326c8 100644
--- a/source/_integrations/vacuum.markdown
+++ b/source/_integrations/vacuum.markdown
@@ -24,7 +24,7 @@ vacuum:
host: 192.168.1.2
```
-### Component services
+### Integration services
Available services: `turn_on`, `turn_off`, `start_pause`, `start`, `pause`, `stop`, `return_to_base`, `locate`, `clean_spot`, `set_fan_speed` and `send_command`.
diff --git a/source/_integrations/vacuum.mqtt.markdown b/source/_integrations/vacuum.mqtt.markdown
index a141b9b6f62..d6d75b6248b 100644
--- a/source/_integrations/vacuum.mqtt.markdown
+++ b/source/_integrations/vacuum.mqtt.markdown
@@ -367,7 +367,7 @@ command_topic:
required: false
type: string
device:
- description: "Information about the device this switch is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
+ description: "Information about the device this switch is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device."
required: false
type: map
keys:
diff --git a/source/_integrations/vacuum.template.markdown b/source/_integrations/vacuum.template.markdown
index 4b032cf5b63..1f186efc3c9 100644
--- a/source/_integrations/vacuum.template.markdown
+++ b/source/_integrations/vacuum.template.markdown
@@ -111,7 +111,7 @@ State-based template entities have the special template variable `this` availabl
### Control vacuum with Harmony Hub
-This example shows how you can use a Template Vacuum to control an IR vacuum cleaner using the [Harmony Hub Remote component](/integrations/harmony).
+This example shows how you can use a Template Vacuum to control an IR vacuum cleaner using the [Harmony Hub Remote integration](/integrations/harmony).
```yaml
vacuum:
diff --git a/source/_integrations/vicare.markdown b/source/_integrations/vicare.markdown
index 54ad909e4fa..0934f9b2aac 100644
--- a/source/_integrations/vicare.markdown
+++ b/source/_integrations/vicare.markdown
@@ -61,7 +61,7 @@ A note about the current temperature attribute: Viessmann devices with room temp
### Supported services `climate.vicare_heating`
-The following services of the [Climate component](/integrations/climate/) are provided by the ViCare integration: `set_temperature`, `set_hvac_mode`, `set_preset_mode`
+The following services of the [Climate integration](/integrations/climate/) are provided by the ViCare integration: `set_temperature`, `set_hvac_mode`, `set_preset_mode`
#### Service `set_temperature`
@@ -78,7 +78,7 @@ Note that `set_temperature` will always affect the current normal temperature or
Set HVAC mode for the climate device. The following modes are supported:
-The `climate.vicare_heating` component has the following mapping of HVAC modes to Viessmann operation modes:
+The `climate.vicare_heating` integration has the following mapping of HVAC modes to Viessmann operation modes:
| HVAC mode | Viessmann mode | Description |
| ---------------------- | -------- | ----------- |
@@ -112,11 +112,11 @@ Eco mode reduces the target temperature by 3°C, whereas Comfort mode sets the t
## Water Heater
-It is not possible to turn on/off water heating via the Water Heater component since this would conflict with the operation modes of the heating component. Therefore the operation mode of that component is just available as an attribute and cannot be modified.
+It is not possible to turn on/off water heating via the Water Heater integration since this would conflict with the operation modes of the heating integration. Therefore the operation mode of that integration is just available as an attribute and cannot be modified.
### Supported services `water_heater.vicare_water`
-The following services of the [Water Heater component](/integrations/water_heater/) are provided by the ViCare integration: `set_temperature`
+The following services of the [Water Heater integration](/integrations/water_heater/) are provided by the ViCare integration: `set_temperature`
#### Service `set_temperature`
diff --git a/source/_integrations/wake_on_lan.markdown b/source/_integrations/wake_on_lan.markdown
index 37ed3ae9458..b1b87bc3c39 100644
--- a/source/_integrations/wake_on_lan.markdown
+++ b/source/_integrations/wake_on_lan.markdown
@@ -29,7 +29,7 @@ To use this integration in your installation, add the following to your `configu
wake_on_lan:
```
-### Component services
+### Integration services
Available services: `send_magic_packet`.
diff --git a/source/_integrations/water_heater.markdown b/source/_integrations/water_heater.markdown
index 14f5a23a6e5..3426fda2d24 100644
--- a/source/_integrations/water_heater.markdown
+++ b/source/_integrations/water_heater.markdown
@@ -12,7 +12,7 @@ ha_integration_type: entity
The `water_heater` integration is built for the controlling and monitoring of hot water heaters.
-To enable this component, pick one of the platforms, and add it to your `configuration.yaml`:
+To enable this integration, pick one of the platforms, and add it to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/watson_iot.markdown b/source/_integrations/watson_iot.markdown
index 0a8ecdb27da..bbac6c9a4c2 100644
--- a/source/_integrations/watson_iot.markdown
+++ b/source/_integrations/watson_iot.markdown
@@ -14,7 +14,7 @@ with an [IBM Watson IoT Platform instance](https://www.ibm.com/us-en/marketplace
## Configuration
-To use this component, you first need to register a gateway device type and then
+To use this integration, you first need to register a gateway device type and then
a gateway device in your IoT platform instance. For instructions on how to do
this check the [official documentation](https://cloud.ibm.com/docs/services/IoT?topic=iot-platform-getting-started#IoT_connectGateway)
which provides the details on doing this. After you register the gateway device
@@ -25,7 +25,7 @@ for your Home Assistant instance you'll need four pieces of information:
- Gateway device ID
- Authentication Token
-With this basic information you can configure the component:
+With this basic information you can configure the integration:
```yaml
# Example configuration.yaml entry:
diff --git a/source/_integrations/wemo.markdown b/source/_integrations/wemo.markdown
index 81811f91b86..58bc30acc1c 100644
--- a/source/_integrations/wemo.markdown
+++ b/source/_integrations/wemo.markdown
@@ -47,7 +47,7 @@ There is currently support for the following device types within Home Assistant:
type: list
{% endconfiguration %}
-Supported devices will be automatically discovered if the optional `discovery` configuration item is omitted or set to true or if the `discovery` integration is enabled. If the `discovery` configuration item is set to false, then automatic discovery of WeMo devices is disabled both for the `wemo` integration and for the `discovery` component. Loading the `wemo` integration with the `discovery` configuration item omitted or set to true will scan the local network for WeMo devices, even if you are not using the `discovery` component.
+Supported devices will be automatically discovered if the optional `discovery` configuration item is omitted or set to true or if the `discovery` integration is enabled. If the `discovery` configuration item is set to false, then automatic discovery of WeMo devices is disabled both for the `wemo` integration and for the `discovery` integration. Loading the `wemo` integration with the `discovery` configuration item omitted or set to true will scan the local network for WeMo devices, even if you are not using the `discovery` integration.
```yaml
# Example configuration.yaml entry with automatic discovery enabled (by omitting the discovery configuration item)
diff --git a/source/_integrations/xiaomi_miio.markdown b/source/_integrations/xiaomi_miio.markdown
index 1cc2bb76e11..77498f62d23 100644
--- a/source/_integrations/xiaomi_miio.markdown
+++ b/source/_integrations/xiaomi_miio.markdown
@@ -13,9 +13,9 @@ ha_category:
ha_iot_class: Local Polling
ha_release: 0.51
ha_codeowners:
- - '@rytilahti'
- - '@syssi'
- - '@starkillerOG'
+ - "@rytilahti"
+ - "@syssi"
+ - "@starkillerOG"
ha_domain: xiaomi_miio
ha_config_flow: true
ha_zeroconf: true
@@ -59,7 +59,7 @@ Devices need to be set up using the Mi Home app and not vendor-specific apps (e.
| [Matter](/integrations/Matter/) |
-| | [HomeKit](/integrations/homekit/) |
+| | [HomeKit](/integrations/homekit_controller/) |
## Thread — A communication protocol
diff --git a/source/_integrations/tomorrowio.markdown b/source/_integrations/tomorrowio.markdown
index ccca0e11491..360574f4f88 100644
--- a/source/_integrations/tomorrowio.markdown
+++ b/source/_integrations/tomorrowio.markdown
@@ -23,9 +23,11 @@ The Tomorrow.io integration allows you to obtain weather, air quality, pollen, a
## Obtain an API key
-You can obtain a free API key by signing up with [Tomorrow.io](https://www.tomorrow.io/weather-api/).
+You can obtain a free API key by signing up with [Tomorrow.io](https://www.tomorrow.io/weather-api/). The integration assumes that your API key is associated with a free Tomorrow.io account. Free accounts include a limited number of daily API requests and the number of daily API requests included varies by account. Login to Tomorrow.io to view the number of daily API requests included with your account.
-The integration will automatically set the refresh interval based on the number of Tomorrow.io integrations that are using the same API key for a given Home Assistant instance. The integration currently assumes you are using a free account so the max requests per day is 100 (the refresh interval is calculated such that you should only use up around 90% of the quota).
+The refresh interval defaults to a time period that is compatible with an account limited to 100 daily API requests and this integration should use around 90% of the available daily requests.
+
+When using a free account, the information provided by Tomorrow.io is limited to the [Core layer](https://docs.tomorrow.io/reference/data-layers-core). It does not include the Air Quality layer or other layers. A paid Tomorrow.io account is required to retrieve those layers.
## Supported Forecast Types
diff --git a/source/_integrations/toon.markdown b/source/_integrations/toon.markdown
index 4cdb9ceeb84..0d1b8118c21 100644
--- a/source/_integrations/toon.markdown
+++ b/source/_integrations/toon.markdown
@@ -46,7 +46,7 @@ There is currently support for the following device types within Home Assistant:
## Setting up a developer account
-In order to be able to use this component, you'll need to sign up for a free Toon API developer account.
+In order to be able to use this integration, you'll need to sign up for a free Toon API developer account.
1. Visit the [Toon API developers website](https://developer.toon.eu/), and [sign in](https://developer.toon.eu/user/login). [Create an account](https://developer.toon.eu/user/register) if you don’t have one already.
2. Open the "[My Apps](https://developer.toon.eu/user/me/apps)" page and click on "Add a new App" button on the top right.
diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown
index 2c438a3c097..75a76442822 100644
--- a/source/_integrations/totalconnect.markdown
+++ b/source/_integrations/totalconnect.markdown
@@ -68,7 +68,7 @@ automation:
{% details "Notes for Home Assistant Core Installations" %}
-If you have issues running this component, you may require `libxml2-dev` and `libxmlsec1-dev` packages. To install these on Raspbian, run the command:
+If you have issues running this integration, you may require `libxml2-dev` and `libxmlsec1-dev` packages. To install these on Raspbian, run the command:
```bash
sudo apt install libxml2-dev libxmlsec1-dev
diff --git a/source/_integrations/tplink_lte.markdown b/source/_integrations/tplink_lte.markdown
index a1488286125..cf063e03057 100644
--- a/source/_integrations/tplink_lte.markdown
+++ b/source/_integrations/tplink_lte.markdown
@@ -18,7 +18,7 @@ The integration provides a notification service that will send an SMS.
## Configuration
-To enable the component, add the following lines to your `configuration.yaml` file:
+To enable the integration, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/tradfri.markdown b/source/_integrations/tradfri.markdown
index 9b8101a342d..c2dc09c22e8 100644
--- a/source/_integrations/tradfri.markdown
+++ b/source/_integrations/tradfri.markdown
@@ -23,7 +23,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `tradfri` integration allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified Zigbee Light Link products) connected to it. Home Assistant will automatically discover the gateway's presence on your local network if `discovery:` is present in your `configuration.yaml` file.
+The IKEA TRÅDFRI integration allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified Zigbee Light Link products) connected to it. Home Assistant will automatically discover the gateway's presence on your local network if `discovery:` is present in your `configuration.yaml` file.
{% include integrations/config_flow.md %}
@@ -57,7 +57,7 @@ Then restart Home Assistant. When prompted, enter the security key and click *co
This does not apply to Home Assistant running in Docker Containers, including the default Home Assistant install.
- For more complex network setups (e.g. VLANs), reference the [following documentation](https://python-miio.readthedocs.io/en/latest/troubleshooting.html#discover-devices-across-subnets) for additional information.
+For more complex network setups (e.g. VLANs), reference the [following documentation](https://python-miio.readthedocs.io/en/latest/troubleshooting.html#discover-devices-across-subnets) for additional information.
@@ -75,6 +75,7 @@ the server to use for each country.
## Troubleshooting
The most common problems are:
+
- Xiaomi Miio devices do not communicate across subnets/VLANs due to the source address of the UDP packet not belonging to the subnet of the device itself, [more information and solutions](https://python-miio.readthedocs.io/en/latest/troubleshooting.html#discover-devices-across-subnets).
- Roborock vacuums need to be connected to the Xiaomi Home app, not the Roborock app, [more information](https://python-miio.readthedocs.io/en/latest/troubleshooting.html#roborock-vacuum-not-detected).
- Blocking the network access to the device is known to cause intermittent connection issues due to the device's internal software hanging and a watchdog restarting the internal software, [more information](https://python-miio.readthedocs.io/en/latest/troubleshooting.html#intermittent-connection-issues-timeouts-xiaomi-vacuum).
@@ -85,15 +86,15 @@ The `xiaomi_miio` gateway integration allows you to control the gateway and its
### Supported Xiaomi gateway models:
-| Gateway name | Zigbee id | model | supported |
-| ------------------ | ------------------- | ------------------------ |------------------------------------------ |
-| Chinese version | lumi.gateway.v3 | DGNWG02LM | yes |
-| European version | lumi.gateway.mieu01 | ZHWG11LM-763 / DGNWQ05LM | yes (cloud credentials needed) |
-| Aqara hub | lumi.gateway.aqhm01 | ZHWG11LM | yes |
-| Mijia Zigbee 3.0 | lumi.gateway.mgl03 | ZNDMWG03LM | yes |
-| Aqara AC Companion | lumi.acpartner.v1 | KTBL01LM | untested |
-| Mi AC Companion | lumi.acpartner.v2 | KTBL02LM | untested |
-| Aqara AC Companion | lumi.acpartner.v3 | KTBL11LM | yes |
+| Gateway name | Zigbee id | model | supported |
+| ------------------ | ------------------- | ------------------------ | ------------------------------ |
+| Chinese version | lumi.gateway.v3 | DGNWG02LM | yes |
+| European version | lumi.gateway.mieu01 | ZHWG11LM-763 / DGNWQ05LM | yes (cloud credentials needed) |
+| Aqara hub | lumi.gateway.aqhm01 | ZHWG11LM | yes |
+| Mijia Zigbee 3.0 | lumi.gateway.mgl03 | ZNDMWG03LM | yes |
+| Aqara AC Companion | lumi.acpartner.v1 | KTBL01LM | untested |
+| Mi AC Companion | lumi.acpartner.v2 | KTBL02LM | untested |
+| Aqara AC Companion | lumi.acpartner.v3 | KTBL11LM | yes |
Some gateways (lumi.gateway.mieu01) do not support getting the connected subdevices locally. For those gateways, cloud credentials can be specified during the config flow and the "Use cloud to get connected subdevices" can be enabled in the options flow (after setting up the integration, click Configuration in the sidebar, then click Integrations and then click Options on the already set up Xiaomi Miio Gateway integration). The connected subdevices will then be retrieved from the Xiaomi Miio cloud (internet), control and status updates of those subdevices will then further take place over local network connection. A re-authentication flow may be triggered when no cloud credentials are provided yet and are needed for that particular gateway model.
@@ -112,65 +113,65 @@ Not yet implemented features (but possible):
These subdevices are fully implemented in HomeAssistant:
-| Subdevice name | Zigbee id | model | features |
-| -------------------------------- | ----------------------- | --------------- | ------------------------------------------------ |
-| Weather sensor | lumi.sensor_ht | WSDCGQ01LM | readout `temperature` and `humidity` |
-| Weather sensor | lumi.weather.v1 | WSDCGQ11LM | readout `temperature`, `humidity` and `pressure` |
-| Wall switch single | lumi.ctrl_ln1 | QBKG11LM | load_power, status, turn_on, turn_off, toggle |
-| Wall switch single | lumi.ctrl_ln1.aq1 | QBKG11LM | load_power, status, turn_on, turn_off, toggle |
-| Wall switch no neutral | lumi.ctrl_neutral1.v1 | QBKG04LM | status, turn_on, turn_off, toggle |
-| Wall switch double | lumi.ctrl_ln2 | QBKG12LM | load_power, status, turn_on, turn_off, toggle |
-| Wall switch double | lumi.ctrl_ln2.aq1 | QBKG12LM | load_power, status, turn_on, turn_off, toggle |
-| Wall switch double no neutral | lumi.ctrl_neutral2 | QBKG03LM | status, turn_on, turn_off, toggle |
-| D1 wall switch triple | lumi.switch.n3acn3 | QBKG26LM | load_power, status, turn_on, turn_off, toggle |
-| D1 wall switch triple no neutral | lumi.switch.l3acn3 | QBKG25LM | load_power, status, turn_on, turn_off, toggle |
-| Wall outlet | lumi.ctrl_86plug.v1 | QBCZ11LM | status, turn_on, turn_off, toggle |
-| Wall outlet | lumi.ctrl_86plug.aq1 | QBCZ11LM | load_power, status, turn_on, turn_off, toggle |
-| Plug | lumi.plug | ZNCZ02LM | load_power, status, turn_on, turn_off, toggle |
-| Relay | lumi.relay.c2acn01 | LLKZMK11LM | load_power, status, turn_on, turn_off, toggle |
-| Smart bulb E27 | lumi.light.aqcn02 | ZNLDP12LM | on/off, brightness, color temperature |
-| IKEA smart bulb E27 white | ikea.light.led1545g12 | LED1545G12 | on/off, brightness, color temperature |
-| IKEA smart bulb E27 white | ikea.light.led1546g12 | LED1546G12 | on/off, brightness, color temperature |
-| IKEA smart bulb E12 white | ikea.light.led1536g5 | LED1536G5 | on/off, brightness, color temperature |
-| IKEA smart bulb GU10 white | ikea.light.led1537r6 | LED1537R6 | on/off, brightness, color temperature |
-| IKEA smart bulb E27 white | ikea.light.led1623g12 | LED1623G12 | on/off, brightness, color temperature |
-| IKEA smart bulb GU10 white | ikea.light.led1650r5 | LED1650R5 | on/off, brightness, color temperature |
-| IKEA smart bulb E12 white | ikea.light.led1649c5 | LED1649C5 | on/off, brightness, color temperature |
+| Subdevice name | Zigbee id | model | features |
+| -------------------------------- | --------------------- | ---------- | ------------------------------------------------ |
+| Weather sensor | lumi.sensor_ht | WSDCGQ01LM | readout `temperature` and `humidity` |
+| Weather sensor | lumi.weather.v1 | WSDCGQ11LM | readout `temperature`, `humidity` and `pressure` |
+| Wall switch single | lumi.ctrl_ln1 | QBKG11LM | load_power, status, turn_on, turn_off, toggle |
+| Wall switch single | lumi.ctrl_ln1.aq1 | QBKG11LM | load_power, status, turn_on, turn_off, toggle |
+| Wall switch no neutral | lumi.ctrl_neutral1.v1 | QBKG04LM | status, turn_on, turn_off, toggle |
+| Wall switch double | lumi.ctrl_ln2 | QBKG12LM | load_power, status, turn_on, turn_off, toggle |
+| Wall switch double | lumi.ctrl_ln2.aq1 | QBKG12LM | load_power, status, turn_on, turn_off, toggle |
+| Wall switch double no neutral | lumi.ctrl_neutral2 | QBKG03LM | status, turn_on, turn_off, toggle |
+| D1 wall switch triple | lumi.switch.n3acn3 | QBKG26LM | load_power, status, turn_on, turn_off, toggle |
+| D1 wall switch triple no neutral | lumi.switch.l3acn3 | QBKG25LM | load_power, status, turn_on, turn_off, toggle |
+| Wall outlet | lumi.ctrl_86plug.v1 | QBCZ11LM | status, turn_on, turn_off, toggle |
+| Wall outlet | lumi.ctrl_86plug.aq1 | QBCZ11LM | load_power, status, turn_on, turn_off, toggle |
+| Plug | lumi.plug | ZNCZ02LM | load_power, status, turn_on, turn_off, toggle |
+| Relay | lumi.relay.c2acn01 | LLKZMK11LM | load_power, status, turn_on, turn_off, toggle |
+| Smart bulb E27 | lumi.light.aqcn02 | ZNLDP12LM | on/off, brightness, color temperature |
+| IKEA smart bulb E27 white | ikea.light.led1545g12 | LED1545G12 | on/off, brightness, color temperature |
+| IKEA smart bulb E27 white | ikea.light.led1546g12 | LED1546G12 | on/off, brightness, color temperature |
+| IKEA smart bulb E12 white | ikea.light.led1536g5 | LED1536G5 | on/off, brightness, color temperature |
+| IKEA smart bulb GU10 white | ikea.light.led1537r6 | LED1537R6 | on/off, brightness, color temperature |
+| IKEA smart bulb E27 white | ikea.light.led1623g12 | LED1623G12 | on/off, brightness, color temperature |
+| IKEA smart bulb GU10 white | ikea.light.led1650r5 | LED1650R5 | on/off, brightness, color temperature |
+| IKEA smart bulb E12 white | ikea.light.led1649c5 | LED1649C5 | on/off, brightness, color temperature |
### Recognized subdevices (not yet implemented)
These subdevices are recognized by the python-miio code but are still being worked on (not yet implemented).
-| Subdevice name | Zigbee id | model |
-| -------------------------------- | ----------------------- | --------------- |
-| Button | lumi.sensor_switch | WXKG01LM |
-| Button | lumi.sensor_switch.aq2 | WXKG11LM 2015 |
-| Button | lumi.sensor_switch.aq3 | WXKG12LM |
-| Button | lumi.remote.b1acn01 | WXKG11LM 2018 |
-| Cube | lumi.sensor_cube.v1 | MFKZQ01LM |
-| Cube | lumi.sensor_cube.aqgl01 | MFKZQ01LM |
-| Motion sensor | lumi.sensor_motion | RTCGQ01LM |
-| Motion sensor | lumi.sensor_motion.aq2 | RTCGQ11LM |
-| Door sensor | lumi.sensor_magnet | MCCGQ01LM |
-| Door sensor | lumi.sensor_magnet.aq2 | MCCGQ11LM |
-| Vibration sensor | lumi.vibration.aq1 | DJT11LM |
-| Honeywell smoke detector | lumi.sensor_smoke | JTYJ-GD-01LM/BW |
-| Honeywell natural gas detector | lumi.sensor_natgas | JTQJ-BF-01LM/BW |
-| Water leak sensor | lumi.sensor_wleak.aq1 | SJCGQ11LM |
-| Remote switch single | lumi.sensor_86sw1.v1 | WXKG03LM 2016 |
-| Remote switch single | lumi.remote.b186acn01 | WXKG03LM 2018 |
-| D1 remote switch single | lumi.remote.b186acn02 | WXKG06LM |
-| Remote switch double | lumi.sensor_86sw2.v1 | WXKG02LM 2016 |
-| Remote switch double | lumi.remote.b286acn01 | WXKG02LM 2018 |
-| D1 remote switch double | lumi.remote.b286acn02 | WXKG07LM |
-| Curtain | lumi.curtain | ZNCLDJ11LM |
-| Curtain | lumi.curtain.aq2 | ZNGZDJ11LM |
-| Curtain B1 | lumi.curtain.hagl04 | ZNCLDJ12LM |
-| Door lock S1 | lumi.lock.aq1 | ZNMS11LM |
-| Door lock S2 | lumi.lock.acn02 | ZNMS12LM |
-| Door lock S2 pro | lumi.lock.acn03 | ZNMS13LM |
-| Vima cylinder lock | lumi.lock.v1 | A6121 |
-| Thermostat S2 | lumi.airrtc.tcpecn02 | KTWKQ03ES |
+| Subdevice name | Zigbee id | model |
+| ------------------------------ | ----------------------- | --------------- |
+| Button | lumi.sensor_switch | WXKG01LM |
+| Button | lumi.sensor_switch.aq2 | WXKG11LM 2015 |
+| Button | lumi.sensor_switch.aq3 | WXKG12LM |
+| Button | lumi.remote.b1acn01 | WXKG11LM 2018 |
+| Cube | lumi.sensor_cube.v1 | MFKZQ01LM |
+| Cube | lumi.sensor_cube.aqgl01 | MFKZQ01LM |
+| Motion sensor | lumi.sensor_motion | RTCGQ01LM |
+| Motion sensor | lumi.sensor_motion.aq2 | RTCGQ11LM |
+| Door sensor | lumi.sensor_magnet | MCCGQ01LM |
+| Door sensor | lumi.sensor_magnet.aq2 | MCCGQ11LM |
+| Vibration sensor | lumi.vibration.aq1 | DJT11LM |
+| Honeywell smoke detector | lumi.sensor_smoke | JTYJ-GD-01LM/BW |
+| Honeywell natural gas detector | lumi.sensor_natgas | JTQJ-BF-01LM/BW |
+| Water leak sensor | lumi.sensor_wleak.aq1 | SJCGQ11LM |
+| Remote switch single | lumi.sensor_86sw1.v1 | WXKG03LM 2016 |
+| Remote switch single | lumi.remote.b186acn01 | WXKG03LM 2018 |
+| D1 remote switch single | lumi.remote.b186acn02 | WXKG06LM |
+| Remote switch double | lumi.sensor_86sw2.v1 | WXKG02LM 2016 |
+| Remote switch double | lumi.remote.b286acn01 | WXKG02LM 2018 |
+| D1 remote switch double | lumi.remote.b286acn02 | WXKG07LM |
+| Curtain | lumi.curtain | ZNCLDJ11LM |
+| Curtain | lumi.curtain.aq2 | ZNGZDJ11LM |
+| Curtain B1 | lumi.curtain.hagl04 | ZNCLDJ12LM |
+| Door lock S1 | lumi.lock.aq1 | ZNMS11LM |
+| Door lock S2 | lumi.lock.acn02 | ZNMS12LM |
+| Door lock S2 pro | lumi.lock.acn03 | ZNMS13LM |
+| Vima cylinder lock | lumi.lock.v1 | A6121 |
+| Thermostat S2 | lumi.airrtc.tcpecn02 | KTWKQ03ES |
## Xiaomi device tracker (Xiaomi Mi WiFi Repeater 2)
@@ -189,13 +190,13 @@ device_tracker:
{% configuration %}
host:
- description: The IP address of your miio device.
- required: true
- type: string
+description: The IP address of your miio device.
+required: true
+type: string
token:
- description: The API token of your miio device.
- required: true
- type: string
+description: The API token of your miio device.
+required: true
+type: string
{% endconfiguration %}
## Xiaomi Air Purifier, Air Humidifier and Standing Fan
@@ -204,50 +205,50 @@ The Air Purifiers, Air Humidifiers and Standing Fans use multiple platforms to a
Supported devices:
-| Name | Model | Model no. |
-| ---------------------- | ---------------------- | --------- |
-| Air Purifier | zhimi.airpurifier.v1 | |
-| Air Purifier 2 | zhimi.airpurifier.v2 | FJY4006CN |
-| Air Purifier V3 | zhimi.airpurifier.v3 | |
-| Air Purifier V5 | zhimi.airpurifier.v5 | |
-| Air Purifier Pro | zhimi.airpurifier.v6 | |
-| Air Purifier Pro V7 | zhimi.airpurifier.v7 | |
-| Air Purifier 2 (mini) | zhimi.airpurifier.m1 | |
-| Air Purifier (mini) | zhimi.airpurifier.m2 | |
-| Air Purifier MA1 | zhimi.airpurifier.ma1 | |
-| Air Purifier MA2 | zhimi.airpurifier.ma2 | |
-| Air Purifier 2S | zhimi.airpurifier.mc1 | |
-| Air Purifier Super | zhimi.airpurifier.sa1 | |
-| Air Purifier Super 2 | zhimi.airpurifier.sa2 | |
-| Air Purifier 3 (2019) | zhimi.airpurifier.ma4 | AC-M6-SC |
-| Air Purifier 3H (2019) | zhimi.airpurifier.mb3 | |
-| Air Purifier 3C | zhimi.airpurifier.mb4 | |
-| Air Purifier ZA1 | zhimi.airpurifier.za1 | |
-| Air Purifier 4 | zhimi.airp.mb5 | AC-M16-SC |
-| Air Purifier 4 PRO | zhimi.airp.vb4 | AC-M15-SC |
-| Air Fresh A1 | dmaker.airfresh.a1 | MJXFJ-150-A1 |
-| Air Fresh VA2 | zhimi.airfresh.va2 | |
-| Air Fresh VA4 | zhimi.airfresh.va4 | |
-| Air Fresh T2017 | dmaker.airfresh.t2017 | MJXFJ-300-G1 |
-| Air Humidifier | zhimi.humidifier.v1 | |
-| Air Humidifier CA1 | zhimi.humidifier.ca1 | |
-| Air Humidifier CA4 | zhimi.humidifier.ca4 | |
-| Air Humidifier CB1 | zhimi.humidifier.cb1 | |
-| Air Humidifier JSQ | deerma.humidifier.jsq | |
-| Air Humidifier JSQ1 | deerma.humidifier.jsq1 | |
-| Air Humidifier MJJSQ | deerma.humidifier.mjjsq| |
-| Standing Fan 1X | dmaker.fan.p5 | |
-| Inverter Pedestal Fan | zhimi.fan.za1 | |
-| Standing Fan 2 | zhimi.fan.za3 | |
-| Standing Fan 2S | zhimi.fan.za4 | |
-| Standing Fan | zhimi.fan.sa1 | |
-| DC Pedestal Fan | zhimi.fan.v2 | |
-| DC Pedestal Fan | zhimi.fan.v3 | |
-| Standing Fan 1C | dmaker.fan.1c | |
-| Tower Fan | dmaker.fan.p9 | |
-| Standing Fan 2 | dmaker.fan.p10 | |
-| Standing Fan Pro | dmaker.fan.p11 | |
-| Standing Fan 3 | zhimi.fan.za5 | |
+| Name | Model | Model no. |
+| ---------------------- | ----------------------- | ------------ |
+| Air Purifier | zhimi.airpurifier.v1 | |
+| Air Purifier 2 | zhimi.airpurifier.v2 | FJY4006CN |
+| Air Purifier V3 | zhimi.airpurifier.v3 | |
+| Air Purifier V5 | zhimi.airpurifier.v5 | |
+| Air Purifier Pro | zhimi.airpurifier.v6 | |
+| Air Purifier Pro V7 | zhimi.airpurifier.v7 | |
+| Air Purifier 2 (mini) | zhimi.airpurifier.m1 | |
+| Air Purifier (mini) | zhimi.airpurifier.m2 | |
+| Air Purifier MA1 | zhimi.airpurifier.ma1 | |
+| Air Purifier MA2 | zhimi.airpurifier.ma2 | |
+| Air Purifier 2S | zhimi.airpurifier.mc1 | |
+| Air Purifier Super | zhimi.airpurifier.sa1 | |
+| Air Purifier Super 2 | zhimi.airpurifier.sa2 | |
+| Air Purifier 3 (2019) | zhimi.airpurifier.ma4 | AC-M6-SC |
+| Air Purifier 3H (2019) | zhimi.airpurifier.mb3 | |
+| Air Purifier 3C | zhimi.airpurifier.mb4 | |
+| Air Purifier ZA1 | zhimi.airpurifier.za1 | |
+| Air Purifier 4 | zhimi.airp.mb5 | AC-M16-SC |
+| Air Purifier 4 PRO | zhimi.airp.vb4 | AC-M15-SC |
+| Air Fresh A1 | dmaker.airfresh.a1 | MJXFJ-150-A1 |
+| Air Fresh VA2 | zhimi.airfresh.va2 | |
+| Air Fresh VA4 | zhimi.airfresh.va4 | |
+| Air Fresh T2017 | dmaker.airfresh.t2017 | MJXFJ-300-G1 |
+| Air Humidifier | zhimi.humidifier.v1 | |
+| Air Humidifier CA1 | zhimi.humidifier.ca1 | |
+| Air Humidifier CA4 | zhimi.humidifier.ca4 | |
+| Air Humidifier CB1 | zhimi.humidifier.cb1 | |
+| Air Humidifier JSQ | deerma.humidifier.jsq | |
+| Air Humidifier JSQ1 | deerma.humidifier.jsq1 | |
+| Air Humidifier MJJSQ | deerma.humidifier.mjjsq | |
+| Standing Fan 1X | dmaker.fan.p5 | |
+| Inverter Pedestal Fan | zhimi.fan.za1 | |
+| Standing Fan 2 | zhimi.fan.za3 | |
+| Standing Fan 2S | zhimi.fan.za4 | |
+| Standing Fan | zhimi.fan.sa1 | |
+| DC Pedestal Fan | zhimi.fan.v2 | |
+| DC Pedestal Fan | zhimi.fan.v3 | |
+| Standing Fan 1C | dmaker.fan.1c | |
+| Tower Fan | dmaker.fan.p9 | |
+| Standing Fan 2 | dmaker.fan.p10 | |
+| Standing Fan Pro | dmaker.fan.p11 | |
+| Standing Fan 3 | zhimi.fan.za5 | |
### Features
@@ -267,31 +268,31 @@ Supported devices:
- `sleep_mode`
- Number entities
-Number | Description
------------------------ | -----------------------
-Favorite Level | Set the favorite level
+| Number | Description |
+| -------------- | ---------------------- |
+| Favorite Level | Set the favorite level |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | ----------------------- | -----------------------
-Filter Life Remaining | The remaining life of the filter | True
-Filter Use | Filter usage time in hours | True
-Humidity | The current humidity measured | True
-Motor Speed | The current motor speed measured in rpm | True
-PM2.5 | The current particulate matter 2.5 measured | True
-Purify Volume | The volume of purified air in qubic meter | False
-Temperature | The current temperature measured | True
-Use Time | The accumulative number of seconds the device has been in use | False
+| Sensor | Description | Enabled by default |
+| --------------------- | ------------------------------------------------------------- | ------------------ |
+| Filter Life Remaining | The remaining life of the filter | True |
+| Filter Use | Filter usage time in hours | True |
+| Humidity | The current humidity measured | True |
+| Motor Speed | The current motor speed measured in rpm | True |
+| PM2.5 | The current particulate matter 2.5 measured | True |
+| Purify Volume | The volume of purified air in qubic meter | False |
+| Temperature | The current temperature measured | True |
+| Use Time | The accumulative number of seconds the device has been in use | False |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the buzzer
-Child Lock | Turn on/off the child lock
-Learn Mode | Turn on/off the learn mode
-LED | Turn on/off the LED
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the buzzer |
+| Child Lock | Turn on/off the child lock |
+| Learn Mode | Turn on/off the learn mode |
+| LED | Turn on/off the LED |
### Air Purifier Pro (zhimi.airpurifier.v6)
@@ -307,33 +308,33 @@ LED | Turn on/off the LED
- `button_pressed`
- Number entities
-Number | Description
------------------------ | -----------------------
-Favorite Level | Set the favorite level
-Volume | Set the volume
+| Number | Description |
+| -------------- | ---------------------- |
+| Favorite Level | Set the favorite level |
+| Volume | Set the volume |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | ----------------------- | -----------------------
-Filter Life Remaining | The remaining life of the filter | True
-Filter Use | Filter usage time in hours | True
-Humidity | The current humidity measured | True
-Illuminance | The current illuminance measured | True
-Motor Speed | The current motor speed measured in rpm | True
-PM2.5 | The current particulate matter 2.5 measured | True
-Purify Volume | The volume of purified air in qubic meter | False
-Second Motor Speed | The current second motor speed measured in rpm | True
-Temperature | The current temperature measured | True
-Use Time | The accumulative number of seconds the device has been in use | False
+| Sensor | Description | Enabled by default |
+| --------------------- | ------------------------------------------------------------- | ------------------ |
+| Filter Life Remaining | The remaining life of the filter | True |
+| Filter Use | Filter usage time in hours | True |
+| Humidity | The current humidity measured | True |
+| Illuminance | The current illuminance measured | True |
+| Motor Speed | The current motor speed measured in rpm | True |
+| PM2.5 | The current particulate matter 2.5 measured | True |
+| Purify Volume | The volume of purified air in qubic meter | False |
+| Second Motor Speed | The current second motor speed measured in rpm | True |
+| Temperature | The current temperature measured | True |
+| Use Time | The accumulative number of seconds the device has been in use | False |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Child Lock | Turn on/off the child lock
-Learn Mode | Turn on/off the learn mode
-LED | Turn on/off the LED
+| Switch | Description |
+| ---------- | -------------------------- |
+| Child Lock | Turn on/off the child lock |
+| Learn Mode | Turn on/off the learn mode |
+| LED | Turn on/off the LED |
### Air Purifier Pro V7 (zhimi.airpurifier.v7)
@@ -345,33 +346,32 @@ LED | Turn on/off the LED
- `button_pressed`
- Number entities
-Number | Description
------------------------ | -----------------------
-Favorite Level | Set the favorite level
-Volume | Set the volume
+| Number | Description |
+| -------------- | ---------------------- |
+| Favorite Level | Set the favorite level |
+| Volume | Set the volume |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | ----------------------- | -----------------------
-Filter Life Remaining | The remaining life of the filter | True
-Filter Use | Filter usage time in hours | True
-Humidity | The current humidity measured | True
-Illuminance | The current illuminance measured | True
-Motor Speed | The current motor speed measured in rpm | True
-PM2.5 | The current particulate matter 2.5 measured | True
-Second Motor Speed | The current second motor speed measured in rpm | True
-Temperature | The current temperature measured | True
-Use Time | The accumulative number of seconds the device has been in use | False
+| Sensor | Description | Enabled by default |
+| --------------------- | ------------------------------------------------------------- | ------------------ |
+| Filter Life Remaining | The remaining life of the filter | True |
+| Filter Use | Filter usage time in hours | True |
+| Humidity | The current humidity measured | True |
+| Illuminance | The current illuminance measured | True |
+| Motor Speed | The current motor speed measured in rpm | True |
+| PM2.5 | The current particulate matter 2.5 measured | True |
+| Second Motor Speed | The current second motor speed measured in rpm | True |
+| Temperature | The current temperature measured | True |
+| Use Time | The accumulative number of seconds the device has been in use | False |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Child Lock | Turn on/off the child lock
-Learn Mode | Turn on/off the learn mode
-LED | Turn on/off the LED
-
+| Switch | Description |
+| ---------- | -------------------------- |
+| Child Lock | Turn on/off the child lock |
+| Learn Mode | Turn on/off the learn mode |
+| LED | Turn on/off the LED |
### Air Purifier MA2 (zhimi.airpurifier.ma2)
@@ -390,32 +390,31 @@ LED | Turn on/off the LED
- `friendly_name`
- `supported_features`
-Number | Description
------------------------ | -----------------------
-Favorite Level | Set the favorite level
+| Number | Description |
+| -------------- | ---------------------- |
+| Favorite Level | Set the favorite level |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | ----------------------- | -----------------------
-Filter Life Remaining | The remaining life of the filter | True
-Filter Use | Filter usage time in hours | True
-Humidity | The current humidity measured | True
-Motor Speed | The current motor speed measured in rpm | True
-PM2.5 | The current particulate matter 2.5 measured | True
-Temperature | The current temperature measured | True
-Illuminance | The current illuminance meassured on top of the device 0-200lux| True
-Use Time | The accumulative number of seconds the device has been in use | False
+| Sensor | Description | Enabled by default |
+| --------------------- | --------------------------------------------------------------- | ------------------ |
+| Filter Life Remaining | The remaining life of the filter | True |
+| Filter Use | Filter usage time in hours | True |
+| Humidity | The current humidity measured | True |
+| Motor Speed | The current motor speed measured in rpm | True |
+| PM2.5 | The current particulate matter 2.5 measured | True |
+| Temperature | The current temperature measured | True |
+| Illuminance | The current illuminance meassured on top of the device 0-200lux | True |
+| Use Time | The accumulative number of seconds the device has been in use | False |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the buzzer
-Child Lock | Turn on/off the child lock
-Learn Mode | Turn on/off the learn mode
-LED | Turn on/off the LED
-
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the buzzer |
+| Child Lock | Turn on/off the child lock |
+| Learn Mode | Turn on/off the learn mode |
+| LED | Turn on/off the LED |
### Air Purifier 2S (zhimi.airpurifier.mc1)
@@ -427,30 +426,30 @@ LED | Turn on/off the LED
- `button_pressed`
- Number entities
-Number | Description
------------------------ | -----------------------
-Favorite Level | Set the favorite level
+| Number | Description |
+| -------------- | ---------------------- |
+| Favorite Level | Set the favorite level |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | ----------------------- | -----------------------
-Filter Life Remaining | The remaining life of the filter | True
-Filter Use | Filter usage time in hours | True
-Humidity | The current humidity measured | True
-Motor Speed | The current motor speed measured in rpm | True
-PM2.5 | The current particulate matter 2.5 measured | True
-Temperature | The current temperature measured | True
-Use Time | The accumulative number of seconds the device has been in use | False
+| Sensor | Description | Enabled by default |
+| --------------------- | ------------------------------------------------------------- | ------------------ |
+| Filter Life Remaining | The remaining life of the filter | True |
+| Filter Use | Filter usage time in hours | True |
+| Humidity | The current humidity measured | True |
+| Motor Speed | The current motor speed measured in rpm | True |
+| PM2.5 | The current particulate matter 2.5 measured | True |
+| Temperature | The current temperature measured | True |
+| Use Time | The accumulative number of seconds the device has been in use | False |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the buzzer
-Child Lock | Turn on/off the child lock
-Learn Mode | Turn on/off the learn mode
-LED | Turn on/off the LED
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the buzzer |
+| Child Lock | Turn on/off the child lock |
+| Learn Mode | Turn on/off the learn mode |
+| LED | Turn on/off the LED |
### Air Purifier 3/3H (2019) (zhimi.airpurifier.ma4/zhimi.airpurifier.mb3)
@@ -462,36 +461,36 @@ This model uses newer MiOT communication protocol.
- `use_time`
- Number entities
-Number | Description
------------------------ | -----------------------
-Fan Level | Set the fan level
-Favorite Level | Set the favorite level
+| Number | Description |
+| -------------- | ---------------------- |
+| Fan Level | Set the fan level |
+| Favorite Level | Set the favorite level |
- Select entities
-Select | Description
------------------------ | -----------------------
-LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
+| Select | Description |
+| -------------- | ------------------------------------------------------ |
+| LED Brightness | Controls the brightness of the LEDs (bright, dim, off) |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | ----------------------- | -----------------------
-Filter Life Remaining | The remaining life of the filter | True
-Filter Use | Filter usage time in hours | True
-Humidity | The current humidity measured | True
-Motor Speed | The current motor speed measured in rpm | True
-PM2.5 | The current particulate matter 2.5 measured | True
-Purify Volume | The volume of purified air in qubic meter | False
-Temperature | The current temperature measured | True
-Use Time | The accumulative number of seconds the device has been in use | False
+| Sensor | Description | Enabled by default |
+| --------------------- | ------------------------------------------------------------- | ------------------ |
+| Filter Life Remaining | The remaining life of the filter | True |
+| Filter Use | Filter usage time in hours | True |
+| Humidity | The current humidity measured | True |
+| Motor Speed | The current motor speed measured in rpm | True |
+| PM2.5 | The current particulate matter 2.5 measured | True |
+| Purify Volume | The volume of purified air in qubic meter | False |
+| Temperature | The current temperature measured | True |
+| Use Time | The accumulative number of seconds the device has been in use | False |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the buzzer
-Child Lock | Turn on/off the child lock
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the buzzer |
+| Child Lock | Turn on/off the child lock |
### Air Purifier 3C (zhimi.airpurifier.mb4)
@@ -499,26 +498,26 @@ Child Lock | Turn on/off the child lock
- Operation modes (Auto, Silent, Favorite)
- Number entities
-Number | Description
------------------------ | -----------------------
-Favorite Motor Speed | Set the favorite motor speed
-LED Brightness | Set the LED brightness
+| Number | Description |
+| -------------------- | ---------------------------- |
+| Favorite Motor Speed | Set the favorite motor speed |
+| LED Brightness | Set the LED brightness |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | ----------------------- | -----------------------
-Filter Life Remaining | The remaining life of the filter | True
-Filter Use | Filter usage time in hours | True
-Motor Speed | The current motor speed measured in rpm | True
-PM2.5 | The current particulate matter 2.5 measured | True
+| Sensor | Description | Enabled by default |
+| --------------------- | ------------------------------------------- | ------------------ |
+| Filter Life Remaining | The remaining life of the filter | True |
+| Filter Use | Filter usage time in hours | True |
+| Motor Speed | The current motor speed measured in rpm | True |
+| PM2.5 | The current particulate matter 2.5 measured | True |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the buzzer
-Child Lock | Turn on/off the child lock
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the buzzer |
+| Child Lock | Turn on/off the child lock |
### Air Purifier ZA1 (zhimi.airpurifier.za1)
@@ -526,34 +525,34 @@ Child Lock | Turn on/off the child lock
- Operation modes (Auto, Silent, Favorite)
- Number entities
-Number | Description
------------------------ | -----------------------
-Favorite Level | Set the favorite level
+| Number | Description |
+| -------------- | ---------------------- |
+| Favorite Level | Set the favorite level |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | ----------------------- | -----------------------
-Filter Life Remaining | The remaining life of the filter | True
-Filter Use | Filter usage time in hours | True
-Motor Speed | The current motor speed measured in rpm | True
-PM2.5 | The current particulate matter 2.5 measured | True
-Humidity | The current humidity measured | True
-Temperature | The current temperature measured | True
-TVOC | The current concentration of Total Organic Volatile Components | True
+| Sensor | Description | Enabled by default |
+| --------------------- | -------------------------------------------------------------- | ------------------ |
+| Filter Life Remaining | The remaining life of the filter | True |
+| Filter Use | Filter usage time in hours | True |
+| Motor Speed | The current motor speed measured in rpm | True |
+| PM2.5 | The current particulate matter 2.5 measured | True |
+| Humidity | The current humidity measured | True |
+| Temperature | The current temperature measured | True |
+| TVOC | The current concentration of Total Organic Volatile Components | True |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the buzzer
-Child Lock | Turn on/off the child lock
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the buzzer |
+| Child Lock | Turn on/off the child lock |
- Select entities
-Select | Description
------------------------ | -----------------------
-LED Brightness | Controls the brightness of the Display (bright, dim, off)
+| Select | Description |
+| -------------- | --------------------------------------------------------- |
+| LED Brightness | Controls the brightness of the Display (bright, dim, off) |
### Air Purifier V3 (zhimi.airpurifier.v3)
@@ -567,24 +566,24 @@ LED Brightness | Controls the brightness of the Display (bright, dim, o
- `button_pressed`
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | ----------------------- | -----------------------
-PM2.5 | The current particulate matter 2.5 measured | True
-Illuminance | The current illuminance measured | True
-Filter Life Remaining | The remaining life of the filter | True
-Filter Use | Filter usage time in hours | True
-Motor Speed | The current motor speed measured in rpm | True
-Second Motor Speed | The current second motor speed measured in rpm | True
-Purify Volume | The volume of purified air in qubic meter | False
-Use Time | The accumulative number of seconds the device has been in use | False
+| Sensor | Description | Enabled by default |
+| --------------------- | ------------------------------------------------------------- | ------------------ |
+| PM2.5 | The current particulate matter 2.5 measured | True |
+| Illuminance | The current illuminance measured | True |
+| Filter Life Remaining | The remaining life of the filter | True |
+| Filter Use | Filter usage time in hours | True |
+| Motor Speed | The current motor speed measured in rpm | True |
+| Second Motor Speed | The current second motor speed measured in rpm | True |
+| Purify Volume | The volume of purified air in qubic meter | False |
+| Use Time | The accumulative number of seconds the device has been in use | False |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the buzzer
-Child Lock | Turn on/off the child lock
-LED | Turn on/off the LED
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the buzzer |
+| Child Lock | Turn on/off the child lock |
+| LED | Turn on/off the LED |
### Air Purifier 4/4 PRO (zhimi.airp.mb5/zhimi.airp.vb4)
@@ -595,39 +594,38 @@ These models use newer MiOT communication protocol.
- Attributes (fan platform)
- Number entities
-Number | Description
------------------------ | -----------------------
-Fan Level | Set the fan level
-Favorite Level | Set the favorite level
+| Number | Description |
+| -------------- | ---------------------- |
+| Fan Level | Set the fan level |
+| Favorite Level | Set the favorite level |
- Select entities
-Select | Description
------------------------ | -----------------------
-LED Brightness | Controls the brightness of the Display (bright, dim, off)
+| Select | Description |
+| -------------- | --------------------------------------------------------- |
+| LED Brightness | Controls the brightness of the Display (bright, dim, off) |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | ----------------------- | -----------------------
-Filter Life Remaining | The remaining life of the filter in % | True
-Filter Time Left | The remaining life of the filter in days | True
-Filter Use | Filter usage time in hours | True
-Humidity | The current humidity measured | True
-Motor Speed | The current motor speed measured in rpm | True
-PM2.5 | The current particulate matter 2.5 measured | True
-PM10 | The current particulate matter 10 measured(4 PRO only) | True
-Purify Volume | The volume of purified air in qubic meter | False
-Temperature | The current temperature measured | True
+| Sensor | Description | Enabled by default |
+| --------------------- | ------------------------------------------------------ | ------------------ |
+| Filter Life Remaining | The remaining life of the filter in % | True |
+| Filter Time Left | The remaining life of the filter in days | True |
+| Filter Use | Filter usage time in hours | True |
+| Humidity | The current humidity measured | True |
+| Motor Speed | The current motor speed measured in rpm | True |
+| PM2.5 | The current particulate matter 2.5 measured | True |
+| PM10 | The current particulate matter 10 measured(4 PRO only) | True |
+| Purify Volume | The volume of purified air in qubic meter | False |
+| Temperature | The current temperature measured | True |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the buzzer
-Child Lock | Turn on/off the child lock
-Ionizer | Turn on/off the negative ion generator
-
+| Switch | Description |
+| ---------- | -------------------------------------- |
+| Buzzer | Turn on/off the buzzer |
+| Child Lock | Turn on/off the child lock |
+| Ionizer | Turn on/off the negative ion generator |
### Air Fresh A1 (dmaker.airfresh.a1)
@@ -635,36 +633,36 @@ Ionizer | Turn on/off the negative ion generator
- Operation modes (Auto, Sleep, Favorite)
- Binary sensor entities
-Binary sensor | Description
------------------------ | -----------------
-Auxiliary Heat Status | Indicates if the heater is actually on
+| Binary sensor | Description |
+| --------------------- | -------------------------------------- |
+| Auxiliary Heat Status | Indicates if the heater is actually on |
- Button entities
-Button | Description
------------------------ | ------------------------------------------
-Reset Dust Filter | Resets filter lifetime and usage of the dust filter
+| Button | Description |
+| ----------------- | --------------------------------------------------- |
+| Reset Dust Filter | Resets filter lifetime and usage of the dust filter |
- Sensor entities
-Sensor | Description
-------------------------------- | --------------------------------------------------------------
-Carbon Dioxide | The current carbon dioxide in ppm
-Dust filter life remaining | The remaining life of the filter
-Dust filter life remaining days | The remaining life of the filter in day
-PM2.5 | The current particulate matter 2.5
-Temperature | The current outside temperature
-Control Speed | The current motor speed in rpm
-Favorite Speed | The favorite motor speed in rpm
+| Sensor | Description |
+| ------------------------------- | --------------------------------------- |
+| Carbon Dioxide | The current carbon dioxide in ppm |
+| Dust filter life remaining | The remaining life of the filter |
+| Dust filter life remaining days | The remaining life of the filter in day |
+| PM2.5 | The current particulate matter 2.5 |
+| Temperature | The current outside temperature |
+| Control Speed | The current motor speed in rpm |
+| Favorite Speed | The favorite motor speed in rpm |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off `buzzer`
-Child Lock | Turn on/off `child lock`
-Display | Turn on/off `display`
-Auxiliary Heat | Turn on/off `heater`
+| Switch | Description |
+| -------------- | ------------------------ |
+| Buzzer | Turn on/off `buzzer` |
+| Child Lock | Turn on/off `child lock` |
+| Display | Turn on/off `display` |
+| Auxiliary Heat | Turn on/off `heater` |
### Air Fresh VA2
@@ -675,30 +673,29 @@ Auxiliary Heat | Turn on/off `heater`
- `extra_features`
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | ----------------------- | -----------------------
-Carbon Dioxide | The current carbon dioxide measured in ppm | True
-Filter Life Remaining | The remaining life of the filter | True
-Filter Use | Filter usage time in hours | True
-Humidity | The current humidity measured | True
-PM2.5 | The current particulate matter 2.5 measured | True
-Temperature | The current temperature measured | True
-Use Time | The accumulative number of seconds the device has been in use | False
+| Sensor | Description | Enabled by default |
+| --------------------- | ------------------------------------------------------------- | ------------------ |
+| Carbon Dioxide | The current carbon dioxide measured in ppm | True |
+| Filter Life Remaining | The remaining life of the filter | True |
+| Filter Use | Filter usage time in hours | True |
+| Humidity | The current humidity measured | True |
+| PM2.5 | The current particulate matter 2.5 measured | True |
+| Temperature | The current temperature measured | True |
+| Use Time | The accumulative number of seconds the device has been in use | False |
- Select entities
-Select | Description
------------------------ | -----------------------
-LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
+| Select | Description |
+| -------------- | ------------------------------------------------------ |
+| LED Brightness | Controls the brightness of the LEDs (bright, dim, off) |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off `buzzer`
-Child Lock | Turn on/off `child lock`
-LED | Turn on/off `led`
-
+| Switch | Description |
+| ---------- | ------------------------ |
+| Buzzer | Turn on/off `buzzer` |
+| Child Lock | Turn on/off `child lock` |
+| LED | Turn on/off `led` |
### Air Fresh VA4
@@ -709,31 +706,30 @@ LED | Turn on/off `led`
- `extra_features`
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | ----------------------- | -----------------------
-Carbon Dioxide | The current carbon dioxide measured in ppm | True
-Filter Life Remaining | The remaining life of the filter | True
-Filter Use | Filter usage time in hours | True
-Humidity | The current humidity measured | True
-PM2.5 | The current particulate matter 2.5 measured | True
-Temperature | The current temperature measured | True
-Use Time | The accumulative number of seconds the device has been in use | False
+| Sensor | Description | Enabled by default |
+| --------------------- | ------------------------------------------------------------- | ------------------ |
+| Carbon Dioxide | The current carbon dioxide measured in ppm | True |
+| Filter Life Remaining | The remaining life of the filter | True |
+| Filter Use | Filter usage time in hours | True |
+| Humidity | The current humidity measured | True |
+| PM2.5 | The current particulate matter 2.5 measured | True |
+| Temperature | The current temperature measured | True |
+| Use Time | The accumulative number of seconds the device has been in use | False |
- Select entities
-Select | Description
------------------------ | -----------------------
-LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
+| Select | Description |
+| -------------- | ------------------------------------------------------ |
+| LED Brightness | Controls the brightness of the LEDs (bright, dim, off) |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off `buzzer`
-Child Lock | Turn on/off `child lock`
-LED | Turn on/off `led`
-Auxiliary Heat | Turn on/off `heater`
-
+| Switch | Description |
+| -------------- | ------------------------ |
+| Buzzer | Turn on/off `buzzer` |
+| Child Lock | Turn on/off `child lock` |
+| LED | Turn on/off `led` |
+| Auxiliary Heat | Turn on/off `heater` |
### Air Fresh T2017 (dmaker.airfresh.t2017)
@@ -741,47 +737,46 @@ Auxiliary Heat | Turn on/off `heater`
- Operation modes (Auto, Sleep, Favorite)
- Binary sensor entities
-Binary sensor | Description
------------------------ | -----------------
-Auxiliary Heat Status | Indicates if the heater is actually on
+| Binary sensor | Description |
+| --------------------- | -------------------------------------- |
+| Auxiliary Heat Status | Indicates if the heater is actually on |
- Button entities
-Button | Description
------------------------ | ------------------------------------------
-Reset Dust Filter | Resets filter lifetime and usage of the dust filter
-Reset Upper Filter | Resets filter lifetime and usage of the upper filter
+| Button | Description |
+| ------------------ | ---------------------------------------------------- |
+| Reset Dust Filter | Resets filter lifetime and usage of the dust filter |
+| Reset Upper Filter | Resets filter lifetime and usage of the upper filter |
- Select entities
-Select | Description
------------------------ | -----------------------
-Auxiliary Heat Level | Controls the level of the heater (Low, Medium, High)
-Display Orientation | Controls the orientation of the display (Forward, Left, Right)
+| Select | Description |
+| -------------------- | -------------------------------------------------------------- |
+| Auxiliary Heat Level | Controls the level of the heater (Low, Medium, High) |
+| Display Orientation | Controls the orientation of the display (Forward, Left, Right) |
- Sensor entities
-Sensor | Description
--------------------------------- | --------------------------------------------------------------
-Carbon Dioxide | The current carbon dioxide in ppm
-Dust filter life remaining | The remaining life of the dust filter
-Dust filter life remaining days | The remaining life of the dust filter in days
-Upper filter life remaining | The remaining life of the upper filter
-Upper filter life remaining days | The remaining life of the upper filter in days
-PM2.5 | The current particulate matter 2.5
-Temperature | The current outside temperature
-Control Speed | The current motor speed in rpm
-Favorite Speed | The favorite motor speed in rpm
+| Sensor | Description |
+| -------------------------------- | ---------------------------------------------- |
+| Carbon Dioxide | The current carbon dioxide in ppm |
+| Dust filter life remaining | The remaining life of the dust filter |
+| Dust filter life remaining days | The remaining life of the dust filter in days |
+| Upper filter life remaining | The remaining life of the upper filter |
+| Upper filter life remaining days | The remaining life of the upper filter in days |
+| PM2.5 | The current particulate matter 2.5 |
+| Temperature | The current outside temperature |
+| Control Speed | The current motor speed in rpm |
+| Favorite Speed | The favorite motor speed in rpm |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off `buzzer`
-Child Lock | Turn on/off `child lock`
-Display | Turn on/off `display`
-Auxiliary Heat | Turn on/off `heater`
-
+| Switch | Description |
+| -------------- | ------------------------ |
+| Buzzer | Turn on/off `buzzer` |
+| Child Lock | Turn on/off `child lock` |
+| Display | Turn on/off `display` |
+| Auxiliary Heat | Turn on/off `heater` |
### Air Humidifier (zhimi.humidifier.v1)
@@ -790,41 +785,41 @@ Auxiliary Heat | Turn on/off `heater`
- Target humidity (30, 40, 50, 60, 70, 80)
- Attributes (humidifier platform)
-Attribute | Description
------------------------ | -----------------------
-`available_modes` | A list with the operation modes available
-`humidity` | The current target humidity
-`max_humidity` | The maximum settable target humidity
-`min_humidity` | The minimum settable target humidity
-`mode` | The current operation mode selected
+| Attribute | Description |
+| ----------------- | ----------------------------------------- |
+| `available_modes` | A list with the operation modes available |
+| `humidity` | The current target humidity |
+| `max_humidity` | The maximum settable target humidity |
+| `min_humidity` | The minimum settable target humidity |
+| `mode` | The current operation mode selected |
- Binary sensor entities
-Binary sensor | Description
------------------------ | -----------------------
-Water Tank | Indicates whether the water tank is connected or not
+| Binary sensor | Description |
+| ------------- | ---------------------------------------------------- |
+| Water Tank | Indicates whether the water tank is connected or not |
- Select entities
-Select | Description
------------------------ | -----------------------
-LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
+| Select | Description |
+| -------------- | ------------------------------------------------------ |
+| LED Brightness | Controls the brightness of the LEDs (bright, dim, off) |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | -------------------------------------------------------------- | ------------------
-Humidity | The current humidity measured | True
-Temperature | The current temperature measured | True
-Use Time | The accumulative number of seconds the device has been in use | False
-Water Level | The current water level percentage measured | True
+| Sensor | Description | Enabled by default |
+| ----------- | ------------------------------------------------------------- | ------------------ |
+| Humidity | The current humidity measured | True |
+| Temperature | The current temperature measured | True |
+| Use Time | The accumulative number of seconds the device has been in use | False |
+| Water Level | The current water level percentage measured | True |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the buzzer
-Child Lock | Turn on/off the child lock
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the buzzer |
+| Child Lock | Turn on/off the child lock |
### Air Humidifier CA (zhimi.humidifier.ca1)
@@ -833,42 +828,42 @@ Child Lock | Turn on/off the child lock
- Target humidity (30, 40, 50, 60, 70, 80)
- Attributes (humidifier platform)
-Attribute | Description
------------------------ | -----------------------
-`available_modes` | A list with the operation modes available
-`humidity` | The current target humidity
-`max_humidity` | The maximum settable target humidity
-`min_humidity` | The minimum settable target humidity
-`mode` | The current operation mode selected
+| Attribute | Description |
+| ----------------- | ----------------------------------------- |
+| `available_modes` | A list with the operation modes available |
+| `humidity` | The current target humidity |
+| `max_humidity` | The maximum settable target humidity |
+| `min_humidity` | The minimum settable target humidity |
+| `mode` | The current operation mode selected |
- Binary sensor entities
-Binary sensor | Description
------------------------ | -----------------------
-Water Tank | Indicates whether the water tank is connected or not
+| Binary sensor | Description |
+| ------------- | ---------------------------------------------------- |
+| Water Tank | Indicates whether the water tank is connected or not |
- Select entities
-Select | Description
------------------------ | ---
-LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
+| Select | Description |
+| -------------- | ------------------------------------------------------ |
+| LED Brightness | Controls the brightness of the LEDs (bright, dim, off) |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | -------------------------------------------------------------- | ------------------
-Humidity | The current humidity measured | True
-Temperature | The current temperature measured | True
-Use Time | The accumulative number of seconds the device has been in use | False
-Water Level | The current water level percentage measured | True
+| Sensor | Description | Enabled by default |
+| ----------- | ------------------------------------------------------------- | ------------------ |
+| Humidity | The current humidity measured | True |
+| Temperature | The current temperature measured | True |
+| Use Time | The accumulative number of seconds the device has been in use | False |
+| Water Level | The current water level percentage measured | True |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the buzzer
-Child Lock | Turn on/off the child lock
-Dry Mode | Turn on/off the dry mode
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the buzzer |
+| Child Lock | Turn on/off the child lock |
+| Dry Mode | Turn on/off the dry mode |
### Air Humidifier CA (zhimi.humidifier.ca4)
@@ -877,50 +872,50 @@ Dry Mode | Turn on/off the dry mode
- Target humidity (30 - 80)
- Attributes (humidifier platform)
-Attribute | Description
------------------------ | -----------------------
-`available_modes` | A list with the operation modes available
-`humidity` | The current target humidity
-`max_humidity` | The maximum settable target humidity
-`min_humidity` | The minimum settable target humidity
-`mode` | The current operation mode selected
+| Attribute | Description |
+| ----------------- | ----------------------------------------- |
+| `available_modes` | A list with the operation modes available |
+| `humidity` | The current target humidity |
+| `max_humidity` | The maximum settable target humidity |
+| `min_humidity` | The minimum settable target humidity |
+| `mode` | The current operation mode selected |
- Binary sensor entities
-Binary sensor | Description
------------------------ | -----------------------
-Water Tank | Indicates whether the water tank is connected or not
+| Binary sensor | Description |
+| ------------- | ---------------------------------------------------- |
+| Water Tank | Indicates whether the water tank is connected or not |
- Number entities
-Number | Description
------------------------ | -----------------------
-Motor Speed | Set the motor speed
+| Number | Description |
+| ----------- | ------------------- |
+| Motor Speed | Set the motor speed |
- Select entities
-Select | Description
------------------------ | -----------------------
-LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
+| Select | Description |
+| -------------- | ------------------------------------------------------ |
+| LED Brightness | Controls the brightness of the LEDs (bright, dim, off) |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | -------------------------------------------------------------- | ------------------
-Actual Speed | The current motor speed measured in rpm | True
-Humidity | The current humidity measured | True
-Temperature | The current temperature measured | True
-Use Time | The accumulative number of seconds the device has been in use | False
-Water Level | The current water level percentage measured | True
+| Sensor | Description | Enabled by default |
+| ------------ | ------------------------------------------------------------- | ------------------ |
+| Actual Speed | The current motor speed measured in rpm | True |
+| Humidity | The current humidity measured | True |
+| Temperature | The current temperature measured | True |
+| Use Time | The accumulative number of seconds the device has been in use | False |
+| Water Level | The current water level percentage measured | True |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the buzzer
-Child Lock | Turn on/off the child lock
-Clean Mode | Turn on/off the clean mode
-Dry Mode | Turn on/off the dry mode
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the buzzer |
+| Child Lock | Turn on/off the child lock |
+| Clean Mode | Turn on/off the clean mode |
+| Dry Mode | Turn on/off the dry mode |
Clean mode and Motor speed can only be set when the device is turned on.
@@ -933,42 +928,42 @@ Clean mode and Motor speed can only be set when the device is turned on.
- Target humidity (30, 40, 50, 60, 70, 80)
- Attributes (humidifier platform)
-Attribute | Description
------------------------ | -----------------------
-`available_modes` | A list with the operation modes available
-`humidity` | The current target humidity
-`max_humidity` | The maximum settable target humidity
-`min_humidity` | The minimum settable target humidity
-`mode` | The current operation mode selected
+| Attribute | Description |
+| ----------------- | ----------------------------------------- |
+| `available_modes` | A list with the operation modes available |
+| `humidity` | The current target humidity |
+| `max_humidity` | The maximum settable target humidity |
+| `min_humidity` | The minimum settable target humidity |
+| `mode` | The current operation mode selected |
- Binary sensor entities
-Binary sensor | Description
------------------------ | -----------------------
-Water Tank | Indicates whether the water tank is connected or not
+| Binary sensor | Description |
+| ------------- | ---------------------------------------------------- |
+| Water Tank | Indicates whether the water tank is connected or not |
- Select entities
-Select | Description
------------------------ | -----------------------
-LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
+| Select | Description |
+| -------------- | ------------------------------------------------------ |
+| LED Brightness | Controls the brightness of the LEDs (bright, dim, off) |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | -------------------------------------------------------------- | ------------------
-Humidity | The current humidity measured | True
-Temperature | The current temperature measured | True
-Use Time | The accumulative number of seconds the device has been in use | False
-Water Level | The current water level percentage measured | True
+| Sensor | Description | Enabled by default |
+| ----------- | ------------------------------------------------------------- | ------------------ |
+| Humidity | The current humidity measured | True |
+| Temperature | The current temperature measured | True |
+| Use Time | The accumulative number of seconds the device has been in use | False |
+| Water Level | The current water level percentage measured | True |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the buzzer
-Child Lock | Turn on/off the child lock
-Dry Mode | Turn on/off the dry mode
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the buzzer |
+| Child Lock | Turn on/off the child lock |
+| Dry Mode | Turn on/off the dry mode |
### Air Humidifier JSQ/JSQ1/MJJSQ (deerma.humidifier.jsq/deerma.humidifier.jsq1/deerma.humidifier.mjjsq)
@@ -977,35 +972,35 @@ Dry Mode | Turn on/off the dry mode
- Target humidity (30, 40, 50, 60, 70, 80)
- Attributes (humidifier platform)
-Attribute | Description
------------------------ | -----------------------
-`available_modes` | A list with the operation modes available
-`humidity` | The current target humidity
-`max_humidity` | The maximum settable target humidity
-`min_humidity` | The minimum settable target humidity
-`mode` | The current operation mode selected
+| Attribute | Description |
+| ----------------- | ----------------------------------------- |
+| `available_modes` | A list with the operation modes available |
+| `humidity` | The current target humidity |
+| `max_humidity` | The maximum settable target humidity |
+| `min_humidity` | The minimum settable target humidity |
+| `mode` | The current operation mode selected |
- Binary sensor entities
-Binary sensor | Description
------------------------ | -----------------------
-Water Tank | Indicates whether the water tank is connected or not
-Water Tank Empty | Indicates whether the water tank is empty or not
+| Binary sensor | Description |
+| ---------------- | ---------------------------------------------------- |
+| Water Tank | Indicates whether the water tank is connected or not |
+| Water Tank Empty | Indicates whether the water tank is empty or not |
- Sensor entities
-Sensor | Description | Enabled by default
------------------------ | -------------------------------------------------------------- | ------------------
-Humidity | The current humidity measured | True
-Temperature | The current temperature measured | True
-Use Time | The accumulative number of seconds the device has been in use | False
+| Sensor | Description | Enabled by default |
+| ----------- | ------------------------------------------------------------- | ------------------ |
+| Humidity | The current humidity measured | True |
+| Temperature | The current temperature measured | True |
+| Use Time | The accumulative number of seconds the device has been in use | False |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the buzzer
-LED | Turn on/off the LED
+| Switch | Description |
+| ------ | ---------------------- |
+| Buzzer | Turn on/off the buzzer |
+| LED | Turn on/off the LED |
### Standing Fan 1X (dmaker.fan.p5)
@@ -1014,18 +1009,18 @@ LED | Turn on/off the LED
- Oscillation (on, off)
- Number entities
-Number | Description
------------------------ | -----------------------
-Delay Off Countdown | Set the delay off countdown in minutes
-Oscillation Angle | Set the oscillation angle in degrees
+| Number | Description |
+| ------------------- | -------------------------------------- |
+| Delay Off Countdown | Set the delay off countdown in minutes |
+| Oscillation Angle | Set the oscillation angle in degrees |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off `buzzer`
-Child Lock | Turn on/off `child lock`
-LED | Turn on/off `led`
+| Switch | Description |
+| ---------- | ------------------------ |
+| Buzzer | Turn on/off `buzzer` |
+| Child Lock | Turn on/off `child lock` |
+| LED | Turn on/off `led` |
### Standing Fan (zhimi.fan.za1, zhimi.fan.za3, zhimi.fan.za4, zhimi.fan.sa1)
@@ -1034,23 +1029,23 @@ LED | Turn on/off `led`
- Oscillation (on, off)
- Number entities
-Number | Description
------------------------ | -----------------------
-Delay Off Countdown | Set the delay off countdown in minutes
-Oscillation Angle | Set the oscillation angle in degrees
+| Number | Description |
+| ------------------- | -------------------------------------- |
+| Delay Off Countdown | Set the delay off countdown in minutes |
+| Oscillation Angle | Set the oscillation angle in degrees |
- Select entities
-Select | Description
------------------------ | -----------------------
-LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
+| Select | Description |
+| -------------- | ------------------------------------------------------ |
+| LED Brightness | Controls the brightness of the LEDs (bright, dim, off) |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off `buzzer`
-Child Lock | Turn on/off `child lock`
+| Switch | Description |
+| ---------- | ------------------------ |
+| Buzzer | Turn on/off `buzzer` |
+| Child Lock | Turn on/off `child lock` |
### DC Pedestal Fan (zhimi.fan.v2, zhimi.fan.v3)
@@ -1059,31 +1054,31 @@ Child Lock | Turn on/off `child lock`
- Oscillation (on, off)
- Number entities
-Number | Description
------------------------ | -----------------------
-Delay Off Countdown | Set the delay off countdown in minutes
-Oscillation Angle | Set the oscillation angle in degrees
+| Number | Description |
+| ------------------- | -------------------------------------- |
+| Delay Off Countdown | Set the delay off countdown in minutes |
+| Oscillation Angle | Set the oscillation angle in degrees |
- Select entities
-Select | Description
------------------------ | -----------------------
-LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
+| Select | Description |
+| -------------- | ------------------------------------------------------ |
+| LED Brightness | Controls the brightness of the LEDs (bright, dim, off) |
- Sensor entities
-Sensor | Description
------------------------ | -----------------------
-Battery | The current battery level in percentage
-Humidity | The current humidity measured
-Temperature | The current temperature measured
+| Sensor | Description |
+| ----------- | --------------------------------------- |
+| Battery | The current battery level in percentage |
+| Humidity | The current humidity measured |
+| Temperature | The current temperature measured |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off `buzzer`
-Child Lock | Turn on/off `child lock`
+| Switch | Description |
+| ---------- | ------------------------ |
+| Buzzer | Turn on/off `buzzer` |
+| Child Lock | Turn on/off `child lock` |
### Standing Fan 1C (dmaker.fan.1c)
@@ -1092,17 +1087,17 @@ Child Lock | Turn on/off `child lock`
- Oscillation (on, off)
- Number entities
-Number | Description
------------------------ | -----------------------
-Delay Off Countdown | Set the delay off countdown in minutes
+| Number | Description |
+| ------------------- | -------------------------------------- |
+| Delay Off Countdown | Set the delay off countdown in minutes |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the Buzzer
-Child Lock | Turn on/off the Child Lock
-LED | Turn on/off the LED
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the Buzzer |
+| Child Lock | Turn on/off the Child Lock |
+| LED | Turn on/off the LED |
### Tower Fan/Standing Fan 2/Standing Fan Pro (dmaker.fan.p9/dmaker.fan.p10/dmaker.fan.p11)
@@ -1111,18 +1106,18 @@ LED | Turn on/off the LED
- Oscillation (on, off)
- Number entities
-Number | Description
------------------------ | -----------------------
-Delay Off Countdown | Set the delay off countdown in minutes
-Oscillation Angle | Set the oscillation angle in degrees
+| Number | Description |
+| ------------------- | -------------------------------------- |
+| Delay Off Countdown | Set the delay off countdown in minutes |
+| Oscillation Angle | Set the oscillation angle in degrees |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the Buzzer
-Child Lock | Turn on/off the Child Lock
-LED | Turn on/off the LED
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the Buzzer |
+| Child Lock | Turn on/off the Child Lock |
+| LED | Turn on/off the LED |
### Standing Fan 3 (zhimi.fan.za5)
@@ -1131,32 +1126,32 @@ LED | Turn on/off the LED
- Oscillation (on, off)
- Binary sensor entities
-Binary sensor | Description
------------------------ | -----------------------
-Power Supply | Indicates whether the power supply is connected or not
+| Binary sensor | Description |
+| ------------- | ------------------------------------------------------ |
+| Power Supply | Indicates whether the power supply is connected or not |
- Number entities
-Number | Description
------------------------ | -----------------------
-Delay Off Countdown | Set the delay off countdown in minutes
-LED Brightness | Set the LED brightness
-Oscillation Angle | Set the oscillation angle in degrees
+| Number | Description |
+| ------------------- | -------------------------------------- |
+| Delay Off Countdown | Set the delay off countdown in minutes |
+| LED Brightness | Set the LED brightness |
+| Oscillation Angle | Set the oscillation angle in degrees |
- Sensor entities
-Sensor | Description
------------------------ | -----------------------
-Humidity | The current humidity measured
-Temperature | The current temperature measured
+| Sensor | Description |
+| ----------- | -------------------------------- |
+| Humidity | The current humidity measured |
+| Temperature | The current temperature measured |
- Switch entities
-Switch | Description
------------------------ | -----------------------
-Buzzer | Turn on/off the Buzzer
-Child Lock | Turn on/off the Child Lock
-Ionizer | Turn on/off the Ionizer
+| Switch | Description |
+| ---------- | -------------------------- |
+| Buzzer | Turn on/off the Buzzer |
+| Child Lock | Turn on/off the Child Lock |
+| Ionizer | Turn on/off the Ionizer |
### Platform Services
@@ -1164,54 +1159,54 @@ Ionizer | Turn on/off the Ionizer
Set the target humidity.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|---------------------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO humidifier entity. |
-| `humidity` | no | Target humidity |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------- |
+| `entity_id` | no | Only act on a specific Xiaomi miIO humidifier entity. |
+| `humidity` | no | Target humidity |
### Service `humidifier.set_mode`
Set the humidifier operation mode.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|---------------------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO humidifier entity. |
-| `mode` | no | The Xiaomi miIO operation mode |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------- |
+| `entity_id` | no | Only act on a specific Xiaomi miIO humidifier entity. |
+| `mode` | no | The Xiaomi miIO operation mode |
### Service `fan.set_percentage`
Set the fan speed percentage.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|---------------------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
-| `percentage` | no | Fan speed. Percentage speed setting |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------- |
+| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
+| `percentage` | no | Fan speed. Percentage speed setting |
### Service `fan.set_preset_mode`
Set the fan operation mode.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|---------------------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
-| `preset_mode` | no | The Xiaomi miIO operation mode |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------- |
+| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
+| `preset_mode` | no | The Xiaomi miIO operation mode |
### Service `xiaomi_miio.fan_reset_filter` (Air Purifier 2 only)
Reset the filter lifetime and usage.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|---------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------- |
+| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
### Service `xiaomi_miio.fan_set_extra_features` (Air Purifier only)
Set the extra features.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|---------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
-| `features` | no | Integer, known values are 0 and 1. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------- |
+| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
+| `features` | no | Integer, known values are 0 and 1. |
## Xiaomi Air Quality Monitor
@@ -1252,36 +1247,36 @@ remote:
{% configuration %}
host:
- description: The IP of your remote.
- required: true
- type: string
+description: The IP of your remote.
+required: true
+type: string
token:
- description: The API token of your remote.
- required: true
- type: string
+description: The API token of your remote.
+required: true
+type: string
name:
- description: The name of your remote.
- required: false
- type: string
+description: The name of your remote.
+required: false
+type: string
slot:
- description: The slot used to save learned command.
- required: false
- type: integer
- default: 1
+description: The slot used to save learned command.
+required: false
+type: integer
+default: 1
timeout:
- description: Timeout for learning a new command.
- required: false
- type: integer
- default: 30
+description: Timeout for learning a new command.
+required: false
+type: integer
+default: 30
commands:
- description: A list of commands
- required: false
- type: map
- keys:
- command:
- description: A list of commands as [raw (learned command)](/integrations/xiaomi_miio/#raw) or [pronto hex code](/integrations/xiaomi_miio/#pronto-hex-code).
- required: true
- type: list
+description: A list of commands
+required: false
+type: map
+keys:
+command:
+description: A list of commands as [raw (learned command)](/integrations/xiaomi_miio/#raw) or [pronto hex code](/integrations/xiaomi_miio/#pronto-hex-code).
+required: true
+type: list
{% endconfiguration %}
### Full Configuration
@@ -1319,7 +1314,7 @@ hold_action:
show_icon: true
show_name: true
entity: remote.xiaomi_miio_ir
-icon: 'mdi:radiator'
+icon: "mdi:radiator"
name: Activate Towel Heater
```
@@ -1334,7 +1329,7 @@ script:
entity_id: "remote.bathroom_remote"
data:
command:
- - 'activate_towel_heater'
+ - "activate_towel_heater"
please_cover_your_ears:
sequence:
- service: remote.send_command
@@ -1342,7 +1337,7 @@ script:
entity_id: "remote.bathroom_remote"
data:
command:
- - 'read_bad_poem'
+ - "read_bad_poem"
```
### Command Types
@@ -1430,68 +1425,32 @@ Currently supported services are:
- `clean_spot`
- `set_fan_speed`
Fan speeds: `Silent`, `Standard`, `Medium`, `Turbo` and `Gentle` (exclusively for mopping).
-- `remote_control_*` (of your robot)
- `xiaomi_clean_zone`
- `xiaomi_clean_segment`
+- `xiaomi_goto`
+- `remote_control_*` (of your robot)
### Platform Services
In addition to all of the services provided by the `vacuum` integration (`start`, `pause`, `stop`, `return_to_base`, `locate`, `set_fan_speed` and `send_command`), the `xiaomi_miio` platform introduces specific services to access the remote control mode of the robot. These are:
+- `xiaomi_miio.vacuum_clean_zone`
+- `xiaomi_miio.vacuum_clean_segment`
+- `xiaomi_miio.vacuum_goto`
- `xiaomi_miio.vacuum_remote_control_start`
- `xiaomi_miio.vacuum_remote_control_stop`
- `xiaomi_miio.vacuum_remote_control_move`
- `xiaomi_miio.vacuum_remote_control_move_step`
-- `xiaomi_miio.vacuum_clean_zone`
-- `xiaomi_miio.vacuum_clean_segment`
-
-### Service `xiaomi_miio.vacuum_remote_control_start`
-
-Start the remote control mode of the robot. You can then move it with `remote_control_move`; when done, call `remote_control_stop`.
-
-| Service data attribute | Optional | Description |
-|---------------------------|----------|---------------------------------------------------|
-| `entity_id` | no | Only act on a specific robot |
-
-### Service `xiaomi_miio.vacuum_remote_control_stop`
-
-Exit the remote control mode of the robot.
-
-| Service data attribute | Optional | Description |
-|---------------------------|----------|---------------------------------------------------|
-| `entity_id` | no | Only act on a specific robot |
-
-### Service `xiaomi_miio.vacuum_remote_control_move`
-
-Remote control the robot. Please ensure you first set it in remote control mode with `remote_control_start`.
-
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-----------------------------------------------------------|
-| `entity_id` | no | Only act on a specific robot |
-| `velocity` | no | Speed: between -0.29 and 0.29 |
-| `rotation` | no | Rotation: between -179 degrees and 179 degrees |
-| `duration` | no | The number of milliseconds that the robot should move for |
-
-### Service `xiaomi_miio.vacuum_remote_control_move_step`
-
-Enter remote control mode, make one move, stop, and exit remote control mode.
-
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-----------------------------------------------------------|
-| `entity_id` | no | Only act on a specific robot |
-| `velocity` | no | Speed: between -0.29 and 0.29 |
-| `rotation` | no | Rotation: between -179 degrees and 179 degrees |
-| `duration` | no | The number of milliseconds that the robot should move for |
### Service `xiaomi_miio.vacuum_clean_zone`
Start the cleaning operation in the areas selected for the number of repeats indicated.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | Only act on a specific robot |
-| `zone` | no | List of zones. Each zone is an array of four integer values. These values represent two sets of x- and y-axis coordinates that describe the beginning and ending points of a square or rectangle cleaning zone. For example, `[[23510,25311,25110,26361]]` creates a box that starts in one corner at the 23510, 25311 (x- and y-axis) coordinates and then is expanded diagonally to the 25110, 26361 coordinates to create a rectangular cleaning zone. |
-| `repeats` | no | Number of cleaning repeats for each zone between 1 and 3. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | no | Only act on a specific robot |
+| `zone` | no | List of zones. Each zone is an array of four integer values. These values represent two sets of x- and y-axis coordinates that describe the beginning and ending points of a square or rectangle cleaning zone. For example, `[[23510,25311,25110,26361]]` creates a box that starts in one corner at the 23510, 25311 (x- and y-axis) coordinates and then is expanded diagonally to the 25110, 26361 coordinates to create a rectangular cleaning zone. |
+| `repeats` | no | Number of cleaning repeats for each zone between 1 and 3. |
Example of `xiaomi_miio.vacuum_clean_zone` use:
@@ -1502,16 +1461,16 @@ Inline array:
automation:
- alias: "Test vacuum zone3"
trigger:
- - event: start
- platform: homeassistant
+ - event: start
+ platform: homeassistant
condition: []
action:
- - service: xiaomi_miio.vacuum_clean_zone
- target:
- entity_id: vacuum.xiaomi_vacuum
- data:
- repeats: "{{states('input_number.vacuum_passes')|int}}"
- zone: [[30914,26007,35514,28807], [20232,22496,26032,26496]]
+ - service: xiaomi_miio.vacuum_clean_zone
+ target:
+ entity_id: vacuum.xiaomi_vacuum
+ data:
+ repeats: "{{states('input_number.vacuum_passes')|int}}"
+ zone: [[30914, 26007, 35514, 28807], [20232, 22496, 26032, 26496]]
```
{% endraw %}
@@ -1523,18 +1482,18 @@ Array with inline zone:
automation:
- alias: "Test vacuum zone3"
trigger:
- - event: start
- platform: homeassistant
+ - event: start
+ platform: homeassistant
condition: []
action:
- - service: xiaomi_miio.vacuum_clean_zone
- target:
- entity_id: vacuum.xiaomi_vacuum
- data:
- repeats: "{{states('input_number.vacuum_passes')|int}}"
- zone:
- - [30914,26007,35514,28807]
- - [20232,22496,26032,26496]
+ - service: xiaomi_miio.vacuum_clean_zone
+ target:
+ entity_id: vacuum.xiaomi_vacuum
+ data:
+ repeats: "{{states('input_number.vacuum_passes')|int}}"
+ zone:
+ - [30914, 26007, 35514, 28807]
+ - [20232, 22496, 26032, 26496]
```
{% endraw %}
@@ -1545,61 +1504,52 @@ Array mode:
automation:
- alias: "Test vacuum zone3"
trigger:
- - event: start
- platform: homeassistant
+ - event: start
+ platform: homeassistant
condition: []
action:
- - service: xiaomi_miio.vacuum_clean_zone
- target:
- entity_id: vacuum.xiaomi_vacuum
- data:
- repeats: 1
- zone:
- - - 30914
- - 26007
- - 35514
- - 28807
- - - 20232
- - 22496
- - 26032
- - 26496
+ - service: xiaomi_miio.vacuum_clean_zone
+ target:
+ entity_id: vacuum.xiaomi_vacuum
+ data:
+ repeats: 1
+ zone:
+ - - 30914
+ - 26007
+ - 35514
+ - 28807
+ - - 20232
+ - 22496
+ - 26032
+ - 26496
```
-### Service `xiaomi_miio.vacuum_goto`
-
-Go the specified coordinates
-
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | Only act on a specific robot |
-| `x_coord` | no | X-coordinate, integer value. The dock is located at x-coordinate 25500. |
-| `y_coord` | no | Y-coordinate, integer value. The dock is located at y-coordinate 25500. |
-
### Service `xiaomi_miio.vacuum_clean_segment`
Clean the specified segment/room. A room is identified by a number. Instructions on how to find the valid room numbers and determine what rooms they map to, read the section [Retrieving room numbers](#retrieving-room-numbers).
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | Only act on a specific robot |
-| `segments` | no | List of segment numbers or one single segment number. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------- |
+| `entity_id` | no | Only act on a specific robot |
+| `segments` | no | List of segment numbers or one single segment number. |
Example of `xiaomi_miio.vacuum_clean_segment` use:
Multiple segments:
+
```yaml
automation:
- alias: "Vacuum kitchen and living room"
trigger:
- - event: start
- platform: homeassistant
+ - event: start
+ platform: homeassistant
condition: []
action:
- - service: xiaomi_miio.vacuum_clean_segment
- target:
- entity_id: vacuum.xiaomi_vacuum
- data:
- segments: [1,2]
+ - service: xiaomi_miio.vacuum_clean_segment
+ target:
+ entity_id: vacuum.xiaomi_vacuum
+ data:
+ segments: [1, 2]
```
Single segment:
@@ -1608,15 +1558,15 @@ Single segment:
automation:
- alias: "Vacuum kitchen"
trigger:
- - event: start
- platform: homeassistant
+ - event: start
+ platform: homeassistant
condition: []
action:
- - service: xiaomi_miio.vacuum_clean_segment
- target:
- entity_id: vacuum.xiaomi_vacuum
- data:
- segments: 1
+ - service: xiaomi_miio.vacuum_clean_segment
+ target:
+ entity_id: vacuum.xiaomi_vacuum
+ data:
+ segments: 1
```
The original app for Xiaomi vacuum has a nice feature of room cleaning with repetition, you can achieve the same result with repeating segments:
@@ -1635,55 +1585,105 @@ automation:
segments: [1, 1]
```
+### Service `xiaomi_miio.vacuum_goto`
+
+Go the specified coordinates.
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------------------------- |
+| `entity_id` | no | Only act on a specific robot |
+| `x_coord` | no | X-coordinate, integer value. The dock is located at x-coordinate 25500. |
+| `y_coord` | no | Y-coordinate, integer value. The dock is located at y-coordinate 25500. |
+
+Note: If your vacuum is in motion and does not respond to the `xiaomi_miio.vacuum_goto` command, call the `vacuum.pause` or `vacuum.stop` service first.
+
+### Service `xiaomi_miio.vacuum_remote_control_start`
+
+Start the remote control mode of the robot. You can then move it with `remote_control_move`; when done, call `remote_control_stop`.
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------- |
+| `entity_id` | no | Only act on a specific robot |
+
+### Service `xiaomi_miio.vacuum_remote_control_stop`
+
+Exit the remote control mode of the robot.
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------- |
+| `entity_id` | no | Only act on a specific robot |
+
+### Service `xiaomi_miio.vacuum_remote_control_move`
+
+Remote control the robot. Please ensure you first set it in remote control mode with `remote_control_start`.
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------- |
+| `entity_id` | no | Only act on a specific robot |
+| `velocity` | no | Speed: between -0.29 and 0.29 |
+| `rotation` | no | Rotation: between -179 degrees and 179 degrees |
+| `duration` | no | The number of milliseconds that the robot should move for |
+
+### Service `xiaomi_miio.vacuum_remote_control_move_step`
+
+Enter remote control mode, make one move, stop, and exit remote control mode.
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------- |
+| `entity_id` | no | Only act on a specific robot |
+| `velocity` | no | Speed: between -0.29 and 0.29 |
+| `rotation` | no | Rotation: between -179 degrees and 179 degrees |
+| `duration` | no | The number of milliseconds that the robot should move for |
+
### Buttons
-Button | Description
------------------------ | ------------------------------------------
-Reset Main Brush | Resets main brush remaining lifespan
-Reset Side Brush | Resets side brush remaining lifespan
-Reset Filter | Resets filter remaining lifespan
-Reset Sensor Dirty | Resets sensor dirtiness (remaining time before needs to be cleaned)
+| Button | Description |
+| ------------------ | ------------------------------------------------------------------- |
+| Reset Main Brush | Resets main brush remaining lifespan |
+| Reset Side Brush | Resets side brush remaining lifespan |
+| Reset Filter | Resets filter remaining lifespan |
+| Reset Sensor Dirty | Resets sensor dirtiness (remaining time before needs to be cleaned) |
### Sensors
{% configuration_basic %}
DnD Start*:
- description: The timestamp when the next DnD (Do not disturb) period will start
+description: The timestamp when the next DnD (Do not disturb) period will start
DnD End*:
- description: The timestamp when the current or next DnD (Do not disturb) period will end
+description: The timestamp when the current or next DnD (Do not disturb) period will end
Total duration*:
- description: The total cleaning duration in seconds
+description: The total cleaning duration in seconds
Total Clean Area*:
- description: The total cleaning area in square meters
+description: The total cleaning area in square meters
Total Clean Count*:
- description: The total amount of times a clean cycle has been ran
+description: The total amount of times a clean cycle has been ran
Total Dust Collection Count*:
- description: The total amount of dust that has been collected
+description: The total amount of dust that has been collected
Filter Left*:
- description: How long the filter can be used in seconds
+description: How long the filter can be used in seconds
Main Brush Left*:
- description: How long the main brush can be used in seconds
+description: How long the main brush can be used in seconds
Sensor Dirty Left*:
- description: How long the sensor can be used in seconds
+description: How long the sensor can be used in seconds
Current Clean Time:
- description: The current cleaning time of the vacuum. If the vacuum is not cleaning, this sensor will have the same value as the "Last Clean Duration" sensor.
+description: The current cleaning time of the vacuum. If the vacuum is not cleaning, this sensor will have the same value as the "Last Clean Duration" sensor.
Current Clean Area:
- description: The current area that has been cleaned. If the vacuum is not cleaning, this sensor will have the same value as the "Last Clean Area" sensor.
+description: The current area that has been cleaned. If the vacuum is not cleaning, this sensor will have the same value as the "Last Clean Area" sensor.
Last Clean Area*:
- description: The last cleaned area in square meters
-Last Clean Duration*:
- description: The last clean duration in seconds
+description: The last cleaned area in square meters
+Last Clean Duration\*:
+description: The last clean duration in seconds
Last Clean End:
- description: The last clean end time as a timestamp
+description: The last clean end time as a timestamp
Last Clean Start:
- description: The last clean start time as a timestamp
+description: The last clean start time as a timestamp
Mop Attached**:
- description: If the mop is attached
+description: If the mop is attached
Water Box Attached**:
- description: If the watter box is attached
-Water Shortage**:
- description: If the water box is low on water
+description: If the watter box is attached
+Water Shortage\*\*:
+description: If the water box is low on water
{% endconfiguration_basic %}
@@ -1694,7 +1694,7 @@ Water Shortage**:
### Attributes
-The vacuums from the `xiaomi` platform does not expose additional attributes other the ones provided by [the `vacuum` component](/integrations/vacuum/#attributes),
+The vacuums from the `xiaomi` platform does not expose additional attributes other the ones provided by [the `vacuum` integration](/integrations/vacuum/#attributes),
### Example on how to clean a specific room
@@ -1718,8 +1718,8 @@ Where params specify room numbers, for multiple rooms, params can be specified l
The vacuum entity stores attribute values for when brushes, filters and sensors need to be
cleaned or replaced (`main_brush_left`, `side_brush_left`, `filter_left` and
-`sensor_dirty_left`). The values are measured in hours. Once the parts are cleaned
-or replaced you can then reset those values on the vacuum. Here is an example script using
+`sensor_dirty_left`). The values are measured in hours. Once the parts are cleaned
+or replaced you can then reset those values on the vacuum. Here is an example script using
[`vacuum.send_command`](/integrations/vacuum/) to reset the hours for the main brush:
```yaml
@@ -1731,7 +1731,7 @@ reset_main_brush_left:
entity_id: vacuum.xiaomi_vacuum_cleaner
data:
command: reset_consumable
- params: ['main_brush_work_time']
+ params: ["main_brush_work_time"]
```
Allowed `params` for the `reset_consumable` command:
@@ -1766,7 +1766,7 @@ vacuum_kitchen:
entity_id: "vacuum.xiaomi_vacuum_cleaner"
data:
command: app_zoned_clean
- params: [[23084,26282,27628,29727,1]]
+ params: [[23084, 26282, 27628, 29727, 1]]
```
### Retrieving Room numbers
@@ -1876,67 +1876,67 @@ Supported models: `philips.light.moonlight`
Set one of the 4 available fixed scenes.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
-| `scene` | no | Scene, between 1 and 4. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------ |
+| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
+| `scene` | no | Scene, between 1 and 4. |
### Service `xiaomi_miio.light_set_delayed_turn_off`
Delayed turn off.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
-| `time_period` | no | Time period for the delayed turn off. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------ |
+| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
+| `time_period` | no | Time period for the delayed turn off. |
### Service `xiaomi_miio.light_reminder_on` (Eyecare Smart Lamp 2 only)
Enable the eye fatigue reminder/notification.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------ |
+| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
### Service `xiaomi_miio.light_reminder_off` (Eyecare Smart Lamp 2 only)
Disable the eye fatigue reminder/notification.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------ |
+| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
-### Service `xiaomi_miio.light_night_light_mode_on` (Eyecare Smart Lamp 2 only)
+### Service `xiaomi_miio.light_night_light_mode_on` (Eyecare Smart Lamp 2 only)
Turn the smart night light mode on.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------ |
+| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
-### Service `xiaomi_miio.light_night_light_mode_off` (Eyecare Smart Lamp 2 only)
+### Service `xiaomi_miio.light_night_light_mode_off` (Eyecare Smart Lamp 2 only)
Turn the smart night light mode off.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------ |
+| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
-### Service `xiaomi_miio.light_eyecare_mode_on` (Eyecare Smart Lamp 2 only)
+### Service `xiaomi_miio.light_eyecare_mode_on` (Eyecare Smart Lamp 2 only)
Turn the eyecare mode on.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------ |
+| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
-### Service `xiaomi_miio.light_eyecare_mode_off` (Eyecare Smart Lamp 2 only)
+### Service `xiaomi_miio.light_eyecare_mode_off` (Eyecare Smart Lamp 2 only)
Turn the eyecare mode off.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------ |
+| `entity_id` | no | Only act on a specific Xiaomi miIO light entity. |
## Xiaomi Smart WiFi Socket and Smart Power Strip
@@ -1990,37 +1990,38 @@ Supported models: `lumi.acpartner.v3` (the socket of the `acpartner.v1` and `v2`
Turn the wifi LED on.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|---------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------- |
+| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
### Service `xiaomi_miio.switch_set_wifi_led_off` (Power Strip only)
Turn the wifi LED off.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|---------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------- |
+| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
### Service `xiaomi_miio.switch_set_power_price` (Power Strip)
Set the power price.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|---------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
-| `price` | no | Power price, between 0 and 999. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------- |
+| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
+| `price` | no | Power price, between 0 and 999. |
### Service `xiaomi_miio.switch_set_power_mode` (Power Strip V1 only)
Set the power mode.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|---------------------------------------------------------------|
-| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
-| `mode` | no | Power mode, valid values are 'normal' and 'green' |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------- |
+| `entity_id` | no | Only act on a specific Xiaomi miIO switch entity. |
+| `mode` | no | Power mode, valid values are 'normal' and 'green' |
## Retrieving the Access Token
+
Not recommended, please specify the cloud credentials during the config flow for easier setup.
However when setting up a device manually the token can be retrieved in one of the following ways.
@@ -2031,15 +2032,15 @@ One of Home Assistant users wrote a tokens extractor tool, which is currently th
1. Install requirements:
- ```bash
- pip3 install pycryptodome pybase64 requests
- ```
+```bash
+pip3 install pycryptodome pybase64 requests
+```
2. Run script
- ```bash
- python3 token_extractor.py
- ```
+```bash
+python3 token_extractor.py
+```
3. Provide e-mail address or username for Xiaomi's account, password and country of the account (most used: CN - China Mainland, DE - Germany etc.)
4. Script will print out all devices connected to the account with their IP address and tokens for use in Home Assistant.
@@ -2055,7 +2056,7 @@ One of Home Assistant users wrote a tokens extractor tool, which is currently th
7. Tap the version number (Plug-in version 2.77.1 as of January 2020, iOS has a white space instead of version number) at the bottom of the screen repeatedly.
8. You should now see 2 extra options listed in English (iOS still in Chinese), this means you enabled developer mode. [if not, try all steps again!].
9. Android: under "Hub info" there is quite some text in JSON format, this includes the "token" that you need.
-iOS: Most options are still in Chinese, you need the fourth item from the top.
+ iOS: Most options are still in Chinese, you need the fourth item from the top.
Note: If you have multiple devices needing a token, e.g., Xiaomi Mi Robot Vacuum and a Xiaomi IR Remote, the above method may not work. The Xiaomi Home app will display a token, though it isn't the correct one. The alternative method using "Mi Home v5.4.49" will provide the correct token.
@@ -2076,6 +2077,7 @@ After resetting the Wi-Fi settings of the Xiaomi robot vacuum, a new Access Toke
These instructions are written for the Mi Home app - not for the new RoboRock app.
This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuum, Mi Robot 2 (Roborock) Vacuum, Xiaomi Philips Lights and Xiaomi IR Remote. +
### Android (not rooted)
@@ -2105,7 +2107,7 @@ This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuu
3. Install [iBackup Viewer](https://www.imactools.com/iphonebackupviewer/), open it, and open your backup.
4. Open the "Raw Data" module.
5. Navigate to `com.xiaomi.mihome`.
-6. Search for a file that looks like this: `123456789_mihome.sqlite` (Note: `_mihome.sqlite` is *not* the correct file. Most likely, you will find this file in the `Documents` folder.)
+6. Search for a file that looks like this: `123456789_mihome.sqlite` (Note: `_mihome.sqlite` is _not_ the correct file. Most likely, you will find this file in the `Documents` folder.)
7. Save this file to your filesystem.
8. Install [DB Browser for SQLite](https://sqlitebrowser.org/).
9. Open DB Browser and load the `.sqlite` file you saved from your backup.
diff --git a/source/_integrations/xs1.markdown b/source/_integrations/xs1.markdown
index c3e37879582..8f4c4f59a82 100644
--- a/source/_integrations/xs1.markdown
+++ b/source/_integrations/xs1.markdown
@@ -86,7 +86,7 @@ Home Assistant can combine temperature sensors and climate actuators into a sing
## Examples
-In this section, you find some real-life examples of how to use this component.
+In this section, you find some real-life examples of how to use this integration.
### Full configuration
diff --git a/source/_integrations/youtube.markdown b/source/_integrations/youtube.markdown
index 779b8f77c42..741569a8519 100644
--- a/source/_integrations/youtube.markdown
+++ b/source/_integrations/youtube.markdown
@@ -15,9 +15,15 @@ ha_integration_type: service
---
The YouTube integration allows you to connect YouTube channels to Home Assistant.
+For every channel you add, it will create sensors for:
+* Subscriber count
+* The latest uploaded video
## Prerequisites
+To be able to configure the integration, you need to have a YouTube channel.
+How to create one can be found [here](https://support.google.com/youtube/answer/1646861).
+
You need to configure developer credentials to allow Home Assistant to access your Google Account.
These credentials are the same as the ones for [Nest](/integrations/nest), [Google Mail](/integrations/google_mail) and [Google Sheets](/integrations/google_sheets).
These are not the same as the one for [Google Calendar](/integrations/google).
diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown
index fd002a20bc1..3ca471af398 100644
--- a/source/_integrations/zha.markdown
+++ b/source/_integrations/zha.markdown
@@ -51,21 +51,21 @@ ZHA uses an open-source Python library implementing a hardware-independent Zigbe
There is currently support for the following device types within Home Assistant:
-- Alarm Control Panel
-- Binary Sensor
-- Button
-- Climate (beta)
-- Cover
-- Fan
-- Light
-- Lock
-- Number (i.e. analog output)
-- Select
-- Sensor
-- Siren
-- Switch
+- [Alarm Control Panel](/integrations/alarm_control_panel/)
+- [Binary Sensor](/integrations/binary_sensor/)
+- [Button](/integrations/button/)
+- [Climate](/integrations/climate/) (beta)
+- [Cover](/integrations/cover/)
+- [Fan](/integrations/fan/)
+- [Light](/integrations/light/)
+- [Lock](/integrations/lock/)
+- [Number](/integrations/number/) (i.e. analog output)
+- [Select](/integrations/select/)
+- [Sensor](/integrations/sensor/)
+- [Siren](/integrations/siren/)
+- [Switch](/integrations/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. As well as support for binding/unbinding (i.e. bind a remote to a lightbulb or group).
+There is also support for Zigbee grouping of lights, switches, and fans (i.e. support for commanding device groups as entities). At least two entities must be added to a Zigbee group in the ZHA integration before the group entity is created. As well as support for [binding and unbinding (i.e. bind a remote to a lightbulb or group)](#binding-and-unbinding).
## Introduction
@@ -232,7 +232,7 @@ custom_quirks_path:
### OTA firmware updates
-ZHA component has the ability to automatically download and perform OTA (Over-The-Air) firmware updates of Zigbee devices if the OTA firmware provider source URL for updates is available. OTA firmware updating is set to disabled (`false`) in the configuration by default.
+The ZHA integration has the ability to automatically download and perform OTA (Over-The-Air) firmware updates of Zigbee devices if the OTA firmware provider source URL for updates is available. OTA firmware updating is set to disabled (`false`) in the configuration by default.
Online OTA providers for firmware updates are currently only available for IKEA, LEDVANCE/OSRAM, SALUS/Computime, and INOVELLI devices. Support for OTA updates from other manufacturers could be supported in the future if they publish their firmware images publicly.
@@ -554,7 +554,7 @@ When reporting issues, please provide the following information in addition to i
### Debug logging
-To enable debug logging for ZHA component and radio libraries, add the following [logger](/integrations/logger/) configuration to `configuration.yaml`:
+To enable debug logging for the ZHA integration and radio libraries, add the following [logger](/integrations/logger/) configuration to `configuration.yaml`:
```yaml
logger:
diff --git a/source/_integrations/zoneminder.markdown b/source/_integrations/zoneminder.markdown
index a8f0044b74f..a9d2309723b 100644
--- a/source/_integrations/zoneminder.markdown
+++ b/source/_integrations/zoneminder.markdown
@@ -109,7 +109,7 @@ action:
The `zoneminder` binary sensor platform lets you monitor the availability of your [ZoneMinder](https://www.zoneminder.com) install.
-Each binary_sensor created will be named after the hostname used when configuring the [ZoneMinder component](/integrations/zoneminder/).
+Each binary_sensor created will be named after the hostname used when configuring the [ZoneMinder integration](/integrations/zoneminder/).
## Camera
@@ -167,7 +167,7 @@ The `zoneminder` switch platform allows you to toggle the current function of al
This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuum, Mi Robot 2 (Roborock) Vacuum, Xiaomi Philips Lights and Xiaomi IR Remote. +
-You must have the [ZoneMinder component](/integrations/zoneminder/) configured to use this and if ZoneMinder authentication is enabled the account specified in the integration configuration must have "Edit" permission for "System".
+You must have the [ZoneMinder integration](/integrations/zoneminder/) configured to use this and if ZoneMinder authentication is enabled the account specified in the integration configuration must have "Edit" permission for "System".
diff --git a/source/_posts/2023-06-07-release-20236.markdown b/source/_posts/2023-06-07-release-20236.markdown
index e7979838c3d..e29efd98bbb 100644
--- a/source/_posts/2023-06-07-release-20236.markdown
+++ b/source/_posts/2023-06-07-release-20236.markdown
@@ -48,6 +48,9 @@ Enjoy the release!
- [Other noteworthy changes](#other-noteworthy-changes)
- [New Integrations](#new-integrations)
- [Integrations now available to set up from the UI](#integrations-now-available-to-set-up-from-the-ui)
+- [Release 2023.6.1 - June 8](#release-202361---june-8)
+- [Release 2023.6.2 - June 14](#release-202362---june-14)
+- [Release 2023.6.3 - June 23](#release-202363---june-23)
- [Need help? Join the community!](#need-help-join-the-community)
- [Breaking Changes](#breaking-changes)
- [Farewell to the following](#farewell-to-the-following)
@@ -385,6 +388,327 @@ The following integrations are now available via the Home Assistant UI:
[Last.fm]: /integrations/lastfm
[Philips Dynalite]: /integrations/dynalite
+## Release 2023.6.1 - June 8
+
+- Add error handling to input_select integration ([@j4n-e4t] - [#93940]) ([input_select docs])
+- Fix OTBR reset ([@emontnemery] - [#94157]) ([thread docs]) ([otbr docs])
+- Bump melnor-bluetooth to fix a timezone issue ([@vanstinator] - [#94159]) ([melnor docs])
+- Fix Abode unit of measurement ([@joostlek] - [#94168]) ([abode docs])
+- Bump pyoverkiz to 1.8.0 ([@iMicknl] - [#94176]) ([overkiz docs])
+- Rename Local Media to My Media ([@balloob] - [#94201]) ([media_source docs])
+- Fix ambiclimate for Python 3.11 ([@megakid] - [#94203]) ([ambiclimate docs])
+- Require pydantic 1.10.8 or higher ([@allenporter] - [#94208])
+- Set httpx log level to warning ([@jpbede] - [#94217])
+- Update aioairzone-cloud to v0.1.8 ([@Noltari] - [#94223]) ([airzone_cloud docs])
+- Bump python-opensky ([@joostlek] - [#93916]) ([opensky docs])
+- Bump python-opensky to 0.0.9 ([@joostlek] - [#94224]) ([opensky docs])
+- Bump pulsectl to 23.5.2 ([@chatziko] - [#94227]) ([pulseaudio_loopback docs])
+- Fix imap crash on email without subject ([@jbouwh] - [#94230]) ([imap docs])
+- Solve wrong return code from modbus. ([@janiversen] - [#94234]) ([flexit docs])
+- Catch exception when user has no lastfm friends ([@joostlek] - [#94235]) ([lastfm docs])
+- Bump aiohomekit to 2.6.5 (fixes python 3.11 regression) ([@Jc2k] - [#94245]) ([homekit_controller docs])
+- Retrieve friends in an async manner in Lastfm ([@joostlek] - [#94255]) ([lastfm docs])
+- Update frontend to 20230608.0 ([@piitaya] - [#94256]) ([frontend docs])
+- Bump unifiprotect to 4.10.2 ([@AngellusMortis] - [#94263]) ([unifiprotect docs])
+- Fix default value when logger used ([@balloob] - [#94269]) ([logger docs])
+- Fix repair issue about no yaml for config entries ([@frenck] - [#94271])
+- Restructure Insteon start-up ([@teharris1] - [#92818]) ([insteon docs])
+- Fix Insteon startup for users with X10 devices ([@teharris1] - [#94277]) ([insteon docs])
+
+[#92818]: https://github.com/home-assistant/core/pull/92818
+[#93916]: https://github.com/home-assistant/core/pull/93916
+[#93940]: https://github.com/home-assistant/core/pull/93940
+[#94157]: https://github.com/home-assistant/core/pull/94157
+[#94158]: https://github.com/home-assistant/core/pull/94158
+[#94159]: https://github.com/home-assistant/core/pull/94159
+[#94168]: https://github.com/home-assistant/core/pull/94168
+[#94176]: https://github.com/home-assistant/core/pull/94176
+[#94201]: https://github.com/home-assistant/core/pull/94201
+[#94203]: https://github.com/home-assistant/core/pull/94203
+[#94208]: https://github.com/home-assistant/core/pull/94208
+[#94217]: https://github.com/home-assistant/core/pull/94217
+[#94223]: https://github.com/home-assistant/core/pull/94223
+[#94224]: https://github.com/home-assistant/core/pull/94224
+[#94227]: https://github.com/home-assistant/core/pull/94227
+[#94230]: https://github.com/home-assistant/core/pull/94230
+[#94234]: https://github.com/home-assistant/core/pull/94234
+[#94235]: https://github.com/home-assistant/core/pull/94235
+[#94245]: https://github.com/home-assistant/core/pull/94245
+[#94255]: https://github.com/home-assistant/core/pull/94255
+[#94256]: https://github.com/home-assistant/core/pull/94256
+[#94263]: https://github.com/home-assistant/core/pull/94263
+[#94269]: https://github.com/home-assistant/core/pull/94269
+[#94271]: https://github.com/home-assistant/core/pull/94271
+[#94277]: https://github.com/home-assistant/core/pull/94277
+[@AngellusMortis]: https://github.com/AngellusMortis
+[@Jc2k]: https://github.com/Jc2k
+[@Noltari]: https://github.com/Noltari
+[@allenporter]: https://github.com/allenporter
+[@balloob]: https://github.com/balloob
+[@chatziko]: https://github.com/chatziko
+[@emontnemery]: https://github.com/emontnemery
+[@frenck]: https://github.com/frenck
+[@iMicknl]: https://github.com/iMicknl
+[@j4n-e4t]: https://github.com/j4n-e4t
+[@janiversen]: https://github.com/janiversen
+[@jbouwh]: https://github.com/jbouwh
+[@joostlek]: https://github.com/joostlek
+[@jpbede]: https://github.com/jpbede
+[@megakid]: https://github.com/megakid
+[@piitaya]: https://github.com/piitaya
+[@teharris1]: https://github.com/teharris1
+[@vanstinator]: https://github.com/vanstinator
+[abode docs]: /integrations/abode/
+[accuweather docs]: /integrations/accuweather/
+[aemet docs]: /integrations/aemet/
+[airthings docs]: /integrations/airthings/
+[airthings_ble docs]: /integrations/airthings_ble/
+[airzone docs]: /integrations/airzone/
+[airzone_cloud docs]: /integrations/airzone_cloud/
+[ambiclimate docs]: /integrations/ambiclimate/
+[flexit docs]: /integrations/flexit/
+[frontend docs]: /integrations/frontend/
+[homekit_controller docs]: /integrations/homekit_controller/
+[imap docs]: /integrations/imap/
+[input_select docs]: /integrations/input_select/
+[insteon docs]: /integrations/insteon/
+[lastfm docs]: /integrations/lastfm/
+[logger docs]: /integrations/logger/
+[media_source docs]: /integrations/media_source/
+[melnor docs]: /integrations/melnor/
+[opensky docs]: /integrations/opensky/
+[otbr docs]: /integrations/otbr/
+[overkiz docs]: /integrations/overkiz/
+[pulseaudio_loopback docs]: /integrations/pulseaudio_loopback/
+[thread docs]: /integrations/thread/
+[unifiprotect docs]: /integrations/unifiprotect/
+
+## Release 2023.6.2 - June 14
+
+- Change pyoppleio to pyoppleio-legacy ([@tinysnake] - [#88050]) ([opple docs])
+- Fix issue with Insteon linked devices maintaining current state ([@teharris1] - [#94286]) ([insteon docs])
+- Bump elkm1-lib to 2.2.5 ([@gwww] - [#94296]) ([elkm1 docs])
+- Bump pylitterbot to 2023.4.2 ([@natekspencer] - [#94301]) ([litterrobot docs])
+- Upgrade sisyphus-control to 3.1.3 ([@jkeljo] - [#94310]) ([sisyphus docs])
+- fix: electrasmart - cast temperature to int in set_temperature ([@jafar-atili] - [#94368]) ([electrasmart docs])
+- Fix dep noaa-coops for noaa_tides ([@jbouwh] - [#94370]) ([noaa_tides docs])
+- Fix deprecated asyncio.wait use with coroutines ([@syssi] - [#94371]) ([xiaomi_miio docs])
+- Update xknxproject to 3.1.1 ([@farmio] - [#94375]) ([knx docs])
+- Re-add event listeners after Z-Wave server disconnection ([@raman325] - [#94383]) ([zwave_js docs])
+- Fix ZHA binding api to actually return responses ([@jasonkuster] - [#94388]) ([zha docs])
+- Abort youtube configuration if user has no channel ([@joostlek] - [#94402]) ([youtube docs])
+- Update knx-frontend to 2023.6.9.195839 ([@farmio] - [#94404]) ([knx docs])
+- Bump unifiprotect to 4.10.3 ([@AngellusMortis] - [#94416]) ([unifiprotect docs])
+- Fix: Xiaomi Miio Fan, delay off countdown unit conversion ([@golles] - [#94428]) ([xiaomi_miio docs])
+- Add unit inference for Amps and VA in APCUPSD integration ([@yuxincs] - [#94431]) ([apcupsd docs])
+- Fix manual update for Command Line ([@gjohansson-ST] - [#94433]) ([command_line docs])
+- Fix reload service in Command Line ([@gjohansson-ST] - [#94436]) ([command_line docs])
+- Set default value for endpoint in zwave device automations ([@raman325] - [#94445]) ([zwave_js docs])
+- Revert "Bump pydaikin 2.9.1 (#93635)" ([@mover85] - [#94469]) ([daikin docs])
+- Bump russound_rio to 1.0.0 ([@chphilli] - [#94500]) ([russound_rio docs])
+- Fix entity and device selector TypedDict's ([@raman325] - [#94510])
+- Bump yalexs-ble to 2.1.18 ([@bdraco] - [#94547]) ([august docs]) ([yalexs_ble docs])
+- Bump `regenmaschine` to 2023.06.0 ([@bachya] - [#94554]) ([rainmachine docs])
+- Update Home Assistant base image to 2023.06.0 ([@frenck] - [#94556])
+- Catch InvalidAuthError in `shutdown()` method for Shelly gen2 devices ([@bieniu] - [#94563]) ([shelly docs])
+- Fix keyboard_remote for python 3.11 ([@lanrat] - [#94570]) ([keyboard_remote docs])
+- Fix failed recovery in roku ([@ctalkington] - [#94572]) ([roku docs])
+- Fix failed recovery in ipp ([@ctalkington] - [#94573]) ([ipp docs])
+- Improve multipan debug logging ([@emontnemery] - [#94580]) ([homeassistant_hardware docs])
+
+[#88050]: https://github.com/home-assistant/core/pull/88050
+[#94158]: https://github.com/home-assistant/core/pull/94158
+[#94286]: https://github.com/home-assistant/core/pull/94286
+[#94288]: https://github.com/home-assistant/core/pull/94288
+[#94296]: https://github.com/home-assistant/core/pull/94296
+[#94301]: https://github.com/home-assistant/core/pull/94301
+[#94310]: https://github.com/home-assistant/core/pull/94310
+[#94368]: https://github.com/home-assistant/core/pull/94368
+[#94370]: https://github.com/home-assistant/core/pull/94370
+[#94371]: https://github.com/home-assistant/core/pull/94371
+[#94375]: https://github.com/home-assistant/core/pull/94375
+[#94383]: https://github.com/home-assistant/core/pull/94383
+[#94388]: https://github.com/home-assistant/core/pull/94388
+[#94402]: https://github.com/home-assistant/core/pull/94402
+[#94404]: https://github.com/home-assistant/core/pull/94404
+[#94416]: https://github.com/home-assistant/core/pull/94416
+[#94428]: https://github.com/home-assistant/core/pull/94428
+[#94431]: https://github.com/home-assistant/core/pull/94431
+[#94433]: https://github.com/home-assistant/core/pull/94433
+[#94436]: https://github.com/home-assistant/core/pull/94436
+[#94445]: https://github.com/home-assistant/core/pull/94445
+[#94469]: https://github.com/home-assistant/core/pull/94469
+[#94500]: https://github.com/home-assistant/core/pull/94500
+[#94510]: https://github.com/home-assistant/core/pull/94510
+[#94547]: https://github.com/home-assistant/core/pull/94547
+[#94554]: https://github.com/home-assistant/core/pull/94554
+[#94556]: https://github.com/home-assistant/core/pull/94556
+[#94563]: https://github.com/home-assistant/core/pull/94563
+[#94570]: https://github.com/home-assistant/core/pull/94570
+[#94572]: https://github.com/home-assistant/core/pull/94572
+[#94573]: https://github.com/home-assistant/core/pull/94573
+[#94580]: https://github.com/home-assistant/core/pull/94580
+[@AngellusMortis]: https://github.com/AngellusMortis
+[@bachya]: https://github.com/bachya
+[@balloob]: https://github.com/balloob
+[@bdraco]: https://github.com/bdraco
+[@bieniu]: https://github.com/bieniu
+[@chphilli]: https://github.com/chphilli
+[@ctalkington]: https://github.com/ctalkington
+[@emontnemery]: https://github.com/emontnemery
+[@farmio]: https://github.com/farmio
+[@frenck]: https://github.com/frenck
+[@gjohansson-ST]: https://github.com/gjohansson-ST
+[@golles]: https://github.com/golles
+[@gwww]: https://github.com/gwww
+[@jafar-atili]: https://github.com/jafar-atili
+[@jasonkuster]: https://github.com/jasonkuster
+[@jbouwh]: https://github.com/jbouwh
+[@jkeljo]: https://github.com/jkeljo
+[@joostlek]: https://github.com/joostlek
+[@lanrat]: https://github.com/lanrat
+[@mover85]: https://github.com/mover85
+[@natekspencer]: https://github.com/natekspencer
+[@raman325]: https://github.com/raman325
+[@syssi]: https://github.com/syssi
+[@teharris1]: https://github.com/teharris1
+[@tinysnake]: https://github.com/tinysnake
+[@yuxincs]: https://github.com/yuxincs
+[accuweather docs]: /integrations/accuweather/
+[aemet docs]: /integrations/aemet/
+[airthings docs]: /integrations/airthings/
+[airthings_ble docs]: /integrations/airthings_ble/
+[airzone docs]: /integrations/airzone/
+[apcupsd docs]: /integrations/apcupsd/
+[august docs]: /integrations/august/
+[command_line docs]: /integrations/command_line/
+[daikin docs]: /integrations/daikin/
+[electrasmart docs]: /integrations/electrasmart/
+[elkm1 docs]: /integrations/elkm1/
+[homeassistant_hardware docs]: /integrations/homeassistant_hardware/
+[insteon docs]: /integrations/insteon/
+[ipp docs]: /integrations/ipp/
+[keyboard_remote docs]: /integrations/keyboard_remote/
+[knx docs]: /integrations/knx/
+[litterrobot docs]: /integrations/litterrobot/
+[noaa_tides docs]: /integrations/noaa_tides/
+[opple docs]: /integrations/opple/
+[rainmachine docs]: /integrations/rainmachine/
+[roku docs]: /integrations/roku/
+[russound_rio docs]: /integrations/russound_rio/
+[shelly docs]: /integrations/shelly/
+[sisyphus docs]: /integrations/sisyphus/
+[unifiprotect docs]: /integrations/unifiprotect/
+[xiaomi_miio docs]: /integrations/xiaomi_miio/
+[yalexs_ble docs]: /integrations/yalexs_ble/
+[youtube docs]: /integrations/youtube/
+[zha docs]: /integrations/zha/
+[zwave_js docs]: /integrations/zwave_js/
+
+## Release 2023.6.3 - June 23
+
+- Register Fully Kiosk services regardless of setup result ([@mheath] - [#88647]) ([fully_kiosk docs])
+- Fortios device tracker updates ([@kimfrellsen] - [#92331]) ([fortios docs])
+- Handle LastFM unavailable ([@joostlek] - [#94456]) ([lastfm docs])
+- Handle Insteon events correctly ([@teharris1] - [#94549]) ([insteon docs])
+- Fix unit for Habitica text sensors ([@atudor2] - [#94550]) ([habitica docs])
+- Bump minimum typing_extensions to 4.6.3 ([@freeDom-] - [#94587]) (dependency)
+- Fix glances raid plugin data ([@freeDom-] - [#94597]) ([glances docs])
+- Make YouTube select lower quality thumbnails ([@joostlek] - [#94652]) ([youtube docs])
+- Add strings for YouTube reauthentication ([@joostlek] - [#94655]) ([youtube docs])
+- Fix bluetooth tracker asyncio usage ([@d03n3rfr1tz3] - [#94695]) ([bluetooth_tracker docs])
+- Fix zwave_js trigger event reattach logic ([@raman325] - [#94702]) ([zwave_js docs])
+- Fix warning from rapt_ble caused by payload version 2 ([@sairon] - [#94718]) ([rapt_ble docs])
+- Fix Totalconnect BinarySensorDeviceClass logic ([@austinmroczek] - [#94772]) ([totalconnect docs])
+- Bump HAP-python to 4.7.0 ([@bdraco] - [#94812]) ([homekit docs]) (dependency)
+- Bump bthome to 2.12.0 ([@Ernst79] - [#94822]) ([bthome docs]) (dependency)
+- Update aioairzone to v0.6.4 ([@Noltari] - [#94873]) ([airzone docs]) (dependency)
+- Bump ical to 4.5.4 ([@allenporter] - [#94894]) ([local_calendar docs])
+- Fix Meteo France blocked config entry when weather alert API fails ([@Quentame] - [#94911]) ([meteo_france docs])
+- Add error handling to hassio issues ([@epenet] - [#94951]) ([hassio docs])
+- Bump Matter Server to 3.5.1: some small fixes and stability improvements ([@marcelveldt] - [#94985]) ([matter docs]) (dependency)
+- Fix zwave_js device diagnostics dump ([@raman325] - [#94999]) ([zwave_js docs])
+- Bump bimmer_connected to 0.13.7 ([@rikroe] - [#95017]) ([bmw_connected_drive docs]) (dependency)
+- Fix goodwe midnight error ([@hmmbob] - [#95041]) ([goodwe docs])
+- Fix removal of orphaned Matter devices ([@marcelveldt] - [#95044]) ([matter docs])
+- Fix KNX device trigger passing info data ([@farmio] - [#95076]) ([knx docs])
+
+[#88647]: https://github.com/home-assistant/core/pull/88647
+[#92331]: https://github.com/home-assistant/core/pull/92331
+[#94158]: https://github.com/home-assistant/core/pull/94158
+[#94288]: https://github.com/home-assistant/core/pull/94288
+[#94456]: https://github.com/home-assistant/core/pull/94456
+[#94549]: https://github.com/home-assistant/core/pull/94549
+[#94550]: https://github.com/home-assistant/core/pull/94550
+[#94587]: https://github.com/home-assistant/core/pull/94587
+[#94597]: https://github.com/home-assistant/core/pull/94597
+[#94621]: https://github.com/home-assistant/core/pull/94621
+[#94652]: https://github.com/home-assistant/core/pull/94652
+[#94655]: https://github.com/home-assistant/core/pull/94655
+[#94695]: https://github.com/home-assistant/core/pull/94695
+[#94702]: https://github.com/home-assistant/core/pull/94702
+[#94718]: https://github.com/home-assistant/core/pull/94718
+[#94772]: https://github.com/home-assistant/core/pull/94772
+[#94812]: https://github.com/home-assistant/core/pull/94812
+[#94822]: https://github.com/home-assistant/core/pull/94822
+[#94873]: https://github.com/home-assistant/core/pull/94873
+[#94894]: https://github.com/home-assistant/core/pull/94894
+[#94911]: https://github.com/home-assistant/core/pull/94911
+[#94951]: https://github.com/home-assistant/core/pull/94951
+[#94985]: https://github.com/home-assistant/core/pull/94985
+[#94999]: https://github.com/home-assistant/core/pull/94999
+[#95017]: https://github.com/home-assistant/core/pull/95017
+[#95041]: https://github.com/home-assistant/core/pull/95041
+[#95044]: https://github.com/home-assistant/core/pull/95044
+[#95076]: https://github.com/home-assistant/core/pull/95076
+[@Ernst79]: https://github.com/Ernst79
+[@Noltari]: https://github.com/Noltari
+[@Quentame]: https://github.com/Quentame
+[@allenporter]: https://github.com/allenporter
+[@atudor2]: https://github.com/atudor2
+[@austinmroczek]: https://github.com/austinmroczek
+[@balloob]: https://github.com/balloob
+[@bdraco]: https://github.com/bdraco
+[@d03n3rfr1tz3]: https://github.com/d03n3rfr1tz3
+[@epenet]: https://github.com/epenet
+[@farmio]: https://github.com/farmio
+[@freeDom-]: https://github.com/freeDom-
+[@frenck]: https://github.com/frenck
+[@hmmbob]: https://github.com/hmmbob
+[@joostlek]: https://github.com/joostlek
+[@kimfrellsen]: https://github.com/kimfrellsen
+[@marcelveldt]: https://github.com/marcelveldt
+[@mheath]: https://github.com/mheath
+[@raman325]: https://github.com/raman325
+[@rikroe]: https://github.com/rikroe
+[@sairon]: https://github.com/sairon
+[@teharris1]: https://github.com/teharris1
+[accuweather docs]: /integrations/accuweather/
+[aemet docs]: /integrations/aemet/
+[airthings docs]: /integrations/airthings/
+[airthings_ble docs]: /integrations/airthings_ble/
+[airzone docs]: /integrations/airzone/
+[bluetooth_tracker docs]: /integrations/bluetooth_tracker/
+[bmw_connected_drive docs]: /integrations/bmw_connected_drive/
+[bthome docs]: /integrations/bthome/
+[fortios docs]: /integrations/fortios/
+[fully_kiosk docs]: /integrations/fully_kiosk/
+[glances docs]: /integrations/glances/
+[goodwe docs]: /integrations/goodwe/
+[habitica docs]: /integrations/habitica/
+[hassio docs]: /integrations/hassio/
+[homekit docs]: /integrations/homekit/
+[insteon docs]: /integrations/insteon/
+[knx docs]: /integrations/knx/
+[lastfm docs]: /integrations/lastfm/
+[local_calendar docs]: /integrations/local_calendar/
+[matter docs]: /integrations/matter/
+[meteo_france docs]: /integrations/meteo_france/
+[rapt_ble docs]: /integrations/rapt_ble/
+[totalconnect docs]: /integrations/totalconnect/
+[youtube docs]: /integrations/youtube/
+[zwave_js docs]: /integrations/zwave_js/
+
## Need help? Join the community!
Home Assistant has a great community of users who are all more than willing
@@ -842,6 +1166,18 @@ be safely deleted.
[@raman325]: https://github.com/raman325
[#93946]: https://github.com/home-assistant/core/pull/93946
+---
+
+If you have zwave_js cover entities already and your device supports Window
+Covering CC, you may see newly created cover entities. The old cover entities
+can safely be deleted, but all customizations must be reapplied to the
+new entities.
+
+([@raman325] - [#93314]) ([documentation](/integrations/zwave_js))
+
+[@raman325]: https://github.com/raman325
+[#93314]: https://github.com/home-assistant/core/pull/93314
+
{% enddetails %}
If you are a custom integration developer and want to learn about breaking
diff --git a/source/_posts/2023-06-27-knx-collaboration.markdown b/source/_posts/2023-06-27-knx-collaboration.markdown
new file mode 100644
index 00000000000..86678890bf1
--- /dev/null
+++ b/source/_posts/2023-06-27-knx-collaboration.markdown
@@ -0,0 +1,28 @@
+---
+layout: post
+title: "Home Assistant collaborates with KNX"
+description: "Home Assistant collaborates with KNX"
+date: 2023-06-27 00:00:00
+date_formatted: "June 27, 2023"
+author: Uwe Bernitt
+comments: true
+categories:
+ - Announcements
+og_image: /images/blog/2023-06-27-knx-collaboration/social.png
+---
+
+
++ +We’re excited to announce that the [KNX Association](https://www.knx.org/knx-en/for-professionals/index.php) has officially endorsed the [KNX integration in Home Assistant](/integrations/knx/). The KNX Association will collaborate with the KNX team at Home Assistant to help with the maintenance of the KNX integration and further streamline the user experience. + +KNX is a home automation standard for commercial and residential building automation that works locally. It is mainly, but not exclusively, based on a central data cable which is generally installed when the house is being built. KNX also has extensions to work over radio frequencies or via IP infrastructure. KNX partners with hundreds of smart home manufacturers and thousands of installers. + +The KNX integration in Home Assistant allows users to use the power of Home Assistant to unify their KNX devices with other smart home devices and experience a beautiful user interface, powerful automations, and local voice control. Users can also configure Home Assistant to expose non-KNX devices back to the KNX network. + +
++ +Home Assistant introduced the KNX integration in [Home Assistant 0.24](/blog/2016/07/16/sqlalchemy-knx-join-simplisafe/) in July 2016. Since its introduction 7 years ago, the community has continued to evolve it. The development is currently led by [marvin-w](https://github.com/marvin-w) and [farmio](https://github.com/farmio), who brought the integration to a platinum quality level. + +It's a thrilling time with organizations like KNX prioritizing seamless Home Assistant integration and working directly with integration developers. We couldn’t be more happy with where things are heading. \ No newline at end of file diff --git a/source/help/reporting_issues.markdown b/source/help/reporting_issues.markdown index 9b6a60d1813..c07e5c9f4ca 100644 --- a/source/help/reporting_issues.markdown +++ b/source/help/reporting_issues.markdown @@ -4,36 +4,42 @@ description: "Reporting issues about Home Assistant" sidebar: false --- -If you have an installation, a setup or a configuration issue please use our [Forum](https://community.home-assistant.io/) to get help. We have a big community which will help you if they can. +If you have an installation, a setup or a configuration issue, please use our [Forum](https://community.home-assistant.io/) to get help. We have a big community which will help you if they can. -If you found a bug then please report it in one of our [trackers](/help/#bugs-feature-requests-and-alike). To help you and our developers to identify the issue quickly, please fill out the provided template. The "weird" content you will see is there to render your entry in a nice format after submitting. It's just [markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). +If you found a bug, then please report it in one of our [trackers](/help/#bugs-feature-requests-and-alike). To help you and our developers to identify the issue quickly, please fill out the provided template. The "weird" content you will see, is there to render your entry in a nice format after submitting. It's just [markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). -Please refer to the [**Settings** -> **About**](https://my.home-assistant.io/redirect/info/) page, which is accessible inside the Home Assistant frontend. +To see the version information, refer to the {% my info title="**Settings** > **About**" %} page. -## First Home Assistant release with the issue +## Description of the problem -Please provide the release which contains the issue. +Provide a summary of your issue and tell us what's wrong. Tell us what you were trying to do and what happened. + +There are integrations which require additional steps (installing third-party tools, compilers, etc.) to get your setup working. Please describe the steps you took and the ones to reproduce the issue if needed. + +## First Home Assistant version with the issue + +Please provide the version which contains the issue. You can find the version information under {% my system_health title="**Settings** > **System** > **Repairs** > Three dots in the upper right > **System information**" %}. ## Last working Home Assistant release (if known) -If possible, provide the latest release of which you know that the integration or platform was working. Home Assistant is evolving very fast and issues may already be addressed or be introduced by a recent change. +If possible, provide the latest release of which you know that the integration or platform was working. Home Assistant is evolving very fast and issues may already be addressed or be introduced by a recent change. You can find the detailed information about your system under {% my system_health title="**Settings** > **System** > **Repairs** > Three dots in the upper right > **System information**" %} ## Operating environment -There are many different ways to run Home Assistant. In this section please mention which you are using, e.g., Home Assistant (using the Home Assistant Operating System), Home Assistant Supervised, Home Assistant Core in Docker or a manual installation of the Home Assistant Core. It can help if you mention which operating system you are using because not all are supported on the same level. +There are many different ways to run Home Assistant. In this section, please mention which you are using: Home Assistant Operating System, Home Assistant Supervised, Home Assistant Core in Docker, or a manual installation of the Home Assistant Core. It would be helpful to mention which operating system you are using because not all are supported on the same level. You can find this information under {% my system_health title="**Settings** > **System** > **Repairs** > Three dots in the upper right > **System information**" %}. ## Integration -Please add the link to the documentation of the integration in question. E.g., +Please add the link to the documentation of the integration in question. For example: - Issue with the `random` sensor: [/integrations/random#sensor](/integrations/random#sensor). - Issue with the `hue` integration: [/integrations/hue/](/integrations/hue/). -### Description of problem +### Diagnostics information -Provide a summary of your issue and tell us what's wrong. +Consider uploading [the diagnostics file](/docs/configuration/troubleshooting/#debug-logs-and-diagnostics) along with your issue report to allow faster triaging and pinpointing the issue. +The information contained in the generated diagnostics file is redacted to avoid any sensitive information while still remaining useful for developers to fix the issue. -There are integrations and platform which require additional steps (installing third-party tools, compilers, etc.) to get your setup working. Please describe the steps you took and the ones to reproduce the issue if needed. ### Problem-relevant `configuration.yaml` entries @@ -46,15 +52,19 @@ sensor: Make sure that you don't post your username, password, API key, access token or other [secrets](/docs/configuration/secrets/). -### Traceback (if applicable) +### Traceback and log information (if applicable) -If things go wrong there will be a so-called traceback or an error message in other words in your log. Please include this. It starts with **Traceback** and can contain information where the error was triggered in the code. +If things go wrong, there will be a so-called traceback or an error message {% my logs title="in your log" %}. Please include this. It starts with **Traceback** and can contain information about where the error was triggered in the code. ```bash Traceback (most recent call last): ... ``` +In some cases, it is also necessary to [enable debug logging](/docs/configuration/troubleshooting/#debug-logs-and-diagnostics) to get detailed logs to triage an issue. +Enabling this will instruct Home Assistant to log a lot of fine-grained information about the integration. This is helpful for debugging and fixing the issue. +In contrast to the diagnostics information, debug logs are not automatically redacted. Make sure to include only the parts you think are relevant to the issue. + ### Additional information This section can contain additional details or other observation. Often the little things can help as well. diff --git a/source/images/blog/2023-06-27-knx-collaboration/panel.png b/source/images/blog/2023-06-27-knx-collaboration/panel.png new file mode 100644 index 00000000000..bfa76f01333 Binary files /dev/null and b/source/images/blog/2023-06-27-knx-collaboration/panel.png differ diff --git a/source/images/blog/2023-06-27-knx-collaboration/social.png b/source/images/blog/2023-06-27-knx-collaboration/social.png new file mode 100644 index 00000000000..08bf71aa786 Binary files /dev/null and b/source/images/blog/2023-06-27-knx-collaboration/social.png differ diff --git a/source/images/integrations/homekit_controller/homekit_controller_add_01.png b/source/images/integrations/homekit_controller/homekit_controller_add_01.png new file mode 100644 index 00000000000..10118a813ae Binary files /dev/null and b/source/images/integrations/homekit_controller/homekit_controller_add_01.png differ diff --git a/source/images/integrations/homekit_controller/homekit_controller_add_02.png b/source/images/integrations/homekit_controller/homekit_controller_add_02.png new file mode 100644 index 00000000000..0c4b0c98d77 Binary files /dev/null and b/source/images/integrations/homekit_controller/homekit_controller_add_02.png differ diff --git a/source/images/integrations/homekit_controller/homekit_controller_add_03.png b/source/images/integrations/homekit_controller/homekit_controller_add_03.png new file mode 100644 index 00000000000..5accfe50571 Binary files /dev/null and b/source/images/integrations/homekit_controller/homekit_controller_add_03.png differ diff --git a/source/images/integrations/tuya/image_002new.png b/source/images/integrations/tuya/image_002new.png new file mode 100644 index 00000000000..36395a442de Binary files /dev/null and b/source/images/integrations/tuya/image_002new.png differ diff --git a/source/images/integrations/zone/zone_edit_ui.png b/source/images/integrations/zone/zone_edit_ui.png index 6fb770a5912..622dc608e18 100644 Binary files a/source/images/integrations/zone/zone_edit_ui.png and b/source/images/integrations/zone/zone_edit_ui.png differ diff --git a/source/voice_control/apple.markdown b/source/voice_control/apple.markdown index 547d726c699..701efa4b1ae 100644 --- a/source/voice_control/apple.markdown +++ b/source/voice_control/apple.markdown @@ -40,7 +40,7 @@ You can import the button shortcut multiple times to create versions for differe ## Multiple servers -The Assist shortcut works also if you have configured multiple Home Assistant servers. By default it will prompt you to pick the server to sent the command too. This is not very hands-off, and so you can update the shortcut to point at a specific server. You will need to import the shortcuts multiple times, once for each server. +The Assist shortcut works also if you have configured multiple Home Assistant servers. By default it will prompt you to pick the server to sent the command to. This is not very hands-off, and so you can update the shortcut to point at a specific server. You will need to import the shortcuts multiple times, once for each server. Open the shortcuts app and edit each Assist shortcut. The text in quotes will be shown in the language of your device. diff --git a/source/voice_control/builtin_sentences.markdown b/source/voice_control/builtin_sentences.markdown index a5b14f961d1..0197eeaf27e 100644 --- a/source/voice_control/builtin_sentences.markdown +++ b/source/voice_control/builtin_sentences.markdown @@ -55,6 +55,6 @@ To get an idea of the specific sentences that are supported for your language, y * () mean alternative elements. * [] mean optional elements. * <> mean an expansion rule. The view these rules, search for `expansion_rules` in the [_common.yaml](https://github.com/home-assistant/intents/blob/main/sentences/en/_common.yaml) file. - * The syntax is explained in detail in the [template sentence syntax documentation](https://developers.home-assistant.io/docs/voice_control/intent-recognition/template-sentence-syntax). + * The syntax is explained in detail in the [template sentence syntax documentation](https://developers.home-assistant.io/docs/voice/intent-recognition/template-sentence-syntax/). diff --git a/source/voice_control/thirteen-usd-voice-remote.markdown b/source/voice_control/thirteen-usd-voice-remote.markdown index 204ce205f1e..614149ffb1a 100644 --- a/source/voice_control/thirteen-usd-voice-remote.markdown +++ b/source/voice_control/thirteen-usd-voice-remote.markdown @@ -29,7 +29,7 @@ Before you can use this device with Home Assistant, you need to install a bit of
-
-
- Green: Power -
- Red: Disk usage +
- Red: Power +
- Green: Disk usage
- Yellow: Home Assistant system state