Screenshot of Home Assistant's Developer Tools.
Screenshot of Home Assistant's Developer Tools.
` | Defines a paragraph.
-`
-At this time it is not yet possible to share a device from Home Assistant to another platform. This feature should be added after the Matter SDK 1.1 is released.
-
You must include either `topic` or `topic_template`, but not both. If providing a payload, you need to include either `payload` or `payload_template`, but not both.
@@ -919,10 +922,10 @@ retain: true
Listen to the specified topic matcher and dumps all received messages within a specific duration into the file `mqtt_dump.txt` in your configuration folder. This is useful when debugging a problem.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `topic` | no | Topic to dump. Can contain a wildcard (`#` or `+`).
-| `duration` | yes | Duration in seconds that we will listen for messages. Default is 5 seconds.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------------------------- |
+| `topic` | no | Topic to dump. Can contain a wildcard (`#` or `+`). |
+| `duration` | yes | Duration in seconds that we will listen for messages. Default is 5 seconds. |
```yaml
topic: openzwave/#
diff --git a/source/_integrations/myq.markdown b/source/_integrations/myq.markdown
index 14028bc5a3e..560fc428e26 100644
--- a/source/_integrations/myq.markdown
+++ b/source/_integrations/myq.markdown
@@ -9,7 +9,6 @@ ha_release: 0.39
ha_iot_class: Cloud Polling
ha_config_flow: true
ha_codeowners:
- - '@bdraco'
- '@ehendrix23'
ha_domain: myq
ha_homekit: true
diff --git a/source/_integrations/mysensors.markdown b/source/_integrations/mysensors.markdown
index 72480e5a412..4b570f6f400 100644
--- a/source/_integrations/mysensors.markdown
+++ b/source/_integrations/mysensors.markdown
@@ -189,7 +189,7 @@ Visit the [library API][MySensors library api] of MySensors for more information
The following binary sensor types are supported:
-#### MySensors version 1.4 and higher
+### MySensors version 1.4 and higher
| S_TYPE | V_TYPE |
| -------- | --------- |
@@ -197,7 +197,7 @@ The following binary sensor types are supported:
| S_MOTION | V_TRIPPED |
| S_SMOKE | V_TRIPPED |
-#### MySensors version 1.5 and higher
+### MySensors version 1.5 and higher
| S_TYPE | V_TYPE |
| ------------ | --------- |
@@ -207,7 +207,7 @@ The following binary sensor types are supported:
| S_VIBRATION | V_TRIPPED |
| S_MOISTURE | V_TRIPPED |
-#### Binary Sensor example sketch
+### Binary Sensor example sketch
```cpp
/**
@@ -259,7 +259,7 @@ void loop()
The following actuator types are supported:
-#### MySensors version 1.5 and higher
+### MySensors version 1.5 and higher
| S_TYPE | V_TYPE |
| ------ | ------------------------------------------------------------------------------------ |
@@ -282,7 +282,7 @@ You can use V_HVAC_SPEED to control the Speed setting of the Fan in the HVAC.
You can use V_TEMP to send the current temperature from the node to Home Assistant.
-#### Climate example sketch for MySensors 2.x
+### Climate example sketch for MySensors 2.x
```cpp
/*
@@ -462,13 +462,13 @@ void sendHeatpumpCommand() {
The following actuator types are supported:
-#### MySensors version 1.4
+### MySensors version 1.4
| S_TYPE | V_TYPE |
| ------- | ------------------------------------------- |
| S_COVER | V_UP, V_DOWN, V_STOP, [V_DIMMER or V_LIGHT] |
-#### MySensors version 1.5 and higher
+### MySensors version 1.5 and higher
| S_TYPE | V_TYPE |
| ------- | ------------------------------------------------ |
@@ -476,7 +476,7 @@ The following actuator types are supported:
All V_TYPES above are required. Use V_PERCENTAGE (or V_DIMMER) if you know the exact position of the cover in percent, use V_STATUS (or V_LIGHT) if you don't.
-#### Cover example sketch
+### Cover example sketch
```cpp
/*
@@ -608,13 +608,13 @@ This sketch is ideally for star topology wiring. You can run up to 12 covers wit
The following sensor types are supported:
-#### MySensors version 2.0 and higher
+### MySensors version 2.0 and higher
| S_TYPE | V_TYPE |
| ------ | ---------- |
| S_GPS | V_POSITION |
-#### Device Tracker example sketch for MySensors 2.x
+### Device Tracker example sketch for MySensors 2.x
```cpp
/**
@@ -691,13 +691,13 @@ void loop()
The following actuator types are supported:
-#### MySensors version 1.4
+### MySensors version 1.4
| S_TYPE | V_TYPE |
| -------- | --------------------- |
| S_DIMMER | V_DIMMER\*, V_LIGHT\* |
-#### MySensors version 1.5 and higher
+### MySensors version 1.5 and higher
| S_TYPE | V_TYPE |
| ------------ | -------------------------------------------------------------- |
@@ -844,21 +844,21 @@ void send_status_message()
The following type combinations are supported:
-#### MySensors version 1.4 and higher
+### MySensors version 1.4 and higher
-| S_TYPE | V_TYPE |
-| -------- | ------------------ |
-| S_IR | V_IR_SEND, V_LIGHT |
+| S_TYPE | V_TYPE |
+| ------ | ------------------ |
+| S_IR | V_IR_SEND, V_LIGHT |
-#### MySensors version 1.5 and higher
+### MySensors version 1.5 and higher
-| S_TYPE | V_TYPE |
-| ------------ | --------------------- |
-| S_IR | V_IR_SEND, V_STATUS |
+| S_TYPE | V_TYPE |
+| ------ | ------------------- |
+| S_IR | V_IR_SEND, V_STATUS |
V_LIGHT or V_STATUS is required to report the on / off state of the remote. Use either V_LIGHT or V_STATUS depending on library version.
-#### IR transceiver example sketch
+### IR transceiver example sketch
```cpp
/*
@@ -934,7 +934,7 @@ void incomingMessage(const MyMessage &message) {
The following sensor types are supported:
-#### MySensors version 1.4 and higher
+### MySensors version 1.4 and higher
| S_TYPE | V_TYPE |
| ------------------ | -------------------------------------- |
@@ -968,7 +968,7 @@ The following sensor types are supported:
| S_AIR_QUALITY | V_LEVEL (replaces V_DUST_LEVEL) |
| S_DUST | V_LEVEL (replaces V_DUST_LEVEL) |
-#### MySensors version 2.0 and higher
+### MySensors version 2.0 and higher
| S_TYPE | V_TYPE |
| --------------- | ------------------------- |
@@ -984,7 +984,7 @@ Some sensor value types are not specific for a certain sensor type. These do not
By using V_UNIT_PREFIX, it's possible to set a custom unit for any sensor. The string value that is sent for V_UNIT_PREFIX will be used in preference to any other unit of measurement, for the defined sensors. V_UNIT_PREFIX can't be used as a stand-alone sensor value type. Sending a supported value type and value from the tables above is also required. V_UNIT_PREFIX is available with MySensors version 1.5 and later.
-#### Sensor example sketch for MySensors 2.x
+### Sensor example sketch for MySensors 2.x
```cpp
/**
@@ -1053,17 +1053,17 @@ void receive(const MyMessage &message) {
The following actuator types are supported:
-#### MySensors version 1.4 and higher
+### MySensors version 1.4 and higher
-| S_TYPE | V_TYPE |
-| -------- | ------------------ |
-| S_DOOR | V_ARMED |
-| S_MOTION | V_ARMED |
-| S_SMOKE | V_ARMED |
-| S_LIGHT | V_LIGHT |
-| S_LOCK | V_LOCK_STATUS |
+| S_TYPE | V_TYPE |
+| -------- | ------------- |
+| S_DOOR | V_ARMED |
+| S_MOTION | V_ARMED |
+| S_SMOKE | V_ARMED |
+| S_LIGHT | V_LIGHT |
+| S_LOCK | V_LOCK_STATUS |
-#### MySensors version 1.5 and higher
+### MySensors version 1.5 and higher
| S_TYPE | V_TYPE |
| ------------ | --------------------- |
@@ -1075,7 +1075,7 @@ The following actuator types are supported:
| S_VIBRATION | V_ARMED |
| S_MOISTURE | V_ARMED |
-#### MySensors version 2.0 and higher
+### MySensors version 2.0 and higher
| S_TYPE | V_TYPE |
| --------------- | -------- |
@@ -1083,7 +1083,7 @@ The following actuator types are supported:
All V_TYPES for each S_TYPE above are required to activate the actuator for the platform. Use either V_LIGHT or V_STATUS depending on library version for cases where that V_TYPE is required.
-#### Switch example sketch
+### Switch example sketch
```cpp
/*
@@ -1133,13 +1133,13 @@ void incomingMessage(const MyMessage &message)
The following sensor types are supported:
-#### MySensors version 2.0 and higher
+### MySensors version 2.0 and higher
| S_TYPE | V_TYPE |
| ------ | ------ |
| S_INFO | V_TEXT |
-#### Text example sketch
+### Text example sketch
```cpp
/*
diff --git a/source/_integrations/mystrom.markdown b/source/_integrations/mystrom.markdown
index 8004ca711f2..7e1fcc6aaae 100644
--- a/source/_integrations/mystrom.markdown
+++ b/source/_integrations/mystrom.markdown
@@ -18,7 +18,6 @@ ha_platforms:
ha_integration_type: integration
---
-
There is currently support for the following device types within Home Assistant:
- [Lights and switches](#lights-and-switches)
@@ -27,7 +26,15 @@ There is currently support for the following device types within Home Assistant:
## Lights and switches
-The myStrom integration allows you to control your [myStrom](https://mystrom.ch/) WiFi Bulbs and WiFi Switches. Make sure that you have enabled the REST API under **Advanced** in the web frontend of the switch.
+The myStrom integration allows you to control your [myStrom](https://mystrom.ch/) Wi-Fi Bulbs and Wi-Fi Switches. Make sure that you have enabled the REST API under **Advanced** in the web frontend of the switch.
+
+Supported devices are:
+ - Switch CH v1 (101)
+ - Bulb (102)
+ - LED strip (105)
+ - Switch CH v2 (106)
+ - Switch EU (107)
+ - Switch Zero (120)
{%include integrations/config_flow.md %}
@@ -130,4 +137,3 @@ curl -d "double=get://192.168.1.3:8123/api/mystrom?api_password%3Dapi_password%2
The command-line tool [`mystrom`](https://github.com/fabaff/python-mystrom) is a helper to configure myStrom buttons.
If you have set [`login_attempts_threshold`](/integrations/http/) and forget to include the `api_password` for an action and that action is triggered then after the threshold is reached will the button no longer work because it is banned. See [IP filtering and banning](/integrations/http/#ip-filtering-and-banning) about how to revert the banning.
-
diff --git a/source/_integrations/ness_alarm.markdown b/source/_integrations/ness_alarm.markdown
index e15bd605e7e..ddd35b8dd6a 100644
--- a/source/_integrations/ness_alarm.markdown
+++ b/source/_integrations/ness_alarm.markdown
@@ -86,7 +86,7 @@ zones:
type: string
{% endconfiguration %}
-#### Time period dictionary example
+### Time period dictionary example
```yaml
scan_interval:
diff --git a/source/_integrations/nest.markdown b/source/_integrations/nest.markdown
index 1ccf4147ffe..8e510ee6578 100644
--- a/source/_integrations/nest.markdown
+++ b/source/_integrations/nest.markdown
@@ -55,10 +55,10 @@ Adding Nest to your Home Assistant instance can be done via the user interface,
{% details "Manual configuration steps" %}
1. Browse to your Home Assistant instance.
-1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
-1. In the bottom right corner, select the
+2. Go to **{% my integrations title="Settings > Devices & Services" %}**.
+3. In the bottom right corner, select the
**{% my config_flow_start icon domain=page.ha_domain %}** button.
-1. From the list, select **Nest** and follow the instructions on screen.
+4. From the list, select **Nest** and follow the instructions on screen.
{% enddetails %}
@@ -70,23 +70,23 @@ By the end of this section you will have a Cloud Project with the necessary APIs
1. Go to the [Google Cloud Console](https://console.developers.google.com/apis/credentials).
-1. If this is your first time here, you likely need to create a new Google Cloud project. Click **Create Project** then **New
+2. If this is your first time here, you likely need to create a new Google Cloud project. Click **Create Project** then **New
Project**.
-1. Give your Cloud Project a name then click **Create**.
+3. Give your Cloud Project a name then click **Create**.
-1. You will need to hold on to your *Cloud Project ID* to enable a subscription to receive updates from devices. Visit the [Cloud Console](https://console.cloud.google.com/home/dashboard) and copy the *Project ID* needed by Home Assistant.
+4. You will need to hold on to your *Cloud Project ID* to enable a subscription to receive updates from devices. Visit the [Cloud Console](https://console.cloud.google.com/home/dashboard) and copy the *Project ID* needed by Home Assistant.
-1. Go to [APIs & Services > Library](https://console.cloud.google.com/apis/library) where you can enable APIs.
+5. Go to [APIs & Services > Library](https://console.cloud.google.com/apis/library) where you can enable APIs.
-1. From the API Library search for [Smart Device management](https://console.cloud.google.com/apis/library/smartdevicemanagement.googleapis.com) and click **Enable**.
+6. From the API Library search for [Smart Device management](https://console.cloud.google.com/apis/library/smartdevicemanagement.googleapis.com) and click **Enable**.
-1. From the API Library search for [Cloud Pub/Sub API](https://console.developers.google.com/apis/library/pubsub.googleapis.com) in the Cloud Console and click **Enable**.
+7. From the API Library search for [Cloud Pub/Sub API](https://console.developers.google.com/apis/library/pubsub.googleapis.com) in the Cloud Console and click **Enable**.
You now have a cloud project ready for the next section to configure authentication with OAuth.
@@ -99,25 +99,25 @@ your cloud project.
1. Go to the [Google API Console](https://console.developers.google.com/apis/credentials).
-1. Click [OAuth consent screen](https://console.cloud.google.com/apis/credentials/consent) and configure it.
+2. Click [OAuth consent screen](https://console.cloud.google.com/apis/credentials/consent) and configure it.
-1. Select **External** (the only choice if you are not a G-Suite user) then click **Create**. While you are here, you may click the *Let us know what you think* to give Google's OAuth team any feedback about your experience configuring credentials for self-hosted software. They make regular improvements to this flow and appear to value feedback.
+3. Select **External** (the only choice if you are not a G-Suite user) then click **Create**. While you are here, you may click the *Let us know what you think* to give Google's OAuth team any feedback about your experience configuring credentials for self-hosted software. They make regular improvements to this flow and appear to value feedback.
-1. The *App Information* screen needs you to enter an **App name** and **User support email**, then enter your email again under **Developer contact email**. These are only shown while you later go through the OAuth flow to authorize Home Assistant to access your account. Click **Save and Continue**. Omit unnecessary information (e.g. logo) to avoid additional review by Google.
+4. The *App Information* screen needs you to enter an **App name** and **User support email**, then enter your email again under **Developer contact email**. These are only shown while you later go through the OAuth flow to authorize Home Assistant to access your account. Click **Save and Continue**. Omit unnecessary information (e.g. logo) to avoid additional review by Google.
-1. On the *Scopes* step click **Save and Continue**.
+5. On the *Scopes* step click **Save and Continue**.
-1. On the *Test Users* step, you need to add your Google Account (e.g., your @gmail.com address) to the list. Click *Save* on your test account then **Save and Continue** to finish the consent flow.
+6. On the *Test Users* step, you need to add your Google Account (e.g., your @gmail.com address) to the list. Click *Save* on your test account then **Save and Continue** to finish the consent flow.
-1. Navigate back to the *OAuth consent screen* and click **Publish App** to set the *Publishing status* is **In Production**.
+7. Navigate back to the *OAuth consent screen* and click **Publish App** to set the *Publishing status* is **In Production**.
-1. The warning says your *app will be available to any user with a Google Account* which refers to the fields you entered on the *App Information* screen if someone finds the URL. This does not expose your Google Account or Nest data.
+8. The warning says your *app will be available to any user with a Google Account* which refers to the fields you entered on the *App Information* screen if someone finds the URL. This does not expose your Google Account or Nest data.
-1. Make sure the status is not *Testing*, or you will get logged out every 7 days.
+9. Make sure the status is not *Testing*, or you will get logged out every 7 days.
{% enddetails %}
@@ -130,23 +130,23 @@ The steps below use *Web Application Auth* with *My Home Assistant* to handle Go
1. Navigate to the [Credentials](https://console.cloud.google.com/apis/credentials) page and click **Create Credentials**.
-1. From the drop-down list select *OAuth client ID*.
+2. From the drop-down list select *OAuth client ID*.
-1. Enter *Web Application* for the Application type.
+3. Enter *Web Application* for the Application type.
-1. Pick a name for your credential.
+4. Pick a name for your credential.
-1. Add **Authorized redirect URIs** end enter `https://my.home-assistant.io/redirect/oauth`
+5. Add **Authorized redirect URIs** end enter `https://my.home-assistant.io/redirect/oauth`
-1. Click *Create* to create the credential.
+6. Click *Create* to create the credential.
-1. You should now be presented with an *OAuth client created* message.
+7. You should now be presented with an *OAuth client created* message.
-1. You now have *OAuth Client ID* and *OAuth Client Secret* needed by Home Assistant. See [Application Credentials](/integrations/application_credentials) for more general detail about how Home Assistant manages credentials.
+8. You now have *OAuth Client ID* and *OAuth Client Secret* needed by Home Assistant. See [Application Credentials](/integrations/application_credentials) for more general detail about how Home Assistant manages credentials.
{% enddetails %}
@@ -157,25 +157,25 @@ Now that you have authentication configured, you will create a Nest Device Acces
1. Go to the [Device Access Registration](https://developers.google.com/nest/device-access/registration) page. Click on the button **[Go to the Device Access Console](https://console.nest.google.com/device-access/)**.
-1. Check the box to "Accept the Terms of Service" and click **Continue to Payment** where you need to pay a fee (currently US$5).
+2. Check the box to "Accept the Terms of Service" and click **Continue to Payment** where you need to pay a fee (currently US$5).
While your Z-Wave mesh is permanently stored on your dongle, the additional metadata is not. When the Z-Wave integration starts up the first time, it will interview your entire Z-Wave network. Depending on the number of devices paired with the Z-Wave dongle, this can take a while. You can speed up this process by manually waking up your battery-powered devices. Most of the time, this is a button press on those devices (see their manual). It is not necessary to exclude and re-include devices from the mesh.
@@ -99,30 +99,30 @@ While your Z-Wave mesh is permanently stored on your dongle, the additional meta
### Adding a new device to the Z-Wave network
1. In Home Assistant, go to {% my integrations title="**Settings** > **Devices & Services**" %}.
-1. In the Z-Wave integration, select the cogwheel, then select **Configure**.
-1. Select **Add device**.
- * The Z-Wave controller is now in inclusion mode.
-1. If your device supports SmartStart (700 series controller), select **Scan QR code** and scan the QR code on your device.
-1. If your device does not support SmartStart, set the device in inclusion mode. Refer to the device manual to see how this is done.
- * If your device is included using S2 security, you may be prompted to enter a PIN number provided with your device. Often, this PIN is provided with the documentation _and_ is also printed on the device itself. For more information on secure inclusion, refer to [this section](/integrations/zwave_js/#should-i-use-secure-inclusion).
-1. The UI should confirm that the device was added. After a short while (seconds to minutes), the entities should also be created.
-1. If the controller fails to add/find your device, cancel the inclusion process.
- * In some cases, it might help to first [remove](/integrations/zwave_js/#removing-a-device-from-the-z-wave-network) a device (exclusion) before you add it, even when the device has not been added to this Z-Wave network yet.
- * Another approach would be to factory reset the device. Refer to the device manual to see how this is done.
+2. Select the Z-Wave integration. Then select **Configure**.
+3. Select **Add device**.
+ - The Z-Wave controller is now in inclusion mode.
+4. If your device supports SmartStart (700 series controller), select **Scan QR code** and scan the QR code on your device.
+5. If your device does not support SmartStart, set the device in inclusion mode. Refer to the device manual to see how this is done.
+ - If your device is included using S2 security, you may be prompted to enter a PIN number provided with your device. Often, this PIN is provided with the documentation _and_ is also printed on the device itself. For more information on secure inclusion, refer to [this section](/integrations/zwave_js/#should-i-use-secure-inclusion).
+6. The UI should confirm that the device was added. After a short while (seconds to minutes), the entities should also be created.
+7. If the controller fails to add/find your device, cancel the inclusion process.
+ - In some cases, it might help to first [remove](/integrations/zwave_js/#removing-a-device-from-the-z-wave-network) a device (exclusion) before you add it, even when the device has not been added to this Z-Wave network yet.
+ - Another approach would be to factory reset the device. Refer to the device manual to see how this is done.
**Important:**
1. **Do not move your Z-Wave stick to include devices.** This is no longer necessary and leads to broken routes.
-1. **Do not initiate device inclusion from the Z-Wave stick itself.** This is no longer supported.
+2. **Do not initiate device inclusion from the Z-Wave stick itself.** This is no longer supported.
### Removing a device from the Z-Wave network
1. In Home Assistant, go to {% my integrations title="**Settings** > **Devices & Services**" %}.
-1. In the Z-Wave integration, select the cogwheel, then select **Configure**.
-1. Select **Remove device**, then **Start exclusion**.
- * The Z-Wave controller is now in exclusion mode.
-1. Put the device you want to remove in exclusion mode. Refer to its manual how this is done.
-1. The UI should confirm that the device was removed and the device and entities will be removed from Home Assistant.
+2. Select the **Z-Wave** integration. Then, select **Configure**.
+3. Select **Remove device**, then **Start exclusion**.
+ - The Z-Wave controller is now in exclusion mode.
+4. Put the device you want to remove in exclusion mode. Refer to its manual how this is done.
+5. The UI should confirm that the device was removed and the device and entities will be removed from Home Assistant.
## Special Z-Wave entities
@@ -150,18 +150,18 @@ The following features can be accessed from the integration configuration panel:
-* **Add device:** Allows you to pre-provision a SmartStart device or start the inclusion process for adding a new device to your network.
-* **Remove device:** Starts the exclusion process for removing a device from your network.
-* **Heal network:** Forces your network to rediscover routes to the controller from each device. This is useful when devices or the controller have moved to a new location, or if you are having significant problems with your network, but it also generates a lot of network traffic and should be used sparingly.
-* **[Controller statistics](https://zwave-js.github.io/node-zwave-js/#/api/controller?id=quotstatistics-updatedquot):** Provides statistics about communication between the controller and other devices, allowing you to troubleshoot your network's RF quality.
-* **Third-party data opt-in/out:** Allows you to opt-in or out of telemetry that the Z-Wave JS project collects to help inform development decisions, influence manufacturers, etc. This telemetry is disabled by default and has to be opted in to be activated.
+- **Add device:** Allows you to pre-provision a SmartStart device or start the inclusion process for adding a new device to your network.
+- **Remove device:** Starts the exclusion process for removing a device from your network.
+- **Heal network:** Forces your network to rediscover routes to the controller from each device. This is useful when devices or the controller have moved to a new location, or if you are having significant problems with your network, but it also generates a lot of network traffic and should be used sparingly.
+- **[Controller statistics](https://zwave-js.github.io/node-zwave-js/#/api/controller?id=quotstatistics-updatedquot):** Provides statistics about communication between the controller and other devices, allowing you to troubleshoot your network's RF quality.
+- **Third-party data opt-in/out:** Allows you to opt-in or out of telemetry that the Z-Wave JS project collects to help inform development decisions, influence manufacturers, etc. This telemetry is disabled by default and has to be opted in to be activated.
### Integration menu
Some features can be accessed from the menu of integration itself. As they are not specific to Z-Wave, they are not described here in detail.
-* **[Download diagnostics](/docs/configuration/troubleshooting/#download-diagnostics):** Exports a JSON file describing the entities of all devices registered with this integration.
+- **[Download diagnostics](/docs/configuration/troubleshooting/#download-diagnostics):** Exports a JSON file describing the entities of all devices registered with this integration.
### Device panel
@@ -169,13 +169,13 @@ The following features can be accessed from the device panel of a Z-Wave device:
-* **Configure:** Provides an easy way to look up and update configuration parameters for the device. While there is an existing service for setting configuration parameter values, this UI may sometimes be quicker to use for one-off changes.
-* **Re-interview:** Forces the device to go through the interview process again so that Z-Wave-JS can discover all of its capabilities. Can be helpful if you don't see all the expected entities for your device.
-* **Heal:** Forces the device to rediscover its optimal route back to the controller. Use this if you think you are experiencing unexpected delays or RF issues with your device. Your device may be less responsive during this process.
-* **Remove failed:** Forces the controller to remove the device from the controller. Can be used when a device has failed and it can't go through the normal exclusion process.
-* **[Statistics](https://zwave-js.github.io/node-zwave-js/#/api/node?id=quotstatistics-updatedquot):** Provides statistics about communication between this device and the controller, allowing you to troubleshoot RF issues with the device.
-* **Update:** Updates a device's firmware using a manually uploaded firmware file. Only some devices support this feature (controllers and devices with the Firmware Update Metadata Command Class).
-* **Download diagnostics:** Exports a JSON file describing the entities of this specific device.
+- **Configure:** Provides an easy way to look up and update configuration parameters for the device. While there is an existing service for setting configuration parameter values, this UI may sometimes be quicker to use for one-off changes.
+- **Re-interview:** Forces the device to go through the interview process again so that Z-Wave-JS can discover all of its capabilities. Can be helpful if you don't see all the expected entities for your device.
+- **Heal:** Forces the device to rediscover its optimal route back to the controller. Use this if you think you are experiencing unexpected delays or RF issues with your device. Your device may be less responsive during this process.
+- **Remove failed:** Forces the controller to remove the device from the controller. Can be used when a device has failed and it can't go through the normal exclusion process.
+- **[Statistics](https://zwave-js.github.io/node-zwave-js/#/api/node?id=quotstatistics-updatedquot):** Provides statistics about communication between this device and the controller, allowing you to troubleshoot RF issues with the device.
+- **Update:** Updates a device's firmware using a manually uploaded firmware file. Only some devices support this feature (controllers and devices with the Firmware Update Metadata Command Class).
+- **Download diagnostics:** Exports a JSON file describing the entities of this specific device.
## Services
@@ -183,14 +183,14 @@ The following features can be accessed from the device panel of a Z-Wave device:
This service will update a configuration parameter. To update multiple partial parameters in a single call, use the `zwave_js.bulk_set_partial_config_parameters` service.
-| Service Data Attribute | Required | Description |
-|------------------------ |----------- |------------------------------------------------------------------------------------------------------------------------------------------- |
-| `entity_id` | no | Entity (or list of entities) to set the configuration parameter on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
-| `device_id` | no | Device ID (or list of device IDs) to set the configuration parameter on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
-| `area_id` | no | Area ID (or list of area IDs) for devices/entities to set the configuration parameter on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
-| `parameter` | yes | The parameter number or the name of the property. The name of the property is case sensitive. |
-| `bitmask` | no | The bitmask for a partial parameter in hex (0xff) or decimal (255) format. If the name of the parameter is provided, this is not needed. |
-| `value` | yes | The target value for the parameter as the integer value or the state label. The state label is case sensitive. |
+| Service Data Attribute | Required | Description |
+| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | no | Entity (or list of entities) to set the configuration parameter on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
+| `device_id` | no | Device ID (or list of device IDs) to set the configuration parameter on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
+| `area_id` | no | Area ID (or list of area IDs) for devices/entities to set the configuration parameter on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
+| `parameter` | yes | The parameter number or the name of the property. The name of the property is case sensitive. |
+| `bitmask` | no | The bitmask for a partial parameter in hex (0xff) or decimal (255) format. If the name of the parameter is provided, this is not needed. |
+| `value` | yes | The target value for the parameter as the integer value or the state label. The state label is case sensitive. |
#### Examples of setting a single parameter value
@@ -236,13 +236,13 @@ data:
This service will bulk set multiple partial configuration parameters. Be warned that correctly using this service requires advanced knowledge of Z-Wave to use correctly.
-| Service Data Attribute | Required | Description |
-|------------------------ |----------- |------------------------------------------------------------------------------------------------------------------------------------------- |
-| `entity_id` | no | Entity (or list of entities) to bulk set partial configuration parameters on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
-| `device_id` | no | Device ID (or list of device IDs) to bulk set partial configuration parameters on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
-| `area_id` | no | Area ID (or list of area IDs) for devices/entities to bulk set partial configuration parameters on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
-| `parameter` | yes | The parameter number of the property. The name of the property is case sensitive. |
-| `value` | yes | Either the raw integer value that you want to set for the entire parameter, or a dictionary where the keys are either the bitmasks (in integer or hex form) or the partial parameter name and the values are the value you want to set on each partial (either the integer value or a named state when applicable). Note that when using a dictionary, and bitmasks that are not provided will be set to their currently cached values. |
+| Service Data Attribute | Required | Description |
+| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | no | Entity (or list of entities) to bulk set partial configuration parameters on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
+| `device_id` | no | Device ID (or list of device IDs) to bulk set partial configuration parameters on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
+| `area_id` | no | Area ID (or list of area IDs) for devices/entities to bulk set partial configuration parameters on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
+| `parameter` | yes | The parameter number of the property. The name of the property is case sensitive. |
+| `value` | yes | Either the raw integer value that you want to set for the entire parameter, or a dictionary where the keys are either the bitmasks (in integer or hex form) or the partial parameter name and the values are the value you want to set on each partial (either the integer value or a named state when applicable). Note that when using a dictionary, and bitmasks that are not provided will be set to their currently cached values. |
#### Examples of bulk setting partial parameter values
@@ -325,68 +325,68 @@ data:
This service will refresh the value(s) for an entity. This service will generate extra traffic on your Z-Wave network and should be used sparingly. Updates from devices on battery may take some time to be received.
-| Service Data Attribute | Required | Description |
-|------------------------ |---------- |-------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `entity_id` | yes | Entity or list of entities to refresh values for. |
-| `refresh_all_values` | no | Whether all values should be refreshed. If `false`, only the primary value will be refreshed. If `true`, all watched values will be refreshed. |
+| Service Data Attribute | Required | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `entity_id` | yes | Entity or list of entities to refresh values for. |
+| `refresh_all_values` | no | Whether all values should be refreshed. If `false`, only the primary value will be refreshed. If `true`, all watched values will be refreshed. |
### Service `zwave_js.set_value`
This service will set a value on a Z-Wave device. It is for advanced use cases where you need to modify the state of a node and can't do it using native Home Assistant entity functionality. Be warned that correctly using this service requires advanced knowledge of Z-Wave. The service provides minimal validation and blindly calls the Z-Wave JS API, so if you are having trouble using it, it is likely because you are providing an incorrect value somewhere. To set a config parameter, you should use the `zwave_js.set_config_parameter` or `zwave_js.bulk_set_partial_config_parameters` services instead of this one.
-| Service Data Attribute | Required | Description |
-|------------------------ |---------- |-------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `entity_id` | no | Entity (or list of entities) to set the value on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
-| `device_id` | no | Device ID (or list of device IDs) to set the value on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
-| `area_id` | no | Area ID (or list of area IDs) for devices/entities to set the value on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
-| `command_class` | yes | ID of Command Class that you want to set the value for. |
-| `property` | yes | ID of Property that you want to set the value for. |
-| `property_key` | no | ID of Property Key that you want to set the value for. |
-| `endpoint` | no | ID of Endpoint that you want to set the value for. |
-| `value` | yes | The new value that you want to set. |
-| `options` | no | Set value options map. Refer to the Z-Wave JS documentation for more information on what options can be set. |
-| `wait_for_result` | no | Boolean that indicates whether or not to wait for a response from the node. If not included in the payload, the integration will decide whether to wait or not. If set to `true`, note that the service call can take a while if setting a value on an asleep battery device. |
+| Service Data Attribute | Required | Description |
+| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | no | Entity (or list of entities) to set the value on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
+| `device_id` | no | Device ID (or list of device IDs) to set the value on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
+| `area_id` | no | Area ID (or list of area IDs) for devices/entities to set the value on. At least one `entity_id`, `device_id`, or `area_id` must be provided. |
+| `command_class` | yes | ID of Command Class that you want to set the value for. |
+| `property` | yes | ID of Property that you want to set the value for. |
+| `property_key` | no | ID of Property Key that you want to set the value for. |
+| `endpoint` | no | ID of Endpoint that you want to set the value for. |
+| `value` | yes | The new value that you want to set. |
+| `options` | no | Set value options map. Refer to the Z-Wave JS documentation for more information on what options can be set. |
+| `wait_for_result` | no | Boolean that indicates whether or not to wait for a response from the node. If not included in the payload, the integration will decide whether to wait or not. If set to `true`, note that the service call can take a while if setting a value on an asleep battery device. |
### Service `zwave_js.multicast_set_value`
This service will set a value on multiple Z-Wave devices using multicast. It is for advanced use cases where you need to set the same value on multiple nodes simultaneously. Be warned that correctly using this service requires advanced knowledge of Z-Wave. The service provides minimal validation beyond what is necessary to properly call the Z-Wave JS API, so if you are having trouble using it, it is likely because you are providing an incorrect value somewhere.
-| Service Data Attribute | Required | Description |
-|------------------------ |---------- |-------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `entity_id` | no | Entity (or list of entities) to set the value on via multicast. At least two `entity_id` or `device_id` must be resolved if not broadcasting the command. |
-| `device_id` | no | Device ID (or list of device IDs) to set the value on via multicast. At least two `entity_id` or `device_id` must be resolved if not broadcasting the command. |
-| `area_id` | no | Area ID (or list of area IDs) for devices/entities to set the value on via multicast. At least two `entity_id` or `device_id` must be resolved if not broadcasting the command. |
-| `broadcast` | no | Boolean that indicates whether you want the message to be broadcast to all nodes on the network. If you have only one Z-Wave network configured, you do not need to provide a `device_id` or `entity_id` when this is set to true. When you have multiple Z-Wave networks configured, you MUST provide at least one `device_id` or `entity_id` so the service knows which network to target. |
-| `command_class` | yes | ID of Command Class that you want to set the value for. |
-| `property` | yes | ID of Property that you want to set the value for. |
-| `property_key` | no | ID of Property Key that you want to set the value for. |
-| `endpoint` | no | ID of Endpoint that you want to set the value for. |
-| `value` | yes | The new value that you want to set. |
-| `options` | no | Set value options map. Refer to the Z-Wave JS documentation for more information on what options can be set. |
+| Service Data Attribute | Required | Description |
+| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | no | Entity (or list of entities) to set the value on via multicast. At least two `entity_id` or `device_id` must be resolved if not broadcasting the command. |
+| `device_id` | no | Device ID (or list of device IDs) to set the value on via multicast. At least two `entity_id` or `device_id` must be resolved if not broadcasting the command. |
+| `area_id` | no | Area ID (or list of area IDs) for devices/entities to set the value on via multicast. At least two `entity_id` or `device_id` must be resolved if not broadcasting the command. |
+| `broadcast` | no | Boolean that indicates whether you want the message to be broadcast to all nodes on the network. If you have only one Z-Wave network configured, you do not need to provide a `device_id` or `entity_id` when this is set to true. When you have multiple Z-Wave networks configured, you MUST provide at least one `device_id` or `entity_id` so the service knows which network to target. |
+| `command_class` | yes | ID of Command Class that you want to set the value for. |
+| `property` | yes | ID of Property that you want to set the value for. |
+| `property_key` | no | ID of Property Key that you want to set the value for. |
+| `endpoint` | no | ID of Endpoint that you want to set the value for. |
+| `value` | yes | The new value that you want to set. |
+| `options` | no | Set value options map. Refer to the Z-Wave JS documentation for more information on what options can be set. |
### Service `zwave_js.invoke_cc_api`
Call this service to use the Command Class API directly. In most cases, the `zwave_js.set_value` service will accomplish what you need to, but some Command Classes have API commands that can't be accessed via that service. Refer to the [Z-Wave JS Command Class documentation](https://zwave-js.github.io/node-zwave-js/#/api/CCs/index) for the available APIs and arguments. Be sure to know what you are doing when calling this service.
-| Service Data Attribute | Required | Description |
-|------------------------ |---------- |-------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `entity_id` | no | Entity (or list of entities) to ping. At least one `entity_id`, `device_id`, or `area_id` must be provided. If `endpoint` is specified, that endpoint will be used to make the CC API call for all devices, otherwise the primary value endpoint will be used for each entity. |
-| `device_id` | no | Device ID (or list of device IDs) to ping. At least one `entity_id`, `device_id`, or `area_id` must be provided. If `endpoint` is specified, that endpoint will be used to make the CC API call for all devices, otherwise the root endpoint (0) will be used for each device. |
-| `area_id` | no | Area ID (or list of area IDs) for devices/entities to ping. At least one `entity_id`, `device_id`, or `area_id` must be provided. If `endpoint` is specified, that endpoint will be used to make the CC API call for all devices, otherwise the root endpoint (0) will be used for each `zwave_js` device in the area. |
-| `command_class` | yes | ID of Command Class that you want to set the value for. |
-| `endpoint` | no | The endpoint to call the CC API against. |
-| `method_name` | yes | The name of the method that is being called from the CC API. |
-| `parameters` | yes | A list of parameters to pass to the CC API method. |
+| Service Data Attribute | Required | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | no | Entity (or list of entities) to ping. At least one `entity_id`, `device_id`, or `area_id` must be provided. If `endpoint` is specified, that endpoint will be used to make the CC API call for all devices, otherwise the primary value endpoint will be used for each entity. |
+| `device_id` | no | Device ID (or list of device IDs) to ping. At least one `entity_id`, `device_id`, or `area_id` must be provided. If `endpoint` is specified, that endpoint will be used to make the CC API call for all devices, otherwise the root endpoint (0) will be used for each device. |
+| `area_id` | no | Area ID (or list of area IDs) for devices/entities to ping. At least one `entity_id`, `device_id`, or `area_id` must be provided. If `endpoint` is specified, that endpoint will be used to make the CC API call for all devices, otherwise the root endpoint (0) will be used for each `zwave_js` device in the area. |
+| `command_class` | yes | ID of Command Class that you want to set the value for. |
+| `endpoint` | no | The endpoint to call the CC API against. |
+| `method_name` | yes | The name of the method that is being called from the CC API. |
+| `parameters` | yes | A list of parameters to pass to the CC API method. |
### Service `zwave_js.reset_meter`
This service will reset the meters on a device that supports the Meter Command Class.
-| Service Data Attribute | Required | Description |
-| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
-| `entity_id` | yes | Entity (or list of entities) for the meters you want to reset. |
-| `meter_type` | no | If supported by the device, indicates the type of meter to reset. Not all devices support this option. |
-| `value` | no | If supported by the device, indicates the value to reset the meter to. Not all devices support this option. |
+| Service Data Attribute | Required | Description |
+| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
+| `entity_id` | yes | Entity (or list of entities) for the meters you want to reset. |
+| `meter_type` | no | If supported by the device, indicates the type of meter to reset. Not all devices support this option. |
+| `value` | no | If supported by the device, indicates the value to reset the meter to. Not all devices support this option. |
### Service `zwave_js.set_lock_usercode`
@@ -536,9 +536,9 @@ Due to some devices not following the Z-Wave Specification, there are scenarios
The following devices currently support this event:
-| Make | Model | Entity Domain |
-|----------------- |---------------------------------- |--------------- |
-| Vision Security | ZL7432 In Wall Dual Relay Switch | `switch` |
+| Make | Model | Entity Domain |
+| --------------- | -------------------------------- | ------------- |
+| Vision Security | ZL7432 In Wall Dual Relay Switch | `switch` |
Value Updated example:
@@ -613,7 +613,7 @@ trigger:
In addition to the [standard automation trigger data](/docs/automation/templating/#all), the `zwave_js.value_updated` trigger platform has additional trigger data available for use.
| Template variable | Data |
-|------------------------------|--------------------------------------------------------------------------------------------|
+| ---------------------------- | ------------------------------------------------------------------------------------------ |
| `trigger.device_id` | Device ID for the device in the device registry. |
| `trigger.node_id` | Z-Wave node ID. |
| `trigger.command_class` | Command class ID. |
@@ -660,13 +660,13 @@ trigger:
In addition to the [standard automation trigger data](/docs/automation/templating/#all), the `zwave_js.event` trigger platform has additional trigger data available for use.
-| Template variable | Data |
-|------------------------------|--------------------------------------------------------------------------------------------|
-| `trigger.device_id` | Device ID for the device in the device registry (only included for node events). |
-| `trigger.node_id` | Z-Wave node ID (only included for node events). |
-| `trigger.event_source` | Source of event (node, controller, or driver). |
-| `trigger.event` | Name of event. |
-| `trigger.event_data` | Any data included in the event. |
+| Template variable | Data |
+| ---------------------- | -------------------------------------------------------------------------------- |
+| `trigger.device_id` | Device ID for the device in the device registry (only included for node events). |
+| `trigger.node_id` | Z-Wave node ID (only included for node events). |
+| `trigger.event_source` | Source of event (node, controller, or driver). |
+| `trigger.event` | Name of event. |
+| `trigger.event_data` | Any data included in the event. |
## Advanced installation instructions
@@ -674,7 +674,7 @@ If you are using Home Assistant Container, Home Assistant Core, or you don't wan
### Running [Z-Wave JS Server](https://github.com/zwave-js/zwave-js-server)
-This application provides the connection between your Z-Wave USB stick and Home Assistant. The Home Assistant Z-Wave integration connects to this server via a websocket connection. You need to run this Z-Wave JS server before you can use the integration.
+This application provides the connection between your Z-Wave USB stick and Home Assistant. The Home Assistant Z-Wave integration connects to this server via a WebSocket connection. You need to run this Z-Wave JS server before you can use the integration.
There are multiple ways to run this server:
The chart below illustrates Options 1 and 2, which are available for Home Assistant OS only.
@@ -725,7 +725,7 @@ Once you have the Z-Wave JS server up and running, you need to install and confi
If you're running full Home Assistant with supervisor, you will be presented with a dialog that asks if you want to use the Z-Wave JS Supervisor add-on. You **must** uncheck this box if you are running the Z-Wave JS server in any manner other than the official Z-Wave JS add-on, including using Z-Wave JS UI add-on.
-If you're not running the supervisor or you've unchecked the above-mentioned box, you will be asked to enter a websocket URL (defaults to ws://localhost:3000). It is very important that you fill in the correct (Docker) IP/hostname here. For example for the Z-Wave JS UI add-on this is `ws://a0d7b954-zwavejs2mqtt:3000`.
+If you're not running the supervisor or you've unchecked the above-mentioned box, you will be asked to enter a WebSocket URL (defaults to ws://localhost:3000). It is very important that you fill in the correct (Docker) IP/hostname here. For example for the Z-Wave JS UI add-on this is `ws://a0d7b954-zwavejs2mqtt:3000`.
## Frequently Asked Questions
@@ -749,12 +749,12 @@ For more information, see [Supported Z-Wave dongles](/docs/z-wave/controllers/#s
Some Z-Wave USB sticks can be auto-discovered, which can simplify the Z-Wave setup process. The following devices have been tested with discovery, and offer a quick setup experience; however, these are **not** all of the devices supported by Z-Wave:
-| Device | Identifier | Vendor |
-| -------| ---------- | ------ |
-| Aeotec Z-Stick Gen5+ | 0658:0200 |
+
+
+
+
+
+
+
+
+
2 _Options prefixed with `[CIFS]` are only available for CIFS targets._
3 _For the `CIFS` option, only version 2.1+ is supported._
-4 _Guest access is not supported. You need to supply a username and password to access the share._
##### Usage types
@@ -86,10 +85,10 @@ By default, the first network storage of type **Backup** that you add will be se
If you want to change the default backup target, you can do the following:
1. Go to **{% my backup title="Settings > System > Backups" %}** in the UI.
-1. Select the menu in the top right of the screen and select the **Change default backup location** option.
-1. In the dialog, there is a single option to set the default backup target.
-1. Choose the one you want from the list.
-1. Select **Save**.
+2. Select the menu in the top right of the screen and select the **Change default backup location** option.
+3. In the dialog, there is a single option to set the default backup target.
+4. Choose the one you want from the list.
+5. Select **Save**.
This list will contain all the network storage targets you have added of usage type **Backup**. It also contains another option to set it back to use `/backup` again.
diff --git a/source/_includes/common-tasks/update.md b/source/_includes/common-tasks/update.md
index af01fb90445..fed403108e6 100644
--- a/source/_includes/common-tasks/update.md
+++ b/source/_includes/common-tasks/update.md
@@ -3,11 +3,11 @@
Best practice for updating a Home Assistant installation:
1. Backup your installation{% if page.installation == "os" or page.installation == "supervised" %}, using the backup functionality Home Assistant offers{% endif %}.
-1. Check the release notes for breaking changes on [Home Assistant release notes](/blog/categories/core/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for **Breaking Changes**.
+2. Check the release notes for breaking changes on [Home Assistant release notes](/blog/categories/core/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for **Breaking Changes**.
{% if page.installation == "os" or page.installation == "supervised" %}
-1. Select "Create backup before updating" in case you encounter an issue that requires a rollback.
-1. Update Home Assistant.
-1. Review persistent notifications and log to see if there are any issues with your configuration that need to be addressed.
+3. Select "Create backup before updating" in case you encounter an issue that requires a rollback.
+4. Update Home Assistant.
+5. Review persistent notifications and log to see if there are any issues with your configuration that need to be addressed.
{% endif %}
{% if page.installation == "os" or page.installation == "supervised" %}
diff --git a/source/_includes/installation/container.md b/source/_includes/installation/container.md
index a8379be6a29..abf11f994d0 100644
--- a/source/_includes/installation/container.md
+++ b/source/_includes/installation/container.md
@@ -15,8 +15,8 @@ If you are using Docker then you need to be on at least version 19.03.9, ideally
Installation with Docker is straightforward. Adjust the following command so that:
-* `/PATH_TO_YOUR_CONFIG` points at the folder where you want to store your configuration and run it.
-* `MY_TIME_ZONE` is a [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), like `TZ=America/Los_Angeles`.
+- `/PATH_TO_YOUR_CONFIG` points at the folder where you want to store your configuration and run it.
+- `MY_TIME_ZONE` is a [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), like `TZ=America/Los_Angeles`.
{% endif %}
diff --git a/source/_includes/installation/operating_system.md b/source/_includes/installation/operating_system.md
index 276fc2d1fa3..f9cb5633e20 100644
--- a/source/_includes/installation/operating_system.md
+++ b/source/_includes/installation/operating_system.md
@@ -21,25 +21,25 @@ Home Assistant bundles (US market):
The bundles come with Home Assistant pre-installed.
-* [ODROID N2+: 2 GB RAM / 16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729286935?ref=eeb6nfw07e)
-* [ODROID N2+: 4 GB RAM / 64 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729221399?ref=eeb6nfw07e)
-* ODROID M1: 4 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573028119?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940567831?ref=eeb6nfw07e)
-* ODROID M1: 8 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573093655?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940633367?ref=eeb6nfw07e)
-* [ODROID M1: 8 GB RAM / 1 TB NVMe / 64 GB eMMC ](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940698903?ref=eeb6nfw07e)
-* ODROID XU4: 2 GB RAM / [32 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729352471?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748782305559?ref=eeb6nfw07e)
+- [ODROID N2+: 2 GB RAM / 16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729286935?ref=eeb6nfw07e)
+- [ODROID N2+: 4 GB RAM / 64 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729221399?ref=eeb6nfw07e)
+- ODROID M1: 4 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573028119?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940567831?ref=eeb6nfw07e)
+- ODROID M1: 8 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573093655?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940633367?ref=eeb6nfw07e)
+- [ODROID M1: 8 GB RAM / 1 TB NVMe / 64 GB eMMC ](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940698903?ref=eeb6nfw07e)
+- ODROID XU4: 2 GB RAM / [32 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729352471?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748782305559?ref=eeb6nfw07e)
Variants without pre-installed Home Assistant:
-* ODROID N2+, [2 GB RAM](https://ameridroid.com/products/odroid-n2-plus?variant=40371828719650?ref=eeb6nfw07e) or [4 GB RAM](https://ameridroid.com/products/odroid-n2-plus?variant=40371828752418?ref=eeb6nfw07e)
-* [ODROID C4](https://ameridroid.com/products/odroid-c4?ref=eeb6nfw07e)
-* [ODROID M1](https://ameridroid.com/products/odroid-M1?ref=eeb6nfw07e)
+- ODROID N2+, [2 GB RAM](https://ameridroid.com/products/odroid-n2-plus?variant=40371828719650?ref=eeb6nfw07e) or [4 GB RAM](https://ameridroid.com/products/odroid-n2-plus?variant=40371828752418?ref=eeb6nfw07e)
+- [ODROID C4](https://ameridroid.com/products/odroid-c4?ref=eeb6nfw07e)
+- [ODROID M1](https://ameridroid.com/products/odroid-M1?ref=eeb6nfw07e)
-* [Power Supply](https://ameridroid.com/products/12v-2a-power-supply-plug?ref=eeb6nfw07e)
-* [CR2032 Coin Cell](https://ameridroid.com/products/rtc-bios-battery?ref=eeb6nfw07e)
-* [eMMC Module](https://ameridroid.com/products/emmc-module-n2-linux-red-dot?ref=eeb6nfw07e)
-* [Case](https://ameridroid.com/products/odroid-n2-case?ref=eeb6nfw07e)
+- [Power Supply](https://ameridroid.com/products/12v-2a-power-supply-plug?ref=eeb6nfw07e)
+- [CR2032 Coin Cell](https://ameridroid.com/products/rtc-bios-battery?ref=eeb6nfw07e)
+- [eMMC Module](https://ameridroid.com/products/emmc-module-n2-linux-red-dot?ref=eeb6nfw07e)
+- [Case](https://ameridroid.com/products/odroid-n2-case?ref=eeb6nfw07e)
-* These are affiliated links. We get commissions for purchases made through links in this post.*
+*These are affiliated links. We get commissions for purchases made through links in this post.*
{% endif %}
@@ -72,13 +72,13 @@ To boot Home Assistant OS, the BIOS needs to have UEFI boot mode enabled and Sec
1. To enter the BIOS, start up your x86-64 hardware and repeatedly press the `F2` key (on some systems this might be `Del`, `F1` or `F10`).
-1. Make sure the UEFI Boot mode is enabled.
+2. Make sure the UEFI Boot mode is enabled.
-1. Disable Secure Boot.
+3. Disable Secure Boot.
-1. Save your changes and exit.
+4. Save your changes and exit.
The BIOS configuration is now complete.
@@ -95,7 +95,7 @@ To write the HAOS image to the boot medium on your x86-64 hardware, there are 2
1. Write the HAOS disk image from your desktop computer directly to the boot medium (e.g. using a USB to S-ATA adapter).
If you can use this method, proceed to "[Write the image to your boot medium](#write-the-image-to-your-boot-medium)" and follow all steps. If you have non-removable internal mediums or don't have the necessary adapter, try the next method instead.
-1. Create a "live operating system" on a USB device running e.g. Ubuntu ([how-to guide](https://ubuntu.com/tutorials/try-ubuntu-before-you-install)). Insert it into your system and boot the live operating system. Then follow from step 2 in "[Write the image to your boot medium](#write-the-image-to-your-boot-medium)".
+2. Create a "live operating system" on a USB device running e.g. Ubuntu ([how-to guide](https://ubuntu.com/tutorials/try-ubuntu-before-you-install)). Insert it into your system and boot the live operating system. Then follow from step 2 in "[Write the image to your boot medium](#write-the-image-to-your-boot-medium)".
{% details "Ubuntu dependencies for Etcher" %}
@@ -120,11 +120,11 @@ sudo apt install libfuse2
If you are using a [Home Assistant Blue](/blue) or ODROID N2+, you can [attach your device directly](/common-tasks/os/#flashing-an-odroid-n2).
{% endif %}
-1. Download and start Balena Etcher. You may need to run it with administrator privileges on Windows.
-1. Select **Flash from URL**.
+2. Download and start Balena Etcher. You may need to run it with administrator privileges on Windows.
+3. Select **Flash from URL**.
-1. Copy the URL for the image. If there are multiple links below, make sure to select the correct link for your version of {{site.installation.types[page.installation_type].board}}:
+4. Copy the URL for the image. If there are multiple links below, make sure to select the correct link for your version of {{site.installation.types[page.installation_type].board}}:
{% if site.installation.types[page.installation_type].variants.size > 1 %}
{% tabbed_block %}
{% for variant in site.installation.types[page.installation_type].variants %}
@@ -157,15 +157,15 @@ _Select and copy the URL or use the "copy" button that appear when you hover it.
5. Paste the URL for the {{site.installation.types[page.installation_type].board}} image into Balena Etcher and select **OK**.
-1. When Balena Etcher has downloaded the image, click **Select target**.
-
-1. Select the boot medium ({{site.installation.types[page.installation_type].installation_media}}) you want to use for your installation.
+6. When Balena Etcher has downloaded the image, click **Select target**.
+[Screenshot of the Etcher software showing the select target button highlighted.](/images/installation/etcher3.png)
+7. Select the boot medium ({{site.installation.types[page.installation_type].installation_media}}) you want to use for your installation.
-1. Select **Flash!** to start writing the image.
+8. Select **Flash!** to start writing the image.
-1. When Balena Etcher has finished writing the image, you will see a confirmation.
+9. When Balena Etcher has finished writing the image, you will see a confirmation.
- * If you are having issues with Balena Etcher, try version [1.10](https://github.com/balena-io/etcher/releases/tag/v1.10.4).
+ - If you are having issues with Balena Etcher, rather than installing from URL, download the file. Then, install from file.
### Start up your {{site.installation.types[page.installation_type].board}}
@@ -176,7 +176,7 @@ _Select and copy the URL or use the "copy" button that appear when you hover it.
- If you used a live operating system (e.g. Ubuntu), shut it down and remove the live operating system USB device.
1. Plug in an Ethernet cable that is connected to the network.
-1. Power the system on. If you have a screen connected to the {{site.installation.types[page.installation_type].board}} system, after a minute or so the Home Assistant welcome banner will appear in the console.
+2. Power the system on. If you have a screen connected to the {{site.installation.types[page.installation_type].board}} system, after a minute or so the Home Assistant welcome banner will appear in the console.
@@ -217,9 +217,6 @@ If you are running an older Windows version or have a stricter network configura
### Download the appropriate image
- [VirtualBox][vdi] (.vdi)
-{% if page.installation_type == 'macos' %}
-- [KVM][qcow2] (.qcow2)
-{% endif %}
{% if page.installation_type == 'windows' or page.installation_type == 'linux' %}
- [KVM][qcow2] (.qcow2)
- [Vmware Workstation][vmdk] (.vmdk)
@@ -239,7 +236,6 @@ Follow this guide if you already are running a supported virtual machine hypervi
- If VirtualBox is not supported on your Mac, and you have experience using virtual machines, you can try running the Home Assistant Operating system on [UTM](https://mac.getutm.app/).
{% endif %}
-
### Create the virtual machine
Load the appliance image into your virtual machine hypervisor. (Note: You are free to assign as much resources as you wish to the VM, please assign enough based on your add-on needs).
@@ -259,10 +255,10 @@ _All these can be extended if your usage calls for more resources._
- title: VirtualBox
content: |
1. Create a new virtual machine.
- 1. Select type **Linux** and version **Linux 2.6 / 3.x / 4.x (64-bit)**.
- 1. Select **Use an existing virtual hard disk file**, select the unzipped VDI file from above.
- 1. Edit the **Settings** of the VM and go to **System** > **Motherboard**. Select **Enable EFI**.
- 1. Then go to **Network** > **Adapter 1**. Choose **Bridged Adapter** and choose your network adapter.
+ 2. Select type **Linux** and version **Linux 2.6 / 3.x / 4.x (64-bit)**.
+ 3. Select **Use an existing virtual hard disk file**, select the unzipped VDI file from above.
+ 4. Edit the **Settings** of the VM and go to **System** > **Motherboard**. Select **Enable EFI**.
+ 5. Then go to **Network** > **Adapter 1**. Choose **Bridged Adapter** and choose your network adapter.
1. Create a new virtual machine.
- 1. Select **Generation 2**.
- 1. Select **Connection** > **Your Virtual Switch that is bridged**.
- 1. Select **Use an existing virtual hard disk** and select the VHDX file from above.
+ 2. Select **Generation 2**.
+ 3. Select **Connection** > **Your Virtual Switch that is bridged**.
+ 4. Select **Use an existing virtual hard disk** and select the VHDX file from above.
After creation, go to **Settings** > **Security** and deselect **Enable Secure Boot**.
{% endif %}
@@ -358,8 +355,8 @@ _All these can be extended if your usage calls for more resources._
### Start up your virtual machine
1. Start the virtual machine.
-1. Observe the boot process of the Home Assistant Operating System.
-1. Once completed, you will be able to reach Home Assistant on homeassistant.local:8123. If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at homeassistant:8123 or `http://X.X.X.X:8123` (replace X.X.X.X with your {{site.installation.types[page.installation_type].board}}’s IP address).
+2. Observe the boot process of the Home Assistant Operating System.
+3. Once completed, you will be able to reach Home Assistant on homeassistant.local:8123. If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at homeassistant:8123 or `http://X.X.X.X:8123` (replace X.X.X.X with your {{site.installation.types[page.installation_type].board}}’s IP address).
{% endif %}
diff --git a/source/_includes/integrations/option_flow.md b/source/_includes/integrations/option_flow.md
index 21bf5e59031..e85dbee0f13 100644
--- a/source/_includes/integrations/option_flow.md
+++ b/source/_includes/integrations/option_flow.md
@@ -7,4 +7,4 @@ Options for {{ name }} can be set via the user interface, by taking the followin
- Browse to your Home Assistant instance.
- Go to **{% my integrations title="Settings > Devices & Services" %}**.
- If multiple instances of {{ name }} are configured, choose the instance you want to configure.
-- Select the cogwheel, then select **Configure**.
+- Select the integration, then select **Configure**.
diff --git a/source/_integrations/airthings_ble.markdown b/source/_integrations/airthings_ble.markdown
index 3bbe5f1415e..8461db06dc1 100644
--- a/source/_integrations/airthings_ble.markdown
+++ b/source/_integrations/airthings_ble.markdown
@@ -18,7 +18,7 @@ ha_integration_type: integration
Integrates Airthings BLE sensors into Home Assistant.
-[Airthings](https://www.airthings.com/) provide different sensors for measuring the air quality. The focus specially on Radon sensors.
+[Airthings](https://www.airthings.com/) provide different devices for measuring the air quality. Initially focusing on radon gas sensors, each device provides a number of different sensors to monitor typical contaminants that's presence contributes to bad air quality in the home.
Requires Airthings hardware and a compatible Bluetooth dongle.
diff --git a/source/_integrations/airvisual.markdown b/source/_integrations/airvisual.markdown
index dfa2b922a06..1241574a70f 100644
--- a/source/_integrations/airvisual.markdown
+++ b/source/_integrations/airvisual.markdown
@@ -51,7 +51,7 @@ For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo >
When configured, the platform will create three sensors for each air quality standard:
-#### Air Quality Index
+### Air Quality Index
- **Description:** This sensor displays a numeric air quality index (AQI), a metric for the overall "health" of the air.
- **Example Sensor Name:** `sensor.chinese_air_quality_index`
@@ -67,13 +67,13 @@ AQI | Status | Description
201 - 300 | **Very unhealthy** | Health warnings of emergency conditions. The entire population is more likely to be affected
301+ | **Hazardous** | Health alert: everyone may experience more serious health effects
-#### Air Pollution Level
+### Air Pollution Level
- **Description:** This sensor displays the associated `Status` (from the above table) for the current AQI.
- **Sample Sensor Name:** `sensor.us_air_pollution_level`
- **Example Sensor Value:** `Moderate`
-#### Main Pollutant
+### Main Pollutant
- **Description:** This sensor displays the pollutant whose value is currently highest.
- **Sample Sensor Name:** `sensor.us_main_pollutant`
diff --git a/source/_integrations/alarm_control_panel.ifttt.markdown b/source/_integrations/alarm_control_panel.ifttt.markdown
index cc1655404f1..f7eab602254 100644
--- a/source/_integrations/alarm_control_panel.ifttt.markdown
+++ b/source/_integrations/alarm_control_panel.ifttt.markdown
@@ -89,11 +89,11 @@ This platform supports the services `alarm_disarm`, `alarm_arm_away`, `alarm_arm
For this system to operate correctly, the following IFTTT applets have to be setup. Obviously, if your alarm device does not support some states, no applets have to be provided for those.
-* **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** disarm the alarm system.
-* **IF** Webhook event `YOUR_ARM_HOME_EVENT` is called, **THEN** set the alarm system to armed home.
-* **IF** Webhook event `YOUR_ARM_NIGHT_EVENT` is called, **THEN** set the alarm system to armed away.
-* **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** set the alarm system to armed night.
-* **IF** the alarm system was disarmed, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "disarmed"}`.
-* **IF** the alarm system state changed to armed home, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_home"}`.
-* **IF** the alarm system state changed to armed away, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_away"}`.
-* **IF** the alarm system state changed to armed night, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_night"}`.
+- **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** disarm the alarm system.
+- **IF** Webhook event `YOUR_ARM_HOME_EVENT` is called, **THEN** set the alarm system to armed home.
+- **IF** Webhook event `YOUR_ARM_NIGHT_EVENT` is called, **THEN** set the alarm system to armed away.
+- **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** set the alarm system to armed night.
+- **IF** the alarm system was disarmed, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "disarmed"}`.
+- **IF** the alarm system state changed to armed home, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_home"}`.
+- **IF** the alarm system state changed to armed away, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_away"}`.
+- **IF** the alarm system state changed to armed night, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_night"}`.
diff --git a/source/_integrations/alarm_control_panel.mqtt.markdown b/source/_integrations/alarm_control_panel.mqtt.markdown
index 761e60b4164..da585e18721 100644
--- a/source/_integrations/alarm_control_panel.mqtt.markdown
+++ b/source/_integrations/alarm_control_panel.mqtt.markdown
@@ -77,7 +77,7 @@ availability_topic:
required: false
type: string
code:
- description: If defined, specifies a code to enable or disable the alarm in the frontend. Note that the code is validated locally and blocks sending MQTT messages to the remote device. For remote code validation, the code can be configured to either of the special values `REMOTE_CODE` (numeric code) or `REMOTE_CODE_TEXT` (text code). In this case, local code validation is bypassed but the frontend will still show a numeric or text code dialog. Use `command_template` to send the code to the remote device. Example configurations for remote code validation [can be found here](./#configurations-with-remote-code-validation).
+ description: If defined, specifies a code to enable or disable the alarm in the frontend. Note that the code is validated locally and blocks sending MQTT messages to the remote device. For remote code validation, the code can be configured to either of the special values `REMOTE_CODE` (numeric code) or `REMOTE_CODE_TEXT` (text code). In this case, local code validation is bypassed but the frontend will still show a numeric or text code dialog. Use `command_template` to send the code to the remote device. Example configurations for remote code validation [can be found here](#configurations-with-remote-code-validation).
required: false
type: string
code_arm_required:
diff --git a/source/_integrations/amcrest.markdown b/source/_integrations/amcrest.markdown
index 457fab8a8ed..4a011bd7f24 100644
--- a/source/_integrations/amcrest.markdown
+++ b/source/_integrations/amcrest.markdown
@@ -200,7 +200,7 @@ Available services:
`start_tour`, `stop_tour`, and
`ptz_control`
-#### Service `enable_audio`/`disable_audio`
+### Service `enable_audio`/`disable_audio`
These services enable or disable the camera's audio stream.
@@ -208,7 +208,7 @@ Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
-#### Service `enable_motion_recording`/`disable_motion_recording`
+### Service `enable_motion_recording`/`disable_motion_recording`
These services enable or disable the camera to record a clip to its configured storage location when motion is detected.
@@ -216,7 +216,7 @@ Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
-#### Service `enable_recording`/`disable_recording`
+### Service `enable_recording`/`disable_recording`
These services enable or disable the camera to continuously record to its configured storage location.
@@ -224,7 +224,7 @@ Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
-#### Service `goto_preset`
+### Service `goto_preset`
This service will cause the camera to move to one of the PTZ locations configured within the camera.
@@ -233,7 +233,7 @@ Service data attribute | Optional | Description
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
`preset` | no | Preset number, starting from 1.
-#### Service `set_color_bw`
+### Service `set_color_bw`
This service will set the color mode of the camera.
@@ -242,7 +242,7 @@ Service data attribute | Optional | Description
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
`color_bw` | no | One of `auto`, `bw` or `color`.
-#### Service `start_tour`/`stop_tour`
+### Service `start_tour`/`stop_tour`
These services start or stop the camera's PTZ tour function.
@@ -250,7 +250,7 @@ Service data attribute | Optional | Description
-|-|-
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
-#### Service `ptz_control`
+### Service `ptz_control`
If your Amcrest or Dahua camera supports PTZ, you will be able to pan, tilt or zoom your camera.
@@ -260,12 +260,12 @@ Service data attribute | Optional | Description
`movement` | no | Direction of the movement. Allowed values: `zoom_in`, `zoom_out`, `up`, `down`, `left`, `right`, `right_up`, `right_down`, `left_up`, `left_down`
`travel_time` | yes |Travel time in fractional seconds. Allowed values: `0` to `1`. Default: `0.2`.
-#### Notes
+## Notes
- PTZ zoom capability does not control VariFocal lens adjustments.
- There can be several seconds of lag before the video (snapshot or live) reflects the camera movement.
-### Example card with controls
+## Example card with controls
Please keep in mind that the bridged adapter only functions over a hardwired Ethernet connection.
Using Wi-Fi on your VirtualBox host is unsupported.
@@ -277,24 +273,24 @@ _All these can be extended if your usage calls for more resources._
```
-
+{% unless page.installation_type == 'macos' %}
- title: KVM (virt-manager)
content: |
1. Create a new virtual machine in `virt-manager`.
- 1 Select **Import existing disk image**, provide the path to the QCOW2 image above.
- 1. Choose **Generic Default** for the operating system.
- 1. Check the box for **Customize configuration before install**.
- 1. Under **Network Selection**, select your bridge.
+ 2. Select **Import existing disk image**, provide the path to the QCOW2 image above.
+ 3. Choose **Generic Default** for the operating system.
+ 4. Check the box for **Customize configuration before install**.
+ 5. Under **Network Selection**, select your bridge.
6. Under customization select **Overview** > **Firmware** > **UEFI x86_64: ...**. Make sure to select a non-secureboot version of OVMF (does not contain the word `secure`, `secboot`, etc.), e.g., `/usr/share/edk2/ovmf/OVMF_CODE.fd`.
- 1. Click **Add Hardware** (bottom left), and select **Channel**.
- 1. Select device type: **unix**.
- 1. Select name: **org.qemu.guest_agent.0**.
- 1. Finally, select **Begin Installation** (upper left corner).
+ 7. Click **Add Hardware** (bottom left), and select **Channel**.
+ 8. Select device type: **unix**.
+ 9. Select name: **org.qemu.guest_agent.0**.
+ 10. Finally, select **Begin Installation** (upper left corner).
- title: KVM (virt-install)
content: |
```bash
- virt-install --name hass --description "Home Assistant OS" --os-variant=generic --ram=2048 --vcpus=2 --disk
If you have a USB dongle to attach, you need to add the option `--hostdev busID.deviceId`. You can discover these IDs via the `lsusb` command.
@@ -314,21 +310,22 @@ _All these can be extended if your usage calls for more resources._
You can recognize the Sonoff dongle at `Bus 003 Device 003`. So the command to install the VM will become:
```bash
- virt-install --name hass --description "Home Assistant OS" --os-variant=generic --ram=2048 --vcpus=2 --disk
+{% endunless %}
{% if page.installation_type == 'windows' or page.installation_type == 'linux' %}
- title: Vmware Workstation
content: |
1. Create a new virtual machine.
- 1. Select **Custom**, make it compatible with the default of Workstation and ESX.
- 1. Choose **I will install the operating system later**, select **Linux** > **Other Linux 5.x or later kernel 64-bit**.
- 1. Select **Use Bridged Networking**.
- 1. Select **Use an existing virtual disk** and select the VMDK file above.
+ 2. Select **Custom**, make it compatible with the default of Workstation and ESX.
+ 3. Choose **I will install the operating system later**, select **Linux** > **Other Linux 5.x or later kernel 64-bit**.
+ 4. Select **Use Bridged Networking**.
+ 5. Select **Use an existing virtual disk** and select the VMDK file above.
After the VM has been created, go to **Settings** > **Options** > **Advanced**. Under **Firmware type** select **UEFI**.
@@ -346,9 +343,9 @@ _All these can be extended if your usage calls for more resources._
diff --git a/source/_integrations/anthemav.markdown b/source/_integrations/anthemav.markdown
index 91fdd467423..9c652c92d3f 100644
--- a/source/_integrations/anthemav.markdown
+++ b/source/_integrations/anthemav.markdown
@@ -20,18 +20,18 @@ Both [Anthem]'s current and last generation of A/V Receivers and Processors supp
### A/V Receiver
-* [MRX 540](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-540/page=overview), [MRX 740](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-740/page=overview), [MRX 1140](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-1140/page=overview)
-* [MRX 520](https://www.anthemav.com/products-current/series=mrx-series-gen3/model=mrx-520/page=overview), [MRX 720](https://www.anthemav.com/products-current/collection=performance/model=mrx-720/page=overview), [MRX 1120](https://www.anthemav.com/products-current/collection=performance/model=mrx-1120/page=overview)
-* [MRX 310](https://www.anthemav.com/products-archived/type=av-receiver/model=mrx-310/page=overview), [MRX 510](https://www.anthemav.com/products-archived/series=mrx-series/model=mrx-510/page=overview), [MRX 710](https://www.anthemav.com/products-archived/type=av-receiver/model=mrx-710/page=overview)
+- [MRX 540](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-540/page=overview), [MRX 740](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-740/page=overview), [MRX 1140](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-1140/page=overview)
+- [MRX 520](https://www.anthemav.com/products-current/series=mrx-series-gen3/model=mrx-520/page=overview), [MRX 720](https://www.anthemav.com/products-current/collection=performance/model=mrx-720/page=overview), [MRX 1120](https://www.anthemav.com/products-current/collection=performance/model=mrx-1120/page=overview)
+- [MRX 310](https://www.anthemav.com/products-archived/type=av-receiver/model=mrx-310/page=overview), [MRX 510](https://www.anthemav.com/products-archived/series=mrx-series/model=mrx-510/page=overview), [MRX 710](https://www.anthemav.com/products-archived/type=av-receiver/model=mrx-710/page=overview)
### A/V Processor
-* [AVM 60](https://www.anthemav.com/products-current/model=avm-60/page=overview)
+- [AVM 60](https://www.anthemav.com/products-current/model=avm-60/page=overview)
### Distribution Solution
-* [MDX 8](https://www.anthemav.com/products-current/type=distribution/model=mdx-8/page=overview), [MDX 16](https://www.anthemav.com/products-current/type=distribution/model=mdx-16/page=overview)
-* Martin Logan [MDA 8](https://www.martinlogan.com/en/product/mda8), [MDA 16](https://www.martinlogan.com/en/product/mda16)
+- [MDX 8](https://www.anthemav.com/products-current/type=distribution/model=mdx-8/page=overview), [MDX 16](https://www.anthemav.com/products-current/type=distribution/model=mdx-16/page=overview)
+- Martin Logan [MDA 8](https://www.martinlogan.com/en/product/mda8), [MDA 16](https://www.martinlogan.com/en/product/mda16)
If your model is not on the list then give it a test, if everything works correctly then add it to the list by clicking on the **Edit this page on GitHub** link above.
@@ -51,8 +51,8 @@ port:
## Notes and Limitations
-* The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls.
-* Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant.
+- The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls.
+- Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant.
diff --git a/source/_integrations/apple_tv.markdown b/source/_integrations/apple_tv.markdown
index b7a7bf51642..ca254f12ac4 100644
--- a/source/_integrations/apple_tv.markdown
+++ b/source/_integrations/apple_tv.markdown
@@ -22,7 +22,7 @@ The Apple TV integration allows you to control an Apple TV (any generation).
There is currently support for the following entities within the Apple TV device:
-- [Media Player](#media_player)
+- [Media Player](#media-player)
- [Remote](#remote)
{% include integrations/config_flow.md %}
@@ -43,12 +43,12 @@ launch specific content in applications.
Examples of some `Deep Links` for popular applications:
-| App | URL |
-|-----------| --- |
-| YouTube | youtube://www.youtube.com/watch?v=dQw4w9WgXcQ
-| Netflix | https://www.netflix.com/title/80234304
-| Disney+ | https://www.disneyplus.com/series/the-beatles-get-back/7DcWEeWVqrkE
-| Apple TV+ | https://tv.apple.com/show/severance/umc.cmc.1srk2goyh2q2zdxcx605w8vtx
+| App | URL |
+| --------- | --------------------------------------------------------------------- |
+| YouTube | youtube://www.youtube.com/watch?v=dQw4w9WgXcQ |
+| Netflix | https://www.netflix.com/title/80234304 |
+| Disney+ | https://www.disneyplus.com/series/the-beatles-get-back/7DcWEeWVqrkE |
+| Apple TV+ | https://tv.apple.com/show/severance/umc.cmc.1srk2goyh2q2zdxcx605w8vtx |
The simplest way to find useful `Deep Links` is to use the “Share” feature in iOS
or macOS versions of the App. Share sheets will often have a “Copy” or
@@ -112,11 +112,11 @@ The following commands are currently available:
### Service `send_command`
-| Service data
attribute | Optional | Description |
-| ------------------------- | -------- | ------------ |
-| `entity_id` | no | `entity_id` of the Apple TV |
-| `command` | no | Command, or list of commands to be sent |
-| `num_repeats` | yes | Number of times to repeat the commands |
+| Service data
attribute | Optional | Description |
+| ------------------------- | -------- | ---------------------------------------------------------------------------------------------- |
+| `entity_id` | no | `entity_id` of the Apple TV |
+| `command` | no | Command, or list of commands to be sent |
+| `num_repeats` | yes | Number of times to repeat the commands |
| `delay_secs` | yes | Interval in seconds between one send and another
This is a `float` value e.g. 1, 1.2 etc. |
### Examples
diff --git a/source/_integrations/arris_tg2492lg.markdown b/source/_integrations/arris_tg2492lg.markdown
index e8ea437206e..dab9af1fc42 100644
--- a/source/_integrations/arris_tg2492lg.markdown
+++ b/source/_integrations/arris_tg2492lg.markdown
@@ -17,8 +17,8 @@ This platform allows you to detect presence by looking at connected devices to a
This is one of the routers provided by:
-* [Ziggo](https://www.ziggo.nl/), a cable operator in the Netherlands, to their customers as the Ziggo Connectbox.
-* [Virgin Media](https://www.virginmedia.com/), a cable operator in the United Kingdom, to their customers as the Hub 3.
+- [Ziggo](https://www.ziggo.nl/), a cable operator in the Netherlands, to their customers as the Ziggo Connectbox.
+- [Virgin Media](https://www.virginmedia.com/), a cable operator in the United Kingdom, to their customers as the Hub 3.
The router prevents the admin user from logging in twice. This can cause problems with accessing the router's configuration pages while this platform is active.
diff --git a/source/_integrations/aten_pe.markdown b/source/_integrations/aten_pe.markdown
index 9273ff9b23d..43437995cc5 100644
--- a/source/_integrations/aten_pe.markdown
+++ b/source/_integrations/aten_pe.markdown
@@ -19,7 +19,7 @@ In order to use it, SNMP must be enabled on your PDU. It is recommended to use S
Tested devices:
-* [PE8324G](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/pe8324/)
+- [PE8324G](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/pe8324/)
To set it up, add the following information to your `configuration.yaml` file:
diff --git a/source/_integrations/awair.markdown b/source/_integrations/awair.markdown
index 15ef993f23f..ad7487f40eb 100644
--- a/source/_integrations/awair.markdown
+++ b/source/_integrations/awair.markdown
@@ -37,13 +37,13 @@ This integration refreshes once every 5 minutes, based on the [default per-devic
The integration will fetch data from each device. The following sensors are supported:
-* Temperature
-* Humidity
-* Carbon dioxide
-* Total volatile organic compounds
-* PM2.5 density
-* PM10 density
-* Sound level
-* Luminescence
+- Temperature
+- Humidity
+- Carbon dioxide
+- Total volatile organic compounds
+- PM2.5 density
+- PM10 density
+- Sound level
+- Luminescence
Not all devices support all sensors; consult Awair's documentation to find out what sensors are present on your device. For first-generation Awair devices with a "dust" sensor, the integration will create identical PM2.5 and PM10 sensors (which reflects the capabilities of the sensor - it can detect dust between PM2.5 and PM10 but cannot differentiate between them).
diff --git a/source/_integrations/binary_sensor.rflink.markdown b/source/_integrations/binary_sensor.rflink.markdown
index e0c6dd44b4f..a8aba0991cc 100644
--- a/source/_integrations/binary_sensor.rflink.markdown
+++ b/source/_integrations/binary_sensor.rflink.markdown
@@ -9,7 +9,7 @@ ha_release: 0.81
ha_domain: rflink
---
-The `rflink` integration supports devices that use [RFLink gateway firmware](https://www.rflink.nl/download.php), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/en/21-rflink-). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
+The `rflink` integration supports devices that use [RFLink gateway firmware](https://www.rflink.nl/download.php), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/21-rflink-). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
First, you have to set up your [RFLink hub](/integrations/rflink/).
diff --git a/source/_integrations/bluetooth.markdown b/source/_integrations/bluetooth.markdown
index 1e06fb9a78f..ccad2ca27bc 100644
--- a/source/_integrations/bluetooth.markdown
+++ b/source/_integrations/bluetooth.markdown
@@ -246,7 +246,7 @@ The following remote adapters are supported:
- [ESPHome](https://esphome.github.io/bluetooth-proxies/)
- Bluetooth advertisement listening: ESPHome ESP32 device with firmware 2022.8.2 or later
- - Bluetooth advertisement bundling: ESPHome ESP32 device with firmware 2022.6.0 or later
+ - Bluetooth advertisement bundling: ESPHome ESP32 device with firmware 2023.6.0 or later
- Single active connection: ESPHome ESP32 device with firmware 2022.9.3 or later
- Multiple active connections: ESPHome ESP32 device with firmware 2022.11.0 or later
- [Shelly](/integrations/shelly/)
diff --git a/source/_integrations/brandt.markdown b/source/_integrations/brandt.markdown
index 9ced5622c56..5da28dfad11 100644
--- a/source/_integrations/brandt.markdown
+++ b/source/_integrations/brandt.markdown
@@ -2,7 +2,7 @@
title: Brandt Smart Control
description: Connect and control your Brandt Smart Control devices using the Overkiz integration
ha_category:
- - Alarm Control Panel
+ - Alarm
- Binary Sensor
- Button
- Climate
diff --git a/source/_integrations/braviatv.markdown b/source/_integrations/braviatv.markdown
index 7ec2b1107c4..b57e18efa82 100644
--- a/source/_integrations/braviatv.markdown
+++ b/source/_integrations/braviatv.markdown
@@ -128,7 +128,7 @@ The commands that can be sent to the TV depends on the model of your TV. To disp
```yaml
service: remote.send_command
target:
- entity_id: media_player.bravia_tv
+ entity_id: remote.bravia_tv
data:
command: "Down"
```
diff --git a/source/_integrations/broadlink.markdown b/source/_integrations/broadlink.markdown
index 7c5a57867ce..dca8784700a 100644
--- a/source/_integrations/broadlink.markdown
+++ b/source/_integrations/broadlink.markdown
@@ -282,11 +282,11 @@ script:
You can use `remote.delete_command` to remove commands that you've learned with the `remote.learn_command` service.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------- |
-| `entity_id` | no | ID of the remote. |
-| `device` | no | Name of the device. |
-| `command` | no | Names of the commands to be deleted. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------ |
+| `entity_id` | no | ID of the remote. |
+| `device` | no | Name of the device. |
+| `command` | no | Names of the commands to be deleted. |
#### Deleting a command
@@ -656,9 +656,9 @@ After a success, do one of the following two options:
```
2. To learn a button hold RF code, hold the button you wish to learn for 1-2 seconds then immediately press enter.
- * You will see the same prompts for a short press as shown above. You should see it return a different base64 code.
- * Test the base64 code to ensure it performs the button 'hold' command as expected, rather than the button 'press' command.
- * This might take some trial and error to get the hold timing right before hitting enter to scan for the code.
+ - You will see the same prompts for a short press as shown above. You should see it return a different base64 code.
+ - Test the base64 code to ensure it performs the button 'hold' command as expected, rather than the button 'press' command.
+ - This might take some trial and error to get the hold timing right before hitting enter to scan for the code.
### Conversion of codes from other projects
diff --git a/source/_integrations/brother.markdown b/source/_integrations/brother.markdown
index 4e5fa3f0a22..1f243077999 100644
--- a/source/_integrations/brother.markdown
+++ b/source/_integrations/brother.markdown
@@ -19,7 +19,7 @@ ha_integration_type: device
The `Brother Printer` integration allows you to read current data from your local Brother printer.
-It usually provides information about the device's state, the left amount of ink or toner and the remaining life of the drum or other parts of the printer.
+It usually provides information about the device's state, the left amount of ink or toner and the remaining lifetime of the drum or other parts of the printer.
The integration monitors every supported part.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/buienradar.markdown b/source/_integrations/buienradar.markdown
index 86d29913d30..e909169eabd 100644
--- a/source/_integrations/buienradar.markdown
+++ b/source/_integrations/buienradar.markdown
@@ -37,7 +37,7 @@ The `buienradar` camera platform uses [buienradar.nl](https://buienradar.nl/) as
Internally, this integration uses the radar map image as [documented](https://www.buienradar.nl/overbuienradar/gratis-weerdata) on buienradar.nl.
The downloaded image is cached to prevent Home Assistant from making a new request to buienradar.nl multiple times a minute when Home Assistant checks for new stills from the camera.
-The camera entity is added disabled by default and should first be enabled before it starts reading the camera images.
+The camera entity is disabled by default and should be [enabled](/common-tasks/general/#enabling-entities) before it reads the camera images.
## Sensor
@@ -49,24 +49,24 @@ The following entities will be created:
- **Barometer forecast**: A numeric barometric forecast (1 to 7)
- **Barometer forecast name**: A textual representation of the barometer forecast (eg: Thunderstorms, Stable, etc.)
- **Condition code**: A symbol and a unique code identifying the current weather condition
- * `a`: sunny/clear
- * `b`: Mix of clear and medium or low clouds
- * `j`: Mix of clear and high clouds
- * `o/r`: Partly cloudy (increasing character increases the condition)
- * `c`: Heavily clouded
- * `p`: Cloudy
- * `d`: Alternating cloudy with local fog
- * `n`: Clear and local mist or fog
- * `f`: Alternatingly cloudy with some light rain
- * `h/k/l`: rainy (increasing character increases the condition)
- * `q`: Heavily clouded with rain
- * `w`: Heavily clouded with rain and winter precipitation
- * `m`: Heavily clouded with some light rain
- * `u`: Cloudy with light snow
- * `i/v`: Heavily clouded with light snowfall (increasing character increases the condition)
- * `t`: (Heavy snowfall)
- * `g`: (Clear with (possibly) some heavy lightning)
- * `s`: (Cloudy with (possibly) some heavy (thunderstorms) showers)
+ - `a`: sunny/clear
+ - `b`: Mix of clear and medium or low clouds
+ - `j`: Mix of clear and high clouds
+ - `o/r`: Partly cloudy (increasing character increases the condition)
+ - `c`: Heavily clouded
+ - `p`: Cloudy
+ - `d`: Alternating cloudy with local fog
+ - `n`: Clear and local mist or fog
+ - `f`: Alternatingly cloudy with some light rain
+ - `h/k/l`: rainy (increasing character increases the condition)
+ - `q`: Heavily clouded with rain
+ - `w`: Heavily clouded with rain and winter precipitation
+ - `m`: Heavily clouded with some light rain
+ - `u`: Cloudy with light snow
+ - `i/v`: Heavily clouded with light snowfall (increasing character increases the condition)
+ - `t`: (Heavy snowfall)
+ - `g`: (Clear with (possibly) some heavy lightning)
+ - `s`: (Cloudy with (possibly) some heavy (thunderstorms) showers)
- **Condition**: A symbol and the current weather condition (`clear`, `cloudy`, `fog`, `rainy`, `snowy` or `lightning`)
- **Condition detailed**: A symbol and detailed current weather condition (`clear`, `partlycloudy`, `cloudy`, `partlycloudy-fog`, `partlycloudy-light-rain`, `partlycloudy-rain`, `light-rain`, `rainy`, `snowy-rainy`, `partlycloudy-light-snow`, `partlycloudy-snow`, `light-snow`, `snowy`, `partlycloudy-lightning` or `lightning`)
- **Condition exact**: A symbol with the full current weather condition (in English)
@@ -102,8 +102,7 @@ The following entities will be created:
- **Condition code n days ahead**: Symbol and condition code of the expected condition n days ahead
- **Condition n days ahead**: Symbol and expected condition n days ahead
- **Detailed condition n days ahead**: Symbol and detailed expected condition n days ahead
-- **Full condition (english) n days ahead**: Symbol and full expected condition n days ahead (in English)
-- **Full condition (dutch) n days ahead**: Symbol and full expected condition n days ahead (in Dutch)
+- **Full condition n days ahead**: Symbol and full expected condition n days ahead
{% include integrations/option_flow.md %}
diff --git a/source/_integrations/calendar.markdown b/source/_integrations/calendar.markdown
index 5c20ebf9492..b61fc8ff40e 100644
--- a/source/_integrations/calendar.markdown
+++ b/source/_integrations/calendar.markdown
@@ -252,4 +252,4 @@ data:
{% endfor %}
```
-{% endraw %}
\ No newline at end of file
+{% endraw %}
diff --git a/source/_integrations/cisco_webex_teams.markdown b/source/_integrations/cisco_webex_teams.markdown
index 1a7e8d0a589..a76593f9eaf 100644
--- a/source/_integrations/cisco_webex_teams.markdown
+++ b/source/_integrations/cisco_webex_teams.markdown
@@ -17,14 +17,14 @@ The `cisco_webex_teams` notification platform allows you to deliver rich notific
To use this notification platform you will need an app (bot) token. To obtain a token visit [Cisco Webex for Developers](https://developer.webex.com/).
-* Detailed instructions can be found in the section titled **Creating a Webex Teams Bot** on the [Webex Teams bot documentation](https://developer.webex.com/docs/bots).
+- Detailed instructions can be found in the section titled **Creating a Webex Teams Bot** on the [Webex Teams bot documentation](https://developer.webex.com/docs/bots).
You also need to specify the `room_id` that you wish to post messages into. The `room_id` can be found in one of two ways:
1. Logging in at [Cisco Webex for Developers](https://developer.webex.com/) and navigate to `Documentation`>`API Reference`>`Messages` and select List Messages, or
2. Log into the web client at [teams.webex.com](https://teams.webex.com/),
- * select the room (or create a new room),
- * then copying the room ID from the URL.
+ - select the room (or create a new room),
+ - then copying the room ID from the URL.
@@ -118,23 +118,23 @@ Here are the automations for the above screenshot:
The following is a list of the allowed html tags and attributes:
-Tag | More Info
---- | ---
-`<@personEmail:email@examplecompany.com>` | Used to tag another Webex Team user by email address.
-`` | Defines a hyperlink. Allows attribute `href`.
-`
-#### Schedules
+## Schedules
Once events have been registered on the DoorBird device, they must be attached to a schedule using the official DoorBird app on Android or iOS or the [DoorBird - WebAdmin](https://webadmin.doorbird.com) portal. Currently, there are schedules available for doorbell, motion, relay, and RFID events (on supported DoorBird devices). Essentially, you can enable an HTTP(S) call from your DoorBird device to the Home Assistant DoorBird API by configuring an action/event (by enabling a schedule).
@@ -98,7 +98,7 @@ On the desired event, you should be able to specify blocks of time for when you
Note: Remember to complete the schedule assignment steps above for each event type you registered. If you are configuring HTTP Call(s) schedules for registered RFID tags, please note that you will have to enable/configure the schedule for each RFID tag.
-### Automation Example
+## Automation Example
The example automation below shows how to turn on a light when somebody presses the DoorBird call button:
diff --git a/source/_integrations/dremel_3d_printer.markdown b/source/_integrations/dremel_3d_printer.markdown
index 49ef9dc3b8f..2ccd3f5598c 100644
--- a/source/_integrations/dremel_3d_printer.markdown
+++ b/source/_integrations/dremel_3d_printer.markdown
@@ -12,7 +12,7 @@ ha_platforms:
- binary_sensor
- button
- camera
- - Sensor
+ - sensor
ha_codeowners:
- '@tkdrob'
ha_integration_type: device
diff --git a/source/_integrations/dynalite.markdown b/source/_integrations/dynalite.markdown
index 1292dfcb7c3..9d8a4dd80d1 100755
--- a/source/_integrations/dynalite.markdown
+++ b/source/_integrations/dynalite.markdown
@@ -35,268 +35,13 @@ Each area can have one or more channels that correspond to the different devices
Additionally, each area can have one or more presets that determine the behavior of all the channels, and sometimes trigger additional actions. Typically, preset '1' in an area means 'on', and preset '4' means 'off'. Additional presets could be used for scenes and dimming.
-## Configuration
+{% include integrations/config_flow.md %}
-Since Philips Dynalite has virtually no auto-discover capabilities, it needs to be configured via the `configuration.yaml` file:
+## Setup
-```yaml
-# Example configuration.yaml entry
-dynalite:
- bridges:
- - host: DEVICE_IP_ADDRESS
-```
+Since Philips Dynalite has virtually no auto-discover capabilities, once it is added via the UI, it needs to be configured via Dynalite panel. Note that the panel is only available to "admin" level users.
-{% configuration %}
-host:
- description: The IP address of the bridge (e.g., 192.168.1.10).
- required: true
- type: string
-port:
- description: Port number of the bridge.
- required: false
- type: integer
- default: 12345
-name:
- description: Name for the bridge.
- required: false
- type: string
- default: dynalite
-active:
- description: "Actively query network. When starting, it will query all devices for their current status, and also will send queries when some changes are in progress (e.g., lights dimming or covers moving). Better experience but creates more load on the Dynalite network. Value can be `on`, `off`, our `init`, where `init` will only send queries during the initial init of Home Assistant."
- required: false
- type: [boolean, string]
- default: false
-polltimer:
- description: "Polling interval for devices in transition. Value in seconds. When devices are in transition (e.g., a light fading), it will ask for a new state every X seconds until it is at the target level. Only relevant when active is set to `on`."
- required: false
- type: float
- default: 1.0
-autodiscover:
- description: Enable auto-discover. As Dynalite does not support native autodiscovery, this tracks events on your network, so if you turn on a light, it will be added to Home Assistant.
- required: false
- type: boolean
- default: false
-default:
- description: Global defaults for the system
- required: false
- type: map
- keys:
- fade:
- description: Default fade
- required: false
- type: float
-area:
- description: Definition for the various Dynalite areas.
- required: true
- type: map
- keys:
- AREA_NUMBER:
- description: The Dynalite area number, 1-255.
- required: true
- type: map
- keys:
- name:
- description: Name of the area.
- required: true
- type: string
- template:
- description: "Type of template to use for the area. Supported values are: `room` and `time_cover`. They are described in detail below in the **template** section. If the template parameters are different than defaults, they can be overridden in this section as well."
- require: false
- type: string
- TEMPLATE_PARAMS:
- description: "This can be any of the settings of the template. For example, for template `room`: `room_on` and `room_off` are possible options."
- required: false
- type: [integer, float]
- default: Value from **template** section or system defaults
- fade:
- description: Fade time for the area, in seconds.
- required: false
- type: float
- default: 2.0
- preset:
- description: Specific presets for the area.
- required: false
- type: map
- keys:
- PRESET_NUMBER:
- description: The Dynalite preset number in the area.
- required: true
- type: map
- keys:
- name:
- description: Name of the preset.
- required: false
- type: string
- default: AREA_NAME Preset PRESET_NUMBER
- fade:
- description: Fade time for the preset, in seconds.
- required: false
- type: float
- default: 2.0
- level:
- description: Level of the channels when the preset is selected, between 0 and 1.
- required: false
- type: float
- nodefault:
- description: Do not use the default presets defined globally, but only the specific ones defined for this area.
- required: false
- type: boolean
- default: false
- channel:
- description: Map of the channels in this area.
- required: false
- type: map
- keys:
- CHANNEL_NUMBER:
- description: The Dynalite channel number in the area, 1-255.
- required: true
- type: map
- keys:
- name:
- description: Name of the channel.
- required: false
- type: string
- default: AREA_NAME Channel CHANNEL_NUMBER
- type:
- description: "Type of entity this channel should appear as. Can be either `light` or if this is a device that is not a light (e.g., water heater), can be `switch`."
- require: false
- type: string
- default: light
- fade:
- description: Fade time for the channel, in seconds.
- required: false
- type: float
- default: 2.0
-preset:
- description: "Default presets for any area without the `nodefault` option."
- required: false
- type: map
- keys:
- PRESET_NUMBER:
- description: The Dynalite preset number in the area.
- required: true
- type: map
- keys:
- name:
- description: "Name of the preset. When used in an area, it will be 'AREA_NAME name'. For example, if a room's name is 'Kitchen' and preset 4 is defined with the name `Off`, it will appear in HA as 'Kitchen Off'."
- required: false
- type: string
- default: AREA_NAME Preset PRESET_NUMBER
- fade:
- description: Fade time for the preset, in seconds.
- required: false
- type: float
- default: 2.0
- level:
- description: Level of the channels when the preset is selected, between 0 and 1.
- required: false
- type: float
-template:
- description: Set the default parameters for the templates.
- required: false
- type: map
- keys:
- room:
- description: This is used to define a room that has a preset to turn on all the channels in the area and a preset to turn off.
- required: false
- type: map
- keys:
- room_on:
- description: Preset to turn area on.
- required: false
- type: integer
- default: 1
- room_off:
- description: Preset to turn area off.
- required: false
- type: integer
- default: 4
- time_cover:
- description: "This is used to define a cover that has 3 presets: `open`, `close`, and `stop`. Potentially can also use a channel that some systems (e.g., Control4) use to also send commands to open and close the cover. It uses the duration it takes to open or close to determine position. In addition, many times, these covers include tilt by opening or closing for a short time, so this can be defined as well."
- required: false
- type: map
- keys:
- open:
- description: Preset to open the cover.
- required: false
- type: integer
- default: 1
- close:
- description: Preset to close the cover.
- required: false
- type: integer
- default: 2
- stop:
- description: Preset to stop the cover.
- required: false
- type: integer
- default: 4
- channel_cover:
- description: Channel that monitors the cover.
- required: false
- type: integer
- duration:
- description: Time in seconds it takes to open or close the cover.
- required: false
- type: integer
- default: 60
- tilt:
- description: "Time in seconds it takes to open or close the cover tilt. `0` means that the cover does not support tilt."
- require: false
- type: integer
- default: 0
- class:
- description: "Type of cover for Home Assistant. Any of the possible [cover classes](/integrations/cover/#device-class) (e.g. `blind`, `garage`, `shutter`) are possible."
- require: false
- type: string
- default: shutter
-{% endconfiguration %}
-
-## Examples
-
-```yaml
-# Example configuration.yaml entry specifying optional parameters
-dynalite:
- bridges:
- - host: DEVICE_IP_ADDRESS
- port: 12345
- autodiscover: true
- polltimer: 1
- area:
- '1':
- name: Office
- template: room
- '2':
- name: Living Room
- template: room
- nodefault: true
- room_on: 2
- room_off: 5
- channel:
- '2':
- name: Entrance Spot
- fade: 10.0
- '3':
- name: Dining Table
- preset:
- '5':
- name: Blinking Lights
- '6':
- name: All Off
- fade: 3.0
- '4':
- name: Curtain
- template: time_cover
- preset:
- '1':
- name: "On"
- '4':
- name: "Off"
- template:
- room:
- room_on: 1
- room_off: 4
-```
+There are global setup parameters and advanced parameters that should normally be left as is. The most important part is defining the areas. Each area normally corresponds to a room or function. They have to be added manually via the UI and match the setup of the existing dynalite installation.
## Initial Configuration and Discovery
diff --git a/source/_integrations/ecobee.markdown b/source/_integrations/ecobee.markdown
index 4fb7011be81..08cfc362536 100644
--- a/source/_integrations/ecobee.markdown
+++ b/source/_integrations/ecobee.markdown
@@ -47,8 +47,8 @@ Log in to the regular consumer portal and click the overflow menu button in the
1. Select the **Developer** option from the hamburger menu on the top-right.
2. Select **Create New**.
3. Complete the form on the right. (Neither of the fields are referenced by Home Assistant)
- * Name: Must be unique across all ecobee users.
- * Summary: Does not need to be unique.
+ - Name: Must be unique across all ecobee users.
+ - Summary: Does not need to be unique.
4. Click *Authorization method* and select **ecobee PIN**.
5. Click **Create**.
@@ -83,7 +83,7 @@ api_key:
` | Defines a section that is quoted from another source. Allows attribute `class` with allowed values `danger`, `warning`, `info`, `primary`, `secondary`.
-`` | Defines bold text.
-`` | Defines important text.
-`` | Defines italic text.
-`` | Defines emphasized text.
-`
` | Defines preformatted text.
-`
` | Defines a piece of computer code.
-`
` | Defines a single line break.
-`
-You must [restart Home Assistant](/docs/configuration/#reloading-changes) for the changes to take effect. After restarting, go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the cogwheel. Then, select **Configure** and continue to authorize the app according to the above **Automatic Configuration**, starting at step 2.
+You must [restart Home Assistant](/docs/configuration/#reloading-changes) for the changes to take effect. After restarting, go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the integration. Then, select **Configure** and continue to authorize the app according to the above **Automatic Configuration**, starting at step 2.
## Notifications
@@ -126,12 +126,12 @@ When enabling the auxiliary heat toggle, the ecobee thermostat HVAC mode will be
The ecobee climate entity has some extra attributes to represent the state of the thermostat.
-| Name | Description |
-| ---- | ----------- |
-| `fan` | If the fan is currently on or off: `on` / `off`.
-| `climate_mode` | This is the climate mode that is active, or would be active if no override is active.
-| `equipment_running` | This is a comma-separated list of equipment that is currently running.
-| `fan_min_on_time` | The minimum amount of time (in minutes) that the fan will run per hour. This is determined by the minimum fan runtime setting which can be changed in the ecobee app or on the thermostat itself.
+| Name | Description |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `fan` | If the fan is currently on or off: `on` / `off`. |
+| `climate_mode` | This is the climate mode that is active, or would be active if no override is active. |
+| `equipment_running` | This is a comma-separated list of equipment that is currently running. |
+| `fan_min_on_time` | The minimum amount of time (in minutes) that the fan will run per hour. This is determined by the minimum fan runtime setting which can be changed in the ecobee app or on the thermostat itself. |
## Ventilator
@@ -141,10 +141,10 @@ The ecobee thermostat supports the addition of an accessory. If you have an air
### Number
-| Name | Description |
-| ---- | ----------- |
-| `ventilator_min_on_time_home` | The minimum amount of time (in minutes) that the ventilator will run per hour, when you are home. This is determined by the minimum ventilator runtime setting which can be changed in the ecobee app or on the thermostat itself.
-| `ventilator_min_on_time_away` | The minimum amount of time (in minutes) that the ventilator will run per hour, when you are away. This is determined by the minimum ventilator runtime setting which can be changed in the ecobee app or on the thermostat itself.
+| Name | Description |
+| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ventilator_min_on_time_home` | The minimum amount of time (in minutes) that the ventilator will run per hour, when you are home. This is determined by the minimum ventilator runtime setting which can be changed in the ecobee app or on the thermostat itself. |
+| `ventilator_min_on_time_away` | The minimum amount of time (in minutes) that the ventilator will run per hour, when you are away. This is determined by the minimum ventilator runtime setting which can be changed in the ecobee app or on the thermostat itself. |
## Services
@@ -169,9 +169,9 @@ Creates a vacation on the selected ecobee thermostat.
| `cool_temp` | no | Cooling temperature during the vacation |
| `heat_temp` | no | Heating temperature during the vacation |
| `start_date` | yes | Date the vacation starts in YYYY-MM-DD format |
-| `start_time` | yes | Time the vacation starts in the local time zone. Must be in 24-hour format (HH:MM:SS) |
+| `start_time` | yes | Time the vacation starts in the local time zone. Must be in 24-hour format (HH:MM:SS) |
| `end_date` | yes | Date the vacation ends in YYYY-MM-DD format (14 days from now if not provided) |
-| `end_time` | yes | Time the vacation ends in the local time zone. Must be in 24-hour format (HH:MM:SS) |
+| `end_time` | yes | Time the vacation ends in the local time zone. Must be in 24-hour format (HH:MM:SS) |
| `fan_mode` | yes | Fan mode of the thermostat during the vacation (auto or on) (auto if not provided) |
| `fan_min_on_time` | yes | Minimum number of minutes to run the fan each hour (0 to 60) during the vacation (0 if not provided) |
@@ -188,37 +188,37 @@ Delete a vacation on the selected ecobee thermostat.
Resumes the currently active schedule.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------ |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Use `entity_id: all` to target all. |
-| `resume_all` | no | true or false |
+| `resume_all` | no | true or false |
### Service `ecobee.set_fan_min_on_time`
Sets the minimum amount of time that the fan will run per hour.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------ |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Use `entity_id: all` to target all. |
-| `fan_min_on_time` | no | integer (e.g., 5) |
+| `fan_min_on_time` | no | integer (e.g., 5) |
### Service `ecobee.set_dst_mode`
Enable/disable automatic daylight savings time.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------------------- |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------ |
| `entity_id` | yes | ecobee thermostat on which to set daylight savings time mode |
-| `dst_enabled` | no | true or false |
+| `dst_enabled` | no | true or false |
### Service `ecobee.set_mic_mode`
Enable/disable Alexa mic (only for ecobee 4).
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------------------- |
-| `entity_id` | yes | ecobee thermostat on which to set the mic mode |
-| `mic_enabled` | no | true or false |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------- |
+| `entity_id` | yes | ecobee thermostat on which to set the mic mode |
+| `mic_enabled` | no | true or false |
### Service `ecobee.set_occupancy_modes`
diff --git a/source/_integrations/ecovacs.markdown b/source/_integrations/ecovacs.markdown
index d8066c8aec6..4c9605f9e92 100644
--- a/source/_integrations/ecovacs.markdown
+++ b/source/_integrations/ecovacs.markdown
@@ -79,6 +79,34 @@ logger:
The `ecovacs` vacuum platform allows you to monitor and control your Ecovacs Deebot vacuums.
+### Vacuum services
+
+The `ecovacs` vacuum platform does not support eithor of the services `vacuum.pause` or `vacuum.start`, it supports the following services instead.
+
+#### Service `vacuum.turn_on`
+
+Start a new cleaning task.
+
+| Service data attribute | Optional | Description |
+|---------------------------|----------|-------------------------------------------------------|
+| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
+
+#### Service `vacuum.turn_off`
+
+Stop the current cleaning task and return to the dock.
+
+| Service data attribute | Optional | Description |
+|---------------------------|----------|-------------------------------------------------------|
+| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
+
+#### Service `vacuum.start_pause`
+
+Start, pause or resume a cleaning task.
+
+| Service data attribute | Optional | Description |
+|---------------------------|----------|-------------------------------------------------------|
+| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
+
### Integration lifespan
The remaining lifespan of components on your Deebot vacuum will be reported as attributes on the vacuum entity. The value will be a whole number representing the percentage of life remaining.
diff --git a/source/_integrations/emulated_roku.markdown b/source/_integrations/emulated_roku.markdown
index dfbaac27269..4cc1ca53a37 100644
--- a/source/_integrations/emulated_roku.markdown
+++ b/source/_integrations/emulated_roku.markdown
@@ -79,12 +79,12 @@ After starting up, you can check if the emulated Roku is reachable at the specif
All Roku commands are sent as `roku_command` events.
-Field | Description
------ | -----------
-`source_name` | Name of the emulated Roku instance that sent the event. Only required when using multiple instances to filter event sources.
-`type` | The type of the event that was called on the API.
-`key` | the code of the pressed key when the command `type` is `keypress`, `keyup` or `keydown`.
-`app_id` | the id of the app that was launched when command `type` is `launch`.
+| Field | Description |
+| ------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `source_name` | Name of the emulated Roku instance that sent the event. Only required when using multiple instances to filter event sources. |
+| `type` | The type of the event that was called on the API. |
+| `key` | the code of the pressed key when the command `type` is `keypress`, `keyup` or `keydown`. |
+| `app_id` | the id of the app that was launched when command `type` is `launch`. |
Available key codes |
------------------- |
@@ -131,12 +131,12 @@ When using Harmony, the app should auto-discover any changes via UPnP discovery
Alternatively, you can trigger the 'Fix' page by pressing a button on the unreachable device's remote in the app and wait ~10 seconds, then click 'Fix it'.
Known limitations:
-* Some Android remotes send key up/down events instead of key presses.
-* Functionality other than key presses and app launches are not implemented yet.
-* App ids are limited between 1-10. (The emulated API reports 10 dummy apps)
-* Harmony uses UPnP discovery (UPnP is not needed after pairing), which might not work in Docker. You can:
- * Change Docker to host networking temporarily, then revert after pairing.
- * Run the `advertise.py` helper script from the emulated_roku library directly somewhere else and point it to the emulated Roku API.
-* Harmony cannot launch apps as it uses IR instead of the Wi-Fi API and will not display the custom dummy app list.
-* Home control buttons cannot be assigned to emulated Roku on the Harmony Hub Companion remote as they are limited to Hue (and possibly other APIs) within Harmony.
-* Harmony will not set the name of the added emulated Roku device to the specified `name`.
+- Some Android remotes send key up/down events instead of key presses.
+- Functionality other than key presses and app launches are not implemented yet.
+- App ids are limited between 1-10. (The emulated API reports 10 dummy apps)
+- Harmony uses UPnP discovery (UPnP is not needed after pairing), which might not work in Docker. You can:
+ - Change Docker to host networking temporarily, then revert after pairing.
+ - Run the `advertise.py` helper script from the emulated_roku library directly somewhere else and point it to the emulated Roku API.
+- Harmony cannot launch apps as it uses IR instead of the Wi-Fi API and will not display the custom dummy app list.
+- Home control buttons cannot be assigned to emulated Roku on the Harmony Hub Companion remote as they are limited to Hue (and possibly other APIs) within Harmony.
+- Harmony will not set the name of the added emulated Roku device to the specified `name`.
diff --git a/source/_integrations/enocean.markdown b/source/_integrations/enocean.markdown
index 16b1d0a8cbe..6e830948eef 100644
--- a/source/_integrations/enocean.markdown
+++ b/source/_integrations/enocean.markdown
@@ -158,10 +158,10 @@ name:
The EnOcean sensor platform currently supports the following device types:
- * [power sensor](#power-sensor)
- * [humidity sensor](#humidity-sensor)
- * [temperature sensor](#temperature-sensor)
- * [window handle](#window-handle)
+- [power sensor](#power-sensor)
+- [humidity sensor](#humidity-sensor)
+- [temperature sensor](#temperature-sensor)
+- [window handle](#window-handle)
To use your EnOcean device, you first have to set up your [EnOcean hub](#hub) and then add the following to your `configuration.yaml` file:
diff --git a/source/_integrations/esphome.markdown b/source/_integrations/esphome.markdown
index fc4869e616f..864956d51b1 100644
--- a/source/_integrations/esphome.markdown
+++ b/source/_integrations/esphome.markdown
@@ -3,15 +3,16 @@ title: ESPHome
description: Support for ESPHome devices using the native ESPHome API.
featured: true
ha_category:
+ - Alarm
- DIY
- Update
- - Alarm Control Panel
ha_release: 0.85
ha_iot_class: Local Push
ha_config_flow: true
ha_codeowners:
- '@OttoWinter'
- '@jesserockz'
+ - '@bdraco'
ha_domain: esphome
ha_zeroconf: true
ha_platforms:
diff --git a/source/_integrations/ezviz.markdown b/source/_integrations/ezviz.markdown
index b97f47b072a..4e74f136c1e 100644
--- a/source/_integrations/ezviz.markdown
+++ b/source/_integrations/ezviz.markdown
@@ -45,6 +45,28 @@ Your cameras will now show under integration options as "discovered devices". Pl
You can also change the camera options should you need to access a high or low res stream. Generally, though it will just work without any modification to options.
+### Integration Entity Options
+
+`Request Timeout (seconds)`:
+
+- This option determines the duration Home Assistant waits for data from the EZVIZ API before giving up. This timeout is specified in seconds. If the API response takes longer than the specified timeout, Home Assistant will stop waiting and assume the request has failed. Adjust this value according to your network conditions and the responsiveness of the EZVIZ API. A higher timeout may be necessary for slower connections.
+
+- Example: If you set the **Request Timeout** to 30 seconds (default option), Home Assistant will wait up to 30 seconds for a response from the EZVIZ API before timing out.
+
+- Please note this only works on the main EZVIZ cloud entity.
+
+`Arguments passed to ffmpeg for cameras`:
+
+- This option allows you to define additional parameters for capturing footage from your EZVIZ cameras. While camera resolution and codec settings are typically configured in the "Ezviz Studio" desktop application, you can use this option to select the desired stream or substream for capturing the footage.
+
+- To choose the appropriate stream or substream, specify the corresponding channel path in the `Arguments passed to ffmpeg for cameras` field. The channel path identifies the specific stream or substream of the camera.
+
+- Example: If you want to use the camera's substream, you can specify the channel path as `/Streaming/Channels/102`. Alternatively, if you prefer the main stream, use `/Streaming/Channels/101`. You can also configure multiple stream/substream options based on your camera's capabilities and resource requirements.
+
+- Cameras typically default to the main stream if this is invalid or not specified.
+
+- Please note this only works on the camera entities.
+
### Service `ezviz.alarm_sound`
If your EZVIZ camera supports warning sounds, you can use this service to set the intensity.
diff --git a/source/_integrations/fastdotcom.markdown b/source/_integrations/fastdotcom.markdown
index cdc2546cc50..385ccb7062e 100644
--- a/source/_integrations/fastdotcom.markdown
+++ b/source/_integrations/fastdotcom.markdown
@@ -58,7 +58,7 @@ manual:
type: boolean
{% endconfiguration %}
-#### Time period dictionary example
+### Time period dictionary example
```yaml
scan_interval:
@@ -70,7 +70,7 @@ scan_interval:
milliseconds: 0
```
-### Service
+## Service
Once loaded, the `fastdotcom` integration will expose a service (`fastdotcom.speedtest`) that can be called to run a Fast.com speed test on demand. This service takes no parameters. This can be useful if you have enabled manual mode.
diff --git a/source/_integrations/fireservicerota.markdown b/source/_integrations/fireservicerota.markdown
index 0b98c4fe523..28639f708bd 100644
--- a/source/_integrations/fireservicerota.markdown
+++ b/source/_integrations/fireservicerota.markdown
@@ -49,36 +49,36 @@ The following entity types are created:
This is the main entity of the integration containing the incident message as its `value`, it has several attributes which are described below.
-| Attribute | Description |
-| --------- | ----------- |
-| `trigger` | Type of trigger, `new` or `update`.|
-| `state` | The state of the incident. |
-| `created_at` | Date and time when incident was created.|
-| `message_to_speech_url` | The URL of the mp3 file containing the spoken text of the incident.|
-| `prio` | Priority of the incident, `a1`, `a2`, `b1` or `b2`.|
-| `type` | Type of incident, e.g. `incident_alert`.|
-| `responder_mode` | Modes of response, e.g. `available_in_schedule_is_acknowledgment`.|
-| `can_respond_until` | Date and time until response is accepted.|
-| `latitude` | The Latitude of the incident.|
-| `longitude` | The Longitude of the incident.|
-| `address_type` | Type of address, e.g. `home`.|
-| `formatted_address` | Address in string format.|
-| `task_ids` | ID(s) of appliance(s) or task(s).|
+| Attribute | Description |
+| ----------------------- | ------------------------------------------------------------------- |
+| `trigger` | Type of trigger, `new` or `update`. |
+| `state` | The state of the incident. |
+| `created_at` | Date and time when incident was created. |
+| `message_to_speech_url` | The URL of the mp3 file containing the spoken text of the incident. |
+| `prio` | Priority of the incident, `a1`, `a2`, `b1` or `b2`. |
+| `type` | Type of incident, e.g. `incident_alert`. |
+| `responder_mode` | Modes of response, e.g. `available_in_schedule_is_acknowledgment`. |
+| `can_respond_until` | Date and time until response is accepted. |
+| `latitude` | The Latitude of the incident. |
+| `longitude` | The Longitude of the incident. |
+| `address_type` | Type of address, e.g. `home`. |
+| `formatted_address` | Address in string format. |
+| `task_ids` | ID(s) of appliance(s) or task(s). |
### Duty Binary Sensor
This entity reflects the duty you have scheduled, the value can be `on` = on duty, `off` = no duty. When you have no duty the response switch is disabled which means you cannot respond to a call.
-| Attribute | Description |
-| --------- | ----------- |
-| `start_time` | Start date and time of duty schedule.|
-| `end_time` | End date and time of duty schedule.|
-| `available` | `true` or `false`.|
-| `active` | `true` or `false`.|
-| `assigned_function_ids` | Function id's, e.g. `540`.|
-| `skill_ids` | Skill id's, e.g. `6, 8`.|
-| `type` | Type, e.g. `standby_duty`.|
-| `assigned function` | Assigned function, e.g. `Chauffeur`.|
+| Attribute | Description |
+| ----------------------- | ------------------------------------- |
+| `start_time` | Start date and time of duty schedule. |
+| `end_time` | End date and time of duty schedule. |
+| `available` | `true` or `false`. |
+| `active` | `true` or `false`. |
+| `assigned_function_ids` | Function id's, e.g. `540`. |
+| `skill_ids` | Skill id's, e.g. `6, 8`. |
+| `type` | Type, e.g. `standby_duty`. |
+| `assigned function` | Assigned function, e.g. `Chauffeur`. |
### Incident Response Switch
@@ -87,26 +87,26 @@ It gets reset to `unknown` value with every incident received. Switching it to `
The following attributes are available:
-| Attribute | Description |
-| --------- | ----------- |
-| `user_name` | Your username.|
-| `assigned_skill_ids` | Assigned skill ID's.|
-| `responded_at` | Time you responded.|
-| `start_time` | Incident response start time.|
-| `status` | Status of response, e.g., `pending`.|
-| `reported_status` | Reported status, e.g., `shown_up`.|
-| `arrived_at_station` | `true` or `false`.|
-| `available_at_incident_creation` | `true` or `false`.|
-| `active_duty_function_ids` | Active function ID's, e.g., `540`.|
+| Attribute | Description |
+| -------------------------------- | ------------------------------------ |
+| `user_name` | Your username. |
+| `assigned_skill_ids` | Assigned skill ID's. |
+| `responded_at` | Time you responded. |
+| `start_time` | Incident response start time. |
+| `status` | Status of response, e.g., `pending`. |
+| `reported_status` | Reported status, e.g., `shown_up`. |
+| `arrived_at_station` | `true` or `false`. |
+| `available_at_incident_creation` | `true` or `false`. |
+| `active_duty_function_ids` | Active function ID's, e.g., `540`. |
## Advanced Configuration
With Automation you can configure one or more of the following useful actions:
1. Sound an alarm and/or switch on lights when an emergency incident is received.
-1. Use text-to-speech to play incident details via a media player while getting dressed.
-1. Respond with a response acknowledgment using a door-sensor when leaving the house or by pressing a button to let your teammates know you are underway.
-1. Cast a FireServiceRota dashboard to a Chromecast device. (this requires a Nabu Casa subscription)
+2. Use text-to-speech to play incident details via a media player while getting dressed.
+3. Respond with a response acknowledgment using a door-sensor when leaving the house or by pressing a button to let your teammates know you are underway.
+4. Cast a FireServiceRota dashboard to a Chromecast device. (this requires a Nabu Casa subscription)
These are documented below.
diff --git a/source/_integrations/flexom.markdown b/source/_integrations/flexom.markdown
index d47ec74f02a..fcd18294c98 100644
--- a/source/_integrations/flexom.markdown
+++ b/source/_integrations/flexom.markdown
@@ -2,7 +2,7 @@
title: Bouygues Flexom
description: Connect and control your Bouygues Flexom devices using the Overkiz integration
ha_category:
- - Alarm Control Panel
+ - Alarm
- Binary Sensor
- Button
- Climate
diff --git a/source/_integrations/flume.markdown b/source/_integrations/flume.markdown
index b848386846c..a06342267d2 100644
--- a/source/_integrations/flume.markdown
+++ b/source/_integrations/flume.markdown
@@ -35,9 +35,9 @@ Flume notifications are available via binary sensors. To clear the notifications
The following notifications are supported:
-* Bridge disconnected
-* High flow
-* Leak detected
+- Bridge disconnected
+- High flow
+- Leak detected
## Configuration for Binary Sensor
diff --git a/source/_integrations/folder_watcher.markdown b/source/_integrations/folder_watcher.markdown
index e658d5b5808..f09826cd10f 100644
--- a/source/_integrations/folder_watcher.markdown
+++ b/source/_integrations/folder_watcher.markdown
@@ -12,11 +12,11 @@ ha_integration_type: integration
This integration adds [Watchdog](https://pythonhosted.org/watchdog/) file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files within configured folders. The monitored `event_type` are:
-* `closed`
-* `created`
-* `deleted`
-* `modified`
-* `moved`
+- `closed`
+- `created`
+- `deleted`
+- `modified`
+- `moved`
Configured folders must be added to [allowlist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored.
diff --git a/source/_integrations/foobot.markdown b/source/_integrations/foobot.markdown
index cd545325912..692d0c9a5aa 100644
--- a/source/_integrations/foobot.markdown
+++ b/source/_integrations/foobot.markdown
@@ -41,9 +41,9 @@ sensor:
Every ten minutes, it'll fetch the last ten minutes average of the following measurements:
- * Temperature
- * Humidity
- * Co2
- * VOC
- * PM2.5
- * [Index](https://help.foobot.io/hc/en-us/articles/204814371-What-does-central-number-mean-)
+ - Temperature
+ - Humidity
+ - Co2
+ - VOC
+ - PM2.5
+ - [Index](https://help.foobot.io/hc/en-us/articles/204814371-What-does-central-number-mean-)
diff --git a/source/_integrations/forecast_solar.markdown b/source/_integrations/forecast_solar.markdown
index ecb80e0eb1a..cd02101c586 100644
--- a/source/_integrations/forecast_solar.markdown
+++ b/source/_integrations/forecast_solar.markdown
@@ -101,7 +101,7 @@ updates (based on a higher data resolution), you could [sign up for one
of their plans](https://doc.forecast.solar/doku.php?id=account_models#compare_plans).
To enable the use of the API key with this integration, go to {% my integrations %}.
-On the Forecast.Solar integration, select the cogwheel, then select **Configure**. Enter the
+Select the Forecast.Solar integration, then select **Configure**. Enter the
API key for your account.
## Tweaking the estimations
@@ -132,7 +132,6 @@ To adjust the configuration settings for your Forecast.Solar integration
instance:
1. Browse to your Home Assistant instance.
-1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
-1. If multiple instances of {{ name }} are configured, choose the instance you want to configure.
-1. Select the cogwheel.
-1. Select **Configure**.
+2. Go to **{% my integrations title="Settings > Devices & Services" %}**.
+3. If multiple instances of {{ name }} are configured, choose the instance you want to configure.
+4. Select **Configure**.
diff --git a/source/_integrations/freebox.markdown b/source/_integrations/freebox.markdown
index e537d22acb0..95e52209093 100644
--- a/source/_integrations/freebox.markdown
+++ b/source/_integrations/freebox.markdown
@@ -29,11 +29,11 @@ The `freebox` integration allows you to observe and control [Freebox router](htt
There is currently support for the following device types within Home Assistant:
-* [Sensor](#sensor) with metrics for connection speed, internal temperature, free partition space and missed calls
-* [Binary sensor](#binary-sensor) for monitoring Raid arrays health
-* [Device tracker](#presence-detection) for connected devices
-* [Switch](#switch) to control Wi-Fi
-* [Camera](#camera)
+- [Sensor](#sensor) with metrics for connection speed, internal temperature, free partition space and missed calls
+- [Binary sensor](#binary-sensor) for monitoring Raid arrays health
+- [Device tracker](#presence-detection) for connected devices
+- [Switch](#switch) to control Wi-Fi
+- [Camera](#camera)
{% include integrations/config_flow.md %}
@@ -90,10 +90,10 @@ To use cameras from the Freebox Delta, you will have to add "Gestion de l'alarme
Only the routers with Freebox OS are supported:
-* Freebox V8 also known as Freebox Pop
-* Freebox V7 also known as Freebox Delta
-* Freebox V6 also known as Freebox Revolution
-* Freebox mini 4k
+- Freebox V8 also known as Freebox Pop
+- Freebox V7 also known as Freebox Delta
+- Freebox V6 also known as Freebox Revolution
+- Freebox mini 4k
## Presence Detection
@@ -114,10 +114,10 @@ refreshes the devices states.
This platform offers you sensors to monitor a Freebox router.
The monitored metrics are:
-* Internal temperature
-* Upload and download rates (in KB/s)
-* Free partition space of used disks
-* Number of missed calls
+- Internal temperature
+- Upload and download rates (in KB/s)
+- Free partition space of used disks
+- Number of missed calls
## Binary sensor
diff --git a/source/_integrations/fritz.markdown b/source/_integrations/fritz.markdown
index 2cadc2b7c26..e00bd9fbc86 100644
--- a/source/_integrations/fritz.markdown
+++ b/source/_integrations/fritz.markdown
@@ -19,12 +19,12 @@ ha_iot_class: Local Polling
ha_platforms:
- binary_sensor
- button
- - image
- device_tracker
- diagnostics
- sensor
- switch
- update
+ - image
ha_ssdp: true
ha_integration_type: integration
---
@@ -82,7 +82,7 @@ If no password is given, it will be auto-generated.
## Integration options
It is possible to change some behaviors through the integration options.
-To change the settings, go to {% my integrations title="**Settings** > **Devices & Services**" %}. On the **AVM FRITZ!Box Tools** integration, select the cogwheel. Then select **Configure**.
+To change the settings, go to {% my integrations title="**Settings** > **Devices & Services**" %}. Select the **AVM FRITZ!Box Tools** integration, then select **Configure**.
- **Consider home**: Number of seconds that must elapse before considering a disconnected device "not at home".
- **Enable old discovery method**: Needed on some scenarios like no mesh support (fw <= 6.x), mixed brands network devices or LAN switches.
diff --git a/source/_integrations/frontier_silicon.markdown b/source/_integrations/frontier_silicon.markdown
index 7df6014cf04..a44dcc3d92f 100644
--- a/source/_integrations/frontier_silicon.markdown
+++ b/source/_integrations/frontier_silicon.markdown
@@ -23,12 +23,12 @@ Frontier Silicon is used by many different brands of radio manufacturers.
Supported devices include, but are not limited to:
-* Hama: [IR50], [IR110], [DIR3110]
-* Medion: [Medion Radios]
-* Silvercrest: [SIRD 14 C2 (archived website)]
-* Teufel: [Radio 3sixty (2019)]
-* Roberts: [Roberts Stream 94i]
-* Some models from: Auna, Technisat, Revo, Pinell, Como Audio
+- Hama: [IR50], [IR110], [DIR3110]
+- Medion: [Medion Radios]
+- Silvercrest: [SIRD 14 C2 (archived website)]
+- Teufel: [Radio 3sixty (2019)]
+- Roberts: [Roberts Stream 94i]
+- Some models from: Auna, Technisat, Revo, Pinell, Como Audio
This integration was developed and tested with a [Roberts Stream 94i].
diff --git a/source/_integrations/futurenow.markdown b/source/_integrations/futurenow.markdown
index 00c73141b5f..b1807f5a6d5 100644
--- a/source/_integrations/futurenow.markdown
+++ b/source/_integrations/futurenow.markdown
@@ -12,8 +12,8 @@ ha_integration_type: integration
---
The `futurenow` light platform allows you to use [P5](https://www.p5.hu/) FutureNow relay/dimmer units as lights. Currently supported units:
-* [FutureNow FNIP-6x2AD](https://www.p5.hu/index.php/products/ethernet-modules/265-fnip-6x2ad) dimmer unit (outputs only)
-* [FutureNow FNIP-8x10A](https://www.p5.hu/index.php/products/ethernet-modules/263-fnip-8x10a) relay unit (outputs only)
+- [FutureNow FNIP-6x2AD](https://www.p5.hu/index.php/products/ethernet-modules/265-fnip-6x2ad) dimmer unit (outputs only)
+- [FutureNow FNIP-8x10A](https://www.p5.hu/index.php/products/ethernet-modules/263-fnip-8x10a) relay unit (outputs only)
### Configuration Sample
diff --git a/source/_integrations/gogogate2.markdown b/source/_integrations/gogogate2.markdown
index d7a4cd9652b..6a78f841efe 100644
--- a/source/_integrations/gogogate2.markdown
+++ b/source/_integrations/gogogate2.markdown
@@ -9,7 +9,6 @@ ha_iot_class: Local Polling
ha_domain: gogogate2
ha_codeowners:
- '@vangorra'
- - '@bdraco'
ha_config_flow: true
ha_homekit: true
ha_platforms:
diff --git a/source/_integrations/google.markdown b/source/_integrations/google.markdown
index a80711dcca3..c0cfd25fadb 100644
--- a/source/_integrations/google.markdown
+++ b/source/_integrations/google.markdown
@@ -95,9 +95,9 @@ For example, your calendar named *Personal* is created as entity `calendar.perso
Individual Calendar *Events* are what powering automations such as:
-* Turn on a light at the *start* of the event named *Front Yard Light*
-* Send a notification *5 minutes before the start of any event*
-* Stop the media player *30 minutes after* the *end* of the event named *Exercise*.
+- Turn on a light at the *start* of the event named *Front Yard Light*
+- Send a notification *5 minutes before the start of any event*
+- Stop the media player *30 minutes after* the *end* of the event named *Exercise*.
See [Calendar Automations](/integrations/calendar#automation) for an overview, and read more about [Calendar Trigger Variables](/docs/automation/templating/#calendar) for the available information you can use in a condition or action such as the event `summary`, `description`, `location` and more.
@@ -137,16 +137,16 @@ This will only be available if you have given Home Assistant `read-write` access
A calendar `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields:
-| Service data attribute | Optional | Description | Example |
-| ---------------------- | -------- | ----------- | --------|
-| `summary` | no | Acts as the title of the event. | Bowling
-| `description` | yes | The description of the event. | Birthday bowling
-| `start_date_time` | yes | The date and time the event should start. | 2019-03-10 20:00:00
-| `end_date_time` | yes | The date and time the event should end. | 2019-03-10 23:00:00
-| `start_date` | yes | The date the whole day event should start. | 2019-03-10
-| `end_date` | yes | The date the whole day event should end. | 2019-03-11
-| `in` | yes | Days or weeks that you want to create the event in. | "days": 2
-| `location` | yes | The location of the event. | Bowling center
+| Service data attribute | Optional | Description | Example |
+| ---------------------- | -------- | --------------------------------------------------- | ------------------- |
+| `summary` | no | Acts as the title of the event. | Bowling |
+| `description` | yes | The description of the event. | Birthday bowling |
+| `start_date_time` | yes | The date and time the event should start. | 2019-03-10 20:00:00 |
+| `end_date_time` | yes | The date and time the event should end. | 2019-03-10 23:00:00 |
+| `start_date` | yes | The date the whole day event should start. | 2019-03-10 |
+| `end_date` | yes | The date the whole day event should end. | 2019-03-11 |
+| `in` | yes | Days or weeks that you want to create the event in. | "days": 2 |
+| `location` | yes | The location of the event. | Bowling center |
diff --git a/source/_integrations/google_assistant.markdown b/source/_integrations/google_assistant.markdown
index 3fdba659654..89a8bc040b2 100644
--- a/source/_integrations/google_assistant.markdown
+++ b/source/_integrations/google_assistant.markdown
@@ -83,10 +83,10 @@ To use Google Assistant, your Home Assistant configuration has to be [externally
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 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.
+ 10. Go back to [Google Cloud Platform](https://console.cloud.google.com/) and select **Close**.
+ 11. Then select **SAVE**.
+ 12. Go to the **Search products and resources** and search for **Homegraph API** and select it.
+ 13. 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).
diff --git a/source/_integrations/google_cloud.markdown b/source/_integrations/google_cloud.markdown
index c424d867dbd..884158516f5 100644
--- a/source/_integrations/google_cloud.markdown
+++ b/source/_integrations/google_cloud.markdown
@@ -30,9 +30,9 @@ tts:
API key obtaining process described in corresponding documentation:
-* [Text-to-speech](https://cloud.google.com/text-to-speech/docs/quickstart-protocol)
-* [Speech-to-text](https://cloud.google.com/speech-to-text/docs/quickstart-protocol)
-* [Geocoding](https://developers.google.com/maps/documentation/geocoding/start)
+- [Text-to-speech](https://cloud.google.com/text-to-speech/docs/quickstart-protocol)
+- [Speech-to-text](https://cloud.google.com/speech-to-text/docs/quickstart-protocol)
+- [Geocoding](https://developers.google.com/maps/documentation/geocoding/start)
Basic instruction for all APIs:
@@ -43,9 +43,9 @@ Basic instruction for all APIs:
5. Enable needed Cloud API visiting one of the links below or [APIs library](https://console.cloud.google.com/apis/library), selecting your `Project` from the dropdown list and clicking the `Continue` button:
- * [Text-to-speech](https://console.cloud.google.com/flows/enableapi?apiid=texttospeech.googleapis.com)
- * [Speech-to-text](https://console.cloud.google.com/flows/enableapi?apiid=speech.googleapis.com)
- * [Geocoding](https://console.cloud.google.com/flows/enableapi?apiid=geocoding-backend.googleapis.com)
+ - [Text-to-speech](https://console.cloud.google.com/flows/enableapi?apiid=texttospeech.googleapis.com)
+ - [Speech-to-text](https://console.cloud.google.com/flows/enableapi?apiid=speech.googleapis.com)
+ - [Geocoding](https://console.cloud.google.com/flows/enableapi?apiid=geocoding-backend.googleapis.com)
6. Set up authentication:
1. Visit [this link](https://console.cloud.google.com/apis/credentials/serviceaccountkey)
@@ -67,7 +67,7 @@ Basic instruction for all APIs:
The Cloud text-to-speech API is priced monthly based on the amount of characters to synthesize into audio sent to the service.
| Feature | Monthly free tier | Paid usage |
-|-------------------------------|---------------------------|-----------------------------------|
+| ----------------------------- | ------------------------- | --------------------------------- |
| Standard (non-WaveNet) voices | 0 to 4 million characters | $4.00 USD / 1 million characters |
| WaveNet voices | 0 to 1 million characters | $16.00 USD / 1 million characters |
diff --git a/source/_integrations/google_generative_ai_conversation.markdown b/source/_integrations/google_generative_ai_conversation.markdown
index 1785e109317..65cd64d6d5f 100644
--- a/source/_integrations/google_generative_ai_conversation.markdown
+++ b/source/_integrations/google_generative_ai_conversation.markdown
@@ -14,7 +14,7 @@ ha_integration_type: service
The Google Generative AI integration adds a conversation agent powered by [Google Generative AI](https://developers.generativeai.google/) in Home Assistant.
-This conversation agent is unable to control your house. It can only query information that has been provided by Home Assistant. To be able to answer questions about your house, Home Assistant will need to provide Google Generative AI with the details of your house, which include areas, devices and their states.
+This conversation agent is unable to control your house. The Google Generative AI conversation agent can be used in automations, but not as a [sentence trigger](/docs/automation/trigger/#sentence-trigger). It can only query information that has been provided by Home Assistant. To be able to answer questions about your house, Home Assistant will need to provide Google Generative AI with the details of your house, which include areas, devices and their states.
This integration requires an API key to use, [which you can generate here](https://makersuite.google.com/app/apikey).
diff --git a/source/_integrations/habitica.markdown b/source/_integrations/habitica.markdown
index cd76006c36b..855d7590e68 100644
--- a/source/_integrations/habitica.markdown
+++ b/source/_integrations/habitica.markdown
@@ -71,19 +71,19 @@ url:
The API is exposed to Home Assistant as a service called `habitica.api_call`. To call it you should specify this keys in service data:
-| Service data attribute | Required | Type | Description |
-|----------------------|--------|--------|----------------|
-| `name` | yes | string | Habitica's username as per `configuration.yaml` entry. |
-| `path` | yes | [string] | Items from API URL in form of an array with method attached at the end. See the example below. |
-| `args` | no | map | Any additional JSON or URL parameter arguments. See the example below and [apidoc](https://habitica.com/apidoc/). |
+| Service data attribute | Required | Type | Description |
+| ---------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
+| `name` | yes | string | Habitica's username as per `configuration.yaml` entry. |
+| `path` | yes | [string] | Items from API URL in form of an array with method attached at the end. See the example below. |
+| `args` | no | map | Any additional JSON or URL parameter arguments. See the example below and [apidoc](https://habitica.com/apidoc/). |
A successful call to this service will fire an event `habitica_api_call_success`.
-| Event data attribute | Type | Description |
-|----------------------|--------|----------------|
-| `name` | string | Copied from service data attribute. |
-| `path` | [string] | Copied from service data attribute. |
-| `data` | map | Deserialized `data` field of JSON object Habitica's server returned in response to API call. For more info see the [API documentation](https://habitica.com/apidoc/). |
+| Event data attribute | Type | Description |
+| -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `name` | string | Copied from service data attribute. |
+| `path` | [string] | Copied from service data attribute. |
+| `data` | map | Deserialized `data` field of JSON object Habitica's server returned in response to API call. For more info see the [API documentation](https://habitica.com/apidoc/). |
#### Let's consider some examples on how to call the service.
@@ -92,12 +92,12 @@ Let's create a new task (a todo) for this user via Home Assistant. There is an [
To create a new task one should hit `https://habitica.com/api/v3/tasks/user` endpoint with `POST` request with a JSON object with task properties.
So let's call the API on `habitica.api_call`.
-* The `name` key becomes `xxxNotAValidNickxxx`.
-* The `path` key is trickier.
- * Remove `https://habitica.com/api/v3/` at the beginning of the endpoint URL.
- * Split the remaining on slashes (/) and **append the lowercase method** at the end.
- * You should get `["tasks", "user", "post"]`. To get a better idea of the API you are recommended to try all of the API calls in IPython console [using this package](https://github.com/ASMfreaK/habitipy/blob/master/README.md).
-* The `args` key is more or less described in the [API documentation](https://habitica.com/apidoc/).
+- The `name` key becomes `xxxNotAValidNickxxx`.
+- The `path` key is trickier.
+ - Remove `https://habitica.com/api/v3/` at the beginning of the endpoint URL.
+ - Split the remaining on slashes (/) and **append the lowercase method** at the end.
+ - You should get `["tasks", "user", "post"]`. To get a better idea of the API you are recommended to try all of the API calls in IPython console [using this package](https://github.com/ASMfreaK/habitipy/blob/master/README.md).
+- The `args` key is more or less described in the [API documentation](https://habitica.com/apidoc/).
Combining all together:
call `habitica.api_call` with data
diff --git a/source/_integrations/harmony.markdown b/source/_integrations/harmony.markdown
index 53b7631ebcf..8471327d2b9 100644
--- a/source/_integrations/harmony.markdown
+++ b/source/_integrations/harmony.markdown
@@ -64,7 +64,7 @@ Start an activity. Will start the default `activity` from `configuration.yaml` i
| `entity_id` | no | Entity ID to target.
| `activity` | yes | Activity ID or Activity Name to start.
-##### Example
+#### Example
In the file 'harmony_REMOTENAME.conf' you can find the available activities, for example:
diff --git a/source/_integrations/hdmi_cec.markdown b/source/_integrations/hdmi_cec.markdown
index 615c8d30837..cf681a6dbb9 100644
--- a/source/_integrations/hdmi_cec.markdown
+++ b/source/_integrations/hdmi_cec.markdown
@@ -18,6 +18,12 @@ The `hdmi_cec` integration provides services that allow selecting the active dev
## CEC Setup
+### Home Assistant OS
+
+To test if HDMI-CEC will work on your Home Assistant OS installation, you can use the official **CEC Scanner** add-on. Run this add-on to see if your hardware has HDMI-CEC capabilities and which devices are connected. Do not have this add-on **Start on boot** as it will interfere with the integration.
+
+Once you've run the add-on, you can use the resulting scan information to configure the integration.
+
### Adapter
The computer running Home Assistant must support CEC, and of course be connected via HDMI to a device also supporting CEC. You can purchase a [USB CEC adapter](https://www.pulse-eight.com/p/104/usb-hdmi-cec-adapter) to add support if necessary. Note that all Raspberry Pi models support CEC natively.
@@ -56,13 +62,13 @@ If after symlinking and adding `hdmi_cec:` to your configuration you are getting
## Testing your installation
-* Login to Raspberry Pi
+- Login to Raspberry Pi
```bash
ssh pi@your_raspberry_pi_ip
```
-* at the command line type:
+- at the command line type:
```bash
echo scan | cec-client -s -d 1
@@ -70,7 +76,7 @@ echo scan | cec-client -s -d 1
Note: to use this command you have to install cec-utils package. In Debian based should be: ```sudo apt install cec-utils```
-* This will give you the list of devices that are on the bus
+- This will give you the list of devices that are on the bus
```bash
opening a connection to the CEC adapter...
@@ -252,5 +258,5 @@ value is ignored.
## Useful References
-* [CEC overview](https://kwikwai.com/knowledge-base/the-hdmi-cec-bus/)
-* [CEC-o-matic](https://www.cec-o-matic.com/)
+- [CEC overview](https://kwikwai.com/knowledge-base/the-hdmi-cec-bus/)
+- [CEC-o-matic](https://www.cec-o-matic.com/)
diff --git a/source/_integrations/hexaom.markdown b/source/_integrations/hexaom.markdown
index 834c7f940f2..f8dc82274b1 100644
--- a/source/_integrations/hexaom.markdown
+++ b/source/_integrations/hexaom.markdown
@@ -2,7 +2,7 @@
title: Hexaom Hexaconnect
description: Connect and control your Hexaom Hexaconnect devices using the Overkiz integration
ha_category:
- - Alarm Control Panel
+ - Alarm
- Binary Sensor
- Button
- Climate
diff --git a/source/_integrations/hi_kumo.markdown b/source/_integrations/hi_kumo.markdown
index 2daeeeb300b..e30c1cb547c 100644
--- a/source/_integrations/hi_kumo.markdown
+++ b/source/_integrations/hi_kumo.markdown
@@ -2,7 +2,7 @@
title: Hitachi Hi Kumo
description: Connect and control your Hitachi Hi Kumo devices using the Overkiz integration
ha_category:
- - Alarm Control Panel
+ - Alarm
- Binary Sensor
- Button
- Climate
diff --git a/source/_integrations/hive.markdown b/source/_integrations/hive.markdown
index 8517ae03d7b..0ee2da5df69 100644
--- a/source/_integrations/hive.markdown
+++ b/source/_integrations/hive.markdown
@@ -2,7 +2,7 @@
title: Hive
description: Instructions on how to integrate Hive devices with Home Assistant.
ha_category:
- - Alarm Control Panel
+ - Alarm
- Binary Sensor
- Climate
- Hub
diff --git a/source/_integrations/homekit_controller.markdown b/source/_integrations/homekit_controller.markdown
index 0031f04f0fe..27b32f6e10d 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,66 +45,77 @@ 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/) integration.
+# Adding a HomeKit device
-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.
+There are different methods to add a HomeKit device to Home Assistant:
-## Supported devices
+- [via Ethernet or Wi-Fi](#adding-a-homekit-device-via-ethernet-or-wi-fi)
+- [via Bluetooth](#adding-a-homekit-device-through-bluetooth)
+- via Thread
+ - [by using Home Assistant’s preferred Thread network](#adding-a-homekit-device-to-a-thread-network-via-home-assistant)
+ - [by using Apple Thread border router](#adding-a-homekit-device-via-apple-thread-border-router)
-There is currently support for the following device types within Home Assistant:
+## Adding a HomeKit device via Ethernet or Wi-Fi
-- Alarm Control Panel (HomeKit security system)
-- Climate (HomeKit thermostats and air conditioners)
-- Cover (HomeKit garage door openers, windows, or window coverings)
-- Light (HomeKit lights)
-- Lock (HomeKit lock)
-- Switch (HomeKit switches, outlets and valves)
-- Binary Sensor (HomeKit motion, contact, occupancy, carbon monoxide and smoke sensors)
-- Sensor (HomeKit humidity, temperature, co2 and light level sensors)
-- Fan
-- Air Quality
-- Humidifier (HomeKit humidifiers and dehumidifiers)
-- Automation Triggers (HomeKit 'stateless' accessories like buttons, remotes and doorbells)
-
-
-
-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.
-
-
-
-HomeKit IP accessories for these device types may work with some caveats:
-
-- If the device is Wi-Fi based and has no physical controls or screen then you may need an Apple HomeKit device like an iPhone or iPad to get the accessory onto your Wi-Fi network. For example, for a Koogeek LS1 you must add the accessory to HomeKit on your iOS device, then remove it from the iOS device. This leaves the LS1 in an unpaired state but still on your Wi-Fi. Home Assistant can then find it and pair with it.
-- You need to know the HomeKit PIN. There is no way to recover this if you do not have it. In this case, you will need to contact the manufacturer to see what options you have.
-
-The integration will poll your devices, but it will also automatically enable push updates for accessories that support it.
-
-## 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.
+The HomeKit controller integration automatically detects HomeKit [compatible devices](#supported-devices) on your network when they are ready to pair.
### Prerequisites
+- If you do not have the [`default_config`](/integrations/default_config/) integration, add [`zeroconf`](/integrations/zeroconf/) to your `configuration.yaml` file.
+- Find your HomeKit pairing code. The code is on the device itself, or on the packaging. If your device has a screen, it may be shown on screen.
+ - There is no way to recover this if you do not have it. In this case, you will need to contact the manufacturer to see what options you have.
+- Make sure your device is powered up.
+- Make sure the device is on your network, but not paired with another HomeKit controller. Depending on the device, you need to follow a different set of steps:
+ - If your device is not already in your network: Join the device to your network:
+ - Follow the instructions of the manufacturer on how to join the device to the network
+ - If the device is HomeKit only (for example the Koogeek LS1 light strip), pair it with the Apple Home app, then follow the next step.
+ - If your device is in your network but is paired with an Apple device via HomeKit: **Remove** the device from the Apple Home app.
+ - Otherwise you won't be able to pair it with Home Assistant.
+ - **Explanation:** Adding the device to the Home app and then removing it again has two effects:
+ - It adds the device to your network. It stays in the network even after you removed it from the app.
+ - Removing the device from the app opens it up for pairing with Home Assistant's HomeKit Controller integration directly. HomeKit devices can only be paired to a single controller at once.
+
+
+### To add a HomeKit device via Ethernet or Wi-Fi
+
+1. The device should have been discovered under **{% my integrations title="Settings > Devices & Services" %}**.
+2. On the HomeKit integration, select **Configure**.
+
+ 
+3. Enter your HomeKit pairing code.
+ - Add the device to a room and select **Finish**.
+ - The device should now be added to your Home Assistant instance.
+4. 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.
+
+## Adding a HomeKit device through Bluetooth
+
+You can add a HomeKit [compatible device](#supported-devices) to Home Assistant via [Bluetooth](/integrations/bluetooth).
+
+### Prerequisites
+
+- Find your HomeKit pairing code. The code is on the device itself, or on the packaging. If your device has a screen, it may be shown on screen.
+ - There is no way to recover this if you do not have it. In this case, you will need to contact the manufacturer to see what options you have.
- 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.
-## To add a HomeKit device through Bluetooth
+### To add a HomeKit device through Bluetooth
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.
+2. On the HomeKit integration, select **Configure**.
+
+ 
+3. To pair the device, enter the HomeKit pairing code.
- 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:
+There are two methods to add a HomeKit [compatible device](#supported-devices) 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)
@@ -125,22 +136,22 @@ This section describes how to add it via Home Assistant's preferred Thread netwo
### 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**.
+2. 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.
+3. 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
+## Adding a HomeKit device via Apple Thread border router
-There are two methods to add a HomeKit device to a Thread network:
+There are two methods to add a HomeKit [compatible device](#supported-devices) 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.
+This section describes how to add a HomeKit [compatible device](#supported-devices) using an Apple Thread border router device such as a HomePod mini.
### Prerequisites
@@ -149,26 +160,51 @@ This section describes how to add a HomeKit device using an Apple Thread border
- 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
+### To add a HomeKit device 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**.
+2. 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.
+3. 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:
+4. To open the device configuration page, on the **HomeKit** integration, select the **device**.
+5. 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.
+## Supported devices
+
+There is currently support for the following device types (also called *domains*) within Home Assistant. They are listed with their default types.
+
+- Alarm Control Panel (HomeKit security system)
+- Climate (HomeKit thermostats and air conditioners)
+- Cover (HomeKit garage door openers, windows, or window coverings)
+- Light (HomeKit lights)
+- Lock (HomeKit lock)
+- Switch (HomeKit switches, outlets and valves)
+- Binary Sensor (HomeKit motion, contact, occupancy, carbon monoxide and smoke sensors)
+- Sensor (HomeKit humidity, temperature, co2 and light level sensors)
+- Fan
+- Air Quality
+- Humidifier (HomeKit humidifiers and dehumidifiers)
+- Automation Triggers (HomeKit 'stateless' accessories like buttons, remotes and doorbells)
+
+
+
+ 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.
+
+
+
+The integration will enable push updates. Devices that connect through Wi-Fi or Ethernet may fall back to only polling if the connection is unstable.
+
## 'Stateless' switches and sensors
Some HomeKit devices (like buttons, remotes and doorbells) don't have sensors that can be read like a normal HomeKit device - they only inform Home Assistant when something happens. This means Home Assistant can't show an entity for them, as they have no state. But they are available for use as [device automations](/integrations/device_automation/).
diff --git a/source/_integrations/homematicip_cloud.markdown b/source/_integrations/homematicip_cloud.markdown
index 93cb494457f..3e349c200dc 100644
--- a/source/_integrations/homematicip_cloud.markdown
+++ b/source/_integrations/homematicip_cloud.markdown
@@ -35,16 +35,16 @@ The [HomematicIP](https://www.homematic-ip.com/) integration platform is used as
There is currently support for the following device types within Home Assistant:
-* Alarm
-* Binary Sensor
-* Button
-* Climate
-* Cover
-* Light
-* Lock
-* Sensor
-* Switch
-* Weather
+- Alarm
+- Binary Sensor
+- Button
+- Climate
+- Cover
+- Light
+- Lock
+- Sensor
+- Switch
+- Weather
{% include integrations/config_flow.md %}
@@ -89,112 +89,112 @@ Within this delay the device registration should be completed in the App, otherw
## Implemented and tested devices
-* homematicip_cloud.alarm_control_panel
- * Combined Alarm Control Panal with INTERNAL and EXTERNAL Security zones (*HmIP-SecurityZone*)
+- homematicip_cloud.alarm_control_panel
+ - Combined Alarm Control Panal with INTERNAL and EXTERNAL Security zones (*HmIP-SecurityZone*)
-* homematicip_cloud.binary_sensor
- * Access Point Cloud Connection (*HmIP-HAP, HmIP-HAP-B1*)
- * Acceleration Sensor (*HMIP-SAM*)
- * Inclination and vibration Sensor (*HMIP-STV*)
- * Window and door contact (*HmIP-SWDO, HmIP-SWDO-PL, HmIP-SWDO-I, HmIP-SWDM, HmIP-SWDM-B2*)
- * Contact Interface flush-mount – 1x channel (*HmIP-FCI1*)
- * Contact Interface flush-mount – 6x channels (*HmIP-FCI6*)
- * Contact Interface (*HmIP-SCI*)
- * Window Rotary Handle Sensor (*HmIP-SRH*)
- * Smoke sensor and alarm (*HmIP-SWSD*)
- * Motion Detector with Brightness Sensor - indoor (*HmIP-SMI*)
- * Motion Detector with Brightness Sensor - outdoor (*HmIP-SMO*)
- * Presence Sensor – indoor (*HmIP-SPI*)
- * Rain Sensor (*HmIP-SRD*)
- * Water Sensor (*HmIP-SWD*)
- * Remote Control - 8x buttons (*HmIP-RC8*) (battery only)
- * Wall-mount Remote Control - 2x buttons (*HmIP-WRC2*) (battery only)
- * Wall-mount Remote Control - flat - 2x buttons (*HmIP-WRCC2*) (battery only)
- * Wall-mount Remote Control - 6x buttons (*HmIP-WRC6*) (battery only)
- * Key Ring Remote Control - 4x buttons (*HmIP-KRC4*) (battery only)
- * Key Ring Remote Control - alarm (*HmIP-KRCA*) (battery only)
- * Alarm Siren (*HmIP-ASIR, -B1*) (battery only)
- * Remote Control for brand switches – 2x buttons (*HmIP-BRC2*) (battery only)
- * Pluggable Power Supply Monitoring (*HmIP-PMFS*)
- * Wired Inbound module – 32x channels (*HMIPW-DRI32*)
+- homematicip_cloud.binary_sensor
+ - Access Point Cloud Connection (*HmIP-HAP, HmIP-HAP-B1*)
+ - Acceleration Sensor (*HMIP-SAM*)
+ - Inclination and vibration Sensor (*HMIP-STV*)
+ - Window and door contact (*HmIP-SWDO, HmIP-SWDO-PL, HmIP-SWDO-I, HmIP-SWDM, HmIP-SWDM-B2*)
+ - Contact Interface flush-mount – 1x channel (*HmIP-FCI1*)
+ - Contact Interface flush-mount – 6x channels (*HmIP-FCI6*)
+ - Contact Interface (*HmIP-SCI*)
+ - Window Rotary Handle Sensor (*HmIP-SRH*)
+ - Smoke sensor and alarm (*HmIP-SWSD*)
+ - Motion Detector with Brightness Sensor - indoor (*HmIP-SMI*)
+ - Motion Detector with Brightness Sensor - outdoor (*HmIP-SMO*)
+ - Presence Sensor – indoor (*HmIP-SPI*)
+ - Rain Sensor (*HmIP-SRD*)
+ - Water Sensor (*HmIP-SWD*)
+ - Remote Control - 8x buttons (*HmIP-RC8*) (battery only)
+ - Wall-mount Remote Control - 2x buttons (*HmIP-WRC2*) (battery only)
+ - Wall-mount Remote Control - flat - 2x buttons (*HmIP-WRCC2*) (battery only)
+ - Wall-mount Remote Control - 6x buttons (*HmIP-WRC6*) (battery only)
+ - Key Ring Remote Control - 4x buttons (*HmIP-KRC4*) (battery only)
+ - Key Ring Remote Control - alarm (*HmIP-KRCA*) (battery only)
+ - Alarm Siren (*HmIP-ASIR, -B1*) (battery only)
+ - Remote Control for brand switches – 2x buttons (*HmIP-BRC2*) (battery only)
+ - Pluggable Power Supply Monitoring (*HmIP-PMFS*)
+ - Wired Inbound module – 32x channels (*HMIPW-DRI32*)
-* homematicip_cloud.button
- * Wall Mounted Garage Door Controller (*HmIP-WGC*)
+- homematicip_cloud.button
+ - Wall Mounted Garage Door Controller (*HmIP-WGC*)
-* homematicip_cloud.climate
- * Climate group (*HmIP-HeatingGroup*)
- * This includes temperature/humidity measures for climate devices of a room delivered by:
- * Wall-mounted thermostat (*HmIP-WTH, HmIP-WTH-2, HmIP-WTH-B*)
- * Brand Wall-mounted thermostat (*HmIP-BWTH, HmIP-BWTH-24*)
- * Radiator thermostat (*HmIP-eTRV, HmIP-eTRV-2, HmIP-eTRV-C*) - should also work with (*HmIP-eTRV-2-UK, HmIP-eTRV-2-B, HmIP-eTRV-2-B1*)
- * Temperature and humidity sensor (*HmIP-STH*)
- * Temperature and humidity Sensor with display (*HmIP-STHD*)
- * Alpha IP Wall Thermostat Display (*ALPHA-IP-RBG*)
- * Alpha IP Wall Thermostat Display analog (*ALPHA-IP-RBGa*)
- * There is no need to directly support the following devices by Home Assistant, because their integration is done by the required wall thermostats:
- * Floor Heating Actuator – 6x channels, 230V (*HMIP-FAL230-C6*)
- * Floor Heating Actuator – 10x channels, 230V (*HMIP-FAL230-C10*)
- * Floor Heating Actuator – 6x channels, 24V (*HMIP-FAL24-C6*)
- * Floor Heating Actuator – 10x channels, 24V (*HMIP-FAL24-C10*)
- * Floor Heating Actuator – 12x channels, motorized (*HMIP-FALMOT-C12*)
+- homematicip_cloud.climate
+ - Climate group (*HmIP-HeatingGroup*)
+ - This includes temperature/humidity measures for climate devices of a room delivered by:
+ - Wall-mounted thermostat (*HmIP-WTH, HmIP-WTH-2, HmIP-WTH-B*)
+ - Brand Wall-mounted thermostat (*HmIP-BWTH, HmIP-BWTH-24*)
+ - Radiator thermostat (*HmIP-eTRV, HmIP-eTRV-2, HmIP-eTRV-C*) - should also work with (*HmIP-eTRV-2-UK, HmIP-eTRV-2-B, HmIP-eTRV-2-B1*)
+ - Temperature and humidity sensor (*HmIP-STH*)
+ - Temperature and humidity Sensor with display (*HmIP-STHD*)
+ - Alpha IP Wall Thermostat Display (*ALPHA-IP-RBG*)
+ - Alpha IP Wall Thermostat Display analog (*ALPHA-IP-RBGa*)
+ - There is no need to directly support the following devices by Home Assistant, because their integration is done by the required wall thermostats:
+ - Floor Heating Actuator – 6x channels, 230V (*HMIP-FAL230-C6*)
+ - Floor Heating Actuator – 10x channels, 230V (*HMIP-FAL230-C10*)
+ - Floor Heating Actuator – 6x channels, 24V (*HMIP-FAL24-C6*)
+ - Floor Heating Actuator – 10x channels, 24V (*HMIP-FAL24-C10*)
+ - Floor Heating Actuator – 12x channels, motorized (*HMIP-FALMOT-C12*)
-* homematicip_cloud.cover
- * Shutter actuator for brand-mount (*HmIP-BROLL*)
- * Shutter actuator for flush-mount (*HmIP-FROLL*)
- * Blind Actuator for brand switches (*HmIP-BBL*)
- * Blind Actuator for DIN rail mount – 4x channels (*HMIP-DRBLI4*)
- * Blind Actuator for flush-mount (*HmIP-FBL*)
- * Garage door module for Tormatic (*HmIP-MOD_TM*)
- * Module for Hoermann drives (*HMIP-MOD-HO*)
- * Hunter Douglas & erfal window blinds (*HMIP-HDM1*)
+- homematicip_cloud.cover
+ - Shutter actuator for brand-mount (*HmIP-BROLL*)
+ - Shutter actuator for flush-mount (*HmIP-FROLL*)
+ - Blind Actuator for brand switches (*HmIP-BBL*)
+ - Blind Actuator for DIN rail mount – 4x channels (*HMIP-DRBLI4*)
+ - Blind Actuator for flush-mount (*HmIP-FBL*)
+ - Garage door module for Tormatic (*HmIP-MOD_TM*)
+ - Module for Hoermann drives (*HMIP-MOD-HO*)
+ - Hunter Douglas & erfal window blinds (*HMIP-HDM1*)
-* homematicip_cloud.light
- * Switch actuator and meter for brand switches (*HmIP-BSM*)
- * Dimming actuator for brand switches (*HmIP-BDT*)
- * Dimming actuator flush-mount (*HmIP-FDT*)
- * Pluggable Dimmer – trailing edge (*HmIP-PDT*)
- * Switch Actuator for brand switches – with signal lamp (*HmIP-BSL*)
- * Wired Dimmer module – 3x channels (*HMIPW-DRD3*)
+- homematicip_cloud.light
+ - Switch actuator and meter for brand switches (*HmIP-BSM*)
+ - Dimming actuator for brand switches (*HmIP-BDT*)
+ - Dimming actuator flush-mount (*HmIP-FDT*)
+ - Pluggable Dimmer – trailing edge (*HmIP-PDT*)
+ - Switch Actuator for brand switches – with signal lamp (*HmIP-BSL*)
+ - Wired Dimmer module – 3x channels (*HMIPW-DRD3*)
-* homematicip_cloud.lock
- * Door Lock Drive - currently, usage just without a pin is possible (*HmIP-DLD*)
+- homematicip_cloud.lock
+ - Door Lock Drive - currently, usage just without a pin is possible (*HmIP-DLD*)
-* homematicip_cloud.sensor
- * Access Point Duty Cycle (*HmIP-HAP, HmIP-HAP-B1*)
- * Wall Mounted Thermostat (*HmIP-WTH, HmIP-WTH2, HmIP-WTH-B*)
- * Radiator thermostat (*HmIP-eTRV, HmIP-eTRV-2, HmIP-eTRV-C*) - should also work with (*HmIP-eTRV-2-UK, HmIP-eTRV-2-B, HmIP-eTRV-2-B1*)
- * Temperature and Humidity Sensor without display - indoor (*HmIP-STH*)
- * Temperature and Humidity Sensor with display - indoor (*HmIP-STHD*)
- * Temperature and Humidity sensor - outdoor (*HmIP-STHO, -A*)
- * Temperature sensor with external probes - 2-way (*HmIP-STE2-PCB*)
- * Motion Detector with Brightness Sensor - indoor (*HmIP-SMI*)
- * Motion Detector with Brightness Sensor - outdoor (*HmIP-SMO*)
- * Presence Sensor – indoor (*HmIP-SPI*)
- * Light Sensor - outdoor (*HmIP-SLO*)
- * Passage Sensor with Direction Recognition (*HmIP-SPDR*) (delta counter)
- * Alpha IP Wall Thermostat Display (*ALPHA-IP-RBG*)
- * Alpha IP Wall Thermostat Display analog (*ALPHA-IP-RBGa*)
+- homematicip_cloud.sensor
+ - Access Point Duty Cycle (*HmIP-HAP, HmIP-HAP-B1*)
+ - Wall Mounted Thermostat (*HmIP-WTH, HmIP-WTH2, HmIP-WTH-B*)
+ - Radiator thermostat (*HmIP-eTRV, HmIP-eTRV-2, HmIP-eTRV-C*) - should also work with (*HmIP-eTRV-2-UK, HmIP-eTRV-2-B, HmIP-eTRV-2-B1*)
+ - Temperature and Humidity Sensor without display - indoor (*HmIP-STH*)
+ - Temperature and Humidity Sensor with display - indoor (*HmIP-STHD*)
+ - Temperature and Humidity sensor - outdoor (*HmIP-STHO, -A*)
+ - Temperature sensor with external probes - 2-way (*HmIP-STE2-PCB*)
+ - Motion Detector with Brightness Sensor - indoor (*HmIP-SMI*)
+ - Motion Detector with Brightness Sensor - outdoor (*HmIP-SMO*)
+ - Presence Sensor – indoor (*HmIP-SPI*)
+ - Light Sensor - outdoor (*HmIP-SLO*)
+ - Passage Sensor with Direction Recognition (*HmIP-SPDR*) (delta counter)
+ - Alpha IP Wall Thermostat Display (*ALPHA-IP-RBG*)
+ - Alpha IP Wall Thermostat Display analog (*ALPHA-IP-RBGa*)
-* homematicip_cloud.switch
- * Pluggable Switch (*HmIP-PS*)
- * Pluggable Switch and Meter (*HmIP-PSM*) - should also work with (*HmIP-PSM-CH, HmIP-PSM-IT, HmIP-PSM-UK, HmIP-PSM-PE*)
- * Switch Actuator and Meter – flush-mount (*HmIP-FSM, HmIP-FSM16*)
- * Switch Actuator with Push-button Input – flush-mount (*HmIP-FSI16*)
- * Open Collector Module Receiver - 8x channels (*HmIP-MOD-OC8*)
- * Multi IO Box - 2x (*HmIP-MIOB*)
- * Switch Circuit Board - 1x channels (*HmIP-PCBS*)
- * Switch Circuit Board - 2x channels (*HmIP-PCBS2*)
- * Printed Circuit Board Switch Battery (*HmIP-PCBS-BAT*)
- * Switch Actuator for heating systems – 2x channels (*HmIP-WHS2*)
- * Wired Switch Actuator – 8x channels (*HMIPW-DRS8*)
- * Switch Actuator for DIN rail mount – 4x channels (*HMIP-DRSI4*)
- * Switch Actuator for DIN rail mount – 1x channels (*HMIP-DRSI1*)
- * Switch Actuator - 2x channels (*HmIP-BS2*)
+- homematicip_cloud.switch
+ - Pluggable Switch (*HmIP-PS*)
+ - Pluggable Switch and Meter (*HmIP-PSM*) - should also work with (*HmIP-PSM-CH, HmIP-PSM-IT, HmIP-PSM-UK, HmIP-PSM-PE*)
+ - Switch Actuator and Meter – flush-mount (*HmIP-FSM, HmIP-FSM16*)
+ - Switch Actuator with Push-button Input – flush-mount (*HmIP-FSI16*)
+ - Open Collector Module Receiver - 8x channels (*HmIP-MOD-OC8*)
+ - Multi IO Box - 2x (*HmIP-MIOB*)
+ - Switch Circuit Board - 1x channels (*HmIP-PCBS*)
+ - Switch Circuit Board - 2x channels (*HmIP-PCBS2*)
+ - Printed Circuit Board Switch Battery (*HmIP-PCBS-BAT*)
+ - Switch Actuator for heating systems – 2x channels (*HmIP-WHS2*)
+ - Wired Switch Actuator – 8x channels (*HMIPW-DRS8*)
+ - Switch Actuator for DIN rail mount – 4x channels (*HMIP-DRSI4*)
+ - Switch Actuator for DIN rail mount – 1x channels (*HMIP-DRSI1*)
+ - Switch Actuator - 2x channels (*HmIP-BS2*)
-* homematicip_cloud.weather
- * Weather Sensor – basic (*HmIP-SWO-B*)
- * Weather Sensor – plus (*HmIP-SWO-PL*)
- * Weather Sensor – pro (*HmIP-SWO-PR*)
+- homematicip_cloud.weather
+ - Weather Sensor – basic (*HmIP-SWO-B*)
+ - Weather Sensor – plus (*HmIP-SWO-PL*)
+ - Weather Sensor – pro (*HmIP-SWO-PR*)
## What to do, if a device is missing in Home Assistant
@@ -322,13 +322,13 @@ action:
Push button devices are only available with a battery sensor. This is due to a limitation of the vendor API (eq3).
It's not possible to detect a key press event on these devices at the moment.
- * Remote Control - 8x buttons (*HmIP-RC8*)
- * Wall-mount Remote Control for brand switches - 2x buttons (*HmIP-BRC2*)
- * Motion Detector for 55mm frames - indoor (HmIP-SMI55)(Push button)
- * Wall-mount Remote Control - 2x buttons (*HmIP-WRC2*)
- * Wall-mount Remote Control - flat - 2x buttons (*HmIP-WRCC2*)
- * Wall-mount Remote Control - 6x buttons (*HmIP-WRC6*)
- * Key Ring Remote Control - 4x buttons (*HmIP-KRC4*)
- * Key Ring Remote Control - alarm (*HmIP-KRCA*)
- * Wall-mount Remote Control – flat (*HmIP-WRCC2*)
- * Rotary Button (*HmIP-WRCR*)
+ - Remote Control - 8x buttons (*HmIP-RC8*)
+ - Wall-mount Remote Control for brand switches - 2x buttons (*HmIP-BRC2*)
+ - Motion Detector for 55mm frames - indoor (HmIP-SMI55)(Push button)
+ - Wall-mount Remote Control - 2x buttons (*HmIP-WRC2*)
+ - Wall-mount Remote Control - flat - 2x buttons (*HmIP-WRCC2*)
+ - Wall-mount Remote Control - 6x buttons (*HmIP-WRC6*)
+ - Key Ring Remote Control - 4x buttons (*HmIP-KRC4*)
+ - Key Ring Remote Control - alarm (*HmIP-KRCA*)
+ - Wall-mount Remote Control – flat (*HmIP-WRCC2*)
+ - Rotary Button (*HmIP-WRCR*)
diff --git a/source/_integrations/honeywell.markdown b/source/_integrations/honeywell.markdown
index be125853c1b..ef52cbb18f5 100644
--- a/source/_integrations/honeywell.markdown
+++ b/source/_integrations/honeywell.markdown
@@ -33,7 +33,7 @@ Home Assistant is integrated with the following devices through [https://mytotal
- Thermostats
- Every thermostat is exposed as a climate entity
- - Known working devices: [TH6320R1004](https://customer.resideo.com/en-US/Pages/Product.aspx?cat=HonECC%2520Catalog&pid=TH6320R1004/U), [RTH9585WF1004](https://www.honeywellhome.com/us/en/products/air/thermostats/wifi-thermostats/wifi-color-touchscreen-thermostat-rth9585wf1004-u/)
+ - Known working devices: [TH6320R1004](https://customer.resideo.com/en-US/Pages/Product.aspx?cat=HonECC%2520Catalog&pid=TH6320R1004/U), [RTH9585WF1004](https://www.honeywellhome.com/us/en/products/air/thermostats/wifi-thermostats/wifi-color-touchscreen-thermostat-rth9585wf1004-u/), [RTH6580WF](https://www.honeywellhome.com/us/en/products/air/thermostats/wifi-thermostats/wifi-7-day-programmable-thermostat-rth6580wf1001-u1/)
- Sensors
- A Temperature sensor entity.
- A Humidity sensor entity.
diff --git a/source/_integrations/html5.markdown b/source/_integrations/html5.markdown
index 8af8f80817a..c7055c289ab 100644
--- a/source/_integrations/html5.markdown
+++ b/source/_integrations/html5.markdown
@@ -51,12 +51,12 @@ vapid_email:
The `html5` platform can only function if all of the following requirements are met:
-* You are using Chrome and/or Firefox on any desktop platform, ChromeOS or Android. Or you added your Home Assistant instance to your home screen on iOS 16.4 or higher.
-* Your Home Assistant instance is accessible from outside your network over HTTPS or can perform an alternative [Domain Name Verification Method](https://support.google.com/webmasters/answer/9008080#domain_name_verification) on the domain used by Home Assistant.
-* If using a proxy, HTTP basic authentication must be off for registering or unregistering for push notifications. It can be re-enabled afterwards.
-* If you don't run Hass.io: `pywebpush` must be installed. `libffi-dev`, `libpython-dev` and `libssl-dev` must be installed prior to `pywebpush` (i.e., `pywebpush` probably won't automatically install).
-* You have configured SSL/TLS for your Home Assistant. It doesn't need to be configured in Home Assistant though, e.g., you can be running NGINX in front of Home Assistant and this will still work. The certificate must be trustworthy (i.e., not self-signed).
-* You are willing to accept the notification permission in your browser.
+- You are using Chrome and/or Firefox on any desktop platform, ChromeOS or Android. Or you added your Home Assistant instance to your home screen on iOS 16.4 or higher.
+- Your Home Assistant instance is accessible from outside your network over HTTPS or can perform an alternative [Domain Name Verification Method](https://support.google.com/webmasters/answer/9008080#domain_name_verification) on the domain used by Home Assistant.
+- If using a proxy, HTTP basic authentication must be off for registering or unregistering for push notifications. It can be re-enabled afterwards.
+- If you don't run Hass.io: `pywebpush` must be installed. `libffi-dev`, `libpython-dev` and `libssl-dev` must be installed prior to `pywebpush` (i.e., `pywebpush` probably won't automatically install).
+- You have configured SSL/TLS for your Home Assistant. It doesn't need to be configured in Home Assistant though, e.g., you can be running NGINX in front of Home Assistant and this will still work. The certificate must be trustworthy (i.e., not self-signed).
+- You are willing to accept the notification permission in your browser.
### Configuring the platform
@@ -224,7 +224,7 @@ During the lifespan of a single push notification, Home Assistant will emit a fe
Common event payload parameters are:
| Parameter | Description |
-|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `action` | The `action` key that you set when sending the notification of the action clicked. Only appears in the `clicked` event. |
| `data` | The data dictionary you originally passed in the notify payload, minus any parameters that were added to the HTML5 notification (`actions`, `badge`, `body`, `dir`, `icon`, `image`, `lang`, `renotify`, `requireInteraction`, `tag`, `timestamp`, `vibrate`). |
| `tag` | The unique identifier of the notification. Can be overridden when sending a notification to allow for replacing existing notifications. |
diff --git a/source/_integrations/hyperion.markdown b/source/_integrations/hyperion.markdown
index 169415b9355..0156bd9c8ad 100644
--- a/source/_integrations/hyperion.markdown
+++ b/source/_integrations/hyperion.markdown
@@ -34,24 +34,32 @@ All configuration options are offered from the frontend. Choose `Options` under
relevant entry on the `Integrations` page.
Options supported:
-- **Priority**: The priority for color and effects, make sure this is lower then the streaming sources priority in hyperion itself (typically lower than 200 is appropriate).
+- **Priority**: The priority for color and effects. Hyperion will choose the source
+ with the lowest priority number as active input. If you have other sources (not
+ originating from Home Assistant) configured, make sure this option is lower than
+ those sources priority in Hyperion itself (typically lower than 200 is appropriate).
- **Effects to hide**: An optional selection of effects to hide from the light effects
list. New effects added to the Hyperion server will be shown by default.
+
## Hyperion Instances
This integration supports multiple Hyperion instances running on a single Hyperion
server. As instances are added/removed on the Hyperion UI, they will automatically be
added/removed from Home Assistant.
+## Light Entity
+
+The default light entity will send data to Hyperion on the priority you have configured
+during integration setup. When turned off, it will clear the configured priority again.
+Other light sources independent of Home Assistant configured in Hyperion might still be
+active and cause light to be emitted. In order to turn the light output off entirely
+regardless of active light sources, you can enable the LED device entity that acts as
+a global switch (see Advanced Entities).
+
## Effects
-The effect list is dynamically pulled from the Hyperion server. The following
-extra effects will be available:
-
-- 'Boblight Server': Use a 'Boblight Server' configured in Hyperion.
-- 'Platform Capture': Use a 'Platform Capture' grabber that is configured in Hyperion.
-- 'USB Capture': Use a 'USB Capture' device that is configured in Hyperion.
-- 'Solid': Use a solid color only.
+The effect list is dynamically pulled from the Hyperion server. Additionally, there
+will be a 'Solid' effect to switch (back) to showing a solid color only.
## Hyperion Camera
@@ -70,20 +78,28 @@ advanced usecases. These entities expose 'raw' underlying Hyperion API component
improved extensibility and interoperability which are particularly useful in cases where
there are multiple Hyperion server clients (of which Home Assistant is one).
-Provided advanced entities:
-
-- `light.[instance]_priority`: A "priority" light that acts exclusively on a given
- Hyperion priority. Only color/effects (and not components) are available in this light.
- Turning this light off will set a black color at this given priority rather than
- turning the light off in absolute terms.
-- `switch.[instance]_component_[component]`: A switch to turn on/off the relevant
- underlying Hyperion component as shown on the Hyperion server `Remote Control` page
- under `Component Control`. This allows fine grained control over sources (e.g. `USB Capture`) and
- Hyperion functionality (e.g. `Blackbar Detection`).
-
These entities may be enabled by visiting the `Integrations` page, choosing the relevant
entity and toggling `Enable entity`, followed by `Update`.
+### Control over external sources: Screen capture and USB capture
+
+Provided entities for controlling external sources:
+
+- `switch.[instance]_component_platform_capture`: Toggles the `Screen Capture` source
+- `switch.[instance]_component_usb_capture`: Toggles the `USB Capture` source
+
+### Control over Hyperion functionality
+
+Further advanced entities to control Hyperion functionality:
+
+- There will be additional `switch.[instance]_component_[component]` entities that can
+ be used to toggle the relevant underlying Hyperion component as shown on the Hyperion
+ server `Remote Control` page under `Components Control`. This allows fine grained
+ control over Hyperion functionality (e.g. `Blackbar Detection`) or device
+ state (`LED Device`).
+- `switch.[instance]_component_all`: refers to the entire Hyperion instance state that
+ controls the toggle on the Hyperion server `Dashboard` page.
+
## Examples
To start Hyperion with an effect, use the following automation:
@@ -135,9 +151,27 @@ To capture the screen on a USB capture device, when playing something on a media
entity_id: media_player.plex
to: "playing"
action:
- - service: light.turn_on
+ - service: switch.turn_on
target:
- entity_id: light.hyperion
- data:
- effect: "USB Capture"
+ entity_id: switch.[instance]_component_usb_capture
+```
+
+To toggle the LED device together with the light entity in order to turn light output on or off for all sources. In this example both entities are turned on together, create another automation with the values reversed for turning both off:
+
+```yaml
+- alias: "Turn LED device on when Hyperion light is activated"
+ trigger:
+ - platform: state
+ entity_id:
+ - light.hyperion
+ from: "off"
+ to: "on"
+ condition:
+ - condition: state
+ entity_id: switch.[instance]_component_led_device
+ state: "off"
+ action:
+ - service: switch.turn_on
+ target:
+ entity_id: switch.[instance]_component_led_device
```
diff --git a/source/_integrations/ibeacon.markdown b/source/_integrations/ibeacon.markdown
index 14cab37919e..0ad3e5ec633 100644
--- a/source/_integrations/ibeacon.markdown
+++ b/source/_integrations/ibeacon.markdown
@@ -57,7 +57,7 @@ iBeacons with a randomized MAC address will be combined into a single set of ent
The integration will create an Estimated Distance sensor by default. This estimated distance assumes perfect RF conditions and line of sight between the iBeacon and the Bluetooth adapter. Estimated distance is generally only helpful to tell if the iBeacon is in the immediate vicinity, near, or far away from the adapter. If the system has multiple adapters, the adapter with the best RSSI value for the iBeacon will be the one reporting the distance. As this can change, checking the source attribute when considering the distance is essential.
-To get the Estimated distance sensor to work, in most cases, it has to be calibrated in the supplier's app. Place the device at 1m in light of sight of the Bluetooth adapter, read the signal strength in dBm, and set it in the corresponding field of the device app.
+To get the Estimated distance sensor to work, in most cases, it has to be calibrated in the supplier's app. Place the device at 1m in line of sight of the Bluetooth adapter, read the signal strength in dBm, and set it in the corresponding field of the device app.
## Known working devices
diff --git a/source/_integrations/icloud.markdown b/source/_integrations/icloud.markdown
index aa721709445..aeb9bd5b80b 100644
--- a/source/_integrations/icloud.markdown
+++ b/source/_integrations/icloud.markdown
@@ -24,7 +24,7 @@ There is currently support for the following platforms within Home Assistant:
- [Device Tracker](#device-tracker)
- [Sensor](#sensor)
-It does require that your devices are registered with the [Find My](https://www.apple.com/uk/icloud/find-my/) service.
+It does require that your devices are registered with the [Find My](https://www.apple.com/icloud/find-my/) service.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/image.markdown b/source/_integrations/image.markdown
index 42f2d5609c7..bdf166fc27f 100644
--- a/source/_integrations/image.markdown
+++ b/source/_integrations/image.markdown
@@ -5,7 +5,7 @@ ha_category:
- Image
ha_release: 2023.7
ha_quality_scale: internal
-ha_domain: camera
+ha_domain: image
ha_codeowners:
- '@home-assistant/core'
ha_integration_type: entity
diff --git a/source/_integrations/imap.markdown b/source/_integrations/imap.markdown
index b4dfdd3356d..6471c32ccec 100644
--- a/source/_integrations/imap.markdown
+++ b/source/_integrations/imap.markdown
@@ -10,7 +10,6 @@ ha_platforms:
- sensor
ha_integration_type: integration
ha_codeowners:
- - '@engrbm87'
- '@jbouwh'
ha_config_flow: true
---
@@ -37,19 +36,26 @@ If you’re going to use Gmail, you need to create an [App Password](https://sup
By default, this integration will count unread emails. By configuring the search string, you can count other results, for example:
-* `ALL` to count all emails in a folder
-* `FROM`, `TO`, `SUBJECT` to find emails in a folder (see [IMAP RFC for all standard options](https://tools.ietf.org/html/rfc3501#section-6.4.4))
-* [Gmail's IMAP extensions](https://developers.google.com/gmail/imap/imap-extensions) allow raw Gmail searches, like `X-GM-RAW "in: inbox older_than:7d"` to show emails older than one week in your inbox. Note that raw Gmail searches will ignore your folder configuration and search all emails in your account!
+- `ALL` to count all emails in a folder
+- `FROM`, `TO`, `SUBJECT` to find emails in a folder (see [IMAP RFC for all standard options](https://tools.ietf.org/html/rfc3501#section-6.4.4))
+- [Gmail's IMAP extensions](https://developers.google.com/gmail/imap/imap-extensions) allow raw Gmail searches, like `X-GM-RAW "in: inbox older_than:7d"` to show emails older than one week in your inbox. Note that raw Gmail searches will ignore your folder configuration and search all emails in your account!
+
### Selecting a charset supported by the imap server
-Below is an example for setting up the integration to connect to your Microsoft 365 account that requires `US_ASCII` as charset:
+Below is an example for setting up the integration to connect to your Microsoft 365 account that requires `US-ASCII` as charset:
- Server: `outlook.office365.com`
- Port: `993`
- Username: Your full email address
- Password: Your password
- Charset: `US-ASCII`
+
+
+Yahoo also requires the character set `US-ASCII`.
+
+
+
### Selecting an alternate SSL cipher list or disable SSL verification (advanced mode)
If the default IMAP server settings do not work, you might try to set an alternate SLL cipher list.
@@ -77,6 +83,7 @@ The enforce polling option is an advanced setting. The option is available only
Email providers may limit the number of reported emails. The number may be less than the limit (10,000 at least for Yahoo) even if you set the `IMAP search` to reduce the number of results. If you are not getting expected events and cleaning your Inbox or the configured folder is not desired, set up an email filter for the specific sender to go into a new folder. Then create a new config entry or modify the existing one with the desired folder.
+
### Using events
When a new message arrives that meets the search criteria the `imap` integration will send a custom [event](/docs/automation/trigger/#event-trigger) that can be used to trigger an automation.
diff --git a/source/_integrations/iperf3.markdown b/source/_integrations/iperf3.markdown
index d75ba415ad1..09eceab51ad 100644
--- a/source/_integrations/iperf3.markdown
+++ b/source/_integrations/iperf3.markdown
@@ -89,7 +89,7 @@ Configuration variables (host):
type: string
{% endconfiguration %}
-#### Time period dictionary example
+### Time period dictionary example
```yaml
scan_interval:
@@ -109,7 +109,7 @@ Parallel streams can help in some situations. As TCP attempts to be fair and con
You can use the service `sensor.iperf3_update` to trigger a manual speed test for all sensors. Iperf3 has its own service call that allow to perform a speed test on a particular entity.
-### Service
+## Service
Once loaded, the `iperf3` integration will expose a service (`iperf3.speedtest`) that can be called to run a speed test on demand. This can be useful if you have enabled manual mode.
diff --git a/source/_integrations/ipma.markdown b/source/_integrations/ipma.markdown
index 8d4363f1cc2..9ad91d0d3dc 100644
--- a/source/_integrations/ipma.markdown
+++ b/source/_integrations/ipma.markdown
@@ -11,6 +11,7 @@ ha_codeowners:
- '@abmantis'
ha_domain: ipma
ha_platforms:
+ - sensor
- weather
ha_integration_type: integration
---
diff --git a/source/_integrations/iqvia.markdown b/source/_integrations/iqvia.markdown
index e17ca809b58..25f62223751 100644
--- a/source/_integrations/iqvia.markdown
+++ b/source/_integrations/iqvia.markdown
@@ -19,10 +19,10 @@ The `iqvia` sensor platform collects and displays allergy, asthma and disease
information (based on a U.S. ZIP code) from [IQVIA](https://www.iqvia.com/).
Data measured includes:
-* Indices for allergies, asthma and cold/flu indices
-* Trends
-* Current outlook
-* more!
+- Indices for allergies, asthma and cold/flu indices
+- Trends
+- Current outlook
+- more!
{% include integrations/config_flow.md %}
@@ -31,13 +31,13 @@ Data measured includes:
Any index-related sensor will have a value between 0.0 and 12.0. The values
map to the following human-friendly ratings:
-Range | Rating
---------- | -----------
-0.0 - 2.4 | Low
-2.5 - 4.8 | Low/Medium
-4.9 - 7.2 | Medium
-7.3 - 9.6 | Medium/High
-9.7 - 12.0 | High
+| Range | Rating |
+| ---------- | ----------- |
+| 0.0 - 2.4 | Low |
+| 2.5 - 4.8 | Low/Medium |
+| 4.9 - 7.2 | Medium |
+| 7.3 - 9.6 | Medium/High |
+| 9.7 - 12.0 | High |
## Understanding Asthma Allergens
@@ -45,10 +45,10 @@ Several asthma-related sensors carry information regarding the top three
"asthma allergens" (i.e., irritants that may exacerbate asthma symptoms).
Example values include:
-Pollutant | Symbol | More Info
---------- | ------ | ---------
-Particulate (<= 2.5 μm) | PM2.5 | [EPA: Particulate Matter (PM) Pollution](https://www.epa.gov/pm-pollution)
-Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution](https://www.epa.gov/pm-pollution)
-Ozone | O | [EPA: Ozone Pollution](https://www.epa.gov/ozone-pollution)
-Sulpher Dioxide | SO2 | [EPA: Sulfur Dioxide (SO2) Pollution](https://www.epa.gov/so2-pollution)
-Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](https://www.epa.gov/co-pollution)
+| Pollutant | Symbol | More Info |
+| ----------------------- | ------ | -------------------------------------------------------------------------------------- |
+| Particulate (<= 2.5 μm) | PM2.5 | [EPA: Particulate Matter (PM) Pollution](https://www.epa.gov/pm-pollution) |
+| Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution](https://www.epa.gov/pm-pollution) |
+| Ozone | O | [EPA: Ozone Pollution](https://www.epa.gov/ozone-pollution) |
+| Sulpher Dioxide | SO2 | [EPA: Sulfur Dioxide (SO2) Pollution](https://www.epa.gov/so2-pollution) |
+| Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](https://www.epa.gov/co-pollution) |
diff --git a/source/_integrations/keyboard_remote.markdown b/source/_integrations/keyboard_remote.markdown
index 4c611257128..6e067a378cf 100644
--- a/source/_integrations/keyboard_remote.markdown
+++ b/source/_integrations/keyboard_remote.markdown
@@ -9,7 +9,7 @@ ha_codeowners:
- '@bendavid'
- '@lanrat'
ha_domain: keyboard_remote
-ha_integration_type: integration
+ha_integration_type: hub
---
Receive signals from a keyboard and use it as a remote control.
@@ -35,12 +35,12 @@ emulate_key_hold:
type: boolean
default: false
emulate_key_hold_delay:
- description: Number of milliseconds to wait before sending first emulated key hold event
+ description: Number of seconds to wait before sending first emulated key hold event
required: false
type: float
default: 0.250
emulate_key_hold_repeat:
- description: Number of milliseconds to wait before sending subsequent emulated key hold event
+ description: Number of seconds to wait before sending subsequent emulated key hold event
required: false
type: float
default: 0.033
@@ -165,3 +165,29 @@ You can check ACLs permissions with:
```bash
getfacl /dev/input/event*
```
+
+## Containers
+
+If you are running Home Assistant Container, you need to pass the input device through to the container. You can pass the input device you want to use directly into the container with the `--devices` flag. However, restarting the container or unplugging and replugging your keyboard will break this integration. This is because only the instance of the keyboard that existed when the container first started will be available inside the container.
+
+Here is an incomplete example `docker-compose.yml` that allows Home Assistant persistent access to input devices in a container:
+
+```yaml
+version: '3.7'
+
+services:
+ homeassistant:
+ image: ghrc.io/homeassistant/home-assistant:stable
+ volumes:
+ - config:/config/
+ - /dev/input:/dev/input/ # this is needed to read input events.
+ restart: unless-stopped
+ device_cgroup_rules:
+ # allow creation of /dev/input/* with mknod, this is not enough on its own and needs mknod to be called in the container
+ - 'c 13:* rmw'
+ devices:
+ # since input id may change, pass them all in
+ - "/dev/input/"
+ ...
+
+```
diff --git a/source/_integrations/kitchen_sink.markdown b/source/_integrations/kitchen_sink.markdown
index 26c4ac62e28..7179786c104 100644
--- a/source/_integrations/kitchen_sink.markdown
+++ b/source/_integrations/kitchen_sink.markdown
@@ -12,6 +12,7 @@ ha_iot_class: Calculated
ha_platforms:
- lock
- sensor
+ - image
ha_integration_type: integration
---
diff --git a/source/_integrations/knx.markdown b/source/_integrations/knx.markdown
index 7cde6fca2e2..46f514055a6 100644
--- a/source/_integrations/knx.markdown
+++ b/source/_integrations/knx.markdown
@@ -44,8 +44,8 @@ ha_platforms:
- sensor
- switch
- text
- - time
- weather
+ - time
ha_config_flow: true
ha_integration_type: hub
---
@@ -338,7 +338,7 @@ address:
type: string
required: true
type:
- description: Type of the exposed value. Either `binary`, `time`, `date`, `datetime` or any supported type of [KNX Sensor](#sensor) (e.g., "temperature" or "humidity").
+ description: Type of the exposed value. Either `binary`, `time` *DPT 10.001*, `date` *DPT 11.001*, `datetime` *DPT 19.001* or any supported type of [KNX Sensor](#sensor) (e.g., "temperature" or "humidity").
type: [string, integer]
required: true
entity_id:
diff --git a/source/_integrations/kodi.markdown b/source/_integrations/kodi.markdown
index 06ed519e360..5add29efbc2 100644
--- a/source/_integrations/kodi.markdown
+++ b/source/_integrations/kodi.markdown
@@ -32,9 +32,9 @@ There is currently support for the following device types within Home Assistant:
If you previously had Kodi configured through `configuration.yaml`, it's advisable to remove it, and configure from the UI.
If you do not remove it, your configuration will be imported with the following limitations:
-* Your turn on/off actions will not be imported. This functionality is now available through device triggers.
-* You may have duplicate entities.
-* Kodi must be on when Home Assistant is loading for the first time for the configuration to be imported.
+- Your turn on/off actions will not be imported. This functionality is now available through device triggers.
+- You may have duplicate entities.
+- Kodi must be on when Home Assistant is loading for the first time for the configuration to be imported.
### Turning On/Off
@@ -73,23 +73,23 @@ automation:
Add music to the default playlist (i.e., playlistid=0).
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | Name(s) of the Kodi entities where to add the media. |
-| `media_type` | yes | Media type identifier. It must be one of SONG or ALBUM. |
-| `media_id` | no | Unique Id of the media entry to add (`songid` or `albumid`). If not defined, `media_name` and `artist_name` are needed to search the Kodi music library. |
-| `media_name` | no| Optional media name for filtering media. Can be 'ALL' when `media_type` is 'ALBUM' and `artist_name` is specified, to add all songs from one artist. |
-| `artist_name` | no | Optional artist name for filtering media. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | no | Name(s) of the Kodi entities where to add the media. |
+| `media_type` | yes | Media type identifier. It must be one of SONG or ALBUM. |
+| `media_id` | no | Unique Id of the media entry to add (`songid` or `albumid`). If not defined, `media_name` and `artist_name` are needed to search the Kodi music library. |
+| `media_name` | no | Optional media name for filtering media. Can be 'ALL' when `media_type` is 'ALBUM' and `artist_name` is specified, to add all songs from one artist. |
+| `artist_name` | no | Optional artist name for filtering media. |
#### Service `kodi.call_method`
Call a [Kodi JSON-RPC API](https://kodi.wiki/?title=JSON-RPC_API) method with optional parameters. Results of the Kodi API call will be redirected in a Home Assistant event: `kodi_call_method_result`.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | Name(s) of the Kodi entities where to run the API method. |
-| `method` | yes | Name of the Kodi JSON-RPC API method to be called. |
-| any other parameter | no | Optional parameters for the Kodi API call. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------- |
+| `entity_id` | no | Name(s) of the Kodi entities where to run the API method. |
+| `method` | yes | Name of the Kodi JSON-RPC API method to be called. |
+| any other parameter | no | Optional parameters for the Kodi API call. |
### Event triggering
diff --git a/source/_integrations/lametric.markdown b/source/_integrations/lametric.markdown
index e6343c9e10a..8905dd99eb8 100644
--- a/source/_integrations/lametric.markdown
+++ b/source/_integrations/lametric.markdown
@@ -250,12 +250,12 @@ your LaMetric devices, use the following steps:
1. Log in with your LaMetric device account to [developer.lametric.com](https://developer.lametric.com).
2. Click the Create button and choose [Notification](https://developer.lametric.com/applications/createsource) app.
3. Fill in the form. You can put almost anything in the fields, they just need to be populated:
- * App Name: Home Assistant
- * Description: Home Assistant
- * Redirect URI: `https://my.home-assistant.io/redirect/oauth`
- * Privacy Policy: `http://localhost/`
- * Check the "basic" and "read_devices" permission boxes
- * Click Save
+ - App Name: Home Assistant
+ - Description: Home Assistant
+ - Redirect URI: `https://my.home-assistant.io/redirect/oauth`
+ - Privacy Policy: `http://localhost/`
+ - Check the "basic" and "read_devices" permission boxes
+ - Click Save
4. You should be directed to your [Notification Apps list](https://developer.lametric.com/applications/sources),
click on "Home Assistant", copy your client ID and Client Secret.
diff --git a/source/_integrations/light.rflink.markdown b/source/_integrations/light.rflink.markdown
index d9b4c5d44e5..1e8b5e0e032 100644
--- a/source/_integrations/light.rflink.markdown
+++ b/source/_integrations/light.rflink.markdown
@@ -9,7 +9,7 @@ ha_release: 0.38
ha_domain: rflink
---
-The `rflink` integration supports devices that use [RFLink gateway firmware](https://www.rflink.nl/download.php), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/en/21-rflink-). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
+The `rflink` integration supports devices that use [RFLink gateway firmware](https://www.rflink.nl/download.php), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/21-rflink-). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
First, you have to set up your [RFLink hub](/integrations/rflink/).
diff --git a/source/_integrations/litterrobot.markdown b/source/_integrations/litterrobot.markdown
index 44ba02d5543..1a45ea99844 100644
--- a/source/_integrations/litterrobot.markdown
+++ b/source/_integrations/litterrobot.markdown
@@ -24,6 +24,7 @@ ha_platforms:
- switch
- update
- vacuum
+ - time
ha_integration_type: hub
---
diff --git a/source/_integrations/local_calendar.markdown b/source/_integrations/local_calendar.markdown
index 265abf7d241..d0ad2e59ed0 100644
--- a/source/_integrations/local_calendar.markdown
+++ b/source/_integrations/local_calendar.markdown
@@ -25,8 +25,8 @@ A calendar entity has a state and attributes that represent the next upcoming ev
Individual Calendar *Events* are what powers automations such as:
-* Turn on a light at the *start* of the event named *Front Yard Light*
-* Send a notification *5 minutes before the start of any event*
-* Stop the media player *30 minutes after* the *end* of the event named *Exercise*.
+- Turn on a light at the *start* of the event named *Front Yard Light*
+- Send a notification *5 minutes before the start of any event*
+- Stop the media player *30 minutes after* the *end* of the event named *Exercise*.
See [Calendar Automations](/integrations/calendar#automation) for an overview, and read more about [Calendar Trigger Variables](/docs/automation/templating/#calendar) for the available information you can use in a condition or action such as the event `summary`, `description`, `location` and more.
diff --git a/source/_integrations/lock.markdown b/source/_integrations/lock.markdown
index 5db9a2e29ce..5b9178d05a6 100644
--- a/source/_integrations/lock.markdown
+++ b/source/_integrations/lock.markdown
@@ -13,8 +13,8 @@ ha_integration_type: entity
Keeps track which locks are in your environment, their state and allows you to control them.
- * Maintains a state per lock and a combined state `all_locks`.
- * Registers services `lock.lock`, `lock.unlock` and `lock.open` (unlatch) to control locks.
+- Maintains a state per lock and a combined state `all_locks`.
+- Registers services `lock.lock`, `lock.unlock` and `lock.open` (unlatch) to control locks.
### Services
@@ -24,9 +24,9 @@ A lock integration provides the following services:
Lock your door, the attribute should appear under a 'data' attribute for the service.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | Entity of the relevant lock. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------- |
+| `entity_id` | no | Entity of the relevant lock. |
##### Example
@@ -41,9 +41,9 @@ action:
Unlock your door, the attribute should appear under a 'data' attribute for the service.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | no | Entity of the relevant lock. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------- |
+| `entity_id` | no | Entity of the relevant lock. |
##### Example
@@ -62,6 +62,6 @@ Go to the **Developer Tools**, then to **Call Service** in the frontend, and cho
{"entity_id":"lock.front_door"}
```
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | Only act on specific lock. Use `entity_id: all` to target all.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------------------------------------------------- |
+| `entity_id` | yes | Only act on specific lock. Use `entity_id: all` to target all. |
diff --git a/source/_integrations/logi_circle.markdown b/source/_integrations/logi_circle.markdown
index fadce1c5bd0..16672154fda 100644
--- a/source/_integrations/logi_circle.markdown
+++ b/source/_integrations/logi_circle.markdown
@@ -23,18 +23,18 @@ The `logi_circle` implementation allows you to integrate your [Logi Circle](http
1. Navigate to the [Circle OAuth2 Client Request Form](https://docs.google.com/forms/d/184FUILJ10rVxotyOQR5DAiu6GcCbK31AZszUdzT1ybs).
2. Fill out your contact name and e-mail address.
3. For the User Visible Client Name, specify "Home Assistant"
-3. Request the following scopes:
- * `circle:activities`
- * `circle:accessories`
- * `circle:live_image`
- * `circle:live`
- * `circle:notifications`
- * `circle:summaries`
-4. Request the `authorization_code` grant type.
-5. For the redirect URI, specify your Home Assistant URL followed by `/api/logi_circle`. For example, if your Home Assistant URL is `https://abc123.ui.nabu.casa`, then request `https://abc123.ui.nabu.casa/api/logi_circle`. The redirect URI must meet the following criteria:
- * The URL must be HTTPS with a SSL certificate issued by a trusted CA (i.e., trusted by normal browsers).
- * At the time you submit your request to Logitech, you need to demonstrate that you have exclusive control of the fully qualified domain name in your redirect URI. An active Home Assistant instance at the redirect URI will suffice. If you don't want to expose your Home Assistant instance publicly, you may also place a static page at the redirect URI with a short message that you will manage redirection of the authorization token to your local Home Assistant instance. Free static hosts that issue subdomains for hosting (e.g., Netlify) are permitted.
- * As the redirect URI must be public facing, no local/reserved TLDs are permitted (eg. .local, .localhost, .example, etc. are not allowed).
+4. Request the following scopes:
+ - `circle:activities`
+ - `circle:accessories`
+ - `circle:live_image`
+ - `circle:live`
+ - `circle:notifications`
+ - `circle:summaries`
+5. Request the `authorization_code` grant type.
+6. For the redirect URI, specify your Home Assistant URL followed by `/api/logi_circle`. For example, if your Home Assistant URL is `https://abc123.ui.nabu.casa`, then request `https://abc123.ui.nabu.casa/api/logi_circle`. The redirect URI must meet the following criteria:
+ - The URL must be HTTPS with a SSL certificate issued by a trusted CA (i.e., trusted by normal browsers).
+ - At the time you submit your request to Logitech, you need to demonstrate that you have exclusive control of the fully qualified domain name in your redirect URI. An active Home Assistant instance at the redirect URI will suffice. If you don't want to expose your Home Assistant instance publicly, you may also place a static page at the redirect URI with a short message that you will manage redirection of the authorization token to your local Home Assistant instance. Free static hosts that issue subdomains for hosting (e.g., Netlify) are permitted.
+ - As the redirect URI must be public facing, no local/reserved TLDs are permitted (eg. .local, .localhost, .example, etc. are not allowed).
Please note that the turn-around time for API access takes up to a month after which you will be contacted by Logitech using the email address you provided in the form.
@@ -134,11 +134,11 @@ The `logi_circle` platform exposes 3 services for interacting with your Logi Cir
Initiates a recording of the camera's live stream.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | Name(s) of entities to initiate a recording for, e.g., `camera.living_room_camera`. If blank, targets all Logi Circle cameras. |
-| `filename ` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/recording_{{ entity_id }}.mp4`{% endraw %}. |
-| `duration` | no | Duration of recording, in seconds.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| `entity_id` | yes | Name(s) of entities to initiate a recording for, e.g., `camera.living_room_camera`. If blank, targets all Logi Circle cameras. |
+| `filename ` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/recording_{{ entity_id }}.mp4`{% endraw %}. |
+| `duration` | no | Duration of recording, in seconds. |
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
@@ -148,10 +148,10 @@ Take a snapshot from a camera's live stream. This differs from the generic [snap
Please note that new snapshots will only be generated if the cached snapshot is older than 30s. Requesting multiple snapshots in quick succession will likely return the same image. Likewise, requesting a snapshot from a camera that is actively streaming (ie. is not in deep sleep) will return a cached image no older than 30s.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | Name(s) of entities to create a live stream snapshot from, e.g., `camera.living_room_camera`. If blank, targets all Logi Circle cameras. |
-| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}.jpg`{% endraw %}. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | yes | Name(s) of entities to create a live stream snapshot from, e.g., `camera.living_room_camera`. If blank, targets all Logi Circle cameras. |
+| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}.jpg`{% endraw %}. |
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
@@ -159,8 +159,8 @@ The path part of `filename` must be an entry in the `allowlist_external_dirs` in
Sets a configuration property for your camera.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | Name(s) of entities to set the operation mode for, e.g., `camera.living_room_camera`. If blank, targets all Logi Circle cameras. |
-| `mode` | no | Configuration property to set. Allowed values: `LED`, `RECORDING_MODE` |
-| `value` | no | Mode value. Allowed values: `true`, `false` |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | yes | Name(s) of entities to set the operation mode for, e.g., `camera.living_room_camera`. If blank, targets all Logi Circle cameras. |
+| `mode` | no | Configuration property to set. Allowed values: `LED`, `RECORDING_MODE` |
+| `value` | no | Mode value. Allowed values: `true`, `false` |
diff --git a/source/_integrations/loqed.markdown b/source/_integrations/loqed.markdown
index e5def245f88..15928810cbd 100644
--- a/source/_integrations/loqed.markdown
+++ b/source/_integrations/loqed.markdown
@@ -1,19 +1,18 @@
---
-title: Loqed Touch Smart Lock
+title: LOQED Touch Smart Lock
description: Instructions on how to integrate a Loqed Touch Smart Lock
ha_category:
- Lock
ha_release: 2023.7
ha_iot_class: Local Push
ha_codeowners:
- - "@mikewoudenbergs"
+ - '@mikewoudenberg'
ha_domain: loqed
ha_platforms:
- lock
- - sensor
ha_config_flow: true
-ha_dhcp: true
ha_integration_type: integration
+ha_zeroconf: true
---
Integrate your LOQED Touch Smart Lock with Home Assistant. The lock instantly notifies Home Assistant of a lock state change and you can change the lock state yourself.
@@ -57,4 +56,3 @@ On [LOQED personal access token website](https://integrations.production.loqed.c
1. Login with your LOQED App e-mail address (you need to be admin).
2. Select **delete** on the Personal Access Token you used when creating this integration.
-
diff --git a/source/_integrations/lyric.markdown b/source/_integrations/lyric.markdown
index 52069813ff8..3a6a85019c7 100644
--- a/source/_integrations/lyric.markdown
+++ b/source/_integrations/lyric.markdown
@@ -25,9 +25,9 @@ The Honeywell Lyric integration integrates the Lyric thermostat platform into Ho
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.
+2. Next, create a [new app](https://developer.honeywellhome.com/user/me/apps/add) via the `My Apps` section.
1. App Name: You can use any name here, but it must not contain special characters.
- 1. Callback URL: `https://my.home-assistant.io/redirect/oauth`
+ 2. Callback URL: `https://my.home-assistant.io/redirect/oauth`
{% details "I have manually disabled My Home Assistant" %}
diff --git a/source/_integrations/matter.markdown b/source/_integrations/matter.markdown
index d2b33c916e8..6e5656e22db 100644
--- a/source/_integrations/matter.markdown
+++ b/source/_integrations/matter.markdown
@@ -85,25 +85,13 @@ Image taken from [this excellent article by The Verge](https://www.theverge.com/
For communicating with Matter devices, the Home Assistant integration runs its own "Matter controller" in a separate process which will be launched as an add-on. This add-on runs the controller software and connects your Matter network (called Fabric in technical terms) and Home Assistant. The Home Assistant Matter integration connects to this server via a WebSocket connection.
-The only supported configuration (for now) for the Matter integration is by running the officially provided Home Assistant Matter add-on. Running the [Matter server](https://github.com/home-assistant-libs/python-matter-server) by any other means is at your own risk and is currently not officially supported.
+### Supported installation types
-## Current state of the integration
+It is recommended to run the Matter add-on on Home Assistant OS. This is currently the best-supported option.
-While the support for Matter is evolving, we will regularly update the Matter integration with new features or device support. Because it might be hard to track what's supported and what's not, we list the current state here and try to update this information regularly.
+If you run Home Assistant in a container, you can run a Docker image of the [Matter server](https://github.com/home-assistant-libs/python-matter-server). The requirements and instructions for your host setup are described on that GitHub page.
-Supported platforms (device types):
-
-- Binary sensor: We have so far tested door/window sensors and motion sensors, but others will probably work too.
-- Climate: Support for thermostat devices has been added but availability of actual devices is limited.
-- Cover: Has been implemented, but support for a tilt feature is still missing.
-- Lights: All features (in the Matter specification) should be supported, including color control, etc.
-- Locks: Basic lock control has been implemented, but not all devices and features are supported yet.
-- Sensor: We have tested Illuminance and temperature sensors, but others will probably work too.
-- Switch: Powerplugs should work (note: no support for energy metering yet in Matter).
-
-Note that a single Matter device can exist on multiple platforms. For example, a Motion sensor also has a temperature sensor and an illuminance sensor on board.
-
-If you own a (bridged) Matter device and you are missing controls for this device, create an issue on [GitHub](https://github.com/home-assistant/home-assistant.io) and make sure to post your Integration diagnostics there. In some cases, we can easily extend the existing platform support based on your diagnostics dump.
+Running Matter on a Home Assistant Core installation is not supported.
## Adding Matter devices to Home Assistant
@@ -162,9 +150,6 @@ This method will allow you to share a device that was added to Google Home to Ho
@@ -128,9 +129,9 @@ A configured client certificate will only be active if broker certificate valida
To change the settings, follow these steps:
1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
-1. On the MQTT integration, select the cogwheel.
-1. Select **Configure**, then **Re-configure MQTT**.
-1. To open the MQTT options page, select **Next**.
+2. Select the MQTT integration.
+3. Select **Configure**, then **Re-configure MQTT**.
+4. To open the MQTT options page, select **Next**.
### Discovery options
@@ -156,8 +157,8 @@ mosquitto_pub -h 127.0.0.1 -t homeassistant/switch/1/on -m "Switch is ON"
Another way to send MQTT messages manually is to use the **MQTT** integration in the frontend. Choose "Settings" on the left menu, click "Devices & Services", and choose "Configure" in the "Mosquitto broker" tile. Enter something similar to the example below into the "topic" field under "Publish a packet" and press "PUBLISH" .
1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
-1. On the Mosquitto broker integration, select the cogwheel, then select **Configure**.
-1. Enter something similar to the example below into the **topic** field under **Publish a packet**. Select **Publish**.
+2. Select the Mosquitto broker integration, then select **Configure**.
+3. Enter something similar to the example below into the **topic** field under **Publish a packet**. Select **Publish**.
```bash
homeassistant/switch/1/power
@@ -568,6 +569,7 @@ The following software has built-in support for MQTT discovery:
- [HASS.Agent](https://github.com/LAB02-Research/HASS.Agent)
- [IOTLink](https://iotlink.gitlab.io) (starting with 2.0.0)
- [MiFlora MQTT Daemon](https://github.com/ThomDietrich/miflora-mqtt-daemon)
+- [MyElectricalData](https://github.com/MyElectricalData/myelectricaldata#english)
- [Nuki Hub](https://github.com/technyon/nuki_hub)
- [Nuki Smart Lock 3.0 Pro](https://support.nuki.io/hc/articles/12947926779409-MQTT-support), [more info](https://developer.nuki.io/t/mqtt-api-specification-v1-3/17626)
- [OpenMQTTGateway](https://github.com/1technophile/OpenMQTTGateway)
@@ -593,16 +595,18 @@ A motion detection device which can be represented by a [binary sensor](/integra
- Configuration topic: `homeassistant/binary_sensor/garden/config`
- State topic: `homeassistant/binary_sensor/garden/state`
-- Payload: `{"name": "garden", "device_class": "motion", "state_topic": "homeassistant/binary_sensor/garden/state"}`
+- Configuration payload: `{"name": "garden", "device_class": "motion", "state_topic": "homeassistant/binary_sensor/garden/state", "unique_id": "motion01ad", "device": {"identifiers": ["01ad"], "name": "Garden" }}`
- Retain: The -r switch is added to retain the configuration topic in the broker. Without this, the sensor will not be available after Home Assistant restarts.
-To create a new sensor manually.
+It is also a good idea to add a `unique_id` to allow changes to the entity and a `device` mapping so we can group all sensors of a device together.
+
+To create a new sensor manually:
```bash
-mosquitto_pub -r -h 127.0.0.1 -p 1883 -t "homeassistant/binary_sensor/garden/config" -m '{"name": "garden", "device_class": "motion", "state_topic": "homeassistant/binary_sensor/garden/state"}'
+mosquitto_pub -r -h 127.0.0.1 -p 1883 -t "homeassistant/binary_sensor/garden/config" -m '{"name": "garden", "device_class": "motion", "state_topic": "homeassistant/binary_sensor/garden/state", "unique_id": "motion01ad", "device": {"identifiers": ["01ad"], "name": "Garden" }}'
```
-Update the state.
+Update the state:
```bash
mosquitto_pub -h 127.0.0.1 -p 1883 -t "homeassistant/binary_sensor/garden/state" -m ON
@@ -621,9 +625,9 @@ For more details please refer to the [MQTT testing section](/integrations/mqtt/#
Setting up a sensor with multiple measurement values requires multiple consecutive configuration topic submissions.
- Configuration topic no1: `homeassistant/sensor/sensorBedroomT/config`
-- Configuration payload no1: `{"device_class": "temperature", "name": "Temperature", "state_topic": "homeassistant/sensor/sensorBedroom/state", "unit_of_measurement": "°C", "value_template": "{% raw %}{{ value_json.temperature}}{% endraw %}" }`
+- Configuration payload no1: `{"device_class": "temperature", "name": "Temperature", "state_topic": "homeassistant/sensor/sensorBedroom/state", "unit_of_measurement": "°C", "value_template": "{% raw %}{{ value_json.temperature}}{% endraw %}","unique_id": "temp01ae", "device": {"identifiers": ["bedroom01ae"], "name": "Bedroom" }}`
- Configuration topic no2: `homeassistant/sensor/sensorBedroomH/config`
-- Configuration payload no2: `{"device_class": "humidity", "name": "Humidity", "state_topic": "homeassistant/sensor/sensorBedroom/state", "unit_of_measurement": "%", "value_template": "{% raw %}{{ value_json.humidity}}{% endraw %}" }`
+- Configuration payload no2: `{"device_class": "humidity", "name": "Humidity", "state_topic": "homeassistant/sensor/sensorBedroom/state", "unit_of_measurement": "%", "value_template": "{% raw %}{{ value_json.humidity}}{% endraw %}","unique_id": "hum01ae", "device": {"identifiers": ["bedroom01ae"], "name": "Bedroom" } }`
- Common state payload: `{ "temperature": 23.20, "humidity": 43.70 }`
#### Entities with command topics
@@ -633,15 +637,15 @@ Setting up a light, switch etc. is similar but requires a `command_topic` as men
- Configuration topic: `homeassistant/switch/irrigation/config`
- State topic: `homeassistant/switch/irrigation/state`
- Command topic: `homeassistant/switch/irrigation/set`
-- Payload: `{"name": "garden", "command_topic": "homeassistant/switch/irrigation/set", "state_topic": "homeassistant/switch/irrigation/state"}`
+- Payload: `{"name": "Irrigation", "command_topic": "homeassistant/switch/irrigation/set", "state_topic": "homeassistant/switch/irrigation/state", "unique_id": "irr01ad", "device": {"identifiers": ["garden01ad"], "name": "Garden" }}`
- Retain: The -r switch is added to retain the configuration topic in the broker. Without this, the sensor will not be available after Home Assistant restarts.
```bash
mosquitto_pub -r -h 127.0.0.1 -p 1883 -t "homeassistant/switch/irrigation/config" \
- -m '{"name": "garden", "command_topic": "homeassistant/switch/irrigation/set", "state_topic": "homeassistant/switch/irrigation/state"}'
+ -m '{"name": "garden", "command_topic": "homeassistant/switch/irrigation/set", "state_topic": "homeassistant/switch/irrigation/state", "unique_id": "irr01ad", "device": {"identifiers": ["garden01ad"], "name": "Garden" }}}'
```
-Set the state.
+Set the state:
```bash
mosquitto_pub -h 127.0.0.1 -p 1883 -t "homeassistant/switch/irrigation/set" -m ON
@@ -680,7 +684,6 @@ 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 integrations optionally support providing an `object_id` which will be used instead if provided.
- Configuration topic: `homeassistant/sensor/device1/config`
@@ -835,14 +838,14 @@ The MQTT integration will register the service `mqtt.publish` which allows publi
### Service `mqtt.publish`
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `topic` | no | Topic to publish payload to.
-| `topic_template` | no | Template to render as topic to publish payload to.
-| `payload` | yes | Payload to publish.
-| `payload_template` | yes | Template to render as payload value.
-| `qos` | yes | Quality of Service to use. (default: 0)
-| `retain` | yes | If message should have the retain flag set. (default: false)
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------ |
+| `topic` | no | Topic to publish payload to. |
+| `topic_template` | no | Template to render as topic to publish payload to. |
+| `payload` | yes | Payload to publish. |
+| `payload_template` | yes | Template to render as payload value. |
+| `qos` | yes | Quality of Service to use. (default: 0) |
+| `retain` | yes | If message should have the retain flag set. (default: false) |
It is currently not possible to share/be invited to a home with a G-Suite account. Make sure that you pay the fee with an account that has access to your devices.
-1. Now the [Device Access Console](https://console.nest.google.com/device-access/project-list) should be visible. Click on **Create project**.
+3. Now the [Device Access Console](https://console.nest.google.com/device-access/project-list) should be visible. Click on **Create project**.
-1. Give your Device Access project a name and click **Next**.
+4. Give your Device Access project a name and click **Next**.
-1. Next you will be asked for an *OAuth client ID* which you created in the previous step and click **Next**.
+5. Next you will be asked for an *OAuth client ID* which you created in the previous step and click **Next**.
-1. Enable Events by clicking on **Enable** and **Create project**.
+6. Enable Events by clicking on **Enable** and **Create project**.
-1. You now have a *Device Access Project ID* needed by Home Assistant.
+7. You now have a *Device Access Project ID* needed by Home Assistant.
{% enddetails %}
@@ -190,28 +190,28 @@ Note that *OAuth for Apps* has been [deprecated](https://developers.googleblog.c
1. In Home Assistant, you should already be going through the setup flow. If not, go back and click the *My: Add Integration* button above to start the setup. The integration will ask you for all of the necessary integration configuration.
-1. Once all configuration information is entered in Home Assistant, a new tab opens, allowing you to choose a Google account. This should be the same developer account you configured above.
+2. Once all configuration information is entered in Home Assistant, a new tab opens, allowing you to choose a Google account. This should be the same developer account you configured above.
-1. The *Google Nest permissions* screen will allow you to choose which devices to configure and lets you select devices from multiple homes. You likely want to enable everything, however, you can leave out any feature you do not wish to use with Home Assistant.
+3. The *Google Nest permissions* screen will allow you to choose which devices to configure and lets you select devices from multiple homes. You likely want to enable everything, however, you can leave out any feature you do not wish to use with Home Assistant.
-1. You will get redirected to another account selection page.
+4. You will get redirected to another account selection page.
-1. You may see a warning screen that says *Google hasn't verified this app* since you just set up an un-verified developer workflow. Click *Continue* to proceed.
+5. You may see a warning screen that says *Google hasn't verified this app* since you just set up an un-verified developer workflow. Click *Continue* to proceed.
-1. Then you will be asked to grant access to additional permissions. Click *Allow*.
+6. Then you will be asked to grant access to additional permissions. Click *Allow*.
-1. Confirm you want to allow persistent access to Home Assistant.
+7. Confirm you want to allow persistent access to Home Assistant.
-1. You will now see a page hosted by *My Home Assistant* asking if you would like to *Link account to Home Assistant?* Click **Link Account** to continue.
+8. You will now see a page hosted by *My Home Assistant* asking if you would like to *Link account to Home Assistant?* Click **Link Account** to continue.
-1. If all went well, you are ready to go!
+9. If all went well, you are ready to go!
@@ -271,15 +271,15 @@ This feature is enabled by the following permissions:
All cameras have motion and person triggers, however only some support capturing snapshots for events. The table below summarizes the [Supported SDM API features](https://developers.google.com/nest/device-access/supported-devices) for each device.
-| Device | Live Stream | Triggers / Events | Media Source
for Triggers / Events |
-| ------ | :---------: | :------: | :--------------------: |
-| Nest Cam (indoor, wired)
Nest Cam (outdoor, battery) | WebRTC | Motion
Person | N/A |
-| Nest Cam Indoor
Nest Cam IQ Indoor
Nest Cam IQ Outdoor
Nest Cam Outdoor | RTSP
Recording | Motion
Person
Sound | Snapshot (jpg) |
-| Nest Cam with floodlight | WebRTC | Motion
Person | N/A |
-| Nest Doorbell (battery) | WebRTC | Motion
Person
Chime | Clip Preview (mp4, gif) |
-| Nest Doorbell (wired, 1st gen) | RTSP
Recording | Motion
Person
Sound
Chime | Snapshot (jpg) |
-| Nest Doorbell (wired, 2nd gen) | WebRTC | Motion
Person
Chime | Clip Preview (mp4, gif) |
-| Nest Hub Max | RTSP
Recording | Motion
Person
Sound
| Snapshot (jpg) |
+| Device | Live Stream | Triggers / Events | Media Source
for Triggers / Events |
+| -------------------------------------------------------------------------------- | :---------------: | :--------------------------------: | :------------------------------------: |
+| Nest Cam (indoor, wired)
Nest Cam (outdoor, battery) | WebRTC | Motion
Person | N/A |
+| Nest Cam Indoor
Nest Cam IQ Indoor
Nest Cam IQ Outdoor
Nest Cam Outdoor | RTSP
Recording | Motion
Person
Sound | Snapshot (jpg) |
+| Nest Cam with floodlight | WebRTC | Motion
Person | N/A |
+| Nest Doorbell (battery) | WebRTC | Motion
Person
Chime | Clip Preview (mp4, gif) |
+| Nest Doorbell (wired, 1st gen) | RTSP
Recording | Motion
Person
Sound
Chime | Snapshot (jpg) |
+| Nest Doorbell (wired, 2nd gen) | WebRTC | Motion
Person
Chime | Clip Preview (mp4, gif) |
+| Nest Hub Max | RTSP
Recording | Motion
Person
Sound
| Snapshot (jpg) |
Given a camera named `Front Yard` then the camera is created with a name such as `camera.front_yard`.
@@ -309,9 +309,9 @@ This is an example of what the `nest_event` payload looks like for a Device Trig
}
```
-* `device_id`: The Home Assistant device identifier for the camera
-* `nest_event_id`: is an opaque identifier that can be used with the Media Source Attachments described below for supported cameras.
-* `zones`: Zones triggering the event if available. Zones are configured in the Google Home App, though not supported by all cameras. Events in the area outside of a named zone will be an empty zone name.
+- `device_id`: The Home Assistant device identifier for the camera
+- `nest_event_id`: is an opaque identifier that can be used with the Media Source Attachments described below for supported cameras.
+- `zones`: Zones triggering the event if available. Zones are configured in the Google Home App, though not supported by all cameras. Events in the area outside of a named zone will be an empty zone name.
{% enddetails %}
@@ -336,9 +336,9 @@ The table above describes which devices support event image snapshots or 10-fram
The Media Source APIs can be used in [Companion App Attachments](https://companion.home-assistant.io/docs/notifications/notification-attachments) for Notifications as actions for Device Triggers above like *Doorbell Pressed*. You will need to be familiar with both the Media Sources supported for your camera, as well as the media capabilities of the companion apps.
-* `/api/nest/event_media/DEVICE_ID/EVENT_ID`: Media for the event, which supports image snapshots (jpg) or clip previews (mp4) depending on the camera type.
+- `/api/nest/event_media/DEVICE_ID/EVENT_ID`: Media for the event, which supports image snapshots (jpg) or clip previews (mp4) depending on the camera type.
-* `/api/nest/event_media/DEVICE_ID/EVENT_ID/thumbnail`: A thumbnail preview of the media, which supports image snapshots (jpg) or clip previews (gif) depending on the camera type.
+- `/api/nest/event_media/DEVICE_ID/EVENT_ID/thumbnail`: A thumbnail preview of the media, which supports image snapshots (jpg) or clip previews (gif) depending on the camera type.
You can use the event payload fields `device_id` and `event_id` in an [automation](/getting-started/automation/) to send a notification from an [actions](/getting-started/automation-action/) as shown in the examples below.
@@ -422,12 +422,12 @@ To improve security and reduce phishing risk Google has [deprecated](https://dev
{% details "Reconfigure the integration %}
1. Make sure to upgrade to the latest version of Home Assistant.
-1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
-1. The **Nest** integration should appear with alert.
+2. Go to **{% my integrations title="Settings > Devices & Services" %}**.
+3. The **Nest** integration should appear with alert.
-1. Click **Reconfigure**.
+4. Click **Reconfigure**.
@@ -439,27 +439,27 @@ If the *Nest* integration does not have an Alert then you probably used *Web Aut
{% details "Create new Web Auth Application Credentials" %}
1. In the Home Assistant flow confirm your *Google Cloud Project ID* and proceed to the next step.
-1. You will be prompted to enter new *Application Credentials*.
-1. In another tab visit the [Google Cloud Console](https://console.cloud.google.com/apis/credentials)
-1. On the *Credentials* page click **Create Credential**.
-1. From the drop-down list select **OAuth client ID**.
-1. Enter **Web Application** for the Application type.
-1. Pick a new name for your credential.
-1. Add **Authorized redirect URIs** end enter `https://my.home-assistant.io/redirect/oauth`
-1. Click *Create* to create the credential.
-1. You now have *OAuth Client ID* and *OAuth Client Secret* needed by Home Assistant.
-1. Back in Home Assistant, you should now be prompted to create [Application Credentials](/integrations/application_credentials) where you will enter the *Client ID* and *Client Secret*.
+2. You will be prompted to enter new *Application Credentials*.
+3. In another tab visit the [Google Cloud Console](https://console.cloud.google.com/apis/credentials)
+4. On the *Credentials* page click **Create Credential**.
+5. From the drop-down list select **OAuth client ID**.
+6. Enter **Web Application** for the Application type.
+7. Pick a new name for your credential.
+8. Add **Authorized redirect URIs** end enter `https://my.home-assistant.io/redirect/oauth`
+9. Click *Create* to create the credential.
+10. You now have *OAuth Client ID* and *OAuth Client Secret* needed by Home Assistant.
+11. Back in Home Assistant, you should now be prompted to create [Application Credentials](/integrations/application_credentials) where you will enter the *Client ID* and *Client Secret*.
{% enddetails %}
{% details "Update Device Access Project" %}
1. Visit the [Device Access Console](https://console.nest.google.com/device-access/)
-1. Select the *Device Access Project* used by *Home Assistant*
-1. You need to then delete the old *OAuth Client ID* by clicking the Trash icon to unlink your Nest project from the deprecated Auth method.
-1. Click the overflow menu `...` then *Add Client ID*
-1. Enter the new *OAuth Client ID* for *Web App Auth* credentials
-1. Back in Home Assistant confirm your *Device Access Project ID*
+2. Select the *Device Access Project* used by *Home Assistant*
+3. You need to then delete the old *OAuth Client ID* by clicking the Trash icon to unlink your Nest project from the deprecated Auth method.
+4. Click the overflow menu `...` then *Add Client ID*
+5. Enter the new *OAuth Client ID* for *Web App Auth* credentials
+6. Back in Home Assistant confirm your *Device Access Project ID*
{% enddetails %}
diff --git a/source/_integrations/nexity.markdown b/source/_integrations/nexity.markdown
index c609c6afaf5..411bb153502 100644
--- a/source/_integrations/nexity.markdown
+++ b/source/_integrations/nexity.markdown
@@ -2,7 +2,7 @@
title: Nexity Eugénie
description: Connect and control your Nexity Eugénie devices using the Overkiz integration
ha_category:
- - Alarm Control Panel
+ - Alarm
- Binary Sensor
- Button
- Climate
diff --git a/source/_integrations/nissan_leaf.markdown b/source/_integrations/nissan_leaf.markdown
index 80e6394d0ea..1d69293c0e1 100644
--- a/source/_integrations/nissan_leaf.markdown
+++ b/source/_integrations/nissan_leaf.markdown
@@ -18,10 +18,10 @@ ha_integration_type: integration
The `nissan_leaf` integration offers integration with the [NissanConnect EV](https://www.nissan.co.uk/dashboard.html) cloud service. NissanConnect EV was previously known as Nissan Carwings. It offers:
-* sensors for the battery status, range and charging status
-* a switch to start and stop the climate control
-* a button to request the car starts charging.
-* service to request updates from the car.
+- sensors for the battery status, range and charging status
+- a switch to start and stop the climate control
+- a button to request the car starts charging.
+- service to request updates from the car.
## Configuration
@@ -117,14 +117,14 @@ You can also use the `nissan_leaf.update` service to request an on-demand update
## Hints
-* The update interval has a minimum of two minutes.
-* Requesting updates uses a small amount of energy from the 12 V battery. The 12 V battery charges from the main traction battery when the car is not plugged in. If the car is left plugged in for a long time, or if the main traction battery is very low then the 12 V battery may gradually discharge. A low update interval may cause the 12 V battery to become flat. When the 12 V battery is flat the car will not start. _Do not set the update interval too low. Use at your own risk._
-* This integration communicates with the Nissan Servers which then communicate with the car. The communication between the car and the Nissan Servers is very slow, and takes up to five minutes to get information from the car, therefore the default polling interval is set to one hour to not overwhelm the connection.
-* Responses from the Nissan servers are received separately for the battery/range, climate control and location. The `updated_on` attribute will show the last time the data was retrieved from the server. There are separate attributes for when the `next_update` is scheduled, and to indicate if `update_in_progress`. The `nissan_leaf.update` service will reset the `next_update` attribute.
-* The Nissan APIs do not allow charging to be stopped remotely.
-* The Nissan servers have a history of being unstable, therefore please confirm that the official Nissan Leaf app/website is working correctly before reporting bugs.
-* In the UK the cut-off for Carwings was the 16 plate 24 kWh and the 65 plate 30 kWh. Cars after this have NissanConnect.
-* As of 25 July 2019 the MyCarFinder API is not longer available, hence the device_tracker support has been removed.
+- The update interval has a minimum of two minutes.
+- Requesting updates uses a small amount of energy from the 12 V battery. The 12 V battery charges from the main traction battery when the car is not plugged in. If the car is left plugged in for a long time, or if the main traction battery is very low then the 12 V battery may gradually discharge. A low update interval may cause the 12 V battery to become flat. When the 12 V battery is flat the car will not start. _Do not set the update interval too low. Use at your own risk._
+- This integration communicates with the Nissan Servers which then communicate with the car. The communication between the car and the Nissan Servers is very slow, and takes up to five minutes to get information from the car, therefore the default polling interval is set to one hour to not overwhelm the connection.
+- Responses from the Nissan servers are received separately for the battery/range, climate control and location. The `updated_on` attribute will show the last time the data was retrieved from the server. There are separate attributes for when the `next_update` is scheduled, and to indicate if `update_in_progress`. The `nissan_leaf.update` service will reset the `next_update` attribute.
+- The Nissan APIs do not allow charging to be stopped remotely.
+- The Nissan servers have a history of being unstable, therefore please confirm that the official Nissan Leaf app/website is working correctly before reporting bugs.
+- In the UK the cut-off for Carwings was the 16 plate 24 kWh and the 65 plate 30 kWh. Cars after this have NissanConnect.
+- As of 25 July 2019 the MyCarFinder API is not longer available, hence the device_tracker support has been removed.
Please report bugs using the following logger configuration.
diff --git a/source/_integrations/openai_conversation.markdown b/source/_integrations/openai_conversation.markdown
index 20932e3f90e..5d61a9fee40 100644
--- a/source/_integrations/openai_conversation.markdown
+++ b/source/_integrations/openai_conversation.markdown
@@ -14,7 +14,7 @@ ha_integration_type: service
The OpenAI integration adds a conversation agent powered by [OpenAI](https://www.openai.com) in Home Assistant.
-This conversation agent is unable to control your house. It can only query information that has been provided by Home Assistant. To be able to answer questions about your house, Home Assistant will need to provide OpenAI with the details of your house, which include areas, devices and their states.
+This conversation agent is unable to control your house. The OpenAI conversation agent can be used in automations, but not as a [sentence trigger](/docs/automation/trigger/#sentence-trigger). It can only query information that has been provided by Home Assistant. To be able to answer questions about your house, Home Assistant will need to provide OpenAI with the details of your house, which include areas, devices and their states.
This integration requires an API key to use, [which you can generate here.](https://platform.openai.com/account/api-keys). This is a paid service, we advise you to monitor your costs in the [OpenAI portal](https://platform.openai.com/account) closely and configure [usage limits](https://platform.openai.com/account/billing/limits) to avoid unwanted costs associated with using the service.
diff --git a/source/_integrations/openhome.markdown b/source/_integrations/openhome.markdown
index c01d3b2fa17..d193136a0c7 100644
--- a/source/_integrations/openhome.markdown
+++ b/source/_integrations/openhome.markdown
@@ -3,6 +3,7 @@ title: Linn / OpenHome
description: Instructions on how to integrate Linn Ds and Openhome renderers into Home Assistant.
ha_category:
- Media Player
+ - Update
ha_release: 0.39
ha_iot_class: Local Polling
ha_config_flow: true
@@ -12,6 +13,7 @@ ha_codeowners:
- '@bazwilliams'
ha_platforms:
- media_player
+ - update
ha_integration_type: integration
---
diff --git a/source/_integrations/opentherm_gw.markdown b/source/_integrations/opentherm_gw.markdown
index dcec979bf1b..543a8483142 100644
--- a/source/_integrations/opentherm_gw.markdown
+++ b/source/_integrations/opentherm_gw.markdown
@@ -75,9 +75,9 @@ Floor Temperature:
Reset the OpenTherm Gateway.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `gateway_id` | no | The `gateway_id` as specified during configuration.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------- |
+| `gateway_id` | no | The `gateway_id` as specified during configuration. |
### Service `set_central_heating_ovrd`
@@ -86,10 +86,10 @@ When overriding the control setpoint (via a [set_control_setpoint](#service-open
To return control of the central heating to the thermostat, call the [set_control_setpoint](#service-opentherm_gwset_control_setpoint) service with temperature value 0.
**You will only need this if you are writing your own software thermostat.**
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `gateway_id` | no | The `gateway_id` as specified during configuration.
-| `ch_override` | no | The desired value for the central heating override. Use `0` to disable or `1` to enable.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------------------------------- |
+| `gateway_id` | no | The `gateway_id` as specified during configuration. |
+| `ch_override` | no | The desired value for the central heating override. Use `0` to disable or `1` to enable. |
@@ -101,11 +101,11 @@ Please read [this information](http://otgw.tclcode.com/standalone.html) from the
Provide the time and day of week to the OpenTherm Gateway. The value provided here will be forwarded to the thermostat on the next date/time request from the thermostat. The OpenTherm Gateway does not have the ability to accurately keep track of time, so it will only retain the information provided here for a maximum of about 61 seconds.
-| Service data attribute | Optional | Default | Description |
-| ---------------------- | -------- | ------- | ----------- |
-| `gateway_id` | no | N/A | The `gateway_id` as specified during configuration.
-| `date` | yes | Today's date | Date from which the day of week will be extracted. Format: `YYYY-MM-DD`.
-| `time` | yes | Current time | Time in 24h format.
+| Service data attribute | Optional | Default | Description |
+| ---------------------- | -------- | ------------ | ------------------------------------------------------------------------ |
+| `gateway_id` | no | N/A | The `gateway_id` as specified during configuration. |
+| `date` | yes | Today's date | Date from which the day of week will be extracted. Format: `YYYY-MM-DD`. |
+| `time` | yes | Current time | Time in 24h format. |
### Service `opentherm_gw.set_control_setpoint`
@@ -117,10 +117,10 @@ Set the central heating control setpoint override on the OpenTherm Gateway.
In a normal situation, the thermostat will calculate and control the central heating setpoint on the boiler. Setting this to any value other than 0 will enable the override and allow the OpenTherm Gateway to control this setting. While the override is active, the OpenTherm Gateway will also request your boiler to activate the central heating circuit. For your boiler's actual maximum and minimum supported setpoint value, please see the `slave_ch_max_setp` and `slave_ch_min_setp` [sensors](#sensors). Due to the potential consequences of leaving this setting enabled for prolonged periods, the override will be disabled when Home Assistant is shut down or restarted.
**You will only need this if you are writing your own software thermostat.**
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `gateway_id` | no | The `gateway_id` as specified during configuration.
-| `temperature` | no | The central heating setpoint. Values between `0.0` and `90.0` are accepted, but your boiler may not support the full range. Set to `0` to disable the override.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `gateway_id` | no | The `gateway_id` as specified during configuration. |
+| `temperature` | no | The central heating setpoint. Values between `0.0` and `90.0` are accepted, but your boiler may not support the full range. Set to `0` to disable the override. |
@@ -136,41 +136,41 @@ been configured to let the room unit control when to keep a
small amount of water preheated, this command can influence
that.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `gateway_id` | no | The `gateway_id` as specified during configuration.
-| `dhw_override` | no | The domestic hot water override state. Value should be 0 or 1 to enable the override in off or on state, or "A" to disable the override.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| `gateway_id` | no | The `gateway_id` as specified during configuration. |
+| `dhw_override` | no | The domestic hot water override state. Value should be 0 or 1 to enable the override in off or on state, or "A" to disable the override. |
### Service `opentherm_gw.set_hot_water_setpoint`
Set the domestic hot water setpoint on the OpenTherm Gateway. Not all boilers support this feature.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `gateway_id` | no | The `gateway_id` as specified during configuration.
-| `temperature` | no | The domestic hot water setpoint to set on the gateway. Values between 0 and 90 are accepted, but not all boilers support this range. Check the values of the `slave_dhw_min_setp` and `slave_dhw_max_setp` sensors to see the supported range on your boiler.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `gateway_id` | no | The `gateway_id` as specified during configuration. |
+| `temperature` | no | The domestic hot water setpoint to set on the gateway. Values between 0 and 90 are accepted, but not all boilers support this range. Check the values of the `slave_dhw_min_setp` and `slave_dhw_max_setp` sensors to see the supported range on your boiler. |
### Service `opentherm_gw.set_gpio_mode`
Configure the GPIO behavior on the OpenTherm Gateway.
For an explanation of the possible modes, see [GPIO modes](#gpio-modes)
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `gateway_id` | no | The `gateway_id` as specified during configuration.
-| `id` | no | The GPIO ID, `A` or `B`.
-| `mode` | no | The GPIO mode to be set.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------- |
+| `gateway_id` | no | The `gateway_id` as specified during configuration. |
+| `id` | no | The GPIO ID, `A` or `B`. |
+| `mode` | no | The GPIO mode to be set. |
### Service `opentherm_gw.set_led_mode`
Configure the function of the LEDs on the OpenTherm Gateway.
For a list of possible modes with explanation, see [LED modes](#led-modes)
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `gateway_id` | no | The `gateway_id` as specified during configuration.
-| `id` | no | The LED ID, accepted values are `A` through `F`.
-| `mode` | no | The LED mode to be set.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------- |
+| `gateway_id` | no | The `gateway_id` as specified during configuration. |
+| `id` | no | The LED ID, accepted values are `A` through `F`. |
+| `mode` | no | The LED mode to be set. |
### Service `opentherm_gw.set_max_modulation`
@@ -182,10 +182,10 @@ Set the maximum modulation level override on the OpenTherm Gateway.
In a normal situation, the thermostat will control the maximum modulation level on the boiler. Setting this to any value other than `-1` will enable the override and allow the OpenTherm Gateway to control this setting. Due to the potential consequences of leaving this setting enabled, the override will be disabled when Home Assistant is shut down or restarted.
**You will only need this if you are writing your own software thermostat.**
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `gateway_id` | no | The `gateway_id` as specified during configuration.
-| `level` | no | The maximum modulation level. Accepted values are `-1` through `100`. Set to `-1` to disable the override.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------- |
+| `gateway_id` | no | The `gateway_id` as specified during configuration. |
+| `level` | no | The maximum modulation level. Accepted values are `-1` through `100`. Set to `-1` to disable the override. |
diff --git a/source/installation/raspberrypi.markdown b/source/installation/raspberrypi.markdown
index 96d40a31821..4b5d682d34f 100644
--- a/source/installation/raspberrypi.markdown
+++ b/source/installation/raspberrypi.markdown
@@ -36,30 +36,30 @@ If Raspberry Pi Imager is not supported by your platform, you can use [Balena Et
1. Download and install the Raspberry Pi Imager on your computer as described under [https://www.raspberrypi.com/software/](https://www.raspberrypi.com/software/).
-1. Open the Raspberry Pi Imager.
+2. Open the Raspberry Pi Imager.
-1. Choose the operating system:
+3. Choose the operating system:
1. Select **Choose OS**.
- 1. Select **Other specific-purpose OS** > **Home assistants and home automation** > **Home Assistant**.
- 1. Choose the Home Assistant OS that matches your hardware (RPi 3 or RPi 4).
+ 2. Select **Other specific-purpose OS** > **Home assistants and home automation** > **Home Assistant**.
+ 3. Choose the Home Assistant OS that matches your hardware (RPi 3 or RPi 4).
-1. Choose the storage:
+4. Choose the storage:
1. Insert the SD card into the computer. Note: the contents of the card will be overwritten.
- 1. Select your SD card.
+ 2. Select your SD card.
-1. Write the installer onto the SD card:
+5. Write the installer onto the SD card:
1. To start the process, select **Write**.
- 1. Wait for the Home Assistant OS to be written to the SD card.
+ 2. Wait for the Home Assistant OS to be written to the SD card.
-1. Eject the SD card.
+6. Eject the SD card.
### Start up your Raspberry Pi
1. Insert the SD card into your Raspberry Pi.
-1. Plug in an Ethernet cable that is connected to the network.
-1. Connect the power supply to start up the device.
+2. Plug in an Ethernet cable that is connected to the network.
+3. Connect the power supply to start up the device.
-1. In the browser of your desktop system, within a few minutes you will be able to reach your new Home Assistant at homeassistant.local:8123.
+4. In the browser of your desktop system, within a few minutes you will be able to reach your new Home Assistant at homeassistant.local:8123.
@@ -198,20 +198,20 @@ Please read [this information](http://otgw.tclcode.com/standalone.html) from the
Provide the outside temperature to the thermostat.
If your thermostat is unable to display an outside temperature and does not support OTC (Outside Temperature Correction), this has no effect. Note that not all thermostats are able to display the full supported range.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `gateway_id` | no | The `gateway_id` as specified during configuration.
-| `temperature` | no | The outside temperature to provide to the thermostat. Accepted values are `-40.0` through `64.0`. Any value above `64.0` will clear a previously configured value (suggestion: `99`).
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `gateway_id` | no | The `gateway_id` as specified during configuration. |
+| `temperature` | no | The outside temperature to provide to the thermostat. Accepted values are `-40.0` through `64.0`. Any value above `64.0` will clear a previously configured value (suggestion: `99`). |
### Service `opentherm_gw.set_setback_temperature`
Configure the setback temperature on the OpenTherm Gateway.
The value you provide here will be used with the GPIO `home` (5) and `away` (6) modes.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `gateway_id` | no | The `gateway_id` as specified during configuration.
-| `temperature` | no | The setback temperature. Accepted values are `0.0` through `30.0`.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------ |
+| `gateway_id` | no | The `gateway_id` as specified during configuration. |
+| `temperature` | no | The setback temperature. Accepted values are `0.0` through `30.0`. |
## Sensors
@@ -529,28 +529,28 @@ Possible modes and their meaning for the GPIO pins are listed here:
Bulletpoints and numbers to match the LED mode layout below.
{% endcomment %}
-* 1\. No function, default for both ports on a freshly flashed chip.
-* 2\. Ground - A permanently low output (0V). Could be used for a power LED.
-* 3\. Vcc - A permanently high output (5V). Can be used as a short-proof power supply for some external circuitry used by the other GPIO port.
-* 4\. LED E - An additional LED if you want to present more than 4 LED functions.
-* 5\. LED F - An additional LED if you want to present more than 5 LED functions.
-* 6\. Home - Set thermostat to setback temperature when pulled low.
-* 7\. Away - Set thermostat to setback temperature when pulled high.
-* 8\. DS1820 (GPIO port B only) - Data line for a DS18S20 or DS18B20 temperature sensor used to measure the outside temperature. A 4k7 resistor should be connected between GPIO port B and Vcc.
+- 1\. No function, default for both ports on a freshly flashed chip.
+- 2\. Ground - A permanently low output (0V). Could be used for a power LED.
+- 3\. Vcc - A permanently high output (5V). Can be used as a short-proof power supply for some external circuitry used by the other GPIO port.
+- 4\. LED E - An additional LED if you want to present more than 4 LED functions.
+- 5\. LED F - An additional LED if you want to present more than 5 LED functions.
+- 6\. Home - Set thermostat to setback temperature when pulled low.
+- 7\. Away - Set thermostat to setback temperature when pulled high.
+- 8\. DS1820 (GPIO port B only) - Data line for a DS18S20 or DS18B20 temperature sensor used to measure the outside temperature. A 4k7 resistor should be connected between GPIO port B and Vcc.
## LED modes
Possible LED modes and their meaning are listed here:
-* R. Receiving an OpenTherm message from the thermostat or boiler.
-* X. Transmitting an OpenTherm message to the thermostat or boiler.
-* T. Transmitting or receiving a message on the thermostat interface.
-* B. Transmitting or receiving a message on the boiler interface.
-* O. Remote setpoint override is active.
-* F. Flame is on.
-* H. Central heating is on.
-* W. Hot water is on.
-* C. Comfort mode (Domestic Hot Water Enable) is on.
-* E. Transmission error has been detected.
-* M. Boiler requires maintenance.
-* P. Raised power mode active on thermostat interface.
+- R. Receiving an OpenTherm message from the thermostat or boiler.
+- X. Transmitting an OpenTherm message to the thermostat or boiler.
+- T. Transmitting or receiving a message on the thermostat interface.
+- B. Transmitting or receiving a message on the boiler interface.
+- O. Remote setpoint override is active.
+- F. Flame is on.
+- H. Central heating is on.
+- W. Hot water is on.
+- C. Comfort mode (Domestic Hot Water Enable) is on.
+- E. Transmission error has been detected.
+- M. Boiler requires maintenance.
+- P. Raised power mode active on thermostat interface.
diff --git a/source/_integrations/openuv.markdown b/source/_integrations/openuv.markdown
index 56c1537ef5b..d80562b6892 100644
--- a/source/_integrations/openuv.markdown
+++ b/source/_integrations/openuv.markdown
@@ -34,19 +34,19 @@ To generate an API key, log in at [the OpenUV website](https://www.openuv.io/).
## Sensors
-| Name | Type | Value |
-|------|------|-------|
-| Current Ozone Level | Sensor | ozone level in du (Dobson Units) |
-| Current UV Index | Sensor | UV Index (numerical value) |
-| Current UV Level | Sensor | UV Level (as literal) |
-| Max UV Index | Sensor | max UV Index for the day (at solar noon) |
-| Protection Window | Binary Sensor | whether sunblock protection should be used |
-| Skin Type 1 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 1](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
-| Skin Type 2 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 2](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
-| Skin Type 3 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 3](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
-| Skin Type 4 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 4](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
-| Skin Type 5 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 5](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
-| Skin Type 6 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 6](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
+| Name | Type | Value |
+| ------------------------------ | ------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| Current Ozone Level | Sensor | ozone level in du (Dobson Units) |
+| Current UV Index | Sensor | UV Index (numerical value) |
+| Current UV Level | Sensor | UV Level (as literal) |
+| Max UV Index | Sensor | max UV Index for the day (at solar noon) |
+| Protection Window | Binary Sensor | whether sunblock protection should be used |
+| Skin Type 1 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 1](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
+| Skin Type 2 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 2](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
+| Skin Type 3 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 3](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
+| Skin Type 4 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 4](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
+| Skin Type 5 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 5](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
+| Skin Type 6 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 6](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
## Updating Data
@@ -63,16 +63,16 @@ query the API for new data after it initially loads. To request new data, the
Note that in the case of UV and ozone data, selecting any one of:
-* Current Ozone Level
-* Current UV Index
-* Current UV Level
-* Max UV Index
-* Skin Type 1 Safe Exposure Time
-* Skin Type 2 Safe Exposure Time
-* Skin Type 3 Safe Exposure Time
-* Skin Type 4 Safe Exposure Time
-* Skin Type 5 Safe Exposure Time
-* Skin Type 6 Safe Exposure Time
+- Current Ozone Level
+- Current UV Index
+- Current UV Level
+- Max UV Index
+- Skin Type 1 Safe Exposure Time
+- Skin Type 2 Safe Exposure Time
+- Skin Type 3 Safe Exposure Time
+- Skin Type 4 Safe Exposure Time
+- Skin Type 5 Safe Exposure Time
+- Skin Type 6 Safe Exposure Time
...as the target for the `homeassistant.update_entity` service will update the data for
_all_ of these entities.
@@ -87,9 +87,9 @@ The Protection Window binary sensor will be `on` when sunblock protection should
By default, this occurs anytime the UV index is above 3.5. This behavior can be
configured via the config entry options within the UI. Two parameters are given:
-* `Starting UV index for the protection window`: the UV index that, when passed, indicates
+- `Starting UV index for the protection window`: the UV index that, when passed, indicates
protection should be utilized
-* `Ending UV index for the protection window`: the UV index that, when passed, indicates
+- `Ending UV index for the protection window`: the UV index that, when passed, indicates
protection is no longer required
## Examples of Updating Data
diff --git a/source/_integrations/oralb.markdown b/source/_integrations/oralb.markdown
index 97170cb1d7e..8e6521addd2 100644
--- a/source/_integrations/oralb.markdown
+++ b/source/_integrations/oralb.markdown
@@ -42,9 +42,9 @@ The integration can discover most Bluetooth-enabled Oral-B toothbrushes. Brushes
## Sensor
-* Mode - selected cleaning mode e.g. daily clean.
-* Number of sectors - brushing areas set in the **Set Pacer Visualisation** in the brushing preferences in the mobile app.
-* Sector - the current sector of brush goal you are in (i.e. if brush goal is 2:00 minutes, and you are at 0:37, you are in sector 2)
-* Time - total brushing time in seconds.
-* Toothbrush state - whether the toothbrush is running, idle.
-* Battery - toothbrush battery percentage.
+- Mode - selected cleaning mode e.g. daily clean.
+- Number of sectors - brushing areas set in the **Set Pacer Visualisation** in the brushing preferences in the mobile app.
+- Sector - the current sector of brush goal you are in (i.e. if brush goal is 2:00 minutes, and you are at 0:37, you are in sector 2)
+- Time - total brushing time in seconds.
+- Toothbrush state - whether the toothbrush is running, idle.
+- Battery - toothbrush battery percentage.
diff --git a/source/_integrations/overkiz.markdown b/source/_integrations/overkiz.markdown
index 7cad9043011..5824eda96e1 100644
--- a/source/_integrations/overkiz.markdown
+++ b/source/_integrations/overkiz.markdown
@@ -2,7 +2,7 @@
title: Overkiz
description: Instructions on how to integrate hubs whom use the Overkiz platform with Home Assistant.
ha_category:
- - Alarm Control Panel
+ - Alarm
- Binary Sensor
- Button
- Climate
diff --git a/source/_integrations/owntracks.markdown b/source/_integrations/owntracks.markdown
index 83546ac5a07..f82e0bda988 100644
--- a/source/_integrations/owntracks.markdown
+++ b/source/_integrations/owntracks.markdown
@@ -21,16 +21,16 @@ By default, the integration listens for incoming messages from OwnTracks via HTT
## Configuration
1. To set up OwnTracks in Home Assistant, go to **{% my integrations title="Settings > Devices & Services" %}**.
-1. Add the **OwnTracks** integration.
- * This will give you the **Webhook** URL as well as the **Encryption key** to use during mobile device configuration (below).
+2. Add the **OwnTracks** integration.
+ - This will give you the **Webhook** URL as well as the **Encryption key** to use during mobile device configuration (below).
### Configuring the app - Android
1. Install the [OwnTracks](https://play.google.com/store/apps/details?id=org.owntracks.android) application for Android.
- * If you need a version of OwnTracks without Google Play Services, the "OSS" flavour is available [here](https://github.com/owntracks/android/releases).
+ - If you need a version of OwnTracks without Google Play Services, the "OSS" flavour is available [here](https://github.com/owntracks/android/releases).
-1. In the app, open the sidebar and select **Preferences**, then **Connection**.
-1. Change the following settings:
+2. In the app, open the sidebar and select **Preferences**, then **Connection**.
+3. Change the following settings:
- **Mode**: HTTP
- **Host**: `
| Name | Subscription Level | Meaning |
-|---------------------------------------|--------------------|-------------------------------------------------------------------------------------------------------------|
+| ------------------------------------- | ------------------ | ----------------------------------------------------------------------------------------------------------- |
| Marginal Operating Emissions Rate | Pro | The currently measured amount of lbs of CO2 per MWh |
| Relative Marginal Emissions Intensity | All | A percentage between the lowest (cleanest) and highest (highest) MOER values observed in the past two weeks |
You can learn more about the data that WattTime collects by viewing these articles:
-* https://www.watttime.org/aer/what-is-aer/
-* https://www.watttime.org/aer/how-aer-works/
+- https://www.watttime.org/aer/what-is-aer/
+- https://www.watttime.org/aer/how-aer-works/
diff --git a/source/_integrations/waze_travel_time.markdown b/source/_integrations/waze_travel_time.markdown
index 99f88931caa..7aac703e9ff 100644
--- a/source/_integrations/waze_travel_time.markdown
+++ b/source/_integrations/waze_travel_time.markdown
@@ -27,7 +27,7 @@ Notes:
## Manual Polling
-Some users want more control over polling intervals. To use more granular polling, you can disable automated polling. Go to {% my integrations title="**Settings** > **Devices & Services**" %}, and on the **Waze Travel Time** integration, select the cogwheel. On the integration entry, select the three dots. Then, select **System options** and toggle the button to disable polling. To manually trigger a polling request, call the [`homeassistant.update_entity` service](/integrations/homeassistant/#service-homeassistantupdate_entity) as needed, either manually or via automations.
+Some users want more control over polling intervals. To use more granular polling, you can disable automated polling. Go to {% my integrations title="**Settings** > **Devices & Services**" %}, and select the **Waze Travel Time** integration. On the integration entry, select the three dots. Then, select **System options** and toggle the button to disable polling. To manually trigger a polling request, call the [`homeassistant.update_entity` service](/integrations/homeassistant/#service-homeassistantupdate_entity) as needed, either manually or via automations.
## Example using dynamic destination
diff --git a/source/_integrations/webostv.markdown b/source/_integrations/webostv.markdown
index bba9429e366..502833141fb 100644
--- a/source/_integrations/webostv.markdown
+++ b/source/_integrations/webostv.markdown
@@ -23,8 +23,8 @@ The `webostv` platform allows you to control a [LG](https://www.lg.com/) webOS S
There is currently support for the following device types within Home Assistant:
-- [Media Player](#media-player)
-- [Notifications](#notifications)
+- [Media Player](/integrations/media_player/)
+- [Notifications](/integrations/notification/)
To begin with enable *LG Connect Apps* feature in *Network* settings of the TV.
diff --git a/source/_integrations/wemo.markdown b/source/_integrations/wemo.markdown
index fc54907addd..4f37e7d534c 100644
--- a/source/_integrations/wemo.markdown
+++ b/source/_integrations/wemo.markdown
@@ -118,7 +118,7 @@ There are several attributes which can be used for automations and templates:
| `current_humidity` | An integer that indicates the current relative humidity percentage of the room, as determined by the device's onboard humidity sensor.
| `fan_mode` | String that indicates the current fan speed setting, as reported by the WeMo humidifier.
| `filter_expired` | A boolean that indicates whether the filter has expired and needs to be replaced.
-| `filter_life` | The used life of the filter (as a percentage).
+| `filter_life` | The used lifetime of the filter (as a percentage).
| `target_humidity` | An integer that indicates the desired relative humidity percentage (this is constrained to the humidity settings of the device, which are 45, 50, 55, 60, and 100).
| `water level` | String that indicates whether the water level is Good, Low, or Empty.
@@ -133,7 +133,7 @@ There are several services which can be used for automations and control of the
| `turn_off` | Calling this service will turn the humidifier off (entity_id is required).
| `turn_on` | Calling this service will turn the humidifier on and set the speed to the last used speed (defaults to medium, entity_id is required).
| `wemo.set_humidity` | Calling this service will set the desired relative humidity setting on the device (entity_id is a required list of 1 or more entities to set humidity on, and target_humidity is a required float value between 0 and 100 (this value will be rounded down and mapped to one of the valid desired humidity settings of 45, 50, 55, 60, or 100 that are supported by the WeMo humidifier)).
-| `wemo.reset_filter_life` | Calling this service will reset the humdifier's filter life back to 100% (entity_id is a required list of 1 or more entities to reset the filter life on). Call this service when you change the filter on your humidifier.
+| `wemo.reset_filter_life` | Calling this service will reset the humdifier's filter lifetime back to 100% (entity_id is a required list of 1 or more entities to reset the filter lifetime on). Call this service when you change the filter on your humidifier.
## Long Press Events and Triggers
diff --git a/source/_integrations/wyoming.markdown b/source/_integrations/wyoming.markdown
index 5edb8a8adc9..35cde5452d0 100644
--- a/source/_integrations/wyoming.markdown
+++ b/source/_integrations/wyoming.markdown
@@ -18,7 +18,7 @@ ha_config_flow: true
The Wyoming integration connects external voice services to Home Assistant using a [small protocol](https://github.com/rhasspy/rhasspy3/blob/master/docs/wyoming.md). This enables [Assist](/voice_control/) to use a variety of local [speech-to-text](/integrations/stt/) and [text-to-speech](/integrations/tts/) systems, such as:
-* Whisper {% my supervisor_addon badge addon="core_whisper" %}
-* Piper {% my supervisor_addon badge addon="core_piper" %}
+- Whisper {% my supervisor_addon badge addon="core_whisper" %}
+- Piper {% my supervisor_addon badge addon="core_piper" %}
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/xiaomi.markdown b/source/_integrations/xiaomi.markdown
index 2dccc9ec56a..f47b8c49807 100644
--- a/source/_integrations/xiaomi.markdown
+++ b/source/_integrations/xiaomi.markdown
@@ -20,10 +20,10 @@ To successfully implement this platform, the Home Assistant host should be capab
In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found for each models.
-* [Yi 720p](https://github.com/fritz-smh/yi-hack)
-* [Yi Home 17CN / 27US / 47US / 1080p Home / Dome / 1080p Dome](https://github.com/shadow-1/yi-hack-v3)
-* [Recent Yi 1080p Home / 1080p Dome](https://github.com/roleoroleo/yi-hack-MStar)
-* [Xiaofang 1080p Camera](https://github.com/samtap/fang-hacks)
+- [Yi 720p](https://github.com/fritz-smh/yi-hack)
+- [Yi Home 17CN / 27US / 47US / 1080p Home / Dome / 1080p Dome](https://github.com/shadow-1/yi-hack-v3)
+- [Recent Yi 1080p Home / 1080p Dome](https://github.com/roleoroleo/yi-hack-MStar)
+- [Xiaofang 1080p Camera](https://github.com/samtap/fang-hacks)
Once installed, please ensure that you have enabled FTP.
diff --git a/source/_integrations/xiaomi_ble.markdown b/source/_integrations/xiaomi_ble.markdown
index f38dc3bd8ec..d3bf2c56280 100644
--- a/source/_integrations/xiaomi_ble.markdown
+++ b/source/_integrations/xiaomi_ble.markdown
@@ -50,15 +50,15 @@ The entities for the sensor classes are added after the values are first receive
Some devices use AES encryption to protect the sensor values they are broadcasting.
-* MiBeacon v2/v3 use unauthenticated AES with a 24 character hexadecimal (12 byte) key
-* MiBeacon v4/v5 use authenticated AES with a 32 character hexadecimal (16 byte) key
+- MiBeacon v2/v3 use unauthenticated AES with a 24 character hexadecimal (12 byte) key
+- MiBeacon v4/v5 use authenticated AES with a 32 character hexadecimal (16 byte) key
This key is called the bindkey or beaconkey.
There are a few ways to obtain a bindkey for your device:
-* Set your own. The [Telink Flasher](https://atc1441.github.io/TelinkFlasher.html) allows you to generate new bindkeys for devices it supports. The new bind key will work with Home Assistant, but the Mi Home app will not recognize the sensor anymore once the device has been activated by the TeLink flasher application. To use the sensor again with the Xiaomi Mi Home app, the device needs to be removed and then re-added inside the Mi Home app.
-* Extract the keys from Xiaomi Cloud using a [token extractor](https://github.com/PiotrMachowski/Xiaomi-cloud-tokens-extractor) tool.
+- Set your own. The [Telink Flasher](https://atc1441.github.io/TelinkFlasher.html) allows you to generate new bindkeys for devices it supports. The new bind key will work with Home Assistant, but the Mi Home app will not recognize the sensor anymore once the device has been activated by the TeLink flasher application. To use the sensor again with the Xiaomi Mi Home app, the device needs to be removed and then re-added inside the Mi Home app.
+- Extract the keys from Xiaomi Cloud using a [token extractor](https://github.com/PiotrMachowski/Xiaomi-cloud-tokens-extractor) tool.
## Devices
@@ -68,12 +68,12 @@ HHCCJCY01, also known as MiFlora or "Flower Care", should be automatically disco
Flower Care firmware update steps:
-* Install the official "Flower Care" app by HHCC:
- * [Google Play](https://play.google.com/store/apps/details?id=com.huahuacaocao.flowercare) (requires location and storage permission)
- * [Apple App Store](https://apps.apple.com/us/app/flower-care/id1095274672)
-* Place the device with the app within 10cm of the plant sensor
-* Press the "+" button on the top right in the devices tab of the app
-* Add the plant sensor to the app and select an arbitrary plant
-* Wait for the synchronization of the sensor to finish, and a dialog asking for a firmware update should appear (this might take a few minutes)
-* The installed and latest firmware version can be verified by selecting the plant -> three-dot menu -> Hardware settings -> Hardware update
-* The Flower Care account and app are not required any further for this integration to work
+- Install the official "Flower Care" app by HHCC:
+ - [Google Play](https://play.google.com/store/apps/details?id=com.huahuacaocao.flowercare) (requires location and storage permission)
+ - [Apple App Store](https://apps.apple.com/app/flower-care/id1095274672)
+- Place the device with the app within 10cm of the plant sensor
+- Press the "+" button on the top right in the devices tab of the app
+- Add the plant sensor to the app and select an arbitrary plant
+- Wait for the synchronization of the sensor to finish, and a dialog asking for a firmware update should appear (this might take a few minutes)
+- The installed and latest firmware version can be verified by selecting the plant -> three-dot menu -> Hardware settings -> Hardware update
+- The Flower Care account and app are not required any further for this integration to work
diff --git a/source/_integrations/xiaomi_miio.markdown b/source/_integrations/xiaomi_miio.markdown
index 1032f494e95..dbcd1b9023d 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
@@ -274,16 +274,16 @@ Supported devices:
- 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 Lifetime 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
@@ -317,7 +317,7 @@ Supported devices:
| Sensor | Description | Enabled by default |
| --------------------- | ------------------------------------------------------------- | ------------------ |
-| Filter Life Remaining | The remaining life of the filter | True |
+| Filter Life Remaining | The remaining lifetime of the filter | True |
| Filter Use | Filter usage time in hours | True |
| Humidity | The current humidity measured | True |
| Illuminance | The current illuminance measured | True |
@@ -353,17 +353,17 @@ Supported devices:
- 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 Lifetime Remaining | The remaining lifetime 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
@@ -396,16 +396,16 @@ Supported devices:
- 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 Lifetime Remaining | The remaining lifetime 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
@@ -432,15 +432,15 @@ Supported devices:
- 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 Lifetime Remaining | The remaining lifetime 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
@@ -474,16 +474,16 @@ This model uses newer MiOT communication protocol.
- 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 Lifetime Remaining | The remaining lifetime 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
@@ -505,12 +505,12 @@ This model uses newer MiOT communication protocol.
- 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 Lifetime Remaining | The remaining lifetime 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
@@ -531,15 +531,15 @@ This model uses newer MiOT communication protocol.
- 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 Lifetime Remaining | The remaining lifetime 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
@@ -566,16 +566,16 @@ This model uses newer MiOT communication protocol.
- `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 Lifetime Remaining | The remaining lifetime 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
@@ -607,17 +607,17 @@ These models use newer MiOT communication protocol.
- 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 Lifetime Remaining | The remaining lifetime of the filter in % | True |
+| Filter Time Left | The remaining lifetime 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
@@ -639,21 +639,21 @@ These models use newer MiOT communication protocol.
- Button entities
-| Button | Description |
-| ----------------- | --------------------------------------------------- |
-| Reset Dust Filter | Resets filter lifetime and usage of the dust filter |
+| Button | Description |
+| ----------------- | ------------------------------------------------------- |
+| Reset Dust Filter | Resets filter lifetimetime 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 lifetime remaining | The remaining lifetime of the filter |
+| Dust filter lifetime remaining days | The remaining lifetime 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
@@ -673,15 +673,15 @@ These models use newer MiOT communication protocol.
- `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 Lifetime Remaining | The remaining lifetime 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
@@ -706,15 +706,15 @@ These models use newer MiOT communication protocol.
- `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 Lifetime Remaining | The remaining lifetime 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
@@ -757,17 +757,17 @@ These models use newer MiOT communication protocol.
- 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 lifetime remaining | The remaining lifetime of the dust filter |
+| Dust filter lifetime remaining days | The remaining lifetime of the dust filter in days |
+| Upper filter lifetime remaining | The remaining lifetime of the upper filter |
+| Upper filter lifetime remaining days | The remaining lifetime 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
diff --git a/source/_integrations/yamaha_musiccast.markdown b/source/_integrations/yamaha_musiccast.markdown
index b175ea27823..4e584020741 100644
--- a/source/_integrations/yamaha_musiccast.markdown
+++ b/source/_integrations/yamaha_musiccast.markdown
@@ -125,7 +125,7 @@ In this section known problems and their resolution are documented.
### Errors on handling UDP messages
The Yamaha MusicCast integration is working with updates sent from the device to Home Assistant instead of pulling all information every few seconds. There is no error correction mechanism in these messages, so that only 100% correct messages can be processed. Whenever there is a corrupt message the Yamaha MusicCast integration will update all device information and log an error message like these:
-* `Received invalid message:
|
-| `media_content_type` | `MUSIC` |
+| `media_content_type` | `MUSIC` |
##### Examples:
@@ -216,11 +216,11 @@ media_content_id: '{ "playlist_name": "The Best of Disco", "shuffle": "1" }'
#### TV Episode
-| Service data attribute | Description |
-| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `entity_id` | `entity_id` of the client |
+| Service data attribute | Description |
+| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | `entity_id` of the client |
| `media_content_id` | Quoted JSON containing:
|
-| `media_content_type` | `EPISODE` |
+| `media_content_type` | `EPISODE` |
##### Examples:
@@ -250,11 +250,11 @@ media_content_id: '{ "library_name": "News TV", "show_name": "60 Minutes", "epis
#### Movie
-| Service data attribute | Description |
-| ---------------------- | ------------------------------------------------------------------------------------------------------- |
-| `entity_id` | `entity_id` of the client |
+| Service data attribute | Description |
+| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | `entity_id` of the client |
| `media_content_id` | Quoted JSON containing:
|
-| `media_content_type` | `movie` |
+| `media_content_type` | `movie` |
##### Examples:
@@ -272,16 +272,16 @@ Instead of searching for a specific known piece of media, many additional parame
These are examples of optional keys that can be included in the `media_content_id` JSON payload customize the search:
-* `unwatched`: Restrict search to unwatched items only (`true`, `false`)
-* `actor`: Restrict search for movies that include a specific actor
-* `collection`: Restrict search within a named Plex collection ("Back to the Future", "Indiana Jones")
-* `contentRating`: Restrict search to a specific content rating ("PG", "R")
-* `country`: Restrict search to a specific country of origin
-* `decade`: Restrict search to a specific decade ("1960", "2010")
-* `director`: Restrict search to a specific director
-* `genre`: Restrict search to a specific genre ("Animation", "Drama", "Sci-Fi")
-* `resolution`: Restrict search to a specific video resolution (480, 720, 1080, "4k")
-* `year`: Restrict search to a specific year
+- `unwatched`: Restrict search to unwatched items only (`true`, `false`)
+- `actor`: Restrict search for movies that include a specific actor
+- `collection`: Restrict search within a named Plex collection ("Back to the Future", "Indiana Jones")
+- `contentRating`: Restrict search to a specific content rating ("PG", "R")
+- `country`: Restrict search to a specific country of origin
+- `decade`: Restrict search to a specific decade ("1960", "2010")
+- `director`: Restrict search to a specific director
+- `genre`: Restrict search to a specific genre ("Animation", "Drama", "Sci-Fi")
+- `resolution`: Restrict search to a specific video resolution (480, 720, 1080, "4k")
+- `year`: Restrict search to a specific year
More parameters and additional details can be found in the `plexapi` library [documentation](https://python-plexapi.readthedocs.io/en/latest/modules/library.html#plexapi.library.LibrarySection.search).
@@ -324,15 +324,15 @@ The search will attempt to guess the type of media based on the search parameter
### Compatibility
-| Client | Limitations |
-| --- | --- |
-| Remote clients | Controls are unavailable |
-| Apple TV | None |
-| iOS | None |
-| NVidia Shield | None |
-| Plexamp | None (music playback only) |
+| Client | Limitations |
+| ------------------ | ------------------------------------------ |
+| Remote clients | Controls are unavailable |
+| Apple TV | None |
+| iOS | None |
+| NVidia Shield | None |
+| Plexamp | None (music playback only) |
| Plex Desktop & Web | Controls are unavailable (as of June 2022) |
-| Plex HTPC | None |
+| Plex HTPC | None |
## Sonos Playback
@@ -344,7 +344,7 @@ To play Plex music directly to Sonos speakers, the following requirements must b
Call the `media_player.play_media` service with the `entity_id` of a Sonos integration device and `media_content_type` prepended with `plex://`. Both [music](#music) and [playlist](#playlist) `media_content_type` values are supported.
-##### Examples:
+### Examples:
Play a track with advanced filtering on a Sonos Speaker
@@ -368,10 +368,10 @@ media_content_id: 'plex://{ "playlist_name": "Party Mix" }'
Refresh a Plex library to scan for new and updated media.
-| Service data attribute | Required | Description | Example |
-| --- | --- | --- | --- |
-| `server_name` | No | Name of Plex server to use if multiple servers configured. | "My Plex Server" |
-| `library_name` | Yes | Name of Plex library to update. | "TV Shows" |
+| Service data attribute | Required | Description | Example |
+| ---------------------- | -------- | ---------------------------------------------------------- | ---------------- |
+| `server_name` | No | Name of Plex server to use if multiple servers configured. | "My Plex Server" |
+| `library_name` | Yes | Name of Plex library to update. | "TV Shows" |
## Notes
diff --git a/source/_integrations/profiler.markdown b/source/_integrations/profiler.markdown
index 92825c70b9f..8dce2096093 100644
--- a/source/_integrations/profiler.markdown
+++ b/source/_integrations/profiler.markdown
@@ -20,21 +20,21 @@ The Profiler integration provides a profile which is a set of statistics that id
Start the profiler for the specified number of seconds.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `seconds` | yes | The number of seconds to run the profile. Defaults to 60.0
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------- |
+| `seconds` | yes | The number of seconds to run the profile. Defaults to 60.0 |
When the profile is complete, Profiler will generate a Python `cprof` and a `callgrind.out` file in your configuration directory. The exact path to these files will appear in a persistent notification so they can be easily located and copied to your desktop.
The `cprof` file can be viewed with:
-* [SnakeViz](https://jiffyclub.github.io/snakeviz/)
-* [Gprof2dot](https://github.com/jrfonseca/gprof2dot)
+- [SnakeViz](https://jiffyclub.github.io/snakeviz/)
+- [Gprof2dot](https://github.com/jrfonseca/gprof2dot)
Additionally, the profiler will generate a `callgrind.out` file that can be viewed with:
-* [KCachegrind or QCachegrind](https://kcachegrind.github.io/)
-* [Gprof2dot](https://github.com/jrfonseca/gprof2dot)
+- [KCachegrind or QCachegrind](https://kcachegrind.github.io/)
+- [Gprof2dot](https://github.com/jrfonseca/gprof2dot)
The gprof2dot tool generates [DOT](http://www.graphviz.org/doc/info/lang.html) files, which can be converted to images using the `dot` tool from [Graphviz](http://www.graphviz.org/) or viewed directly using [xdot](https://github.com/jrfonseca/xdot.py). The `-e` and `-n` parameters can be used to set the minimum percentage required to include a function in the output file. Observe these examples:
@@ -55,9 +55,9 @@ gprof2dot -f pstats profile.1234567890123456.cprof | dot -Tsvg -o profile.svg
Start the memory profiler for the specified number of seconds.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `seconds` | yes | The number of seconds to run the profile. Defaults to 60.0
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------- |
+| `seconds` | yes | The number of seconds to run the profile. Defaults to 60.0 |
When the memory profile is complete, Profiler will generate a `.hpy` file in your configuration directory. The exact path to these files will appear in a persistent notification so they can be easily located and copied to your desktop.
@@ -73,9 +73,9 @@ hpy().pb()
Start logging the growth of objects in memory.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `scan_interval` | yes | The the frequency between logging objects. Defaults to 30.0
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------------- |
+| `scan_interval` | yes | The the frequency between logging objects. Defaults to 30.0 |
Periodically log the growth of new objects in memory. This service's primary use case is finding memory leaks. This service can be run for long periods to find slow leaks. For finding fast leaks, `profiler.start_log_object_sources` is preferred; however, it is much more CPU intensive.
@@ -87,10 +87,10 @@ Stop logging the growth of objects in memory.
Start logging the growth of objects in memory and attempt to find the source of the new objects.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `scan_interval` | yes | The the frequency between logging objects. Defaults to 30.0
-| `max_objects` | yes | The number of new objects to examine for source information. Defaults to 5
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------------------------------------------------------------- |
+| `scan_interval` | yes | The the frequency between logging objects. Defaults to 30.0 |
+| `max_objects` | yes | The number of new objects to examine for source information. Defaults to 5 |
Periodically log the growth of new objects in memory. This service's primary use case is finding memory leaks.
@@ -102,9 +102,9 @@ Stop logging the growth of objects with sources in memory.
### Service {% my developer_call_service service="profiler.dump_log_objects" %}
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `type` | no | The type of object to dump to the log.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------------------------- |
+| `type` | no | The type of object to dump to the log. |
When `start_log_objects` highlights the growth of a collection of objects in memory, this service can help investigate. The `repr` of each object that matches `type` will be logged.
diff --git a/source/_integrations/prusalink.markdown b/source/_integrations/prusalink.markdown
index 7dcecbb4f95..f9c090fd6c8 100644
--- a/source/_integrations/prusalink.markdown
+++ b/source/_integrations/prusalink.markdown
@@ -24,4 +24,4 @@ To obtain the API key:
- On your printer, navigate to **Settings** > **Network** > **PrusaLink**.
- The API key is shown at the bottom of the screen.
-{% include integrations/config_flow.md %}
\ No newline at end of file
+{% include integrations/config_flow.md %}
diff --git a/source/_integrations/purpleair.markdown b/source/_integrations/purpleair.markdown
index 013362fd0b3..b68ff6682b4 100644
--- a/source/_integrations/purpleair.markdown
+++ b/source/_integrations/purpleair.markdown
@@ -31,6 +31,21 @@ Settings:
description: Configure additional settings (e.g., show/hide sensor icons on the map).
{% endconfiguration_basic %}
+## Creating an API key
+
+To add this integration, you need a (free) Purple Air API Key. A new account currently comes with 1 million free points. After that, you need to buy additional points to continue to use the API. The current plugin uses ~30K points/day. The 1 million points last about a month. A lack of points will trigger API errors until you buy more points.
+
+Detailed instructions can be found [here](https://community.purpleair.com/t/creating-api-keys/3951) but in summary you:
+
+- Create an account at https://develop.purpleair.com/ (which uses Single Sign-On through a Google account).
+- On the ['keys'](https://develop.purpleair.com/keys) page press the "plus" button to create an API key. Leave the defaults of **Read** and **Enabled**.
+- Go to the ['projects'](https://develop.purpleair.com/projects) page and select the edit (pencil) button on the listed Project. Add points (for example 1,000,000), then select **Update**.
+- Go back to the ['keys'](https://develop.purpleair.com/keys) page and copy the API key. It will be a value like XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXX.
+- Paste that API key into the **API Key** field when creating the integration in Home Assistant.
+
+Note that if you are using your own sensor, it will need to be set to **Public** to be visible.
+
+
## Creating an AQI Rating from Raw Particulate Data
The PurpleAir API does not provide AQI data; therefore, the integration does not create
diff --git a/source/_integrations/qnap.markdown b/source/_integrations/qnap.markdown
index c54033180fe..aab6e2b1030 100644
--- a/source/_integrations/qnap.markdown
+++ b/source/_integrations/qnap.markdown
@@ -9,7 +9,9 @@ ha_domain: qnap
ha_config_flow: true
ha_platforms:
- sensor
-ha_integration_type: integration
+ha_integration_type: device
+ha_codeowners:
+ - '@disforw'
---
The QNAP integration allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/).
diff --git a/source/_integrations/remote.markdown b/source/_integrations/remote.markdown
index a6adec6984a..f8d38397a68 100644
--- a/source/_integrations/remote.markdown
+++ b/source/_integrations/remote.markdown
@@ -13,8 +13,8 @@ ha_integration_type: entity
Keeps track which remotes are in your environment, their state and allows you to control them.
- * Maintains a state per remote and a combined state `all_remotes`.
- * Registers services `remote/turn_on`, `remote/turn_off`, `remote/toggle`, and `remote/send_command` to control remotes.
+- Maintains a state per remote and a combined state `all_remotes`.
+- Registers services `remote/turn_on`, `remote/turn_off`, `remote/toggle`, and `remote/send_command` to control remotes.
### Use the services
@@ -24,8 +24,8 @@ Go to the **Developer Tools**, then to **Call Service** in the frontend, and cho
{"entity_id":"remote.family_room"}
```
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | Only act on a specific remote, else target all.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------- |
+| `entity_id` | yes | Only act on a specific remote, else target all. |
See the platform documentation for each type of remote for more detailed examples.
diff --git a/source/_integrations/renson.markdown b/source/_integrations/renson.markdown
index 5bc7d29e597..36c9ba8d828 100644
--- a/source/_integrations/renson.markdown
+++ b/source/_integrations/renson.markdown
@@ -4,16 +4,17 @@ description: Instructions on how to integrate Renson Endura Delta sensors into H
ha_category:
- Sensor
ha_release: 2023.7
-ha_iot_class: Local Poll
+ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
- '@jimmyd-be'
ha_domain: renson
ha_platforms:
- sensor
+ha_integration_type: integration
---
The Renson integration pulls in data from the Renson Endura delta device. Most of the sensors that can be monitored from inside the Android/iOS application can be monitored with this integration.
-{% include integrations/config_flow.md %}
\ No newline at end of file
+{% include integrations/config_flow.md %}
diff --git a/source/_integrations/reolink.markdown b/source/_integrations/reolink.markdown
index a6ed97d823e..50507437d80 100644
--- a/source/_integrations/reolink.markdown
+++ b/source/_integrations/reolink.markdown
@@ -59,6 +59,7 @@ The latency for receiving the events is the best for ONVIF push and the worst fo
For redundancy, these sensors are polled every 60 seconds together with the update of all other entities.
Not all camera models generate ONVIF push events for all event types, some binary sensors might, therefore, only be polled.
For list of Reolink products that support ONVIF see the [Reolink Support Site](https://support.reolink.com/hc/en-us/articles/900000617826).
+To ensure you have the best latency possible, refer to the [Reducing latency of motion events](#Reducing_latency_of_motion_events) section.
## Asterisk (*) next to entities listed in this documentation
@@ -179,36 +180,42 @@ The latest firmware can be downloaded from the [Reolink download center](https:/
The following models have been tested and confirmed to work:
-- C1 Pro
-- C2 Pro
-- E1 Zoom
-- E1 Outdoor
-- E1 Outdoor Pro
-- RLC-410
-- RLC-410W
-- RLC-411
-- RLC-420
-- RLC-510A
-- RLC-511
-- RLC-511W
-- RLC-520
-- RLC-520A
-- RLC-522
-- RLC-810A
-- RLC-811A
-- RLC-81PA
-- RLC-820A
-- RLC-822A
-- RLC-823A
-- RLC-833A
-- RLC-1224A
-- RLN8-410 NVR
-- RLN16-410 NVR
-- RLN36 NVR
-- Reolink Duo 2 WiFi
-- Reolink Duo Floodlight PoE
-- Reolink TrackMix (PoE and Wi-Fi)
-- Reolink Video Doorbell (PoE and Wi-Fi)
+- C1 Pro*
+- C2 Pro*
+- [CX410](https://reolink.com/product/cx410/)
+- [E1 Zoom](https://reolink.com/product/e1-zoom/)
+- [E1 Outdoor](https://reolink.com/product/e1-outdoor/)
+- [E1 Outdoor PoE](https://reolink.com/product/e1-outdoor-poe/)
+- [E1 Outdoor Pro](https://reolink.com/product/e1-outdoor-pro/)
+- RLC-410*
+- [RLC-410W](https://reolink.com/product/rlc-410w/)
+- RLC-411*
+- RLC-420*
+- RLC-423*
+- [RLC-510A](https://reolink.com/product/rlc-510a/)
+- RLC-511*
+- RLC-511W*
+- [RLC-511WA](https://reolink.com/product/rlc-511wa/)
+- RLC-520*
+- [RLC-520A](https://reolink.com/product/rlc-520a/)
+- RLC-522*
+- [RLC-810A](https://reolink.com/product/rlc-810a/)
+- [RLC-811A](https://reolink.com/product/rlc-811a/)
+- [RLC-81PA](https://reolink.com/product/rlc-81pa/)
+- [RLC-820A](https://reolink.com/product/rlc-820a/)
+- [RLC-822A](https://reolink.com/product/rlc-822a/)
+- [RLC-823A](https://reolink.com/product/rlc-823a/)
+- [RLC-833A](https://reolink.com/product/rlc-833a/)
+- [RLC-1224A](https://reolink.com/product/rlc-1224a/)
+- [RLN8-410 NVR](https://reolink.com/product/rln8-410/)
+- [RLN16-410 NVR](https://reolink.com/product/rln16-410/)
+- [RLN36 NVR](https://reolink.com/product/rln36/)
+- [Reolink Duo 2 WiFi](https://reolink.com/product/reolink-duo-wifi/)
+- [Reolink Duo Floodlight PoE](https://reolink.com/product/reolink-duo-floodlight-poe/)
+- Reolink TrackMix ([PoE](https://reolink.com/product/reolink-trackmix-poe/) and [Wi-Fi](https://reolink.com/product/reolink-trackmix-wifi/))
+- Reolink Video Doorbell ([PoE](https://reolink.com/product/reolink-video-doorbell/) and [Wi-Fi](https://reolink.com/product/reolink-video-doorbell-wifi/))
+
+*These models are discontinued and not sold anymore, they will continue to work with Home Assistant.
Battery-powered cameras are not yet supported.
@@ -256,3 +263,16 @@ Then power up the camera while pointing it at the QR code. It takes about a minu
- On some camera models, the RTMP port needs to be enabled in order for the HTTP(S) port to function properly. Make sure this port is also enabled if you get a `Cannot connect to host` error while one of the HTTP/HTTPS ports is already enabled.
- Setting a static IP address for Reolink cameras/NVRs in your router is advisable to prevent (temporal) connectivity issues when the IP address changes.
- Do not set a static IP in the Reolink device itself, but leave the **Connection Type** on **DHCP** under **Settings** > **Network** > **Network Information** > **Set Up**. If you set it to **static** on the Reolink device itself, this is known to cause incorrect DHCP requests on the network. The incorrect DHCP request causes Home Assistant to use the wrong IP address for the camera, resulting in connection issues. The issue originates from the Reolink firmware, which keeps sending DCHP requests even when you set a static IP address in the Reolink device.
+
+### Reducing latency of motion events
+
+ONVIF push will result in slightly faster state changes of the binary motion/AI event sensors than ONVIF long polling.
+However, ONVIF push has some additional network configuration requirements:
+
+- Reolink products can not push motion events to an HTTPS address (SSL).
+Therefore, make sure a (local) HTTP address at which HA is reachable is configured under **Home Assistant URL** in the {% my network title="network settings" %}.
+A valid address could, for example, be `http://192.168.1.10:8123` where `192.168.1.10` is the IP of the Home Assistant device".
+
+- Since a HTTP address is needed, Reolink push is incompatible with a global SSL certificate.
+Therefore, ensure no Global SSL certificate is configured in the [`configuration.yaml` under HTTP](/integrations/http/#ssl_certificate).
+An SSL certificate can still be enforced for external connections, by, for instance, using the [NGINX add-on](https://github.com/home-assistant/addons/tree/master/nginx_proxy) or [NGINX Proxy Manager add-on](https://github.com/hassio-addons/addon-nginx-proxy-manager) instead of a globally enforced SSL certificate.
diff --git a/source/_integrations/repetier.markdown b/source/_integrations/repetier.markdown
index d29dd5890d9..ead521e0b13 100644
--- a/source/_integrations/repetier.markdown
+++ b/source/_integrations/repetier.markdown
@@ -104,8 +104,8 @@ camera:
To generate the needed API-key do the following:
-* Go to your Repetier Server web-console
-* Push the settings icon (the gear icon)
-* Select User Profiles.
-* Create a new user, deselect all options and click Create User.
-* Edit the newly created user and take note of the API-key for this user, that's the one to use in the Home Assistant Settings
+- Go to your Repetier Server web-console
+- Push the settings icon (the gear icon)
+- Select User Profiles.
+- Create a new user, deselect all options and click Create User.
+- Edit the newly created user and take note of the API-key for this user, that's the one to use in the Home Assistant Settings
diff --git a/source/_integrations/rexel.markdown b/source/_integrations/rexel.markdown
index a003b45f259..540f84a8277 100644
--- a/source/_integrations/rexel.markdown
+++ b/source/_integrations/rexel.markdown
@@ -2,7 +2,7 @@
title: Rexel Energeasy Connect
description: Connect and control your Rexel Energeasy Connect devices using the Overkiz integration
ha_category:
- - Alarm Control Panel
+ - Alarm
- Binary Sensor
- Button
- Climate
diff --git a/source/_integrations/rflink.markdown b/source/_integrations/rflink.markdown
index ebe82669094..60e1c80f055 100644
--- a/source/_integrations/rflink.markdown
+++ b/source/_integrations/rflink.markdown
@@ -17,7 +17,7 @@ ha_codeowners:
ha_integration_type: integration
---
-The `rflink` integration supports devices that use [RFLink gateway firmware](https://www.rflink.nl/download.php), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/en/21-rflink-). RFLink Gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
+The `rflink` integration supports devices that use [RFLink gateway firmware](https://www.rflink.nl/download.php), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/21-rflink-). RFLink Gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
The 433 MHz spectrum is used by many manufacturers mostly using their own protocol/standard and includes devices like: light switches, blinds, weather stations, alarms and various other sensors.
@@ -101,7 +101,7 @@ Tested with Wifi serial bridge [esp-link V2.2.3](https://github.com/jeelabs/esp-
-Due to different logic levels, a voltage level shifter is required between the 3.3V NodeMCU and 5V Arduino MEGA 2560 pins. The BSS138 bidirectional logic level converter has been tested for serial pins and the [link](https://www.aliexpress.com/item/8CH-IIC-I2C-Logic-Level-Converter-Bi-Directional-Module-DC-DC-5V-to-3-3V-Setp/32238089139.html) is recommended for the CC2500 transceiver (used for IKEA Ansluta and Philips Living Colors)
+Due to different logic levels, a voltage level shifter is required between the 3.3V NodeMCU and 5V Arduino MEGA 2560 pins. The BSS138 bidirectional logic level converter has been tested for serial pins and the [link](https://aliexpress.com/item/32238089139.html) is recommended for the CC2500 transceiver (used for IKEA Ansluta and Philips Living Colors)
diff --git a/source/_integrations/ridwell.markdown b/source/_integrations/ridwell.markdown
index eeadaf87081..4f07405fb97 100644
--- a/source/_integrations/ridwell.markdown
+++ b/source/_integrations/ridwell.markdown
@@ -25,9 +25,9 @@ The Ridwell integration allows users to track waste recycling pickups scheduled
The pickup sensor contains a `pickup_types` state attribute, which contains:
-* The items being picked up during this particular event
-* The category of each item
-* The quantity of each item
+- The items being picked up during this particular event
+- The category of each item
+- The quantity of each item
For example:
diff --git a/source/_integrations/rituals_perfume_genie.markdown b/source/_integrations/rituals_perfume_genie.markdown
index bc45189bf82..9197c2bf208 100644
--- a/source/_integrations/rituals_perfume_genie.markdown
+++ b/source/_integrations/rituals_perfume_genie.markdown
@@ -16,6 +16,7 @@ ha_codeowners:
ha_domain: rituals_perfume_genie
ha_platforms:
- binary_sensor
+ - diagnostics
- number
- select
- sensor
diff --git a/source/_integrations/roborock.markdown b/source/_integrations/roborock.markdown
index 0b2212c83f5..9d65669a263 100644
--- a/source/_integrations/roborock.markdown
+++ b/source/_integrations/roborock.markdown
@@ -16,6 +16,7 @@ ha_codeowners:
- '@Lash-L'
ha_domain: roborock
ha_platforms:
+ - diagnostics
- select
- sensor
- switch
@@ -27,7 +28,7 @@ The Roborock integration allows you to control your [Roborock](https://us.roboro
This integration requires a cloud connection to set up the device, but it communicates with the device entirely over your home network.
-Once you log in with your Roborock account, the integration will automatically discover your Roborock devices and get the needed information to communicate locally with them. Please ensure your Home Assistant instance can communicate with the local IP of your device. We recommend setting a static IP for your Roborock Vacuum to help prevent future issues.
+Once you log in with your Roborock account, the integration will automatically discover your Roborock devices and get the needed information to communicate locally with them. Please ensure your Home Assistant instance can communicate with the local IP of your device. We recommend setting a static IP for your Roborock Vacuum to help prevent future issues. The device communicates on port 58867. Depending on your firewall, you may need to allow communication from Home Assistant to your vacuum on that port.
{% include integrations/config_flow.md %}
@@ -43,7 +44,7 @@ As of right now - no. When the vacuum is disconnected from the internet, it will
If you can add your device to the Roborock app - it is supported. However, some older vacuums like the Roborock S5 must be connected using the Mi Home app and can be set up in Home Assistant through the [Xiaomi Miio](/integrations/xiaomi_miio/) integration.
### What features will you support?
-We are working on adding a lot of features to the core integration. We have reverse-engineered over 100 commands. The following are some of the functionalities we plan to add to Home Assistant Core. We ask that you are patient with us as we add them.
+We are working on adding a lot of features to the core integration. We have reverse-engineered over [100 commands](https://python-roborock.readthedocs.io/en/latest/api_commands.html). The documentation is currently very bare-bones, and we are looking for users to help us make it more complete. The following are some of the functionalities we plan to add to Home Assistant Core. We ask that you are patient with us as we add them.
- Selective room cleaning
- Dock controls
- Manual vacuum remote control
@@ -53,13 +54,14 @@ We are working on adding a lot of features to the core integration. We have reve
### How can I clean a specific room?
We plan to make the process simpler in the future, but for now, it is a multi-step process.
-1) Enable debug logging for this integration and reload it.
-2) Search your logs for 'Got home data' and then find the attribute rooms.
-3) Write the rooms down; they have a name and 6 digit ID.
-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 `repeat` with a number (ranging from 1 to 3) to determine how many times you want to clean these areas.
+1. Make sure to first name the rooms in the Roborock app; otherwise, they won't appear in the debug log.
+2. [Enable debug logging](/docs/configuration/troubleshooting/#enabling-debug-logging) for this integration and reload it.
+3. Search your logs for 'Got home data' and find the attribute rooms.
+4. Write the rooms down; they have a name and 6 digit ID.
+5. Go to {% my developer_call_service service="vacuum.send_command" title="**Developer Tools** > **Services** > **Vacuum: Send Command**" %}. Select your vacuum as the entity and `get_room_mapping` as the command.
+6. 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.
+7. Now, you have the 2-digit ID that your vacuum uses to describe a room.
+8. Go back to {% my developer_call_service service="vacuum.send_command" title="**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
diff --git a/source/_integrations/roon.markdown b/source/_integrations/roon.markdown
index 78a39506701..2aca290e722 100644
--- a/source/_integrations/roon.markdown
+++ b/source/_integrations/roon.markdown
@@ -20,24 +20,24 @@ This integration uses Roon Core, a Roon application that runs on a machine on yo
## Configuration
-1. From the Home Assistant front-end, go to {% my integrations title="**Settings** > **Devices & Services**" %}. On the **Roon** integration, select the cogwheel. Then, select **Configure**.
-1. Home Assistant will then try to find your Roon Core - if it is successful it will display `Authorize HomeAssistant in Roon`. Select **Submit** and skip to step 4.
-1. If your Roon Core is not automatically found, enter the `Hostname` or `IP address` for the Roon Core machine when requested and select **Submit**.
-1. Home Assistant will then contact your Roon Core and ask to be authorized. You will need to enable this extension in the Room Application. Go to **Settings** and then **Extensions**. There, you will see an entry for Home Assistant with a button next to it. Select **Enable**.
-1. Roon core will then provide Home Assistant with the details of your media players.
-1. In Home Assistant you can then pick an area for each of your music players, and add them to Home Assistant.
+1. From the Home Assistant front-end, go to {% my integrations title="**Settings** > **Devices & Services**" %}. Select the **Roon** integration. Then, select **Configure**.
+2. Home Assistant will then try to find your Roon Core - if it is successful it will display `Authorize HomeAssistant in Roon`. Select **Submit** and skip to step 4.
+3. If your Roon Core is not automatically found, enter the `Hostname` or `IP address` for the Roon Core machine when requested and select **Submit**.
+4. Home Assistant will then contact your Roon Core and ask to be authorized. You will need to enable this extension in the Room Application. Go to **Settings** and then **Extensions**. There, you will see an entry for Home Assistant with a button next to it. Select **Enable**.
+5. Roon core will then provide Home Assistant with the details of your media players.
+6. In Home Assistant you can then pick an area for each of your music players, and add them to Home Assistant.
## Services
-#### Service `media_player.play_media`
+### Service `media_player.play_media`
Roon uses a path based on the roon browser hierarchy to specify which media to play. You can find this by using the media browser, or by following the examples below. If roon can't follow the path you will find an error in the log that will show which part of the path roon could not follow, and the possibilities at that point.
-| Service data attribute | Optional | Description |
-| -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
-| `media_content_id` | no | A path to specify the media you want to play, see examples below. |
-| `media_content_type` | no | Only `music` is supported |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------------------------- |
+| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
+| `media_content_id` | no | A path to specify the media you want to play, see examples below. |
+| `media_content_type` | no | Only `music` is supported |
For example to play the album Harvest by Neil Young you should set `media_content_id` to `Library/Artists/Neil Young/Harvest` and to play BBC Radio 4 you would set `media_content_id` to `My Live Radio/BBC Radio 4`
@@ -45,7 +45,7 @@ Roon uses a path based on the roon browser hierarchy to specify which media to p
Transfer playback from one player to another.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | id of the source player.
-| `transfer_id` | no | id of the destination player.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------- |
+| `entity_id` | yes | id of the source player. |
+| `transfer_id` | no | id of the destination player. |
diff --git a/source/_integrations/samsungtv.markdown b/source/_integrations/samsungtv.markdown
index dd988d79a57..a4138699ae7 100644
--- a/source/_integrations/samsungtv.markdown
+++ b/source/_integrations/samsungtv.markdown
@@ -23,36 +23,7 @@ ha_integration_type: device
The `samsungtv` platform allows you to control a [Samsung Smart TV](https://www.samsung.com/uk/tvs/all-tvs/).
-### Setup
-
-Go to the integrations page in your configuration and click on new integration -> Samsung TV.
-If your TV is on and you have enabled [SSDP](/integrations/ssdp) discovery, it's likely that you just have to confirm the detected device.
-
-When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication.
-
-### YAML Configuration
-
-YAML configuration is around for people that prefer YAML.
-To use this integration, add the following to your `configuration.yaml` file:
-
-```yaml
-# Example configuration.yaml entry
-samsungtv:
- - host: IP_ADDRESS
-```
-
-{% configuration %}
-host:
- description: "The hostname or IP of the Samsung Smart TV, e.g., `192.168.0.10`."
- required: true
- type: string
-name:
- description: The name you would like to give to the Samsung Smart TV.
- required: false
- type: string
-{% endconfiguration %}
-
-After saving the YAML configuration, the TV must be turned on _before_ launching Home Assistant in order for the TV to be registered the first time.
+{% include integrations/config_flow.md %}
### Turn on action
diff --git a/source/_integrations/scene.markdown b/source/_integrations/scene.markdown
index 529300d77c8..30959148f41 100644
--- a/source/_integrations/scene.markdown
+++ b/source/_integrations/scene.markdown
@@ -1,5 +1,5 @@
---
-title: Scenes
+title: Scene
description: Instructions on how to setup scenes within Home Assistant.
ha_category:
- Organization
@@ -11,6 +11,24 @@ ha_domain: scene
ha_integration_type: entity
---
+A scene entity is an entity that can restore the state of a group of entities.
+Scenes can be user-defined or can be provided through an integration.
+
+## The state of a scene
+
+The scene entity is stateless, as in, it cannot have a state like the `on` or
+`off` state that, for example, a normal switch entity has.
+
+Every scene entity does keep track of the timestamp of when the last time
+the scene entity was called via the Home Assistant UI or called via
+a service call.
+
+## Scenes created by integrations
+
+Some integrations like [Philips Hue](/integrations/hue), [MQTT](/integrations/mqtt), and [KNX](/integrations/knx) provide scenes. You can activate them from the Home Assistant UI or via as service calls. In this case, the integration provides the preferred states to restore.
+
+## Creating a scene
+
You can create scenes that capture the states you want certain entities to be. For example, a scene can specify that light A should be turned on and light B should be bright red.
Scenes can be created and managed via the user interface using the [Scene Editor](/docs/scene/editor/). They can also be manually configured via `configuration.yaml`. Note that the entity data is not service call parameters, it's a representation of the wanted state:
diff --git a/source/_integrations/scrape.markdown b/source/_integrations/scrape.markdown
index 1fc50d91491..99d38e72257 100644
--- a/source/_integrations/scrape.markdown
+++ b/source/_integrations/scrape.markdown
@@ -163,7 +163,7 @@ In this section you find some real-life examples of how to use this sensor. Ther
### Home Assistant
-The current release Home Assistant is published on [https://www.home-assistant.io/](/)
+The current release Home Assistant is published on [homepage](/)
{% raw %}
@@ -259,3 +259,28 @@ scrape:
```
{% endraw %}
+
+### Container cleaning by CleanProfs in The Netherlands
+
+This example gets the container type and container cleaning date for the next two cleanings.
+
+```yaml
+# Example configuration.yaml entry. Change postal code and house number to your own address.
+scrape:
+ - resource: https://crm.cleanprofs.nl/search/planning
+ method: POST
+ payload: zipcode=5624JW&street_number=17
+ headers:
+ Content-Type: application/x-www-form-urlencoded
+ sensor:
+ - name: "Type container 1"
+ select: "div.nk-tb-item:nth-child(2) > div:nth-child(1) > span:nth-child(1)"
+ - name: "Date container 1"
+ select: "div.nk-tb-item:nth-child(2) > div:nth-child(3) > span:nth-child(1) > span:nth-child(1)"
+ - name: "Type container 2"
+ select: "div.nk-tb-item:nth-child(3) > div:nth-child(1) > span:nth-child(1)"
+ - name: "Date container 2"
+ select: "div.nk-tb-item:nth-child(3) > div:nth-child(3) > span:nth-child(1) > span:nth-child(1)"
+
+```
+
diff --git a/source/_integrations/screenlogic.markdown b/source/_integrations/screenlogic.markdown
index 809cbb10e26..47baf691aeb 100644
--- a/source/_integrations/screenlogic.markdown
+++ b/source/_integrations/screenlogic.markdown
@@ -34,7 +34,7 @@ The Pentair ScreenLogic integration allows you to integrate your Pentair Intelli
ScreenLogic options are set via **Settings** -> **Devices & Services** -> **Pentair ScreenLogic** -> **Options**.
-* Seconds between scans - How many seconds between each polling of the ScreenLogic gateway.
+-= Seconds between scans - How many seconds between each polling of the ScreenLogic gateway.
## Services
diff --git a/source/_integrations/select.markdown b/source/_integrations/select.markdown
index 566ee76dccf..05a9f43a8fc 100644
--- a/source/_integrations/select.markdown
+++ b/source/_integrations/select.markdown
@@ -94,7 +94,7 @@ The {% my developer_call_service service="select.select_option" %} service
changes the selected option to a specific desired option provided in the
service call using the required `option` service call data.
-The service call wil not succeed if the selected option is not available in
+The service call will not succeed if the selected option is not available in
the list of options for the targeted entity.
{% my developer_call_service badge service="select.select_option" %}
diff --git a/source/_integrations/sensor.rflink.markdown b/source/_integrations/sensor.rflink.markdown
index 453e6e1333b..fb4dbc91cfd 100644
--- a/source/_integrations/sensor.rflink.markdown
+++ b/source/_integrations/sensor.rflink.markdown
@@ -9,7 +9,7 @@ ha_release: 0.38
ha_domain: rflink
---
-The `rflink` integration supports devices that use [RFLink gateway firmware](https://www.rflink.nl/download.php), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/en/21-rflink-). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
+The `rflink` integration supports devices that use [RFLink gateway firmware](https://www.rflink.nl/download.php), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/21-rflink-). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
## Configuration
diff --git a/source/_integrations/sentry.markdown b/source/_integrations/sentry.markdown
index c066e1e0d0e..cf0f2d044f7 100644
--- a/source/_integrations/sentry.markdown
+++ b/source/_integrations/sentry.markdown
@@ -28,10 +28,10 @@ Before configuring the Sentry integration, you'll need to get Sentry account and
Follow these steps to get the DSN:
1. Go to **Projects**.
-1. Select **Create project**.
-1. Fill out the **Give your project a name** and **choose Assign a Team** fields and select the **Create project** button.
-1. Select the **Get your DSN** link in top of the page.
- * Your DSN is now visible and looks like
@@ -110,13 +110,13 @@ The integration will trigger an event when a device with the [button](https://de
}
```
-| Attribute | Description |
-| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `component_id` | Describes which integration of the device triggered the event. `main` represents the parent device. For devices with child-devices, this attribute identifies the child that raised the event. For multi-button devices, the current SmartThings API will no longer pass the ButtonNumber but use a child component_id for each button. The device handler installed on SmartThings must be able to create those child components. |
-| `device_id` | The unique id of the device in SmartThings. This can be located in the Home Assistant device registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). |
-| `location_id` | The unique id of the location the device is part of. This can be found in the configuration entry registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). |
-| `value` | Describes the action taken on the button. See the [button](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#button) capability reference for a list of possible values (not all are supported by every device). |
-| `name` | The name given to the device in SmartThings. |
+| Attribute | Description |
+| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `component_id` | Describes which integration of the device triggered the event. `main` represents the parent device. For devices with child-devices, this attribute identifies the child that raised the event. For multi-button devices, the current SmartThings API will no longer pass the ButtonNumber but use a child component_id for each button. The device handler installed on SmartThings must be able to create those child components. |
+| `device_id` | The unique id of the device in SmartThings. This can be located in the Home Assistant device registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). |
+| `location_id` | The unique id of the location the device is part of. This can be found in the configuration entry registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). |
+| `value` | Describes the action taken on the button. See the [button](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#button) capability reference for a list of possible values (not all are supported by every device). |
+| `name` | The name given to the device in SmartThings. |
Event data payloads are logged at the debug level, see [debugging](#debugging) for more information.
@@ -140,15 +140,15 @@ Support for additional platforms will be added in the future.
The SmartThings Binary Sensor platform lets you view devices that have binary sensor-related capabilities. A Binary Sensor entity will be created for each attribute (below) supported by the device.
-| Capability | Attribute | On-Value |
-| ----------------------------------------------------------------------------------------------------------------------- | -------------- | ---------- |
+| Capability | Attribute | On-Value |
+| ------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ---------- |
| [`accelerationSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#accelerationSensor) | `acceleration` | `active` |
| [`contactSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#contactSensor) | `contact` | `open` |
-| [`filterStatus`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#filterStatus) | `filterStatus` | `replace` |
+| [`filterStatus`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#filterStatus) | `filterStatus` | `replace` |
| [`motionSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#motionSensor) | `motion` | `active` |
| [`presenceSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#presenceSensor) | `presence` | `present` |
| [`tamperAlert`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#tamperAlert) | `tamper` | `detected` |
-| [`valve`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#valve) | `valve` | `open` |
+| [`valve`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#valve) | `valve` | `open` |
| [`waterSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#waterSensor) | `water` | `wet` |
### Climate
@@ -159,25 +159,25 @@ The SmartThings Climate platform lets you control devices that have air conditio
For a SmartThings Air Conditioner to be represented by the climate platform, it must have all of the following required capabilities:
-| Capability | Climate Features |
-| ------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [`airConditionerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) (required) | `hvac mode`, `hvac action` |
-| [`airConditionerFanMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerFanMode) (required) | `fan mode` |
-| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) (required) | `temperature` |
-| [`thermostatCoolingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) (required) | `target temp` |
-| [`demandResponseLoadControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#demandResponseLoadControl) | `drlc_status_duration` (state attribute), `drlc_status_level` (state attribute), `drlc_status_override` (state attribute), `drlc_status_start` (state attribute) |
+| Capability | Climate Features |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [`airConditionerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) (required) | `hvac mode`, `hvac action` |
+| [`airConditionerFanMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerFanMode) (required) | `fan mode` |
+| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) (required) | `temperature` |
+| [`thermostatCoolingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) (required) | `target temp` |
+| [`demandResponseLoadControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#demandResponseLoadControl) | `drlc_status_duration` (state attribute), `drlc_status_level` (state attribute), `drlc_status_override` (state attribute), `drlc_status_start` (state attribute) |
#### Thermostats
For a SmartThings thermostat to be represented by the climate platform, it must have all the capabilities from either "set a" _or_ "set b":
-| Capability | Climate Features |
-| ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
-| [`thermostat`](https://developer-preview.smartthings.com/docs/devices/capabilities/deprecated#thermostat) (set a) | `hvac mode`, `hvac action`, `target temp high`, `target temp low` and `fan mode` |
-| [`thermostatMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatMode) (set b) | `hvac mode` |
+| Capability | Climate Features |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| [`thermostat`](https://developer-preview.smartthings.com/docs/devices/capabilities/deprecated#thermostat) (set a) | `hvac mode`, `hvac action`, `target temp high`, `target temp low` and `fan mode` |
+| [`thermostatMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatMode) (set b) | `hvac mode` |
| [`thermostatCoolingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) (seb b) | `target temp low` |
| [`thermostatHeatingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatHeatingSetpoint) (set b) | `target temp high` |
-| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) (set b) |
+| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) (set b) |
| [`thermostatOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatOperatingState) | `hvac action` |
| [`thermostatFanMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatFanMode) | `fan mode` |
| [`relativeHumidityMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#relativeHumidityMeasurement) | `humidity` (state attribute) |
@@ -186,29 +186,29 @@ For a SmartThings thermostat to be represented by the climate platform, it must
The SmartThings Cover platform lets you control devices that have open/close related capabilities. For a device to be represented by the cover platform, it must have one of the capabilities from "set a" below.
-| Capability | Cover Features |
-| ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- |
-| [`doorControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#doorControl) (set a) | `open` and `close` |
+| Capability | Cover Features |
+| ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
+| [`doorControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#doorControl) (set a) | `open` and `close` |
| [`garageDoorControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/deprecated#garageDoorControl) (seb a) | `open` and `close` |
-| [`windowShade`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#windowShade) (set a) | `open` and `close` |
-| [`switchLevel`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#switchLevel) | `position` |
-| [`windowShadeLevel`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference/#windowShadeLevel) | `position` |
-| [`battery`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery_level` (state attribute) |
+| [`windowShade`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#windowShade) (set a) | `open` and `close` |
+| [`switchLevel`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#switchLevel) | `position` |
+| [`windowShadeLevel`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference/#windowShadeLevel) | `position` |
+| [`battery`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery_level` (state attribute) |
### Fan
The SmartThings Fan platform lets you control devices that have fan-related capabilities. For a SmartThings device to be represented by the fan platform, it must have one or more of the capabilities below in addition to the [`switch`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Switch) capability.
-| Capability | Fan Features |
-| --------------------------------------------------------------------------------------------------- | -------------------------------------------- |
+| Capability | Fan Features |
+| ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| [`fanSpeed`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#fanSpeed) | `speed` (`off`, `low`, `medium`, and `high`) |
### Light
The SmartThings Light platform lets you control devices that have light-related capabilities. For a SmartThings device to be represented by the light platform, it must have one or more of the capabilities below in addition to the [`switch`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Switch) capability.
-| Capability | Light Features |
-| ------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
+| Capability | Light Features |
+| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| [`switchLevel`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#switchLevel) | `brightness` and `transition` |
| [`colorControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#colorControl) | `color` |
| [`colorTemperature`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#colorTemperature) | `color_temp` |
@@ -221,62 +221,62 @@ The SmartThings Lock platform lets you control devices that have the [`lock`](ht
The SmartThings Sensor platform lets your view devices that have sensor-related capabilities. A Sensor entity is created for each attribute (below) supported by the device.
-| Capability | Attributes |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
-| [`activityLightingMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#activityLightingMode) | `lightingMode` |
-| [`airConditionerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) | `airConditionerMode` |
-| [`airQualitySensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#airQualitySensor) | `airQuality` |
-| [`alarm`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#alarm) | `alarm` |
-| [`audioVolume`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#audioVolume) | `volume` |
-| [`battery`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery` |
-| [`bodyMassIndexMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#bodyMassIndexMeasurement) | `bmiMeasurement` |
-| [`bodyWeightMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#bodyWeightMeasurement) | `bodyWeightMeasurement` |
-| [`carbonDioxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#carbonDioxideMeasurement) | `carbonDioxide` |
-| [`carbonMonoxideDetector`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#carbonMonoxideDetector) | `carbonMonoxide` |
-| [`carbonMonoxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#carbonMonoxideMeasurement) | `carbonMonoxideLevel` |
-| [`dishwasherOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dishwasherOperatingState) | `machineState`, `dishwasherJobState` and `completionTime` |
-| [`dryerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dryerMode) | `dryerMode` |
-| [`dryerOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dryerOperatingState) | `machineState`, `dryerJobState` and `completionTime` |
-| [`dustSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#dustSensor) | `fineDustLevel` and `dustLevel` |
-| [`energyMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#energyMeter) | `energy` |
-| [`equivalentCarbonDioxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#equivalentCarbonDioxideMeasurement) | `equivalentCarbonDioxideMeasurement` |
-| [`formaldehydeMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#formaldehydeMeasurement) | `formaldehydeLevel` |
-| [`gasMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#gasMeter) | `gasMeter`, `meterCalorific`, `meterTime`, and `meterVolume` |
-| [`illuminanceMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#illuminanceMeasurement) | `illuminance` |
-| [`infraredLevel`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#infraredLevel) | `infraredLevel` |
-| [`lock`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#lock) | `lock` |
-| [`mediaInputSource`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaInputSource) | `inputSource` |
-| [`mediaPlaybackRepeat`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlaybackRepeat) | `playbackRepeatMode` |
-| [`mediaPlaybackShuffle`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlaybackShuffle) | `playbackShuffle` |
-| [`mediaPlayback`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlayback) | `playbackStatus` |
-| [`odorSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#odorSensor) | `odorLevel` |
-| [`ovenMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenMode) | `ovenMode` |
-| [`ovenOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenOperatingState) | `machineState`, `ovenJobState` and `completionTime` |
-| [`ovenSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenSetpoint) | `ovenSetpoint` |
-| [`powerConsumptionReport`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#powerConsumptionReport) | `deltaEnergy`, `energy`, `energySaved`, `power`, `powerEnergy` |
-| [`powerMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#powerMeter) | `power` |
-| [`powerSource`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#powerSource) | `powerSource` |
-| [`refrigerationSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#refrigerationSetpoint) | `refrigerationSetpoint` |
-| [`relativeHumidityMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#relativeHumidityMeasurement) | `humidity` |
-| [`robotCleanerCleaningMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerCleaningMode) | `robotCleanerCleaningMode` |
-| [`robotCleanerMovement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerMovement) | `robotCleanerMovement` |
-| [`robotCleanerTurboMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerTurboMode) | `robotCleanerTurboMode` |
-| [`signalStrength`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#signalStrength) | `lqi` and `rssi` |
-| [`smokeDetector`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#smokeDetector) | `smoke` |
-| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) | `temperature` |
-| [`thermostatCoolingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) | `coolingSetpoint` |
-| [`thermostatFanMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatFanMode) | `thermostatFanMode` |
-| [`thermostatHeatingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatHeatingSetpoint) | `heatingSetpoint` |
-| [`thermostatMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatMode) | `thermostatMode` |
-| [`thermostatOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatOperatingState) | `thermostatOperatingState` |
-| [`thermostatSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/deprecated#thermostatSetpoint) | `thermostatSetpoint` |
-| [`threeAxis`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#threeAxis) | `threeAxis` (as discrete sensors `X`, `Y` and `Z`) |
-| [`tvChannel`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#tvChannel) | `tvChannel` and `tvChannelName` |
-| [`tvocMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#tvocMeasurement) | `tvocLevel` |
-| [`ultravioletIndex`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#ultravioletIndex) | `ultravioletIndex` |
-| [`voltageMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#voltageMeasurement) | `voltage` |
-| [`washerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#washerMode) | `washerMode` |
-| [`washerOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#washerOperatingState) | `machineState`, `washerJobState` and `completionTime` |
+| Capability | Attributes |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
+| [`activityLightingMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#activityLightingMode) | `lightingMode` |
+| [`airConditionerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) | `airConditionerMode` |
+| [`airQualitySensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#airQualitySensor) | `airQuality` |
+| [`alarm`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#alarm) | `alarm` |
+| [`audioVolume`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#audioVolume) | `volume` |
+| [`battery`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery` |
+| [`bodyMassIndexMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#bodyMassIndexMeasurement) | `bmiMeasurement` |
+| [`bodyWeightMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#bodyWeightMeasurement) | `bodyWeightMeasurement` |
+| [`carbonDioxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#carbonDioxideMeasurement) | `carbonDioxide` |
+| [`carbonMonoxideDetector`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#carbonMonoxideDetector) | `carbonMonoxide` |
+| [`carbonMonoxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#carbonMonoxideMeasurement) | `carbonMonoxideLevel` |
+| [`dishwasherOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dishwasherOperatingState) | `machineState`, `dishwasherJobState` and `completionTime` |
+| [`dryerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dryerMode) | `dryerMode` |
+| [`dryerOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dryerOperatingState) | `machineState`, `dryerJobState` and `completionTime` |
+| [`dustSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#dustSensor) | `fineDustLevel` and `dustLevel` |
+| [`energyMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#energyMeter) | `energy` |
+| [`equivalentCarbonDioxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#equivalentCarbonDioxideMeasurement) | `equivalentCarbonDioxideMeasurement` |
+| [`formaldehydeMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#formaldehydeMeasurement) | `formaldehydeLevel` |
+| [`gasMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#gasMeter) | `gasMeter`, `meterCalorific`, `meterTime`, and `meterVolume` |
+| [`illuminanceMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#illuminanceMeasurement) | `illuminance` |
+| [`infraredLevel`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#infraredLevel) | `infraredLevel` |
+| [`lock`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#lock) | `lock` |
+| [`mediaInputSource`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaInputSource) | `inputSource` |
+| [`mediaPlaybackRepeat`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlaybackRepeat) | `playbackRepeatMode` |
+| [`mediaPlaybackShuffle`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlaybackShuffle) | `playbackShuffle` |
+| [`mediaPlayback`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlayback) | `playbackStatus` |
+| [`odorSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#odorSensor) | `odorLevel` |
+| [`ovenMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenMode) | `ovenMode` |
+| [`ovenOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenOperatingState) | `machineState`, `ovenJobState` and `completionTime` |
+| [`ovenSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenSetpoint) | `ovenSetpoint` |
+| [`powerConsumptionReport`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#powerConsumptionReport) | `deltaEnergy`, `energy`, `energySaved`, `power`, `powerEnergy` |
+| [`powerMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#powerMeter) | `power` |
+| [`powerSource`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#powerSource) | `powerSource` |
+| [`refrigerationSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#refrigerationSetpoint) | `refrigerationSetpoint` |
+| [`relativeHumidityMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#relativeHumidityMeasurement) | `humidity` |
+| [`robotCleanerCleaningMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerCleaningMode) | `robotCleanerCleaningMode` |
+| [`robotCleanerMovement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerMovement) | `robotCleanerMovement` |
+| [`robotCleanerTurboMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerTurboMode) | `robotCleanerTurboMode` |
+| [`signalStrength`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#signalStrength) | `lqi` and `rssi` |
+| [`smokeDetector`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#smokeDetector) | `smoke` |
+| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) | `temperature` |
+| [`thermostatCoolingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) | `coolingSetpoint` |
+| [`thermostatFanMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatFanMode) | `thermostatFanMode` |
+| [`thermostatHeatingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatHeatingSetpoint) | `heatingSetpoint` |
+| [`thermostatMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatMode) | `thermostatMode` |
+| [`thermostatOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatOperatingState) | `thermostatOperatingState` |
+| [`thermostatSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/deprecated#thermostatSetpoint) | `thermostatSetpoint` |
+| [`threeAxis`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#threeAxis) | `threeAxis` (as discrete sensors `X`, `Y` and `Z`) |
+| [`tvChannel`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#tvChannel) | `tvChannel` and `tvChannelName` |
+| [`tvocMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#tvocMeasurement) | `tvocLevel` |
+| [`ultravioletIndex`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#ultravioletIndex) | `ultravioletIndex` |
+| [`voltageMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#voltageMeasurement) | `voltage` |
+| [`washerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#washerMode) | `washerMode` |
+| [`washerOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#washerOperatingState) | `machineState`, `washerJobState` and `completionTime` |
### Scene
@@ -286,8 +286,8 @@ The SmartThings Scene platform lets you activate scenes defined in SmartThings w
The SmartThings Switch platform lets you control devices that have the [`switch`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#switch) capability that are not already represented by a more specific platform. The following optional capabilities will provide energy and power utilization information:
-| Capability | Switch Features |
-| --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
+| Capability | Switch Features |
+| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| [`energyMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#energyMeter) | energy consumption (`today_energy_kwh` state attribute) |
| [`powerMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#powerMeter) | power consumption (`current_power_w` state attribute) |
@@ -331,8 +331,8 @@ This error message occurs when all of the SmartThings locations under the accoun
#### Webhook Troubleshooting Checklist
1. Ensure external URL is properly set to the _external address_ that Home Assistant is available to the internet. SmartThings must be able to reach this address.
-1. Validate there are no problems with your certificate or SSL configuration by using an online checker, such as [https://www.digicert.com/help/](https://www.digicert.com/help/).
-1. Some reverse proxy configuration settings can interfere with communication from SmartThings. For example, TLSv1.3 is not supported. Setting the supported cipher suite too restrictly will prevent handshaking. The following NGINX SSL configuration is known to work:
+2. Validate there are no problems with your certificate or SSL configuration by using an online checker, such as [https://www.digicert.com/help/](https://www.digicert.com/help/).
+3. Some reverse proxy configuration settings can interfere with communication from SmartThings. For example, TLSv1.3 is not supported. Setting the supported cipher suite too restrictly will prevent handshaking. The following NGINX SSL configuration is known to work:
```nginx
# cert.crt also contains intermediate certificates
ssl_certificate /path/to/cert.crt;
@@ -346,7 +346,7 @@ This error message occurs when all of the SmartThings locations under the accoun
ssl_session_cache shared:SSL:10m;
ssl_session_tickets off;
```
-1. While the error message (above) is being displayed, run the following command from outside your local network to confirm it is responding to the ping lifecycle event:
+4. While the error message (above) is being displayed, run the following command from outside your local network to confirm it is responding to the ping lifecycle event:
```bash
curl -X POST https://{EXTERNAL_URL}/api/webhook/{WEBHOOK_ID} -H "Content-Type: application/json; charset=utf-8" -d $'{"lifecycle": "PING", "executionId": "00000000-0000-0000-0000-000000000000", "locale": "en", "version": "1.0.0", "pingData": { "challenge": "00000000-0000-0000-0000-000000000000"}}'
```
diff --git a/source/_integrations/somfy.markdown b/source/_integrations/somfy.markdown
index 72f41d0fd9a..631dae8101d 100644
--- a/source/_integrations/somfy.markdown
+++ b/source/_integrations/somfy.markdown
@@ -2,7 +2,7 @@
title: Somfy
description: Connect and control your Somfy devices using the Overkiz integration
ha_category:
- - Alarm Control Panel
+ - Alarm
- Binary Sensor
- Button
- Climate
diff --git a/source/_integrations/spc.markdown b/source/_integrations/spc.markdown
index 8a27c774e9a..439ef80f94f 100644
--- a/source/_integrations/spc.markdown
+++ b/source/_integrations/spc.markdown
@@ -38,7 +38,7 @@ api_url:
required: true
type: string
ws_url:
- description: URL of the SPC Web Gateway websocket, e.g., `ws://
#### Downgrading UniFi Protect
@@ -102,12 +103,12 @@ but it is not required. The entities that are created will automatically adjust
use has.
1. Login to your _Local Portal_ on your UniFi OS device, and click on _Users_. **Note**: This **must** be done from
- the UniFi OS by accessing it directly by IP address (i.e. _Local Portal_), not via `unifi.ui.com` or within the
- UniFi Protect app.
-2. In the upper right corner, click on _Add User_.
-3. Fill out the fields for your user. Be sure the role you assign to the user grants them access to at least one or
- more UniFi Protect devices.
-4. Click _Add_ in the bottom right.
+ the UniFi OS by accessing it directly by IP address (i.e. _Local Portal_), not via `unifi.ui.com` or within the
+ UniFi Protect app.
+2. Go to **Admins** from the left hand side menu or [IP address]/admins/users e.g. 192.168.1.1/admins/users.
+3. Click on **Add New Admin**.
+4. Select **Full Management** for the role. Uncheck **Allow Remote Access** and fill out the fields for your user.
+5. Click **Add** in the bottom right.
@@ -118,10 +119,10 @@ you can stream your camera in Home Assistant. This may already be enabled by def
check that this is done. To check and enable the feature:
1. Open UniFi Protect and click on _Devices_.
-1. Select the camera you want to ensure can stream in UniFi Protect.
-1. Click the _Settings_ tab in the top right.
-1. Expand the _Advanced_ section at the bottom.
-1. Enable a minimum 1 stream out of the 3 available. The Stream with the Highest resolution is the default enabled one.
+2. Select the camera you want to ensure can stream in UniFi Protect.
+3. Click the _Settings_ tab in the top right.
+4. Expand the _Advanced_ section at the bottom.
+5. Enable a minimum 1 stream out of the 3 available. The Stream with the Highest resolution is the default enabled one.
{% include integrations/config_flow.md %}
@@ -144,8 +145,8 @@ and in many cases, get a read-only sensor instead of an editable switch/select/n
**Smart Detections**: The following cameras have Smart Detections:
-* All "AI" series cameras. This includes the [AI 360](https://store.ui.com/collections/unifi-protect/products/unifi-protect-ai-360) and the [AI Bullet](https://store.ui.com/collections/unifi-protect/products/uvc-ai-bullet).
-* All "G4" series cameras. This includes the [G4 Doorbell](https://store.ui.com/collections/unifi-protect/products/uvc-g4-doorbell), [G4 Bullet](https://store.ui.com/collections/unifi-protect/products/uvc-g4-bullet), [G4 Pro](https://store.ui.com/collections/unifi-protect/products/uvc-g4-pro) and [G4 Instant](https://store.ui.com/collections/unifi-protect/products/camera-g4-instant).
+- All "AI" series cameras. This includes the [AI 360](https://store.ui.com/collections/unifi-protect/products/unifi-protect-ai-360) and the [AI Bullet](https://store.ui.com/collections/unifi-protect/products/uvc-ai-bullet).
+- All "G4" series cameras. This includes the [G4 Doorbell](https://store.ui.com/collections/unifi-protect/products/uvc-g4-doorbell), [G4 Bullet](https://store.ui.com/collections/unifi-protect/products/uvc-g4-bullet), [G4 Pro](https://store.ui.com/collections/unifi-protect/products/uvc-g4-pro) and [G4 Instant](https://store.ui.com/collections/unifi-protect/products/camera-g4-instant).
G3 Series cameras do _not_ have Smart detections.
@@ -153,41 +154,41 @@ G3 Series cameras do _not_ have Smart detections.
Each UniFi Protect camera will get a device in Home Assistant with the following:
-* **Camera** - A camera for each camera channel and RTSP(S) combination found for each camera (up to 7). Only the highest resolution RTSPS camera entity will be enabled by default.
- * If your camera is a G4 Doorbell Pro, an additional camera entity will be added for the Package Camera. The Package Camera entity will _not_ have streaming capabilities regardless of whether RTSPS is enabled on the channel or not. This is due to the Package Camera having a very low FPS that does not make it compatible with HLS streaming.
-* **Media Player** - If your camera has a speaker, you will get a media player entity that allows you to play audio to your camera's speaker. Any audio file URI that is playable by FFmpeg will be able to be played to your speaker, including via the [TTS Say Service](/integrations/tts/#service-say).
-* **Privacy Mode** - If your camera allows for Privacy Masks, there will be a configuration switch to toggle a "Privacy Mode" that disables recording, microphone, and a black privacy zone over the whole camera.
-* **Sensors** - Sensors include "Is Dark", "Motion Detected", detected object sensors (if the camera supports smart detections), and "Doorbell Chime" (if the camera has a chime). Several diagnostics sensors are added including sensors on uptime, network connection stats, and storage stats. Doorbells will also have a "Voltage" sensor for troubleshooting electrical issues.
- * There is one detected object sensor per Smart Detection supported by the camera and a combined sensor for if _any_ object is detected.
-* **Device Configuration** - Cameras will get various configuration controls based on the features available to the camera. Currently provided configuration controls:
- * configuration sliders for Chime Type, Zoom Level, Microphone Sensitivity, and WDR Level
- * configuration switches Overlay Information, Smart Detections types, Status Light, HDR, High FPS mode, System Sounds
- * configuration text and select for LCD Screen for doorbells to either set custom messages or use predefined messages
-* **Button** - A disabled by default button is added for each camera device. The button will let you reboot your camera device.
+- **Camera** - A camera for each camera channel and RTSP(S) combination found for each camera (up to 7). Only the highest resolution RTSPS camera entity will be enabled by default.
+ - If your camera is a G4 Doorbell Pro, an additional camera entity will be added for the Package Camera. The Package Camera entity will _not_ have streaming capabilities regardless of whether RTSPS is enabled on the channel or not. This is due to the Package Camera having a very low FPS that does not make it compatible with HLS streaming.
+- **Media Player** - If your camera has a speaker, you will get a media player entity that allows you to play audio to your camera's speaker. Any audio file URI that is playable by FFmpeg will be able to be played to your speaker, including via the [TTS Say Service](/integrations/tts/#service-say).
+- **Privacy Mode** - If your camera allows for Privacy Masks, there will be a configuration switch to toggle a "Privacy Mode" that disables recording, microphone, and a black privacy zone over the whole camera.
+- **Sensors** - Sensors include "Is Dark", "Motion Detected", detected object sensors (if the camera supports smart detections), and "Doorbell Chime" (if the camera has a chime). Several diagnostics sensors are added including sensors on uptime, network connection stats, and storage stats. Doorbells will also have a "Voltage" sensor for troubleshooting electrical issues.
+ - There is one detected object sensor per Smart Detection supported by the camera and a combined sensor for if _any_ object is detected.
+- **Device Configuration** - Cameras will get various configuration controls based on the features available to the camera. Currently provided configuration controls:
+ - configuration sliders for Chime Type, Zoom Level, Microphone Sensitivity, and WDR Level
+ - configuration switches Overlay Information, Smart Detections types, Status Light, HDR, High FPS mode, System Sounds
+ - configuration text and select for LCD Screen for doorbells to either set custom messages or use predefined messages
+- **Button** - A disabled by default button is added for each camera device. The button will let you reboot your camera device.
### UniFi Protect Floodlights
Each UniFi Protect floodlight will get a device in Home Assistant with the following:
-* **Light** - A light entity will be added for each floodlight device. The light entity will let you control turning on or off your light as well as adjust the brightness of your floodlight.
-* **Sensors** - Sensors are provided for data provided from floodlight devices. Sensors include "Is Dark" and "Motion Detected".
-* **Device Configuration** - Floodlights will get configuration controls for the PIR Motion Sensitivity, the Auto-shutoff Duration after detected motion, and Status Light switch
-* **Button** - A disabled by default button is added for each floodlight device. The button will let you reboot your floodlight device.
+- **Light** - A light entity will be added for each floodlight device. The light entity will let you control turning on or off your light as well as adjust the brightness of your floodlight.
+- **Sensors** - Sensors are provided for data provided from floodlight devices. Sensors include "Is Dark" and "Motion Detected".
+- **Device Configuration** - Floodlights will get configuration controls for the PIR Motion Sensitivity, the Auto-shutoff Duration after detected motion, and Status Light switch
+- **Button** - A disabled by default button is added for each floodlight device. The button will let you reboot your floodlight device.
### UniFi Protect Smart Sensors
UniFi Protect smart sensors are a bit different than normal sensors. They are a multi-sensor that can act as a contact sensor (door/window), a motion detector, a light level detector, a humidity sensor, a temperature level sensor, an alarm sound sensor, and/or a leak detector. Each sensor function can be enabled or disabled dynamically. Disabled sensors will be marked as "unavailable".
-* **Sensors** - A sensor is provided for each major function of the smart sensor device:
- * **Contact** - A contact sensor will be available if the mount type is set as "Door", "Window" or "Garage".
- * **Motion Detection** - A motion detection sensor will be available if the mount type is not set to "Leak" and motion detection is enabled.
- * **Light Level** - A light level sensor will be available if the mount type is not set to "Leak" and the light sensor is enabled.
- * **Humidity** - A humidity sensor will be available if the mount type is not set to "Leak" and the humidity sensor is enabled.
- * **Temperature** - A temperature sensor will be available if the mount type is not set to "Leak" and the temperature sensor is enabled.
- * **Alarm Sound** - An alarm sensor will be available if the mount type is not set to "Leak" and the alarm sound sensor is enabled. The Alarm Sound sensor can have the values "none", "smoke" and "co". More values may be added over time automatically as UniFi Protect adds support for detecting more alarms.
- * **Tamper** - A binary sensor to detect tampering.
-* **Device Configuration** - Smart sensors will get configuration controls for the Status Light, enabling/disabling all of the main sensors, selecting the Paired Camera, and changing the Mount Type of the sensor.
-* **Button** - A button to clear the tampered state as well as a disabled by default button to restart the device.
+- **Sensors** - A sensor is provided for each major function of the smart sensor device:
+ - **Contact** - A contact sensor will be available if the mount type is set as "Door", "Window" or "Garage".
+ - **Motion Detection** - A motion detection sensor will be available if the mount type is not set to "Leak" and motion detection is enabled.
+ - **Light Level** - A light level sensor will be available if the mount type is not set to "Leak" and the light sensor is enabled.
+ - **Humidity** - A humidity sensor will be available if the mount type is not set to "Leak" and the humidity sensor is enabled.
+ - **Temperature** - A temperature sensor will be available if the mount type is not set to "Leak" and the temperature sensor is enabled.
+ - **Alarm Sound** - An alarm sensor will be available if the mount type is not set to "Leak" and the alarm sound sensor is enabled. The Alarm Sound sensor can have the values "none", "smoke" and "co". More values may be added over time automatically as UniFi Protect adds support for detecting more alarms.
+ - **Tamper** - A binary sensor to detect tampering.
+- **Device Configuration** - Smart sensors will get configuration controls for the Status Light, enabling/disabling all of the main sensors, selecting the Paired Camera, and changing the Mount Type of the sensor.
+- **Button** - A button to clear the tampered state as well as a disabled by default button to restart the device.
#### Tamper Sensor
@@ -197,30 +198,30 @@ Once the tamper sensor is triggered, it stays active until manually cleared. A b
Each UniFi Protect viewer will get a device in Home Assistant with the following:
-* **Liveview Select** - A select control will be added for each viewer device that will allow you to select which liveview is being displayed on the viewer.
-* **Button** - A disabled by default button is added for each viewer device. The button will let you reboot your viewer device.
+- **Liveview Select** - A select control will be added for each viewer device that will allow you to select which liveview is being displayed on the viewer.
+- **Button** - A disabled by default button is added for each viewer device. The button will let you reboot your viewer device.
### UniFi Protect DoorLock
Each UniFi Protect door lock will get a device in Home Assistant with the following:
-* **Lock** - A lock control will be added to lock and unlock your door lock device.
-* **Device Configuration** - Door locks will get configuration controls for the Auto-Lock Timeout, selecting the Paired Camera, and Status Light switch
-* **Button** - A disabled by default button is added for each door lock device. The button will let you reboot your door lock device.
+- **Lock** - A lock control will be added to lock and unlock your door lock device.
+- **Device Configuration** - Door locks will get configuration controls for the Auto-Lock Timeout, selecting the Paired Camera, and Status Light switch
+- **Button** - A disabled by default button is added for each door lock device. The button will let you reboot your door lock device.
### UniFi Protect Smart Chime
Each UniFi Protect smart chime will get a device in Home Assistant with the following:
-* **Button** - A button to trigger the chime manually for each smart chime device. Also, a disabled by default button is added to let you reboot your smart chime device.
-* **Device Configuration** - Smart chimes will get a volume slider to adjust the chime's loudness and a sensor for the last time the chime rang.
+- **Button** - A button to trigger the chime manually for each smart chime device. Also, a disabled by default button is added to let you reboot your smart chime device.
+- **Device Configuration** - Smart chimes will get a volume slider to adjust the chime's loudness and a sensor for the last time the chime rang.
### NVR
Your main UniFi Protect NVR device also gets a number of diagnostics sensors that can be used for tracking the state of your UniFi Protect system:
-* **Disk Health**: Each disk installed in your NVR will have a disk health sensor. These are simple good/bad sensors and the order is not promised to match the order in UniFi OS. Disk model number is provided as a state attribute though to help map sensor to disk.
-* **Utilization and Storage Sensors**: Several other sensors are also added for uptime, hardware utilization, and distribution details of the video on disk.
+- **Disk Health**: Each disk installed in your NVR will have a disk health sensor. These are simple good/bad sensors and the order is not promised to match the order in UniFi OS. Disk model number is provided as a state attribute though to help map sensor to disk.
+- **Utilization and Storage Sensors**: Several other sensors are also added for uptime, hardware utilization, and distribution details of the video on disk.
## Media Source
@@ -234,10 +235,10 @@ The media source is split into 5 folders/levels:
2. Camera Selector - either lets you select all cameras or a specific camera to view events for.
3. Event Selector - either lets you select all events or a specific event type to view events for.
4. Time Selector - filters events for a given time range:
- * Last 24 Hours
- * Last 7 Days
- * Last 30 Days
- * By Month since start of recording - selecting a month lets you either view the whole month or a specific date
+ - Last 24 Hours
+ - Last 7 Days
+ - Last 30 Days
+ - By Month since start of recording - selecting a month lets you either view the whole month or a specific date
5. Event Selector - lets you select the specific event for playback
Since the media browser does not have any pagination or filtering, all of the events must be loaded into memory. As a result, the number of events loaded at once is truncated to 10,000 by default. The number of events will be listed at "10000 (TRUNCATED)" if the event count was truncated. You can raise or lower the limit of the number of events that can be loaded using the Config Entry Options.
@@ -257,37 +258,37 @@ Below are the accepted identifiers to resolve media. Since events do not necessa
Sets the default doorbell message. This will be the message that is automatically selected when a message "expires".
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
-| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect instances. |
-| `message` | No | The default message for your Doorbell. Must be less than 30 characters. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
+| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect instances. |
+| `message` | No | The default message for your Doorbell. Must be less than 30 characters. |
### Service unifiprotect.add_doorbell_text
Adds a new custom message for Doorbells.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
-| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect instances. |
-| `message` | No | New custom message to add for Doorbells. Must be less than 30 characters. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
+| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect instances. |
+| `message` | No | New custom message to add for Doorbells. Must be less than 30 characters. |
### Service unifiprotect.remove_doorbell_text
Removes an existing message for Doorbells.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
-| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect instances. |
-| `message` | No | Existing custom message to remove for Doorbells. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
+| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect instances. |
+| `message` | No | Existing custom message to remove for Doorbells. |
### Service unifiprotect.set_chime_paired_doorbells
Use to set the paired doorbell(s) with a smart chime.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
-| `device_id` | No | The device ID of the Chime you want to pair or unpair doorbells to. |
-| `doorbells` | Yes | A target selector for any number of doorbells you want to pair to the chime. No value means unpair all. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------- |
+| `device_id` | No | The device ID of the Chime you want to pair or unpair doorbells to. |
+| `doorbells` | Yes | A target selector for any number of doorbells you want to pair to the chime. No value means unpair all. |
## Views
@@ -295,9 +296,9 @@ The integration provides two proxy views to proxy media content from your Home A
These URLs work great when trying to send notifications. Home Assistant will automatically sign the URLs and make them safe for external consumption if used in an automation or [notify service](/integrations/notify/).
-| View URL | Description |
-| ------------------------------------------------------------ | -------------------------------------------------- |
-| `/api/unifiprotect/thumbnail/{nvr_id}/{event_id}` | Proxies a JPEG event thumbnail from UniFi Protect. |
+| View URL | Description |
+| ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `/api/unifiprotect/thumbnail/{nvr_id}/{event_id}` | Proxies a JPEG event thumbnail from UniFi Protect. |
| `/api/unifiprotect/video/{nvr_id}/{camera_id}/{start}/{end}` | Proxies a MP4 video clip from UniFi Protect for a specific camera. Start and end must be in [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html). |
`nvr_id` can either be the UniFi Protect ID of your NVR or the config entry ID for your UniFi Protect integration. `camera_id` can either be the UniFi Protect ID of your camera or an entity ID of any entity provided by the UniFi Protect integration that can be reversed to a UniFi Protect camera (i.e., an entity ID of a detected object sensor).
@@ -306,7 +307,7 @@ These URLs work great when trying to send notifications. Home Assistant will aut
### Delay in Video Feed
-The default settings on the stream integration will give you a 5-15+ second delay. You can reduce this delay to 1-3 seconds, by enabling [LL-HLS in the stream integration](/integrations/stream/#ll-hls). You will also want to put an HTTP/2 reserve proxy in front of Home Assistant so you can have connection pooling. If you do not add a reverse proxy, you may start to get "Waiting for Websocket..." messages while trying to view too many camera streams at once. One way to do this is using the official NGINX Proxy Add-on:
+The default settings on the stream integration will give you a 5-15+ second delay. You can reduce this delay to 1-3 seconds, by enabling [LL-HLS in the stream integration](/integrations/stream/#ll-hls). You will also want to put an HTTP/2 reserve proxy in front of Home Assistant so you can have connection pooling. If you do not add a reverse proxy, you may start to get "Waiting for WebSocket..." messages while trying to view too many camera streams at once. One way to do this is using the official NGINX Proxy Add-on:
{% my supervisor_addon addon="core_nginx_proxy" badge %}
diff --git a/source/_integrations/vacuum.markdown b/source/_integrations/vacuum.markdown
index de3155326c8..7e65a41f08e 100644
--- a/source/_integrations/vacuum.markdown
+++ b/source/_integrations/vacuum.markdown
@@ -1,10 +1,11 @@
---
title: Vacuum
-description: Instructions on how to setup and use vacuum's in Home Assistant.
+description: Instructions on how to setup and use vacuums in Home Assistant.
ha_release: 0.51
ha_domain: vacuum
ha_quality_scale: internal
-ha_category: []
+ha_category:
+ - Vacuum
ha_codeowners:
- '@home-assistant/core'
ha_integration_type: entity
@@ -12,111 +13,75 @@ ha_integration_type: entity
The `vacuum` integration enables the ability to control home cleaning robots within Home Assistant.
-## Configuration
+## Services
-To use this integration in your installation, add a `vacuum` platform to your `configuration.yaml` file, like the [Xiaomi](/integrations/xiaomi_miio#xiaomi-mi-robot-vacuum).
-
-```yaml
-# Example configuration.yaml entry
-vacuum:
- - platform: xiaomi_miio
- name: Living room
- host: 192.168.1.2
-```
-
-### 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`.
+Available services: `start`, `pause`, `stop`, `return_to_base`, `locate`, `clean_spot`, `set_fan_speed` and `send_command`.
Before calling one of these services, make sure your vacuum platform supports it.
-#### Service `vacuum.turn_on`
-
-Start a new cleaning task. For the Xiaomi Vacuum, Roomba, and Neato use `vacuum.start` instead.
-
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
-
-#### Service `vacuum.turn_off`
-
-Stop the current cleaning task and return to the dock. For the Xiaomi Vacuum, Roomba, and Neato use `vacuum.stop` instead.
-
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
-
-#### Service `vacuum.start_pause`
-
-Start, pause or resume a cleaning task. For the Xiaomi Vacuum, Roomba, and Neato use `vacuum.start` and `vacuum.pause` instead.
-
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
-
-#### Service `vacuum.start`
+### Service `vacuum.start`
Start or resume a cleaning task.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------- |
+| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
-#### Service `vacuum.pause`
+### Service `vacuum.pause`
Pause a cleaning task.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------- |
+| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
-#### Service `vacuum.stop`
+### Service `vacuum.stop`
Stop the current activity of the vacuum.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------- |
+| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
-#### Service `vacuum.return_to_base`
+### Service `vacuum.return_to_base`
Tell the vacuum to return home.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------- |
+| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
-#### Service `vacuum.locate`
+### Service `vacuum.locate`
Locate the vacuum cleaner robot.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------- |
+| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
-#### Service `vacuum.clean_spot`
+### Service `vacuum.clean_spot`
Tell the vacuum cleaner to do a spot clean-up.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------- |
+| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
-#### Service `vacuum.set_fan_speed`
+### Service `vacuum.set_fan_speed`
Set the fan speed of the vacuum. The `fanspeed` can be a label, as `balanced` or `turbo`, or be a number; it depends on the `vacuum` platform.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
-| `fan_speed` | no | Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium', or by percentage, between 0 and 100. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
+| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
+| `fan_speed` | no | Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium', or by percentage, between 0 and 100. |
-#### Service `vacuum.send_command`
+### Service `vacuum.send_command`
Send a platform-specific command to the vacuum cleaner.
-| Service data attribute | Optional | Description |
-|---------------------------|----------|-------------------------------------------------------|
-| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
-| `command` | no | Command to execute. |
-| `params` | yes | Parameters for the command. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------- |
+| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
+| `command` | no | Command to execute. |
+| `params` | yes | Parameters for the command. |
diff --git a/source/_integrations/vacuum.mqtt.markdown b/source/_integrations/vacuum.mqtt.markdown
index 8df9daa95c7..69ad45ef75f 100644
--- a/source/_integrations/vacuum.mqtt.markdown
+++ b/source/_integrations/vacuum.mqtt.markdown
@@ -8,322 +8,11 @@ ha_domain: mqtt
---
The `mqtt` vacuum integration allows you to control your MQTT-enabled vacuum.
-There are two possible message schemas - `legacy` and `state`, chosen by setting the `schema` configuration parameter.
-New installations should use the `state` schema as `legacy` is deprecated and might be removed someday in the future.
-The `state` schema is preferred because the vacuum will then be represented as a `StateVacuumDevice` which is the preferred parent vacuum entity.
-The initial state of the state vacuum entity will set to `unknown` and can be reset by a device by sending a `null` payload as state. The legacy `mqtt` vacuum does not support handling an `unknown` state.
-
-This documentation has 3 sections. Configuration for `legacy` vacuum with examples, configuration for `state` vacuum with examples and shared section with examples which are the same for both schemas.
+The initial state of the MQTT vacuum entity will set to `unknown` and can be reset by a device by sending a `null` payload as state.
## Configuration
-
-
-To add your MQTT vacuum to your installation, add the following to your `configuration.yaml` file:
-
-```yaml
-# Example configuration.yaml entry
-mqtt:
- - vacuum:
- command_topic: "vacuum/command"
-```
-
-## Legacy Configuration
-
-Legacy MQTT vacuum configuration section.
-
-{% configuration %}
-availability:
- description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
- required: false
- type: list
- keys:
- payload_available:
- description: The payload that represents the available state.
- required: false
- type: string
- default: online
- payload_not_available:
- description: The payload that represents the unavailable state.
- required: false
- type: string
- default: offline
- topic:
- description: An MQTT topic subscribed to receive availability (online/offline) updates.
- required: true
- type: string
- value_template:
- description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
- required: false
- type: template
-availability_mode:
- description: When `availability` is configured, this controls the conditions needed to set the entity to `available`. Valid entries are `all`, `any`, and `latest`. If set to `all`, `payload_available` must be received on all configured availability topics before the entity is marked as online. If set to `any`, `payload_available` must be received on at least one configured availability topic before the entity is marked as online. If set to `latest`, the last `payload_available` or `payload_not_available` received on any configured availability topic controls the availability.
- required: false
- type: string
- default: latest
-availability_template:
- description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`."
- required: false
- type: template
-availability_topic:
- description: The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with `availability`.
- required: false
- type: string
-battery_level_template:
- description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to define the battery level of the vacuum. This is required if `battery_level_topic` is set.
- required: false
- type: template
-battery_level_topic:
- description: The MQTT topic subscribed to receive battery level values from the vacuum.
- required: false
- type: string
-charging_template:
- description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to define the charging state of the vacuum. This is required if `charging_topic` is set.
- required: false
- type: template
-charging_topic:
- description: The MQTT topic subscribed to receive charging state values from the vacuum.
- required: false
- type: string
-cleaning_template:
- description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to define the cleaning state of the vacuum. This is required if `cleaning_topic` is set.
- required: false
- type: template
-cleaning_topic:
- description: The MQTT topic subscribed to receive cleaning state values from the vacuum.
- required: false
- type: string
-command_topic:
- description: The MQTT topic to publish commands to control the vacuum.
- required: false
- type: string
-docked_template:
- description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to define the docked state of the vacuum. This is required if `docked_topic` is set.
- required: false
- type: template
-docked_topic:
- description: The MQTT topic subscribed to receive docked state values from the vacuum.
- required: false
- type: string
-enabled_by_default:
- description: Flag which defines if the entity should be enabled when first added.
- required: false
- type: boolean
- default: true
-encoding:
- description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of incoming payload.
- required: false
- type: string
- default: "utf-8"
-entity_category:
- description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
- required: false
- type: string
- default: None
-error_template:
- description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to define potential error messages emitted by the vacuum. This is required if `error_topic` is set.
- required: false
- type: template
-error_topic:
- description: The MQTT topic subscribed to receive error messages from the vacuum.
- required: false
- type: string
-fan_speed_list:
- description: List of possible fan speeds for the vacuum.
- required: false
- type: [string, list]
-fan_speed_template:
- description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to define the fan speed of the vacuum. This is required if `fan_speed_topic` is set.
- required: false
- type: template
-fan_speed_topic:
- description: The MQTT topic subscribed to receive fan speed values from the vacuum.
- required: false
- type: string
-icon:
- description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
- required: false
- type: icon
-json_attributes_template:
- description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation."
- required: false
- type: template
-json_attributes_topic:
- description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation.
- required: false
- type: string
-name:
- description: The name of the vacuum. Can be set to `null` if only the device name is relevant.
- required: false
- type: string
- default: MQTT Vacuum
-object_id:
- description: Used instead of `name` for automatic generation of `entity_id`
- required: false
- type: string
-payload_available:
- description: The payload that represents the available state.
- required: false
- type: string
- default: online
-payload_clean_spot:
- description: The payload to send to the `command_topic` to begin a spot cleaning cycle.
- required: false
- type: string
- default: clean_spot
-payload_locate:
- description: The payload to send to the `command_topic` to locate the vacuum (typically plays a song).
- required: false
- type: string
- default: locate
-payload_not_available:
- description: The payload that represents the unavailable state.
- required: false
- type: string
- default: offline
-payload_return_to_base:
- description: The payload to send to the `command_topic` to tell the vacuum to return to base.
- required: false
- type: string
- default: return_to_base
-payload_start_pause:
- description: The payload to send to the `command_topic` to start or pause the vacuum.
- required: false
- type: string
- default: start_pause
-payload_stop:
- description: The payload to send to the `command_topic` to stop the vacuum.
- required: false
- type: string
- default: stop
-payload_turn_off:
- description: The payload to send to the `command_topic` to turn the vacuum off.
- required: false
- type: string
- default: turn_off
-payload_turn_on:
- description: The payload to send to the `command_topic` to begin the cleaning cycle.
- required: false
- type: string
- default: turn_on
-qos:
- description: The maximum QoS level of the state topic.
- required: false
- type: integer
- default: 0
-retain:
- description: If the published message should have the retain flag on or not.
- required: false
- type: boolean
- default: false
-schema:
- description: The schema to use. Must be `legacy` or omitted to select the legacy schema.
- required: false
- type: string
- default: legacy
-send_command_topic:
- description: The MQTT topic to publish custom commands to the vacuum.
- required: false
- type: string
-set_fan_speed_topic:
- description: The MQTT topic to publish commands to control the vacuum's fan speed.
- required: false
- type: string
-supported_features:
- description: List of features that the vacuum supports (possible values are `turn_on`, `turn_off`, `pause`, `stop`, `return_home`, `battery`, `status`, `locate`, `clean_spot`, `fan_speed`, `send_command`).
- required: false
- type: [string, list]
- default: "`turn_on`, `turn_off`, `stop`, `return_home`, `status`, `battery`, `clean_spot`"
-unique_id:
- description: An ID that uniquely identifies this vacuum. If two vacuums have the same unique ID, Home Assistant will raise an exception.
- required: false
- type: string
-{% endconfiguration %}
-
-### Legacy configuration example
-
-{% raw %}
-
-```yaml
-# Example configuration.yaml entry
-mqtt:
- - vacuum:
- name: "MQTT Vacuum"
- supported_features:
- - turn_on
- - turn_off
- - pause
- - stop
- - return_home
- - battery
- - status
- - locate
- - clean_spot
- - fan_speed
- - send_command
- command_topic: "vacuum/command"
- battery_level_topic: "vacuum/state"
- battery_level_template: "{{ value_json.battery_level }}"
- charging_topic: "vacuum/state"
- charging_template: "{{ value_json.charging }}"
- cleaning_topic: "vacuum/state"
- cleaning_template: "{{ value_json.cleaning }}"
- docked_topic: "vacuum/state"
- docked_template: "{{ value_json.docked }}"
- error_topic: "vacuum/state"
- error_template: "{{ value_json.error }}"
- fan_speed_topic: "vacuum/state"
- fan_speed_template: "{{ value_json.fan_speed }}"
- set_fan_speed_topic: "vacuum/set_fan_speed"
- fan_speed_list:
- - min
- - medium
- - high
- - max
- send_command_topic: "vacuum/send_command"
-```
-
-{% endraw %}
-
-### Legacy MQTT Protocol
-
-The above configuration for this integration expects an MQTT protocol like the following.
-See also [Shared MQTT Protocol](#shared-mqtt-protocol).
-
-#### Legacy Basic Commands
-
-MQTT topic: `vacuum/command`
-
-Possible MQTT payloads:
-
-- `turn_on` - Begin cleaning
-- `turn_off` - Turn the Vacuum off
-- `return_to_base` - Return to base/dock
-- `stop` - Stop the Vacuum
-- `clean_spot` - Initialize a spot cleaning cycle
-- `locate` - Locate the vacuum (typically by playing a song)
-- `start_pause` - Toggle the vacuum between cleaning and stopping
-
-#### Status/Sensor Updates
-
-MQTT topic: `vacuum/state`
-
-MQTT payload:
-
-```json
-{
- "battery_level": 61,
- "docked": true,
- "cleaning": false,
- "charging": true,
- "fan_speed": "off",
- "error": "Error message"
-}
-```
-
-## State Configuration
-
-State MQTT vacuum configuration section.
+MQTT vacuum configuration section.
{% configuration %}
availability:
@@ -488,7 +177,7 @@ retain:
type: boolean
default: false
schema:
- description: The schema to use. Must be `state` to select the state schema.
+ description: The schema to use. Must be `state`.
required: false
type: string
default: legacy
@@ -515,7 +204,7 @@ unique_id:
type: string
{% endconfiguration %}
-### State configuration example
+## Configuration example
```yaml
# Example configuration.yaml entry
@@ -545,12 +234,11 @@ mqtt:
send_command_topic: "vacuum/send_command"
```
-### State MQTT Protocol
+## MQTT Protocol
-The above configuration for this integration expects an MQTT protocol like the following.
-See also [Shared MQTT Protocol](#shared-mqtt-protocol).
+The configuration for this integration expects an MQTT protocol like the following.
-#### State Basic Commands
+### Basic Commands
MQTT topic: `vacuum/command`
@@ -563,82 +251,6 @@ Possible MQTT payloads:
- `clean_spot` - Initialize a spot cleaning cycle
- `locate` - Locate the vacuum (typically by playing a song)
-#### Send Custom Command
-
-Vacuum send_command allows three parameters:
-
-- entity_id
-- command
-- params - optional
-
-If params are not provided it sends command as payload to MQTT send_command topic.
-If params are provided service sends JSON as payload with such structure:
-
-```json
-{
- 'command': 'command',
- 'param1-key': 'param1-value'
-}
-```
-
-Service trigger example:
-
-```yaml
-- alias: "Push command based on sensor"
- trigger:
- - platform: state
- entity_id: sensor.sensor
- action:
- service: vacuum.send_command
- target:
- entity_id: vacuum.vacuum_entity
- data:
- command: "custom_command"
- params:
- - key: value
-```
-
-MQTT topic: `vacuum/send_command`
-
-#### Status/Sensor Updates
-
-MQTT topic: `vacuum/state`
-
-MQTT payload:
-
-```json
-{
- "battery_level": 61,
- "state": "docked",
- "fan_speed": "off"
-}
-```
-
-State has to be one of vacuum states supported by Home Assistant:
-
-- cleaning,
-- docked,
-- paused,
-- idle,
-- returning,
-- error.
-
-## Shared MQTT Protocol
-
-The configuration for this integration expects an MQTT protocol like the following.
-These services are identical for both - legacy and state vacuum.
-
-### Set Fan Speed
-
-MQTT topic: `vacuum/set_fan_speed`
-
-Possible MQTT payloads:
-
-- `min` - Minimum fan speed
-- `medium` - Medium fan speed
-- `high` - High fan speed
-- `max` - Max fan speed
-
### Send Custom Command
Vacuum send_command allows three parameters:
@@ -676,6 +288,40 @@ Service trigger example:
MQTT topic: `vacuum/send_command`
+### Status/Sensor Updates
+
+MQTT topic: `vacuum/state`
+
+MQTT payload:
+
+```json
+{
+ "battery_level": 61,
+ "state": "docked",
+ "fan_speed": "off"
+}
+```
+
+State has to be one of vacuum states supported by Home Assistant:
+
+- cleaning,
+- docked,
+- paused,
+- idle,
+- returning,
+- error.
+
+### Set Fan Speed
+
+MQTT topic: `vacuum/set_fan_speed`
+
+Possible MQTT payloads:
+
+- `min` - Minimum fan speed
+- `medium` - Medium fan speed
+- `high` - High fan speed
+- `max` - Max fan speed
+
## Usage examples
### Usage with cloudless Xiaomi vacuums
diff --git a/source/_integrations/vacuum.template.markdown b/source/_integrations/vacuum.template.markdown
index 1f186efc3c9..5dd93a77d8b 100644
--- a/source/_integrations/vacuum.template.markdown
+++ b/source/_integrations/vacuum.template.markdown
@@ -1,7 +1,8 @@
---
title: "Template Vacuum"
description: "Instructions how to setup Template vacuums within Home Assistant."
-ha_category: Vacuum
+ha_category:
+ - Vacuum
ha_release: 0.96
ha_iot_class: Local Push
ha_quality_scale: internal
diff --git a/source/_integrations/vesync.markdown b/source/_integrations/vesync.markdown
index d4ece32357e..2fb4c2f9b83 100644
--- a/source/_integrations/vesync.markdown
+++ b/source/_integrations/vesync.markdown
@@ -92,7 +92,7 @@ itself. Note that prior versions of the integration exposed these as state attri
| `sensor.
-There is a bug in the firmware of Ultraloq devices that causes the door state sensor to not be updated and the latch to always be reported as "OPEN".
-
-Ultraloq smart locks allow users to enter their homes without a key. The lock can be controlled remotely using the Ultraloq app or by using Home Assistant. U-tec, their parent company, is a member of the Works with Home Assistant partner program. This means they are committed to making sure the Ultraloq Z-Wave products are up-to-date and ready to use with Home Assistant.
-
-Ultraloq Z-Wave Series smart locks work locally and integrate seamlessly with the Z-Wave integration in Home Assistant (Z-Wave stick required).
-
-To add Ultraloq Z-Wave products, pair them as Z-Wave devices:
-
-{% my add_zwave_device badge domain=page.ha_domain %}
-
-[Learn more about Z-Wave in Home Assistant.](/integrations/zwave_js/)
diff --git a/source/_integrations/unifiprotect.markdown b/source/_integrations/unifiprotect.markdown
index 12140a85f1c..97a326506a6 100644
--- a/source/_integrations/unifiprotect.markdown
+++ b/source/_integrations/unifiprotect.markdown
@@ -22,8 +22,8 @@ ha_iot_class: Local Push
ha_config_flow: true
ha_quality_scale: platinum
ha_codeowners:
- - '@AngellusMortis'
- - '@bdraco'
+ - "@AngellusMortis"
+ - "@bdraco"
ha_domain: unifiprotect
ha_platforms:
- binary_sensor
@@ -49,9 +49,9 @@ The UniFi Protect integration adds support for retrieving Camera feeds and Senso
This Integration supports all UniFi OS Consoles that can run UniFi Protect. Currently, this includes:
-* Any UniFi Protect Network Video Recorder (**[UNVR](https://store.ui.com/collections/unifi-protect-nvr/products/unvr)** or **[UNVRPRO](https://store.ui.com/collections/unifi-protect-nvr/products/unvr-pro)**)
-* Any UniFi "Dream" device (**[UDMPRO](https://store.ui.com/collections/unifi-network-unifi-os-consoles/products/udm-pro)**, **[UDR](https://store.ui.com/collections/unifi-network-unifi-os-consoles/products/dream-router)**, or **[UDMSE](https://store.ui.com/collections/unifi-network-unifi-os-consoles/products/dream-machine-se)**), _except the base UniFi Dream Machine/UDM_
-* UniFi Cloud Key Gen2 Plus (**[UCKP](https://store.ui.com/collections/unifi-protect-nvr/products/unifi-cloudkey-plus)**) firmware version v2.0.24+
+- Any UniFi Protect Network Video Recorder (**[UNVR](https://store.ui.com/collections/unifi-protect-nvr/products/unvr)** or **[UNVRPRO](https://store.ui.com/collections/unifi-protect-nvr/products/unvr-pro)**)
+- Any UniFi "Dream" device (**[UDMPRO](https://store.ui.com/collections/unifi-network-unifi-os-consoles/products/udm-pro)**, **[UDR](https://store.ui.com/collections/unifi-network-unifi-os-consoles/products/dream-router)**, or **[UDMSE](https://store.ui.com/collections/unifi-network-unifi-os-consoles/products/dream-machine-se)**), _except the base UniFi Dream Machine/UDM_
+- UniFi Cloud Key Gen2 Plus (**[UCKP](https://store.ui.com/collections/unifi-protect-nvr/products/unifi-cloudkey-plus)**) firmware version v2.0.24+
UCKP with Firmware v1.x **do NOT run UniFi OS**, you must upgrade to firmware `[v2.0.24](https://community.ui.com/releases/UniFi-Cloud-Key-Firmware-2-0-24/b6684f1e-8542-4660-bc0b-74e0634448e8)` or newer.
@@ -66,6 +66,7 @@ The absolute **minimal** software version is `[v1.20.0](https://community.ui.com
**Early Access releases are not supported by Home Assistant.**
Using Early Access versions will likely cause your UniFi Protect integration to break unexpectedly.
+
-We are fully aware that this is not what you expect from a Works With Home Assistant brand and we are in contact Ultraloq to get this resolved!
-
Currently `qr_code` supports QR Install Codes from:
@@ -343,42 +343,42 @@ from the same group:
This service removes an existing device from the network. You can find the IEEE address of the device on the device card of Zigbee devices. An example of an IEEE address data parameter format is `00:0d::6f:00:05:7d:2d:34`.
-| Data | Optional | Description |
-| ---- | ---- | ----------- |
-| `ieee` | no | IEEE address of the device to remove
+| Data | Optional | Description |
+| ------ | -------- | ------------------------------------ |
+| `ieee` | no | IEEE address of the device to remove |
### Service `zha.set_lock_user_code`
This service sets a lock code on a Zigbee lock.
-| Data | Optional | Description |
-| --------- | ---- | ----------- |
-| `code_slot` | no | Which lock code slot to store the code. Ex. 1-32 will work for Kwikset 954
-| `user_code` | no | Code to set on the lock. Ex. Kwikset accepts numbers 4-8 digits in length
+| Data | Optional | Description |
+| ----------- | -------- | -------------------------------------------------------------------------- |
+| `code_slot` | no | Which lock code slot to store the code. Ex. 1-32 will work for Kwikset 954 |
+| `user_code` | no | Code to set on the lock. Ex. Kwikset accepts numbers 4-8 digits in length |
### Service `zha.clear_lock_user_code`
This service clears a lock code from a Zigbee lock.
-| Data | Optional | Description |
-| --------- | ---- | ----------- |
-| `code_slot` | no | Which lock code slot to clear
+| Data | Optional | Description |
+| ----------- | -------- | ----------------------------- |
+| `code_slot` | no | Which lock code slot to clear |
### Service `zha.enable_lock_user_code`
This service enables a lock code on a Zigbee lock.
-| Data | Optional | Description |
-| --------- | ---- | ----------- |
-| `code_slot` | no | Which lock code slot to enable
+| Data | Optional | Description |
+| ----------- | -------- | ------------------------------ |
+| `code_slot` | no | Which lock code slot to enable |
### Service `zha.disable_lock_user_code`
This service disables a lock code on a Zigbee lock.
-| Data | Optional | Description |
-| --------- | ---- | ----------- |
-| `code_slot` | no | Which lock code slot to disable
+| Data | Optional | Description |
+| ----------- | -------- | ------------------------------- |
+| `code_slot` | no | Which lock code slot to disable |
## Adding devices
@@ -387,10 +387,10 @@ Tip! It is highly recommended that you read through the two segments under the t
**To add a new Zigbee device:**
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
-1. On the **Zigbee Home Automation** integration select the cogwheel, the select **Configure**.
-1. To start a scan for new devices, on the bottom right corner of the screen, select **Add device**.
-1. Reset your Zigbee devices to factory default settings according to the device instructions provided by the manufacturer (e.g., turn on/off lights up to 10 times; switches usually have a reset button/pin). It might take a few seconds for the devices to appear. You can click on **Show logs** for more verbose output.
-1. Once the device is found, it will appear on that page and will be automatically added to your devices. You can optionally change its name and add it to an area (you can change this later). You can search again to add another device, or you can go back to the list of added devices.
+2. Select the **Zigbee Home Automation** integration. Then, select **Configure**.
+3. To start a scan for new devices, on the bottom right corner of the screen, select **Add device**.
+4. Reset your Zigbee devices to factory default settings according to the device instructions provided by the manufacturer (e.g., turn on/off lights up to 10 times; switches usually have a reset button/pin). It might take a few seconds for the devices to appear. You can click on **Show logs** for more verbose output.
+5. Once the device is found, it will appear on that page and will be automatically added to your devices. You can optionally change its name and add it to an area (you can change this later). You can search again to add another device, or you can go back to the list of added devices.
### Using router devices to add more devices
@@ -431,6 +431,44 @@ After restoring a Home Assistant backup, you can re-configure ZHA and migrate to
Within ZHA is possible to use this backup and restore feature to migrate between some different radio types, if the respective radio library supports it. Currently, ZHA supports migrating the Zigbee network between different Zigbee Coordinator adapters based on chips from Silicon Labs, Texas Instruments, or ConBee/RaspBee if the backup was made from inside ZHA.
+## Migrating to a new Zigbee coordinator adapter inside ZHA
+
+Follow this guide if you have a Zigbee Home Assistant (ZHA) network running and want to migrate from one Zigbee coordinator radio adapter to another Zigbee coordinator radio adapter.
+
+### Prerequisites
+
+- Your old Zigbee Coordinator radio adapter is used in the ZHA integration (not in deCONZ or MQTT).
+- It is of radio type ezsp (Silicon Labs EmberZnet), znp (Texas Instruments Z-Stack ZNP), or deCONZ (ConBee/RaspBee from dresden elektronik).
+ - If your old Zigbee coordinator is a deCONZ (ConBee/RaspBee) radio adapter, make sure it is running [firmware 0x26700700 (from 2021-08-18)](https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/Firmware-Changelog) or later.
+
+### To migrate to a new Zigbee coordinator radio inside ZHA
+
+1. Go to **{% my integrations title="Settings > Devices & Services" %}** and select the ZHA integration. Then select **Configure**.
+2. Under **Network settings**, select **Migrate radio**.
+3. Reconfiguration of ZHA will start. Select **Submit**.
+4. Under **Migrate or re-configure**, select **Migrate to a new radio**.
+5. **Migrate to a new radio** will inform you that an automatic backup will be performed and that your old Zigbee coordinator radio will then be reset before the backup is automatically restored.
+ - Select **Submit**.
+6. **Unplug your old radio** will inform you that your old Zigbee coordinator radio has been reset and that you can now plug in your new Zigbee coordinator radio adapter.
+ - To avoid interference, use a USB extension cable.
+ - Use a USB 2.0 port or a powered USB 2.0 hub and keep the Zigbee stick away from USB 3.0 devices.
+ - You may now also choose to either unplug your old Zigbee coordinator radio adapter or keep your old radio plugged in.
+ - If that radio was a combined Z-Wave and Zigbee radio, like the HUSBZB-1 adapter, then only the Zigbee radio part of it was reset. Confirm that the Zigbee Coordinator radio adapter is properly connected and select **Submit**.
+7. You now need to start the backup restore process.
+ - Select your new Zigbee radio from the list of serial ports and select **Next**.
+ - If your new radio does not appear or you need to reboot after plugging in new hardware, you can resume the migration after a reboot: under **Network Settings**, select **Re-configure the current radio** and choose your new radio.
+8. Under **Network Formation**, select **Restore an automatic backup**.
+9. Under **Restore Automation Backup**, choose the latest automatic backup and select **Submit**.
+10. If your radio requires overwriting the IEEE address, you will see a screen titled **Overwrite Radio IEEE Address**. Check the **Permanently replace the radio IEEE address** box and click **Submit**. Overwriting the IEEE address may take a while.
+ - Your old Zigbee Coordinator radio and your new stick will now have the same Zigbee IEEE address (unique MAC address for the Zigbee device).
+ - Selecting this option is required for the migration process to complete successfully.
+ - From this point onwards, you should not operate the old stick in the same area unless you change the Zigbee IEEE address on it.
+ - If you do not migrate the Zigbee IEEE address from your old Zigbee Coordinator radio, then you will have to re-join/re-pair many of your devices in order to keep them working.
+11. Finally, a **Success!** message should pop up with information that all options were successfully saved.
+ - Select **Finish** to confirm.
+
+The migration process is complete. However, be aware that you will not be able to control your existing Zigbee devices until the new coordinator fully joins the network. This process can take a few minutes. If some existing devices do not function after some time, try power-cycling them to allow them to re-join the network.
+
## Troubleshooting
To help resolve any kinks or compatibility problems, report bugs as issues with debug logs. Please note the current limitations and follow the instructions in this troubleshooting section.
@@ -471,8 +509,8 @@ People familiar with other Zigbee gateway solutions for home automation may know
If you do not want to develop such a "quirk" Python script yourself, you can submit a "device support request" as a new issue to the [ZHA Device Handlers project repository on GitHub](https://github.com/zigpy/zha-device-handlers/issues):
1. Sign in to GitHub.
2. Select **New issue** and follow the instructions.
- * New device support requests require the device signature + diagnostic information.
- * You may also need to actively help in further testing or provide additional information to the volunteering developers.
+ - New device support requests require the device signature + diagnostic information.
+ - You may also need to actively help in further testing or provide additional information to the volunteering developers.
Note that submitting a new "device support request" does not guarantee that someone else will develop a custom "quirk" for ZHA. The project relies on volunteering developers. However, without "device support requests", the developers may not be aware that your specific Zigbee device is not working correctly in ZHA.
@@ -505,7 +543,7 @@ For example, interference from USB 3.x ports, unshielded USB 3.x devices, and no
Zigbee also uses [mesh networking topology](https://en.wikipedia.org/wiki/Mesh_networking), which means that most mains-powered devices are a "Zigbee Router" that can act as a signal repeater and range extended by transmitting data over long distances by passing data messages through the Zigbee network mesh of intermediate devices to reach more distant Zigbee devices. Thus to have a healthy Zigbee network, you need many Zigbee Router devices relatively close to each other in order to achieve good coverage and range.
-##### Actions to optimize Zigbee Coordinator radio hardware
+#### Actions to optimize Zigbee Coordinator radio hardware
Common root causes of unreliable performance are often seen with outdated Zigbee Coordinator radio adapter hardware, limited by obsolete chips, bad antenna designs, or old/buggy firmware. You can improve most Zigbee setups by using a good Zigbee Coordinator radio adapter and maintaining it.
@@ -522,7 +560,7 @@ Common root causes of unreliable performance are often seen with outdated Zigbee
While using an older Zigbee Coordinator radio adapter hardware might work, using obsolete hardware and/or old firmware can prevent reliable operation. It is also generally a good idea to upgrade Zigbee Coordinator firmware before troubleshooting any further if and when run into problems with devices.
-##### Actions to avoid or workaround EMI/EMF/RMI interference
+#### Actions to avoid or workaround EMI/EMF/RMI interference
Since all Zigbee Coordinator radio adapters are very sensitive/susceptible to all types of EMI/EMF/RMI you should always try to optimize the placement of the Zigbee Coordinator and avoid known sources of interference.
@@ -550,7 +588,7 @@ When reporting issues, please provide the following information in addition to i
1. Debug logs for the issue, see [debug logging](#debug-logging)
2. Model of Zigbee radio being used
3. If the issue is related to a specific Zigbee device, provide both the **Zigbee Device Signature** and the **Diagnostics** information.
- * Both the **Zigbee Device Signature** and the **Diagnostics** information can be found under {% my integrations title="**Settings** > **Devices & Services**" %}. On the **Zigbee Home Automation** integration, select the cogwheel. Then, select **Configure** > **Devices** (pick your device). Select **Zigbee Device Signature** and **Download Diagnostics**, respectively.
+ - Both the **Zigbee Device Signature** and the **Diagnostics** information can be found under {% my integrations title="**Settings** > **Devices & Services**" %}. Select the **Zigbee Home Automation** integration. Then, select **Configure** > **Devices** (pick your device). Select **Zigbee Device Signature** and **Download Diagnostics**, respectively.
### Debug logging
diff --git a/source/_integrations/zwave_js.markdown b/source/_integrations/zwave_js.markdown
index d2321a86d30..450d0039d95 100644
--- a/source/_integrations/zwave_js.markdown
+++ b/source/_integrations/zwave_js.markdown
@@ -51,46 +51,46 @@ The Z-Wave integration allows you to control a Z-Wave network via the [Z-Wave JS
To run a Z-Wave network, you need the following elements:
-* A [supported Z-Wave controller](/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-modules). First-time user? For recommendations on what to buy, go [here](#which-z-wave-controller-should-i-buy).
-* A running Z-Wave JS server.
-* An installed Z-Wave integration in Home Assistant.
+- A [supported Z-Wave controller](/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-modules). First-time user? For recommendations on what to buy, go [here](#which-z-wave-controller-should-i-buy).
+- A running Z-Wave JS server.
+- An installed Z-Wave integration in Home Assistant.
### Setting up a Z-Wave JS server
-The easiest way to get started is by using the built-in Z-Wave JS add-on in Home Assistant.
+If you are running Home Assistant Operating System or Home Assistant Supervised, the easiest way to get started is by using the built-in Z-Wave JS add-on in Home Assistant.
For other ways to setup a Z-Wave server, refer to the [advanced installation instructions](#advanced-installation-instructions).
Follow these steps:
1. Open the Home Assistant user interface.
-1. Plug the Z-Wave dongle into the device running Home Assistant.
- * Most likely, your dongle will be recognized automatically. On the user interface, you will be asked if you want to set up this device with the Z-Wave JS add-on. Select **Submit**.
- * If your dongle is not recognized, follow these steps:
+2. Plug the Z-Wave dongle into the device running Home Assistant.
+ - Most likely, your dongle will be recognized automatically. On the user interface, you will be asked if you want to set up this device with the Z-Wave JS add-on. Select **Submit**.
+ - If your dongle is not recognized, follow these steps:
{% details "Manual setup steps" %}
Use this My button:
{% my config_flow_start badge domain="zwave_js" %}, or follow these steps:
-* Browse to your Home Assistant instance.
-* Go to **{% my integrations title="Settings > Devices & Services" %}**.
-* In the bottom right, select the
+- Browse to your Home Assistant instance.
+- Go to **{% my integrations title="Settings > Devices & Services" %}**.
+- In the bottom right, select the
**{% my config_flow_start icon domain="zwave_js" %}** button.
-* From the list, select **Z-Wave**.
-* Follow the instructions on screen to complete the setup.
+- From the list, select **Z-Wave**.
+- Follow the instructions on screen to complete the setup.
{% enddetails %}
3. Wait for the installation to complete.
-1. You are prompted for network security keys.
- * If you are using Z-Wave for the first time, leave all the fields empty and select **Submit**. The system will generate network security keys for you.
- * If this Z-Wave dongle has already been paired with secure devices, you need to enter the previously used network key as the S0 network key. S2 security keys will be automatically generated for you.
- * Make sure that you keep a backup of these keys in a safe place in case you need to move your Z-Wave dongle to another device. Copy and paste them somewhere safe.
-1. Wait for the Z-Wave JS add-on to start up.
-1. Once the installation is complete, the **Device info** of the Z-Wave controller is shown.
- * You successfully installed the Z-Wave integration and the Z-Wave JS add-on.
- * You can now [add](/integrations/zwave_js/#adding-a-new-device-to-the-z-wave-network) devices to the Z-Wave network.
+4. You are prompted for network security keys.
+ - If you are using Z-Wave for the first time, leave all the fields empty and select **Submit**. The system will generate network security keys for you.
+ - If this Z-Wave dongle has already been paired with secure devices, you need to enter the previously used network key as the S0 network key. S2 security keys will be automatically generated for you.
+ - Make sure that you keep a backup of these keys in a safe place in case you need to move your Z-Wave dongle to another device. Copy and paste them somewhere safe.
+5. Wait for the Z-Wave JS add-on to start up.
+6. Once the installation is complete, the **Device info** of the Z-Wave controller is shown.
+ - You successfully installed the Z-Wave integration and the Z-Wave JS add-on.
+ - You can now [add](/integrations/zwave_js/#adding-a-new-device-to-the-z-wave-network) devices to the Z-Wave network.
\ No newline at end of file
+
Polling should only be used as a last resort. You must use it with care and accept the negative impact on your network. Z-Wave is a very low speed network and poll requests can easily flood your network and slow down your commands.
@@ -861,8 +861,8 @@ If the interview is complete, then the device does not yet have a device file fo
When trying to determine why something isn't working as you expect, or when reporting an issue with the integration, it is helpful to know what Z-Wave JS sees as the current state of your Z-Wave network. To get a dump of your current network state, follow these steps:
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
-1. On the **Z-Wave** integration, select the cogwheel, then select the three dots.
-1. From he dropdown menu, select **Download diagnostics**.
+2. Select the **Z-Wave** integration. Then, select the three dots.
+3. From he dropdown menu, select **Download diagnostics**.
### Interference issues
@@ -873,19 +873,19 @@ Many users have reported issues with interference when the USB stick was directl
Z-Wave JS writes details to its logs. To access these logs, follow these steps:
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
-1. On the **Z-Wave** integration, select the cogwheel, then select **Configure**.
-1. Open the **Logs** tab.
-1. Make sure to keep this browser tab open. Otherwise the logging is not active.
+2. Select the **Z-Wave** integration. Then, select **Configure**.
+3. Open the **Logs** tab.
+4. Make sure to keep this browser tab open. Otherwise the logging is not active.
## Z-Wave terminology
For some of the concepts, you may come across different terminology in Z-Wave than in Home Assistant.
The table below provides equivalents for some of those terms.
-| Z-Wave functionality | Home Assistant |
-| -------------------------------------- | ------------------------------------------------------------------------|
-| inclusion | add |
-| exclusion | remove |
-| barrier operator | cover |
-| window covering | cover |
-| multilevel switch | represented by different entity types: cover, fan, dimmer, etc. |
+| Z-Wave functionality | Home Assistant |
+| -------------------- | --------------------------------------------------------------- |
+| inclusion | add |
+| exclusion | remove |
+| barrier operator | cover |
+| window covering | cover |
+| multilevel switch | represented by different entity types: cover, fan, dimmer, etc. |
diff --git a/source/_posts/2015-01-24-release-notes.markdown b/source/_posts/2015-01-24-release-notes.markdown
index 4ca68b27162..0c3d4392439 100644
--- a/source/_posts/2015-01-24-release-notes.markdown
+++ b/source/_posts/2015-01-24-release-notes.markdown
@@ -21,11 +21,11 @@ Thanks to the work done by John McLaughlin and Geoff Norton we now support the l
**The getting started guide and component page have been reorganized**
-
The getting started instructions have been split into separate pages per component and a general overview page. The goal is to have a page per component that describes:
- * What it does
- * How to set it up
- * Which states it maintains
- * Which services it provides
- * Additional development tips
+- What it does
+- How to set it up
+- Which states it maintains
+- Which services it provides
+- Additional development tips
**More reasonable errors**
Home Assistant should now throw better errors and offer solutions if you do not have the right version of Python 3, forgot to clone the git submodules or install the dependencies.
diff --git a/source/_posts/2015-02-07-looking-at-the-past.markdown b/source/_posts/2015-02-07-looking-at-the-past.markdown
index 245aab06075..109ac5eed65 100644
--- a/source/_posts/2015-02-07-looking-at-the-past.markdown
+++ b/source/_posts/2015-02-07-looking-at-the-past.markdown
@@ -12,8 +12,8 @@ categories:
Ever since the launch of Home Assistant you have been able to track the state of your house. But the view has always been limited to what the current state is. Not what it was. Today we are going to change that by introducing two brand new components:
-* Recorder component that will record every event to a SQLite database
-* History component that will query and aggregate the recorded events
+- Recorder component that will record every event to a SQLite database
+- History component that will query and aggregate the recorded events
By adding this view into the past, we are adding an extra dimension into the state of your house. This brings great new possibilities for future features. The focus of today's release is on getting the recording component to you to start recording and getting some data. To show what is being recorded a view has been added that shows the last 24 hours of your house. Expect more extensive tools to explore your history in the future.
diff --git a/source/_posts/2015-05-09-utc-time-zone-awareness.markdown b/source/_posts/2015-05-09-utc-time-zone-awareness.markdown
index 442b7855770..23218f9d08c 100644
--- a/source/_posts/2015-05-09-utc-time-zone-awareness.markdown
+++ b/source/_posts/2015-05-09-utc-time-zone-awareness.markdown
@@ -33,6 +33,6 @@ This refactor adds a new migration for the database adding a `utc_offset` column
All built-in components have been upgraded. The following list is only for people that run custom components:
- * `hass.track_time_change` and `hass.track_point_in_time` will now return a time zone aware datetime object. Python does not allow comparing a naive with an aware datetime object.
- * the sun attributes for rising and setting are now in UTC. The methods `sun.next_rising(hass)` and `sun.next_setting(hass)` are backwards compatible, just be careful if you used to read the raw attributes.
- * the API sends all times in UTC. If you use anything else besides the frontend to talk to HA, make sure it handles it differently.
+- `hass.track_time_change` and `hass.track_point_in_time` will now return a time zone aware datetime object. Python does not allow comparing a naive with an aware datetime object.
+- the sun attributes for rising and setting are now in UTC. The methods `sun.next_rising(hass)` and `sun.next_setting(hass)` are backwards compatible, just be careful if you used to read the raw attributes.
+- the API sends all times in UTC. If you use anything else besides the frontend to talk to HA, make sure it handles it differently.
diff --git a/source/_posts/2015-06-10-release-notes.markdown b/source/_posts/2015-06-10-release-notes.markdown
index d5aed27afa5..9ceaf1507b3 100644
--- a/source/_posts/2015-06-10-release-notes.markdown
+++ b/source/_posts/2015-06-10-release-notes.markdown
@@ -28,17 +28,17 @@ To update to the latest version, run scripts/update. Please report
Before jumping into the newly supported platforms, here are the other improvements that are landing this release:
- * Fronted upgraded to Polymer 1.0 by @balloob
- * Include other YAML files using the `!include` keyword by @andythigpen
- * Switch support and bug fixes for Vera platform by @jamespcole
- * HTTP session support for the HTTP component by @jamespcole
- * Device tracker bugfixes by @Dutchy-
- * Bugfix for device tracker platform by @fbradyirl
- * Fixing Chromecast support by @wind-rider
- * Media player improvements by @balloob and @wind-rider
- * Nest thermostat bugfixes by @balloob
- * Fix the device tracker getting in a deadlock by @balloob
- * Update documentation by @fabaff
+- Fronted upgraded to Polymer 1.0 by @balloob
+- Include other YAML files using the `!include` keyword by @andythigpen
+- Switch support and bug fixes for Vera platform by @jamespcole
+- HTTP session support for the HTTP component by @jamespcole
+- Device tracker bugfixes by @Dutchy-
+- Bugfix for device tracker platform by @fbradyirl
+- Fixing Chromecast support by @wind-rider
+- Media player improvements by @balloob and @wind-rider
+- Nest thermostat bugfixes by @balloob
+- Fix the device tracker getting in a deadlock by @balloob
+- Update documentation by @fabaff
__Music Player Daemon__
Fabaff has contributed MusicPlayerDaemon support. The mpd platform allows you to control a [Music Player Daemon](http://www.musicpd.org/) from Home Assistant. Right now, only playback is supported and not playlist manipulation.
diff --git a/source/_posts/2015-11-16-zwave-switches-lights-and-honeywell-thermostats-now-supported.markdown b/source/_posts/2015-11-16-zwave-switches-lights-and-honeywell-thermostats-now-supported.markdown
index a7cb68e5745..31b87fe756a 100644
--- a/source/_posts/2015-11-16-zwave-switches-lights-and-honeywell-thermostats-now-supported.markdown
+++ b/source/_posts/2015-11-16-zwave-switches-lights-and-honeywell-thermostats-now-supported.markdown
@@ -28,20 +28,20 @@ homeassistant:
- * Thermostat: [Honeywell](/integrations/honeywell/) now supported ([@sander76])
- * Switch: [Orvibo](/integrations/orvibo) now supported ([@happyleavesaoc])
- * Camera: [mjpeg camera's](/integrations/mjpeg) now supported ([@ryanturner])
- * Notify: Pushetta now supported ([@fabaff])
- * Light: [MQTT](/integrations/light.mqtt/) now supported ([@hexxter])
- * Light: [Z-Wave](/integrations/zwave/) now supported ([@leoc])
- * Switch: [Z-Wave](/integrations/zwave/) now supported ([@leoc])
- * New component [logger](/integrations/logger/) allows filtering logged data ([@badele])
- * New component [updater](/integrations/updater/) will notify users if an update for Home Assistant is available ([@rmkraus])
- * Notify: [PushBullet](/integrations/pushbullet) now allows targeting contacts/channels/specific devices ([@tomduijf])
- * Light: Allow controlling color temperature ([@tomduijf])
- * Frontend: about page added ([@balloob])
- * Switch RGB as the color unit used in light component ([@balloob])
- * Re-install platform and component dependencies after a Home Assistant version upgrade ([@balloob])
+- Thermostat: [Honeywell](/integrations/honeywell/) now supported ([@sander76])
+- Switch: [Orvibo](/integrations/orvibo) now supported ([@happyleavesaoc])
+- Camera: [mjpeg camera's](/integrations/mjpeg) now supported ([@ryanturner])
+- Notify: Pushetta now supported ([@fabaff])
+- Light: [MQTT](/integrations/light.mqtt/) now supported ([@hexxter])
+- Light: [Z-Wave](/integrations/zwave/) now supported ([@leoc])
+- Switch: [Z-Wave](/integrations/zwave/) now supported ([@leoc])
+- New component [logger](/integrations/logger/) allows filtering logged data ([@badele])
+- New component [updater](/integrations/updater/) will notify users if an update for Home Assistant is available ([@rmkraus])
+- Notify: [PushBullet](/integrations/pushbullet) now allows targeting contacts/channels/specific devices ([@tomduijf])
+- Light: Allow controlling color temperature ([@tomduijf])
+- Frontend: about page added ([@balloob])
+- Switch RGB as the color unit used in light component ([@balloob])
+- Re-install platform and component dependencies after a Home Assistant version upgrade ([@balloob])
[Material Design Icons]: https://pictogrammers.com/library/mdi/
[@sander76]: https://github.com/sander76
diff --git a/source/_posts/2016-08-27-notifications-hue-fake-unification.markdown b/source/_posts/2016-08-27-notifications-hue-fake-unification.markdown
index a3b525aebd3..05d7dd5cc0a 100644
--- a/source/_posts/2016-08-27-notifications-hue-fake-unification.markdown
+++ b/source/_posts/2016-08-27-notifications-hue-fake-unification.markdown
@@ -32,15 +32,15 @@ For my next trick, let's hand out some...
I felt that I had to 1-up Paulus ([@balloob]) somehow with his 500,000 pageviews stat he shared in the [0.26 blog post](/blog/2016/08/13/foursquare-fast-com-ffmpeg-gpsd/), so I pushed myself and our development community as a whole super hard the last two weeks to put a lot of love into Home Assistant to bring you not just one, but six **#Amazing** stats for this release. As of 0.27, we have now surpassed the following milestones:
-* [10,000](https://travis-ci.org/home-assistant/home-assistant/builds/154660811) builds on Travis (congrats to [@BluGeni])
-* [3,000](https://github.com/home-assistant/home-assistant/pull/3000) issues and pull requests (thanks [@kellerza]!)
-* [2,000](https://github.com/home-assistant/home-assistant/pull/2991) pull requests alone (awesome [@fabaff]!!)
-* 900 forks on Github!
+- [10,000](https://travis-ci.org/home-assistant/home-assistant/builds/154660811) builds on Travis (congrats to [@BluGeni])
+- [3,000](https://github.com/home-assistant/home-assistant/pull/3000) issues and pull requests (thanks [@kellerza]!)
+- [2,000](https://github.com/home-assistant/home-assistant/pull/2991) pull requests alone (awesome [@fabaff]!!)
+- 900 forks on Github!
In addition,
-* We are very close to 4,000 stars on Github!
-* [I'm now #5 contributor by most commits!!!](https://github.com/home-assistant/home-assistant/graphs/contributors) Hey wait, how'd this get in here 😳...
+- We are very close to 4,000 stars on Github!
+- [I'm now #5 contributor by most commits!!!](https://github.com/home-assistant/home-assistant/graphs/contributors) Hey wait, how'd this get in here 😳...
Now that we have that great news out of the way, onto this week's release which is going to keep the **#Amazing** gravy train rolling right along and get to the stuff you all _really_ are here for.
diff --git a/source/_posts/2016-10-24-explaining-the-updater.markdown b/source/_posts/2016-10-24-explaining-the-updater.markdown
index ed9a4ecf1ce..c4cb5d3069d 100644
--- a/source/_posts/2016-10-24-explaining-the-updater.markdown
+++ b/source/_posts/2016-10-24-explaining-the-updater.markdown
@@ -26,11 +26,11 @@ Please note that this functionality is not done yet but will be available in a f
As developers of Home Assistant, we will be able to see in what kind of environments Home Assistant is running. Here’s a few data points we didn’t have until now:
-* Total number of instances
-* Which operating systems versions and flavors are in use
-* Python version
-* What option is more popular: Docker, Virtualenv or bare metal installs?
-* How popular is our new [Raspberry Pi image][rpi-image]?
+- Total number of instances
+- Which operating systems versions and flavors are in use
+- Python version
+- What option is more popular: Docker, Virtualenv or bare metal installs?
+- How popular is our new [Raspberry Pi image][rpi-image]?
## Why we look up your IP address with GeoIP
diff --git a/source/_posts/2016-12-03-remote-websockets-sonarr.markdown b/source/_posts/2016-12-03-remote-websockets-sonarr.markdown
index a0fec3cf789..6fbf5663fec 100644
--- a/source/_posts/2016-12-03-remote-websockets-sonarr.markdown
+++ b/source/_posts/2016-12-03-remote-websockets-sonarr.markdown
@@ -25,12 +25,12 @@ The brand new [`remote`][remote] component made by [@iandday] will simplify the
The [HomeMatic][homematic] component has received some updates worth mentioning:
-* Additional services
- * `reconnect`: Reconnect to your CCU/Homegear without restarting Home Assistant.
- * `set_dev_value`: Manually control a device, even if it's not supported by Home Assistant yet.
-* Support for multiple HomeMatic hosts
-* Support for HomeMatic Wired (most devices) and HomeMatic IP (a few devices)
-* Various improvements and fixes, especially for HM-Sec-Key (KeyMatic)
+- Additional services
+ - `reconnect`: Reconnect to your CCU/Homegear without restarting Home Assistant.
+ - `set_dev_value`: Manually control a device, even if it's not supported by Home Assistant yet.
+- Support for multiple HomeMatic hosts
+- Support for HomeMatic Wired (most devices) and HomeMatic IP (a few devices)
+- Various improvements and fixes, especially for HM-Sec-Key (KeyMatic)
The support for multiple hosts is a result of allowing mixed configurations with wireless, wired, and IP devices. This has the drawback of making the update a breaking change (along with the renamed `set_value` service). However, the benefits and possibilities gained will be worth it.
diff --git a/source/_posts/2017-03-28-http-to-mqtt-bridge.markdown b/source/_posts/2017-03-28-http-to-mqtt-bridge.markdown
index 30668843a00..69c56f70fc0 100644
--- a/source/_posts/2017-03-28-http-to-mqtt-bridge.markdown
+++ b/source/_posts/2017-03-28-http-to-mqtt-bridge.markdown
@@ -22,16 +22,16 @@ The app could be hosted on any Node.js hosting. I prefer [Heroku: Cloud Applicat
1. Configure [CloudMQTT](https://www.cloudmqtt.com/). Check this [video tutorial](https://www.youtube.com/watch?v=VaWdvVVYU3A) for details.
1. [](https://heroku.com/deploy?template=https://github.com/petkov/http_to_mqtt) HTTP to MQTT bridge app.
1. Add the [Configuration Variables](https://devcenter.heroku.com/articles/config-vars#setting-up-config-vars-for-a-deployed-application) to your Heroku app mentioned here.
- * AUTH_KEY: Can be any string, eg. `912ec803b2ce49e4a541068d495ab570`.
- * MQTT_HOST: The host of your MQTT broker, eg. mqtts://k99.cloudmqtt.com:21234.
- * MQTT_USER: MQTT username
- * MQTT_PASS: MQTT password
+ - AUTH_KEY: Can be any string, eg. `912ec803b2ce49e4a541068d495ab570`.
+ - MQTT_HOST: The host of your MQTT broker, eg. mqtts://k99.cloudmqtt.com:21234.
+ - MQTT_USER: MQTT username
+ - MQTT_PASS: MQTT password
1. Create an IFTTT applet the same way as described in [BRUH Automation](https://youtu.be/087tQ7Ly7f4?t=265) video.
1. Configure [Maker Webhooks](https://ifttt.com/maker_webhooks) service with below parameters.
- * URL: `https://
+- **After upgrading the add-on, I’m unable to access it directly.**
Direct access to the add-on might now be disabled by default by the add-on developer. If the add-on supports running Ingress + direct access, you can re-enable direct access by setting a port number in the “Network” section of the add-on configuration.
-* **After upgrading the add-on, my `panel_iframe` doesn’t work anymore.**
+- **After upgrading the add-on, my `panel_iframe` doesn’t work anymore.**
This is related to the question above. Once you enable direct access again, your iFrame panel will start working again. Until the automated panel integration lands in 0.92, you can also manually add a panel that points at Ingress.
-* **I cannot upgrade my add-on: “This update is no longer compatible with your system.”**
+- **I cannot upgrade my add-on: “This update is no longer compatible with your system.”**
Please update your Home Assistant installation to 0.91.3 or higher.
-* **I cannot access the add-on via Ingress using the Tor Browser or Firefox.**
+- **I cannot access the add-on via Ingress using the Tor Browser or Firefox.**
We found a last minute issue impacting Firefox based browsers (including the Tor Browser). There are some issues accessing add-ons that use WebSockets. We have identified the issue and expect it to be solved with the release of Home Assistant 0.91.4.
diff --git a/source/_posts/2019-04-24-release-92.markdown b/source/_posts/2019-04-24-release-92.markdown
index c53437dd638..d4d21167a27 100644
--- a/source/_posts/2019-04-24-release-92.markdown
+++ b/source/_posts/2019-04-24-release-92.markdown
@@ -175,9 +175,9 @@ Experiencing issues introduced by this release? Please report them in our [issue
- __Amcrest__ - Remove Build Date, Version and Serial Number attributes from sensors. These values do not change during the life of the device and are not appropriate for state attributes. ([@pnbruckner] - [#22418]) ([amcrest docs])
- __Insteon__ - Placeholders that forwarded users from insteon_plm and insteon_local to insteon component have been removed. ([@balloob] - [#22710])
- __Logi Circle__ - This is a breaking change to the Logi Circle integration which migrates from Logitech's private API to their public API.
- * Authentication with Logi Circle's API is now performed using an authorization code grant, and is managed by the Integrations page. It's no longer possible to authenticate with a username and password directly. Please remove any existing configuration for the logi_circle integration and follow the directions here to configure the logi_circle integration with at least a client_id, client_secret, api_key and redirect_uri.
- * Logi Circle camera and sensor entities are now auto-discovered once the integration is authenticated. Users should remove the logi_circle integration from camera and sensor platforms as this is no longer supported.
- * Logi Circle services have been moved from the camera domain to the logi_circle domain
+ - Authentication with Logi Circle's API is now performed using an authorization code grant, and is managed by the Integrations page. It's no longer possible to authenticate with a username and password directly. Please remove any existing configuration for the logi_circle integration and follow the directions here to configure the logi_circle integration with at least a client_id, client_secret, api_key and redirect_uri.
+ - Logi Circle camera and sensor entities are now auto-discovered once the integration is authenticated. Users should remove the logi_circle integration from camera and sensor platforms as this is no longer supported.
+ - Logi Circle services have been moved from the camera domain to the logi_circle domain
Please check the documentation for further details. ([@evanjd] - [#20624]) ([logi_circle docs])
- __Introduction__ - The introduction integration has been removed. It used to be part of the initially created configuration but no longer served a purpose. ([@balloob] - [#22944]) ([introduction docs])
diff --git a/source/_posts/2019-05-16-release-93.markdown b/source/_posts/2019-05-16-release-93.markdown
index bf0f2387e3d..4624a7f75b8 100644
--- a/source/_posts/2019-05-16-release-93.markdown
+++ b/source/_posts/2019-05-16-release-93.markdown
@@ -157,8 +157,8 @@ Experiencing issues introduced by this release? Please report them in our [issue
- __Homematic IP Cloud__ - Adds homematicip cloud temperature sensor from thermostats. Entity IDs of HmIP-SLO (Light Sensor Outdoor) will change and stale entities will need to be removed from the entity registry. ([@SukramJ] - [#23263]) ([homematicip_cloud docs])
- __Pollen.com__
- * IQVIA is the parent company which hosts a variety of sites (https://pollen.com, https://flustar.com, etc.) from which valid data can come. To accommodate this, the Pollen.com sensor platform is now the IQVIA component and the configuration.yaml schema has changed accordingly. ([@bachya] - [#22986]) ([iqvia docs]) ([pollen docs])
- * The IQVIA component no longer provides historical data for allergen and asthma conditions. Tactically, this means all historical sensors – including "Yesterday" sensors – will no longer appear; users will need to update any automations that previously relied on these sensors. ([@bachya] - [#23258]) ([iqvia docs])
+ - IQVIA is the parent company which hosts a variety of sites (https://pollen.com, https://flustar.com, etc.) from which valid data can come. To accommodate this, the Pollen.com sensor platform is now the IQVIA component and the configuration.yaml schema has changed accordingly. ([@bachya] - [#22986]) ([iqvia docs]) ([pollen docs])
+ - The IQVIA component no longer provides historical data for allergen and asthma conditions. Tactically, this means all historical sensors – including "Yesterday" sensors – will no longer appear; users will need to update any automations that previously relied on these sensors. ([@bachya] - [#23258]) ([iqvia docs])
Example configuration:
```yaml
@@ -170,8 +170,8 @@ Experiencing issues introduced by this release? Please report them in our [issue
- __Sonos__
- * Configuring the Sonos integration as a media_player: platform in configuration.yaml was deprecated in 0.72 and has now been removed. Please see the notes above in this release post as well as the component documentation for further info. ([@amelchio] - [#23385]) ([sonos docs])
- * Sonos-specific services have been moved from the media_player domain to the sonos domain. For example, media_player.sonos_join has become sonos.join. Services sonos.set_sleep_timer, sonos.clear_sleep_timer, sonos.update_alarm and sonos.set_option now require the entity_id parameter and will not target all when it is missing. You can use all to target all. ([@amelchio] - [#23670]) ([sonos docs])
+ - Configuring the Sonos integration as a media_player: platform in configuration.yaml was deprecated in 0.72 and has now been removed. Please see the notes above in this release post as well as the component documentation for further info. ([@amelchio] - [#23385]) ([sonos docs])
+ - Sonos-specific services have been moved from the media_player domain to the sonos domain. For example, media_player.sonos_join has become sonos.join. Services sonos.set_sleep_timer, sonos.clear_sleep_timer, sonos.update_alarm and sonos.set_option now require the entity_id parameter and will not target all when it is missing. You can use all to target all. ([@amelchio] - [#23670]) ([sonos docs])
- __Nmap__ - In Linux, and when running a setuid nmap, MAC addresses are reported with a leading zero in each byte. Under Mac OS X, when running the arp command, there is no leading zero. This makes it annoying to share config files between a Mac and Linux setup. This change fixes this by forcing MAC addresses to be zero padded, "breaking" Mac detection on a Mac by aligning it to the convention on Linux ([@mikeage] - [#23492]) ([nmap_tracker docs])
diff --git a/source/_posts/2019-06-05-release-94.markdown b/source/_posts/2019-06-05-release-94.markdown
index ef670af4c92..f958180dba9 100644
--- a/source/_posts/2019-06-05-release-94.markdown
+++ b/source/_posts/2019-06-05-release-94.markdown
@@ -207,9 +207,9 @@ Experiencing issues introduced by this release? Please report them in our [issue
```
- __Plex__
- * Configuration option `include_non_clients` has been removed. The component was unnecessarily complicated with separate update methods for Plex devices and Plex sessions. This change always updates all known Plex clients regardless of type. The previous design also had issues where the Plex sessions are never polled if there are no Plex clients connected at startup and only 'session' client types connect after that point. This leads to a failure to discover new devices. This is a breaking change if the config option `include_non_clients` is being used since it has been removed. ([@jjlawren] - [#24038]) ([plex docs])
+ - Configuration option `include_non_clients` has been removed. The component was unnecessarily complicated with separate update methods for Plex devices and Plex sessions. This change always updates all known Plex clients regardless of type. The previous design also had issues where the Plex sessions are never polled if there are no Plex clients connected at startup and only 'session' client types connect after that point. This leads to a failure to discover new devices. This is a breaking change if the config option `include_non_clients` is being used since it has been removed. ([@jjlawren] - [#24038]) ([plex docs])
- * Configuration options use_custom_entity_ids and entity_namespace have been removed. This change will prepend the display name (and therefore the default entity_id) of each newly created entity with 'Plex' for easy identification. Users may customize each display name and entity_id as desired via the Entity Registry. Entities created before this PR will not be affected as the unique_id remains the same. ([@jjlawren] - [#24072]) ([plex docs])
+ - Configuration options use_custom_entity_ids and entity_namespace have been removed. This change will prepend the display name (and therefore the default entity_id) of each newly created entity with 'Plex' for easy identification. Users may customize each display name and entity_id as desired via the Entity Registry. Entities created before this PR will not be affected as the unique_id remains the same. ([@jjlawren] - [#24072]) ([plex docs])
- __Verisure__ - Base entity_id of alarm_control_panel on alias of installation set by giid rather than first installation. This is a breaking change as it will change entity_id of alarm_control_panel in cases where a user is configuring an installation using giid that is not the first installation. ([@tkjacobsen] - [#23606]) ([verisure docs])
- __Zestimate__ - Changed name property to return Zestimate and the property address. This will make it easier to distinguish multiple Zestimate sensor entities in the UI and is a breaking change as it will change entity_id of Zestimate sensors. If you have automations relying on your Zestimate sensor(s) you may need to revisit them to fix the ID's to the new ones. Also, you may need to update your Zestimate sensor(s) in your Lovelace UI. ([@dreed47] - [#23770]) ([zestimate docs])
diff --git a/source/_posts/2019-08-07-release-97.markdown b/source/_posts/2019-08-07-release-97.markdown
index e8a4043da65..212e1ed25d7 100644
--- a/source/_posts/2019-08-07-release-97.markdown
+++ b/source/_posts/2019-08-07-release-97.markdown
@@ -167,7 +167,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
language: french
```
-- **TotalConnect** - Total Connect Client was upgraded to support more than one alarm panel and allow future support for additional sensors. Previous `alarm_control_panel` entries must be removed, and a new totalconnect entry must be added to configuration.yaml. See https://www.home-assistant.io/integrations/totalconnect/ for configuration details. ([@austinmroczek] - [#24427]) ([totalconnect docs])
+- **TotalConnect** - Total Connect Client was upgraded to support more than one alarm panel and allow future support for additional sensors. Previous `alarm_control_panel` entries must be removed, and a new totalconnect entry must be added to configuration.yaml. See for configuration details. ([@austinmroczek] - [#24427]) ([totalconnect docs])
- **Nuki** - The `lock.nuki_unlatch` service has been removed. It has been replaced by the `lock.open` service. The `lock.nuki_lock_n_go` service has been renamed to `nuki.lock_n_go`. Users that are using the removed or renamed services in automations need to replace them with the new services. ([@franfos] - [#22888]) ([nuki docs])
- **Snapcast** - This changes adds multiroom support for the snapcast component. It adds 2 services `media_player.snapcast_join` and `media_player.snapcast_unjoin` to group/ungroup a client with another client. Also added source selection support in the snapcast clients as the groups are unusable due to their dynamic nature. ([@lyghtnox] - [#24061]) ([snapcast docs])
- **Ambient Weather Station** - The `unique_id` for Ambient sensors uses a new formula, meaning that even though they have the same friendly names, new sensors will be created. The integration will automatically perform this migration under the hood, but if you've altered the entity IDs of any Ambient PWS entities, you'll need do the same to the new entities upon creation. Additionally, the `monitored_keys` configuration option is no longer supported in `configuration.yaml`. The integration will now create sensors for all conditions supported by the particular device.
diff --git a/source/_posts/2019-09-18-release-99.markdown b/source/_posts/2019-09-18-release-99.markdown
index 5b826ffe91b..b623adfd537 100644
--- a/source/_posts/2019-09-18-release-99.markdown
+++ b/source/_posts/2019-09-18-release-99.markdown
@@ -266,12 +266,12 @@ Experiencing issues introduced by this release? Please report them in our [issue
password: password
```
-* **Radiotherm** - Update climate attributes. Automations may break if the user is checking against the previous "mode" or "fan" attributes or previous mode or fan attribute values. - ([@dieselrabbit] - [#26465]) ([radiotherm docs])
+- **Radiotherm** - Update climate attributes. Automations may break if the user is checking against the previous "mode" or "fan" attributes or previous mode or fan attribute values. - ([@dieselrabbit] - [#26465]) ([radiotherm docs])
- The old "mode" attribute is now supported via "hvac_action" attribute.
- The old "fan" attribute now called "fan_action" to follow "hvac_action" .
-* **SolarEdge** - Monitored conditions are no longer supported. - ([@Cereal2nd] - [#26282]) ([solaredge docs])
+- **SolarEdge** - Monitored conditions are no longer supported. - ([@Cereal2nd] - [#26282]) ([solaredge docs])
- **SMA** - Removes deprecated SMA config - ([@balloob] - [#26306]) ([sma docs])
diff --git a/source/_posts/2019-12-17-hassos-release-3.markdown b/source/_posts/2019-12-17-hassos-release-3.markdown
index 2f11e06f058..38fea446d85 100644
--- a/source/_posts/2019-12-17-hassos-release-3.markdown
+++ b/source/_posts/2019-12-17-hassos-release-3.markdown
@@ -51,7 +51,7 @@ Another option is to use our powerful CLI, that is shipped with the SSH add-on.
After some confusion about the statement of supporting virtual environments and running Hass.io on top of a custom Linux; so let's clarify it.
-The supported ways to run Hass.io are documented here: 
Screenshot of High Accuracy Zoning.
Screenshot of Media Player Widget
-There is a bug in the firmware of Ultraloq devices that causes the door state sensor to not be updated and the latch to always be reported as "OPEN".
-We are fully aware that this is not what you expect from a Works With Home Assistant brand and we are in contact Ultraloq to get this resolved!
+
+On July 11th, 2023, due to fundamentally different perceptions of best Home Assistant user experience, Ultraloq by U-tec was removed from Works With Home Assistant partner program.
diff --git a/source/_posts/2022-12-20-year-of-voice.markdown b/source/_posts/2022-12-20-year-of-voice.markdown
index 90b98e262e7..77c28d40063 100644
--- a/source/_posts/2022-12-20-year-of-voice.markdown
+++ b/source/_posts/2022-12-20-year-of-voice.markdown
@@ -14,6 +14,14 @@ og_image: /images/blog/2022-12-20-year-of-voice/conversation.png
_**TL;DR**: It is our goal for 2023 to let users control Home Assistant in their own language. Mike Hansen, creator of Rhasspy, has joined Nabu Casa to lead this effort. We’re starting off by building a [collection of intent matching sentences in every language](https://github.com/home-assistant/intents)._
+**Updates:**
+
+ - [Year of the Voice - Chapter 1](https://www.home-assistant.io/blog/2023/01/26/year-of-the-voice-chapter-1/) (January 26, 2023)
+ - [Year of the Voice - Chapter 2](/blog/2023/04/27/year-of-the-voice-chapter-2/) (April 27, 2023)
+ - [Year of the Voice - Chapter 3](/blog/2023/07/20/year-of-the-voice-chapter-3/) (July 20, 2023)
+
+
+
Usually, the month of December is meant to reflect back. However, we already did that last month when we hosted the [State of the Open Home 2022](https://www.youtube.com/watch?v=D936T1Ze8-4). We didn’t only reflect, we also announced our focus for next year: 2023 is going to be the year of voice.
It is our goal for 2023 to let users control Home Assistant in their own language.
diff --git a/source/_posts/2023-07-05-release-20237.markdown b/source/_posts/2023-07-05-release-20237.markdown
new file mode 100644
index 00000000000..d9249f8b687
--- /dev/null
+++ b/source/_posts/2023-07-05-release-20237.markdown
@@ -0,0 +1,1035 @@
+---
+layout: post
+title: "2023.7: Responding services"
+description: "Services can now respond with data, a new dialog for lock, sentence triggers, fewer breaking changes, Bluetooth proxies are now the fastest option, copy 'n paste in dashboards, brand new image entities, a dashboard action to open assist, climate support for Matter, and more!"
+date: 2023-07-05 00:00:00
+date_formatted: "July 5, 2023"
+author: Franck Nijhof
+author_twitter: frenck
+comments: true
+categories:
+ - Release-Notes
+ - Core
+og_image: /images/blog/2023-07/social.png
+---
+
+
+
+Home Assistant Core 2023.7! 🎉
+
+The previous release was a big one, and this one is no different!
+
+This release brings in a change to Home Assistant, which we consider to be one
+of the biggest game changers of the past years: Services can now respond with
+data! 🤯
+
+It is such a fundamental change, which will allow for many new use cases and
+opens the gates for endless possibilities. I'm so excited about this one!
+
+But that is not all; there is a lot more in store for you! Some of my favorites:
+The Bluetooth proxies are now lightning fast, copy 'n paste in dashboards, a new
+sentence trigger, and I love that a broken automation no longer disappears
+into thin air but now shows up in the UI marked as problematic.
+
+All-in-all, a great release packed with many new features and a lot of
+quality-of-life improvements.
+
+Enjoy the release!
+
+../Frenck
+
+
+
+- [Services can now respond](#services-can-now-respond)
+- [New entity dialog for Locks](#new-entity-dialog-for-locks)
+- [Sentence trigger](#sentence-trigger)
+- [Open assist action](#open-assist-action)
+- [Image entities](#image-entities)
+- [Energy dashboard: Self-sufficiency](#energy-dashboard-self-sufficiency)
+- [Copy 'n paste support in dashboards](#copy-n-paste-support-in-dashboards)
+- [Select the timezone to use/display](#select-the-timezone-to-usedisplay)
+- [Iteration of the integrations dashboard](#iteration-of-the-integrations-dashboard)
+- [Unavailable automations and scripts](#unavailable-automations-and-scripts)
+- [New script dialog](#new-script-dialog)
+- [Lightning fast Bluetooth proxies](#lightning-fast-bluetooth-proxies)
+- [Matter updates](#matter-updates)
+- [Reducing the risk of running into breaking changes](#reducing-the-risk-of-running-into-breaking-changes)
+- [Other noteworthy changes](#other-noteworthy-changes)
+- [New integrations](#new-integrations)
+- [Release 2023.7.1 - July 6](#release-202371---july-6)
+- [Release 2023.7.2 - July 13](#release-202372---july-13)
+- [Release 2023.7.3 - July 21](#release-202373---july-21)
+- [Integrations now available to set up from the UI](#integrations-now-available-to-set-up-from-the-ui)
+- [Need help? Join the community!](#need-help-join-the-community)
+- [Breaking changes](#breaking-changes)
+- [Farewell to the following](#farewell-to-the-following)
+- [All changes](#all-changes)
+
+Don't forget to [join our release party live stream on YouTube](https://www.youtube.com/watch?v=r0DLyU-4nWo)
+5 July 2023, at 12:00 PDT / 21:00 CEST!
+
+
+
+In this release, we have included two brand-new services to play with service responses:
+
+- {% my developer_call_service service="conversation.process" %} - This
+ service allows you to ask Assist a command or question and get a response
+ back.
+- {% my developer_call_service service="calendar.list_events" %} - This service
+ enables you to ask Home Assistant for a list of events on your calendar.
+
+If you combine those in an automation, in the morning, you could ask
+Home Assistant for today's calendar events, add things like weather information,
+send it to ChatGPT using the conversation process, and ask it to summarize it
+and use that response to send a notification to your phone.
+
+[@allenporter] has put this all together for you in
+[this Blueprint](/blueprints/blog/2023-07/notify_agent_agenda.yaml):
+
+{% my blueprint_import badge blueprint_url="https://www.home-assistant.io/blueprints/blog/2023-07/notify_agent_agenda.yaml" %}
+
+This is just one example, but the possibilities are endless! It is exciting
+to see what other creative use cases and new services with responses will
+be added in the future!
+
+[This feature is also added to scripts!](/docs/scripts#stopping-a-script-sequence)
+So, you can make your scripts respond and use that response in your automations.
+This is a great way to make your scripts more dynamic and flexible.
+
+A special thanks to [@allenporter], who has been responsible for building out
+the larger part of this feature!
+
+[@allenporter]: https://github.com/allenporter
+
+## New entity dialog for Locks
+
+We are continuing to improve the entity dialogs. This time, we have reworked
+the entity dialog for locks. It looks great!
+
+It looks similar to the entity dialog for the switch, but it has a few
+extra features like asking for an unlock code and has a beautiful animation
+when it is (un)locking.
+
+
+
+## Sentence trigger
+
+Our [Assist](/voice_control/) is getting more and more powerful! This time,
+we have added a new trigger to our automation editor that allows you to
+trigger an automation when a sentence is said to the default Assist conversation
+agent. 🤯
+
+
+
+Creating an automation based on something that is said, has never been easier.
+In the above screenshot, just mentioning "what a mess" will send out the living
+room vacuum to start cleaning up the mess.
+
+## Open assist action
+
+Another one for the Year of the Voice, a brand new action for use in dashboard
+cards, has been added: the Assist action!
+
+
+
+With this action, you can directly open Assist from your dashboards using,
+for example, a button and even make Assist listen right away.
+
+
+
+There are quite a few cases where this action can be useful. For example, if
+you have a tablet mounted on the wall, you can use this action to open Assist
+and start listening immediately using a single button touch.
+
+## Image entities
+
+There is a brand new entity type in town: the [image entity](/integrations/image/).
+
+The image entity is very similar to the [camera entity](/integrations/camera/),
+but instead of providing a live stream, it provides a single image. For example,
+a QR code that provides the Wi-Fi credentials for your guest network, a weather
+map, an image of the last motion detected by your camera, or just the cute cat
+picture of the day!
+
+
+
+While the camera entity provided similar functionality, we wanted to make an
+entity tailored for these specific use cases. An image entity is much
+more lightweight and efficient compared to the camera entity. Also, this keeps
+our camera entities focused on providing actual camera feeds.
+
+Support for this brand new entity has been added to the [AVM Fritz!Box Tools](/integrations/fritz/)
+(for guest network access), and the [MQTT](/integrations/mqtt/) and
+[Template](/integrations/template/) integrations if you want to build your own.
+
+## Energy dashboard: Self-sufficiency
+
+The energy dashboard has a new gauge, added by [@TillFleisch]: Self-sufficiency.
+
+This gauge tells you how self-sufficient your home is. The more you take from
+the grid, the more the value will decrease.
+
+
+
+Increasing this value can be done by lowering your consumption from the grid,
+for example, by using the washing machine when the sun is shining and solar
+production is high or by creating automations that turn off devices when solar
+production is low. Another more drastic way is by adding more solar panels
+or battery storage.
+
+[@TillFleisch]: https://github.com/TillFleischmann
+
+## Copy 'n paste support in dashboards
+
+In the previous release, [@karwosts] added the amazing [copy 'n paste feature](/blog/2023/06/07/release-20236/#copy-n-paste-support-in-the-automation-editor)
+to our automation and script editors. This release, he is back with the same
+feature for our dashboards!
+
+You can now cut, copy, and paste cards between your dashboards, views, and
+even inside other nested cards. This makes it a lot easier to reorganize your
+dashboards!
+
+
+
+Just like with automations, select the card you want to cut or copy, and
+when adding a new card to your dashboard, you will see a new option to paste.
+
+When reorganizing your dashboards that use a masonry layout, it is mandatory to
+understand the order of the cards across the different columns in your view.
+To make that easier we now show a positional number on the card when
+your dashboard is in edit mode.
+
+Added bonus: Who needs drag 'n drop when you've got click 'n ...teleport?
+Just kidding, of course; however, teleporting already makes things a lot easier!
+Click on the positional number to enter a new position for the card.
+
+
+
+[@karwosts]: https://github.com/karwosts
+
+## Select the timezone to use/display
+
+You can now select which timezone the Home Assistant interface should use
+in your user profile. Useful when traveling or when you, for example,
+manage an instance for a relative in a different time zone.
+
+
+
+You can choose to use the timezone of your current location, or use the timezone
+that your Home Assistant server is in. The Home Assistant frontend will adjust
+all of the date & times to the selected timezone.
+
+## Iteration of the integrations dashboard
+
+In the last release, we introduced new [integrations dashboard & pages](/blog/2023/06/07/release-20236/#integrations-dashboard--pages),
+which many of you really liked. Yet, there has been some feedback, and we
+have been working on improving it.
+
+The main goal was to make it feel less busy, more familiar and consistent with
+all other UI you see in Home Assistant.
+
+
+
+The cards shown are now more consistent with the rest of Home Assistant and the
+full integration name and logo is now clickable. The cog, device and service
+items have been removed, and the indicators for custom integrations
+and cloud services are no longer overlapping the logos.
+
+## Unavailable automations and scripts
+
+Automations and scripts are awesome! They can add a lot of comfort to your
+home, making your home automation feel like magic. But they have a weird quirk:
+if you made an error in their configuration, they would just disappear
+from Home Assistant. 😞
+
+This is no longer the case! 😀 If an automation or script has an error, it will
+now show up as unavailable, accompanied by a red confused automation robot.
+
+
+
+Selecting such an automation will show you the details of the error message
+so you know what is going on and what to fix.
+
+
+
+## New script dialog
+
+When you create a new automation, you’ll get a nice dialog where you can create
+a new one from scratch or use one of your imported blueprints
+as a starting point.
+
+[@karwosts] has now added the same dialog to our script editor! 🎉
+
+
+
+Being able to set up scripts from Blueprints is great, as combined with the
+brand new [service response](#services-can-now-respond) feature, these
+become a lot more powerful and a lot more useful for sharing!
+
+You can find new script Blueprints for you to use in the
+[Blueprint Exchange on our community forum](https://community.home-assistant.io/tags/c/blueprints-exchange/53/script?ascending=false&order=views).
+
+[@karwosts]: https://github.com/karwosts
+
+## Lightning fast Bluetooth proxies
+
+A great way to extend the range of Bluetooth for your Home Assistant set up
+is by using [Bluetooth proxies](https://esphome.github.io/bluetooth-proxies/).
+These Bluetooth proxies are now even faster! Like... really fast! 🚀
+
+You can expect to see a 40-80% decrease in network traffic between
+Home Assistant and the proxy device. It now bundles and sends multiple
+Bluetooth advertisements in bulk, instead of sending them one by one.
+
+Another large contributor to the speed increase is that the processing of the
+advertisements is now done in Home Assistant instead of on the proxy device.
+A win-win; it is faster this way and contributes to making the ESP device more
+stable and reliable.
+
+For this to work, you need [ESPHome 2023.6.0](https://esphome.io) or later.
+
+## Matter updates
+
+Quite a few significant changes have been made to the Matter integration.
+
+The biggest change can be found in the way subscriptions are handled. Especially
+on larger (Thread) networks, this will result in a much faster and more reliable
+experience. This also affects startup time, which is now blazing fast (from
+minutes to seconds).
+
+Changes to connected Matter bridges are now instantly detected, so when adding
+a new device to a bridge (like, for example, a connected Aqara M2 hub) the device
+will show up immediately.
+
+Last but most certainly not least: The Matter integration now supports
+climate devices! 🎉
+
+
+A Nest Thermostat connected as a Matter climate device.
+
+ Read out your Discovergy gas and electricity meters.
+- **[Dremel 3D Printer]**, added by [@tkdrob]
+ Monitor your Dremel 3D printer and its printing progress.
+- **[Renson]**, added by [@jimmyd-be]
+ Monitor your Renson ventilation system.
+- **[Image]**, added by [@emontnemery]
+ A new entity type that is like a camera, but specifically for images.
+- **[LOQED Touch Smart Lock]**, added by [@cpolhout] and [@mikewoudenberg]
+ Control your LOQED smart lock.
+
+[@cpolhout]: https://github.com/cpolhout
+[@emontnemery]: https://github.com/emontnemery
+[@jimmyd-be]: https://github.com/jimmyd-be
+[@jpbede]: https://github.com/jpbede
+[@mikewoudenberg]: https://github.com/mikewoudenberg
+[@tkdrob]: https://github.com/tkdrob
+[Discovergy]: /integrations/discovergy
+[Dremel 3D Printer]: /integrations/dremel_3d_printer
+[Image]: /integrations/image
+[LOQED Touch Smart Lock]: /integrations/loqed
+[Renson]: /integrations/renson
+
+## Release 2023.7.1 - July 6
+
+- Fix not including device_name in friendly name if it is None ([@jbouwh] - [#95485])
+- Handle integrations with empty services or failing to load during service description enumeration ([@bdraco] - [#95911])
+- Update frontend to 20230705.1 ([@bramkragten] - [#95913]) ([frontend docs])
+- Make SwitchBot no_devices_found message more helpful ([@bdraco] - [#95916]) ([switchbot docs])
+- Migrate bracketed IP addresses in ZHA config entry ([@puddly] - [#95917]) ([zha docs])
+- Use device name for Nuki ([@joostlek] - [#95941]) ([nuki docs])
+- Add explicit device naming for Tuya sensors ([@joostlek] - [#95944]) ([tuya docs])
+- Fix entity name for Flick Electric ([@joostlek] - [#95947]) ([flick_electric docs])
+- Fix matter exception NoneType in set_brightness for optional min/max level values ([@neocolis] - [#95949]) ([matter docs])
+- Fix grouping feature for MusicCast ([@micha91] - [#95958]) ([yamaha_musiccast docs])
+- Bump pyrainbird to 2.1.0 ([@allenporter] - [#95968]) ([rainbird docs])
+- Add missing qnap translation ([@emontnemery] - [#95969]) ([qnap docs])
+- Set correct `response` value in service description when `async_set_service_schema` is used ([@bramkragten] - [#95985]) ([script docs])
+- Explicitly use device name as entity name for Xiaomi fan and humidifier ([@jpbede] - [#95986]) ([xiaomi_miio docs])
+- Make script services always respond when asked ([@bramkragten] - [#95991]) ([script docs])
+- Fix state of slimproto players ([@marcelveldt] - [#96000]) ([slimproto docs])
+
+[#95485]: https://github.com/home-assistant/core/pull/95485
+[#95908]: https://github.com/home-assistant/core/pull/95908
+[#95911]: https://github.com/home-assistant/core/pull/95911
+[#95913]: https://github.com/home-assistant/core/pull/95913
+[#95916]: https://github.com/home-assistant/core/pull/95916
+[#95917]: https://github.com/home-assistant/core/pull/95917
+[#95941]: https://github.com/home-assistant/core/pull/95941
+[#95944]: https://github.com/home-assistant/core/pull/95944
+[#95947]: https://github.com/home-assistant/core/pull/95947
+[#95949]: https://github.com/home-assistant/core/pull/95949
+[#95958]: https://github.com/home-assistant/core/pull/95958
+[#95968]: https://github.com/home-assistant/core/pull/95968
+[#95969]: https://github.com/home-assistant/core/pull/95969
+[#95985]: https://github.com/home-assistant/core/pull/95985
+[#95986]: https://github.com/home-assistant/core/pull/95986
+[#95991]: https://github.com/home-assistant/core/pull/95991
+[#96000]: https://github.com/home-assistant/core/pull/96000
+[@allenporter]: https://github.com/allenporter
+[@bdraco]: https://github.com/bdraco
+[@bramkragten]: https://github.com/bramkragten
+[@emontnemery]: https://github.com/emontnemery
+[@frenck]: https://github.com/frenck
+[@jbouwh]: https://github.com/jbouwh
+[@joostlek]: https://github.com/joostlek
+[@jpbede]: https://github.com/jpbede
+[@marcelveldt]: https://github.com/marcelveldt
+[@micha91]: https://github.com/micha91
+[@neocolis]: https://github.com/neocolis
+[@puddly]: https://github.com/puddly
+[abode docs]: /integrations/abode/
+[accuweather docs]: /integrations/accuweather/
+[acmeda docs]: /integrations/acmeda/
+[flick_electric docs]: /integrations/flick_electric/
+[frontend docs]: /integrations/frontend/
+[matter docs]: /integrations/matter/
+[nuki docs]: /integrations/nuki/
+[qnap docs]: /integrations/qnap/
+[rainbird docs]: /integrations/rainbird/
+[script docs]: /integrations/script/
+[slimproto docs]: /integrations/slimproto/
+[switchbot docs]: /integrations/switchbot/
+[tuya docs]: /integrations/tuya/
+[xiaomi_miio docs]: /integrations/xiaomi_miio/
+[yamaha_musiccast docs]: /integrations/yamaha_musiccast/
+[zha docs]: /integrations/zha/
+
+## Release 2023.7.2 - July 13
+
+- Fix ESPHome deep sleep devices staying unavailable after unexpected disconnect ([@bdraco] - [#96354]) ([esphome docs])
+- Bump pydaikin 2.10.5 ([@mover85] - [#95656]) ([daikin docs])
+- Bump pywemo from 0.9.1 to 1.1.0 ([@esev] - [#95951]) ([wemo docs])
+- Get MyStrom device state before checking support ([@joostlek] - [#96004]) ([mystrom docs])
+- Refactor async_get_hass to rely on threading.local instead of a ContextVar ([@jbouwh] - [#96005]) ([mqtt docs])
+- Use explicit device naming for Switchbot ([@joostlek] - [#96011]) ([switchbot docs])
+- Remove openhome from discovery component ([@bazwilliams] - [#96021]) ([discovery docs])
+- UPB explicit device name ([@joostlek] - [#96042]) ([upb docs])
+- Use default MyStrom devicetype if not present ([@joostlek] - [#96070]) ([mystrom docs])
+- Fix implicit use of device name in Slimproto ([@frenck] - [#96081]) ([slimproto docs])
+- Fix implicit device name for RainMachine `update` entity ([@bachya] - [#96094]) ([rainmachine docs])
+- Use explicit device name for Yalexs BLE ([@joostlek] - [#96105]) ([yalexs_ble docs])
+- Fix reference to translation reference in buienradar translations ([@jbouwh] - [#96119]) ([buienradar docs])
+- Bump goalzero to 0.2.2 ([@tkdrob] - [#96121]) ([goalzero docs])
+- Fix implicitly using device name in Yale Smart Living ([@gjohansson-ST] - [#96161]) ([yale_smart_alarm docs])
+- Bump bthome to 2.12.1 ([@Ernst79] - [#96166]) ([bthome docs])
+- Use explicit device name for Stookwijzer ([@joostlek] - [#96184]) ([stookwijzer docs])
+- Enable retries on rainbird devices by loading model and version ([@allenporter] - [#96190]) ([rainbird docs])
+- Fix race fetching ESPHome dashboard when there are no devices set up ([@bdraco] - [#96196]) ([esphome docs])
+- Bump Roborock to v0.30.0 ([@Lash-L] - [#96268]) ([roborock docs])
+- Use explicit device naming for Escea ([@joostlek] - [#96270]) ([escea docs])
+- Fix ZHA serialization issue with warning devices ([@puddly] - [#96275]) ([zha docs])
+- Bump reolink_aio to 0.7.3 ([@starkillerOG] - [#96284]) ([reolink docs])
+- Bump aiohomekit to 2.6.7 ([@bdraco] - [#96291]) ([homekit_controller docs])
+- Add has entity name to Blink ([@joostlek] - [#96322]) ([blink docs])
+- Fix extra verbiage in Ridwell rotating category sensor ([@bachya] - [#96345]) ([ridwell docs])
+- Update RestrictedPython to 6.1 ([@frenck] - [#96358]) ([python_script docs])
+- Add explicit device naming to Led BLE ([@joostlek] - [#96421]) ([led_ble docs])
+- Always add guest wifi qr code entity in AVM Fritz!Tools ([@mib1185] - [#96435]) ([fritz docs])
+- Fix mixed case service schema registration ([@bdraco] - [#96448])
+- Ensure ESPHome dashboard connection recovers if its down when core starts ([@bdraco] - [#96449]) ([esphome docs])
+
+[#95656]: https://github.com/home-assistant/core/pull/95656
+[#95908]: https://github.com/home-assistant/core/pull/95908
+[#95951]: https://github.com/home-assistant/core/pull/95951
+[#96004]: https://github.com/home-assistant/core/pull/96004
+[#96005]: https://github.com/home-assistant/core/pull/96005
+[#96006]: https://github.com/home-assistant/core/pull/96006
+[#96011]: https://github.com/home-assistant/core/pull/96011
+[#96021]: https://github.com/home-assistant/core/pull/96021
+[#96042]: https://github.com/home-assistant/core/pull/96042
+[#96070]: https://github.com/home-assistant/core/pull/96070
+[#96081]: https://github.com/home-assistant/core/pull/96081
+[#96094]: https://github.com/home-assistant/core/pull/96094
+[#96105]: https://github.com/home-assistant/core/pull/96105
+[#96119]: https://github.com/home-assistant/core/pull/96119
+[#96121]: https://github.com/home-assistant/core/pull/96121
+[#96161]: https://github.com/home-assistant/core/pull/96161
+[#96166]: https://github.com/home-assistant/core/pull/96166
+[#96184]: https://github.com/home-assistant/core/pull/96184
+[#96190]: https://github.com/home-assistant/core/pull/96190
+[#96196]: https://github.com/home-assistant/core/pull/96196
+[#96268]: https://github.com/home-assistant/core/pull/96268
+[#96270]: https://github.com/home-assistant/core/pull/96270
+[#96275]: https://github.com/home-assistant/core/pull/96275
+[#96284]: https://github.com/home-assistant/core/pull/96284
+[#96291]: https://github.com/home-assistant/core/pull/96291
+[#96322]: https://github.com/home-assistant/core/pull/96322
+[#96345]: https://github.com/home-assistant/core/pull/96345
+[#96354]: https://github.com/home-assistant/core/pull/96354
+[#96358]: https://github.com/home-assistant/core/pull/96358
+[#96421]: https://github.com/home-assistant/core/pull/96421
+[#96435]: https://github.com/home-assistant/core/pull/96435
+[#96448]: https://github.com/home-assistant/core/pull/96448
+[#96449]: https://github.com/home-assistant/core/pull/96449
+[@Ernst79]: https://github.com/Ernst79
+[@Lash-L]: https://github.com/Lash-L
+[@allenporter]: https://github.com/allenporter
+[@bachya]: https://github.com/bachya
+[@balloob]: https://github.com/balloob
+[@bazwilliams]: https://github.com/bazwilliams
+[@bdraco]: https://github.com/bdraco
+[@esev]: https://github.com/esev
+[@frenck]: https://github.com/frenck
+[@gjohansson-ST]: https://github.com/gjohansson-ST
+[@jbouwh]: https://github.com/jbouwh
+[@joostlek]: https://github.com/joostlek
+[@mib1185]: https://github.com/mib1185
+[@mover85]: https://github.com/mover85
+[@puddly]: https://github.com/puddly
+[@starkillerOG]: https://github.com/starkillerOG
+[@tkdrob]: https://github.com/tkdrob
+[abode docs]: /integrations/abode/
+[accuweather docs]: /integrations/accuweather/
+[acmeda docs]: /integrations/acmeda/
+[blink docs]: /integrations/blink/
+[bthome docs]: /integrations/bthome/
+[buienradar docs]: /integrations/buienradar/
+[daikin docs]: /integrations/daikin/
+[discovery docs]: /integrations/discovery/
+[escea docs]: /integrations/escea/
+[esphome docs]: /integrations/esphome/
+[fritz docs]: /integrations/fritz/
+[goalzero docs]: /integrations/goalzero/
+[homekit_controller docs]: /integrations/homekit_controller/
+[led_ble docs]: /integrations/led_ble/
+[mqtt docs]: /integrations/mqtt/
+[mystrom docs]: /integrations/mystrom/
+[python_script docs]: /integrations/python_script/
+[rainbird docs]: /integrations/rainbird/
+[rainmachine docs]: /integrations/rainmachine/
+[reolink docs]: /integrations/reolink/
+[ridwell docs]: /integrations/ridwell/
+[roborock docs]: /integrations/roborock/
+[slimproto docs]: /integrations/slimproto/
+[stookwijzer docs]: /integrations/stookwijzer/
+[switchbot docs]: /integrations/switchbot/
+[upb docs]: /integrations/upb/
+[wemo docs]: /integrations/wemo/
+[yale_smart_alarm docs]: /integrations/yale_smart_alarm/
+[yalexs_ble docs]: /integrations/yalexs_ble/
+[zha docs]: /integrations/zha/
+
+## Release 2023.7.3 - July 21
+
+- Use device class naming for SimpliSafe ([@joostlek] - [#96093]) ([simplisafe docs])
+- Always try PullPoint with ONVIF ([@bdraco] - [#96377]) ([onvif docs])
+- Bump vallox-websocket-api to 3.3.0 ([@slovdahl] - [#96493]) ([vallox docs]) (dependency)
+- Fix Vallox fan entity naming ([@slovdahl] - [#96494]) ([vallox docs])
+- Bump devolo_plc_api to 1.3.2 ([@Shutgun] - [#96499]) ([devolo_home_network docs]) (dependency)
+- Support MyStrom switch 120 ([@joostlek] - [#96535]) ([mystrom docs])
+- Defer SSDP UPNP server start until the started event ([@bdraco] - [#96555]) ([ssdp docs])
+- Handle empty strings for ESPHome UOMs ([@bdraco] - [#96556]) ([esphome docs])
+- Bump onvif-zeep-async to 3.1.12 ([@bdraco] - [#96560]) ([onvif docs]) (dependency)
+- Fix daikin missing key after migration ([@mover85] - [#96575]) ([daikin docs])
+- Ensure androidtv_remote does not block startup of HA ([@quthla] - [#96582]) ([androidtv_remote docs])
+- Bump pyrainbird to 2.1.1 ([@allenporter] - [#96601]) ([rainbird docs]) (dependency)
+- Bump pyrainbird to 3.0.0 ([@allenporter] - [#96610]) ([rainbird docs]) (dependency)
+- Fix SmartThings Cover Set Position (for window shades) ([@andrewsayre] - [#96612]) ([smartthings docs]) (dependency)
+- Improve imap error handling for config entry ([@jbouwh] - [#96724]) ([imap docs])
+- Use explicit device name for Stookalert ([@joostlek] - [#96755]) ([stookalert docs])
+- Prevent otbr creating multiple config entries ([@emontnemery] - [#96783]) ([otbr docs])
+- Fix check for HA Yellow radio in otbr config flow ([@emontnemery] - [#96789]) ([otbr docs])
+- Update PyYAML to 6.0.1 ([@cdce8p] - [#96800]) (dependency)
+- Update pycocotools to 2.0.6 ([@cdce8p] - [#96831]) ([tensorflow docs]) (dependency)
+- Add username to Reauth flow in Honeywell ([@mkmer] - [#96850]) ([honeywell docs])
+- bump python-Roborock to 0.30.1 ([@Lash-L] - [#96877]) ([roborock docs]) (dependency)
+- Avoid infinite loop on corrupt stream recording ([@uvjustin] - [#96881]) ([stream docs])
+- Bump AIOSomecomfort to 0.0.15 in Honeywell ([@mkmer] - [#96904]) ([honeywell docs]) (dependency)
+- Fix timer switch in Sensibo ([@gjohansson-ST] - [#96911]) ([sensibo docs])
+- Disable wheels building for pycocotools ([@frenck] - [#96937])
+- Fix esphome entity ids in test ([@bdraco] - [#96965]) ([esphome docs])
+- Add custom bypass night arming to SIA alarm codes ([@etnoy] - [#95736]) ([sia docs])
+- Upgrade pymazda to 0.3.10 ([@bdr99] - [#96954]) ([mazda docs]) (dependency)
+- Fix OTBR tests on RC ([@frenck] - [#96966]) ([otbr docs])
+- Update aiohttp to 3.8.5 ([@frenck] - [#96945]) (dependency)
+- Remove stateclass from Systemmonitor process sensor ([@joostlek] - [#96973]) ([systemmonitor docs])
+- Fix task leak on config entry unload/retry ([@bdraco] - [#96981])
+- Bump env_canada to v0.5.36 ([@michaeldavie] - [#96987]) ([environment_canada docs])
+- Update pyfibaro dependency ([@rappenze] - [#97004]) ([fibaro docs]) (dependency)
+
+[#95736]: https://github.com/home-assistant/core/pull/95736
+[#95908]: https://github.com/home-assistant/core/pull/95908
+[#96006]: https://github.com/home-assistant/core/pull/96006
+[#96093]: https://github.com/home-assistant/core/pull/96093
+[#96377]: https://github.com/home-assistant/core/pull/96377
+[#96487]: https://github.com/home-assistant/core/pull/96487
+[#96493]: https://github.com/home-assistant/core/pull/96493
+[#96494]: https://github.com/home-assistant/core/pull/96494
+[#96499]: https://github.com/home-assistant/core/pull/96499
+[#96535]: https://github.com/home-assistant/core/pull/96535
+[#96555]: https://github.com/home-assistant/core/pull/96555
+[#96556]: https://github.com/home-assistant/core/pull/96556
+[#96560]: https://github.com/home-assistant/core/pull/96560
+[#96575]: https://github.com/home-assistant/core/pull/96575
+[#96582]: https://github.com/home-assistant/core/pull/96582
+[#96601]: https://github.com/home-assistant/core/pull/96601
+[#96610]: https://github.com/home-assistant/core/pull/96610
+[#96612]: https://github.com/home-assistant/core/pull/96612
+[#96724]: https://github.com/home-assistant/core/pull/96724
+[#96755]: https://github.com/home-assistant/core/pull/96755
+[#96783]: https://github.com/home-assistant/core/pull/96783
+[#96789]: https://github.com/home-assistant/core/pull/96789
+[#96800]: https://github.com/home-assistant/core/pull/96800
+[#96831]: https://github.com/home-assistant/core/pull/96831
+[#96850]: https://github.com/home-assistant/core/pull/96850
+[#96877]: https://github.com/home-assistant/core/pull/96877
+[#96881]: https://github.com/home-assistant/core/pull/96881
+[#96904]: https://github.com/home-assistant/core/pull/96904
+[#96911]: https://github.com/home-assistant/core/pull/96911
+[#96937]: https://github.com/home-assistant/core/pull/96937
+[#96945]: https://github.com/home-assistant/core/pull/96945
+[#96954]: https://github.com/home-assistant/core/pull/96954
+[#96965]: https://github.com/home-assistant/core/pull/96965
+[#96966]: https://github.com/home-assistant/core/pull/96966
+[#96973]: https://github.com/home-assistant/core/pull/96973
+[#96981]: https://github.com/home-assistant/core/pull/96981
+[#96987]: https://github.com/home-assistant/core/pull/96987
+[#97004]: https://github.com/home-assistant/core/pull/97004
+[@Lash-L]: https://github.com/Lash-L
+[@Shutgun]: https://github.com/Shutgun
+[@allenporter]: https://github.com/allenporter
+[@andrewsayre]: https://github.com/andrewsayre
+[@balloob]: https://github.com/balloob
+[@bdr99]: https://github.com/bdr99
+[@bdraco]: https://github.com/bdraco
+[@cdce8p]: https://github.com/cdce8p
+[@emontnemery]: https://github.com/emontnemery
+[@etnoy]: https://github.com/etnoy
+[@frenck]: https://github.com/frenck
+[@gjohansson-ST]: https://github.com/gjohansson-ST
+[@jbouwh]: https://github.com/jbouwh
+[@joostlek]: https://github.com/joostlek
+[@michaeldavie]: https://github.com/michaeldavie
+[@mkmer]: https://github.com/mkmer
+[@mover85]: https://github.com/mover85
+[@quthla]: https://github.com/quthla
+[@rappenze]: https://github.com/rappenze
+[@slovdahl]: https://github.com/slovdahl
+[@uvjustin]: https://github.com/uvjustin
+[abode docs]: /integrations/abode/
+[accuweather docs]: /integrations/accuweather/
+[acmeda docs]: /integrations/acmeda/
+[androidtv_remote docs]: /integrations/androidtv_remote/
+[daikin docs]: /integrations/daikin/
+[devolo_home_network docs]: /integrations/devolo_home_network/
+[environment_canada docs]: /integrations/environment_canada/
+[esphome docs]: /integrations/esphome/
+[fibaro docs]: /integrations/fibaro/
+[honeywell docs]: /integrations/honeywell/
+[imap docs]: /integrations/imap/
+[mazda docs]: /integrations/mazda/
+[mystrom docs]: /integrations/mystrom/
+[onvif docs]: /integrations/onvif/
+[otbr docs]: /integrations/otbr/
+[rainbird docs]: /integrations/rainbird/
+[roborock docs]: /integrations/roborock/
+[sensibo docs]: /integrations/sensibo/
+[sia docs]: /integrations/sia/
+[simplisafe docs]: /integrations/simplisafe/
+[smartthings docs]: /integrations/smartthings/
+[ssdp docs]: /integrations/ssdp/
+[stookalert docs]: /integrations/stookalert/
+[stream docs]: /integrations/stream/
+[systemmonitor docs]: /integrations/systemmonitor/
+[tensorflow docs]: /integrations/tensorflow/
+[vallox docs]: /integrations/vallox/
+
+## Integrations now available to set up from the UI
+
+The following integrations are now available via the Home Assistant UI:
+
+- **[myStrom]**, done by [@pail23]
+- **[Google Translate text-to-speech]**, done by [@MartinHjelmare]
+- **[Linn / Openhome]**, done by [@bazwilliams]
+- **[QNAP]**, done by [@disforw]
+
+[@bazwilliams]: https://github.com/bazwilliams
+[@disforw]: https://github.com/disforw
+[@MartinHjelmare]: https://github.com/MartinHjelmare
+[@pail23]: https://github.com/pail23
+[Google Translate text-to-speech]: /integrations/google_translate
+[Linn / Openhome]: /integrations/openhome
+[myStrom]: /integrations/mystrom
+[QNAP]: /integrations/qnap
+
+## Need help? Join the community!
+
+Home Assistant has a great community of users who are all more than willing
+to help each other out. So, join us!
+
+Our very active [Discord chat server](/join-chat) is an excellent place to be
+at, and don't forget to join our amazing [forums](https://community.home-assistant.io/).
+
+Found a bug or issue? Please report it in our [issue tracker](https://github.com/home-assistant/core/issues),
+to get it fixed! Or, check [our help page](/help) for guidance for more
+places you can go.
+
+Are you more into email? [Sign-up for our Building the Open Home Newsletter](/newsletter)
+to get the latest news about features, things happening in our community and
+other news about building an Open Home; straight into your inbox.
+
+## Breaking changes
+
+{% details "Home Assistant Container (Docker)" %}
+
+If you use the Home Assistant Container installation method, for example, using
+Docker, please make sure you are using our official (multi-platform) images.
+
+The correct and preferred image to use for our stable releases is:
+
+- `ghcr.io/home-assistant/home-assistant:stable`
+
+Although not the preferred location by the Home Assistant project, the image
+is also available on DockerHub:
+
+- `homeassistant/home-assistant:stable`
+
+The reason for mentioning this in this breaking change section is that we have
+seen usage of our internal, intermediate, platform build images. These images
+are not meant for use directly, and using the above listed images is strongly
+recommended.
+
+As of this release, we no longer publish our intermediate platform images to
+DockerHub. This means that if you are using these images, you will no longer
+receive updates. Please use the above-listed images instead.
+
+([@pvizeli] - [#95236])
+
+[@pvizeli]: https://github.com/pvizeli
+[#95236]: https://github.com/home-assistant/core/pull/95236
+
+{% enddetails %}
+
+{% details "Bose SoundTouch" %}
+
+The previously deprecated YAML configuration of the Bose SoundTouch
+integration has been removed.
+
+Bose SoundTouch is now configured via the UI. Any existing YAML
+configuration has been imported in previous releases and can now be safely
+removed from your YAML configuration files.
+
+([@gjohansson-ST] - [#94090]) ([documentation](/integrations/soundtouch))
+
+[@gjohansson-ST]: https://github.com/gjohansson-ST
+[#94090]: https://github.com/home-assistant/core/pull/94090
+
+{% enddetails %}
+
+{% details "Conversation" %}
+
+When using the Assist shortcut on iOS, it will now always talk to Home Assistant
+conversation agent even if the OpenAI or Google LLM conversation integrations
+are set up.
+
+([@balloob] - [#95225]) ([documentation](/integrations/conversation))
+
+[@balloob]: https://github.com/balloob
+[#95225]: https://github.com/home-assistant/core/pull/95225
+
+{% enddetails %}
+
+{% details "ESPHome" %}
+
+As an additional security hardening measure, the default for allowing ESPHome
+devices to make service calls has changed. If you want to permit the ESPHome
+device to make service calls, it must be enabled in the options flow.
+
+- For existing devices, calling Home Assistant services continues to be allowed.
+- For newly configured devices, it must now be enabled in the options flow.
+
+([@bdraco] - [#95143]) ([documentation](/integrations/esphome))
+
+[@bdraco]: https://github.com/bdraco
+[#95143]: https://github.com/home-assistant/core/pull/95143
+
+{% enddetails %}
+
+{% details "Home Assistant Supervisor" %}
+
+The default name given to backups created with the `hassio.full_backup`
+and `hassio.partial_backup` services is now longer `""` but the date and time
+the backup was initiated (`%Y-%m-%d %H:%M:%S`, for example,
+"2023-07-05 13:37:42").
+
+([@ludeeus] - [#94468]) ([documentation](/integrations/hassio))
+
+[@ludeeus]: https://github.com/ludeeus
+[#94468]: https://github.com/home-assistant/core/pull/94468
+
+{% enddetails %}
+
+{% details "Hyperion" %}
+
+The behavior of Hyperion lights has changed:
+
+Turning off the light entity will only clear the priority you have configured during the integration setup. Other Home Assistant independent light sources in Hyperion might still be active and cause light to be emitted. If you want to turn the light off entirely, regardless of active light sources, you can enable the `switch.[instance]_led_device` entity that acts as a global switch.
+
+External effects that are unrelated to the Hyperion light source (such as USB capture) have been removed from the light entity. To control them, enable the respective disabled-by-default switch entity.
+
+([@Sab44 ] - [#80478]) ([documentation](/integrations/hyperion))
+
+[@Sab44]: https://github.com/Sab44
+[#80478]: https://github.com/home-assistant/core/pull/80478
+
+{% enddetails %}
+
+{% details "MQTT" %}
+
+If the `initial` temperature, `min_temp`, or `max_temp` is not set, the default
+temperature will be converted to the set `temperature_unit` or system default
+temperature unit if this is not degrees Celsius.
+
+([@jbouwh] - [#93965]) ([documentation](/integrations/mqtt))
+
+[@jbouwh]: https://github.com/jbouwh
+[#93965]: https://github.com/home-assistant/core/pull/93965
+
+---
+
+The behavior of MQTT climate when `power_command_topic` is set has been changed:
+
+- The `hvac_mode` state attribute is no longer optimistically set if
+ `power_command_topic` is defined and `climate.turn_on` or `climate.turn_off`
+ is called.
+- When `hvac_mode` is changed, `payload_on` or `payload_off` messages will
+ not be published on the `power_command_topic`.
+
+This also means `power_command_topic` is no longer deprecated.
+
+([@jbouwh] - [#94832]) ([documentation](/integrations/mqtt))
+
+[@jbouwh]: https://github.com/jbouwh
+[#94832]: https://github.com/home-assistant/core/pull/94832
+
+{% enddetails %}
+
+{% details "MusicCast" %}
+
+The values for the `source` attribute have changed. We wanted to show more user
+friendly values for the `source` attribute, such as "Net Radio" instead
+of "net_radio".
+
+If you have any automation depending on the `source` state attribute of the
+media player entity, you will have to update these. Calling the `select_source`
+service will still be possible using the old source names.
+([@micha91] - [#74954]) ([documentation](/integrations/yamaha_musiccast))
+
+[@micha91]: https://github.com/micha91
+[#74954]: https://github.com/home-assistant/core/pull/74954
+
+{% enddetails %}
+
+{% details "SMHI" %}
+
+The attribute `cloudiness` has been replaced by the attribute `cloud_coverage`.
+Please update any automation or scripts that is using this attribute to use the
+newly added `cloud_coverage` attribute.
+
+([@gjohansson-ST] - [#95096]) ([documentation](/integrations/smhi))
+
+[@gjohansson-ST]: https://github.com/gjohansson-ST
+[#95096]: https://github.com/home-assistant/core/pull/95096
+
+{% enddetails %}
+
+{% details "Slack" %}
+
+The previously deprecated YAML configuration of the Slack
+integration has been removed.
+
+Slack is now configured via the UI. Any existing YAML
+configuration has been imported in previous releases and can now be safely
+removed from your YAML configuration files.
+
+([@gjohansson-ST] - [#94106]) ([documentation](/integrations/slack))
+
+[@gjohansson-ST]: https://github.com/gjohansson-ST
+[#94106]: https://github.com/home-assistant/core/pull/94106
+
+{% enddetails %}
+
+{% details "Xbox" %}
+
+The previously deprecated YAML configuration of the Xbox
+integration has been removed.
+
+Xbox is now configured via the UI. Any existing YAML
+configuration has been imported in previous releases and can now be safely
+removed from your YAML configuration files.
+
+([@gjohansson-ST] - [#94094]) ([documentation](/integrations/xbox))
+
+[@gjohansson-ST]: https://github.com/gjohansson-ST
+[#94094]: https://github.com/home-assistant/core/pull/94094
+
+{% enddetails %}
+
+{% details "Z-Wave" %}
+
+Fan speed percentage for Honeywell(JE/Jasco) 39358 and Enbrighten(GE/Jasco)
+55258 in wall fan controllers are now mapped to levels (low, medium, high).
+
+This may affect scripts or automatons setting fan speeds to specific percentages.
+
+([@jgrieger1] - [#92371]) ([documentation](/integrations/zwave_js))
+
+[@jgrieger1]: https://github.com/jgrieger1
+[#92371]: https://github.com/home-assistant/core/pull/92371
+
+{% enddetails %}
+
+If you are a custom integration developer and want to learn about breaking
+changes and new features available for your integration: Be sure to follow our
+[developer blog][devblog]. The following are the most notable for this release:
+
+- [Changes to entity naming](https://developers.home-assistant.io/blog/2023/06/28/entity-name-changes)
+- [Service Call API changes](https://developers.home-assistant.io/blog/2023/06/14/service-calls)
+- [Service call description filters](https://developers.home-assistant.io/blog/2023/06/28/service-description-filters)
+
+[devblog]: https://developers.home-assistant.io/blog/
+
+## Farewell to the following
+
+The following integrations are also no longer available as of this release:
+
+- **SenseME** has been removed. Big Ass Fans changed the protocol in a newer
+ firmware in April 2022. The [Big Ass Fans integration] can be used
+ as a replacement, after updating to the latest firmware.
+ ([@bdraco] - [#94363])
+
+[@bdraco]: https://github.com/bdraco
+[#94363]: https://github.com/home-assistant/core/pull/94363
+[Big Ass Fans integration]: /integrations/baf
+
+## All changes
+
+Of course, there is a lot more in this release. You can find a list of
+all changes made here: [Full changelog for Home Assistant Core 2023.7](/changelogs/core-2023.7)
diff --git a/source/_posts/2023-07-20-year-of-the-voice-chapter-3.markdown b/source/_posts/2023-07-20-year-of-the-voice-chapter-3.markdown
new file mode 100644
index 00000000000..80481024e43
--- /dev/null
+++ b/source/_posts/2023-07-20-year-of-the-voice-chapter-3.markdown
@@ -0,0 +1,204 @@
+---
+layout: post
+title: "Year of the Voice - Chapter 3: Ready when you are"
+description: "The full power of Assist on all of your Android devices."
+date: 2023-07-20 00:00:00
+date_formatted: "July 20, 2023"
+author: Mike Hansen
+comments: true
+categories: Assist
+og_image: /images/blog/2023-07-20-year-of-the-voice-chapter-3/social.png
+---
+
+
+Assist on Android is built-in to the Android app and uses the speech-to-text from Home Assistant
+
+Select a voice assistant from any of your configured Home Assistant instances
+
+Launch Assist from anywhere on Android without having to open the Home Assistant app
+
+Native Assist on Wear OS
+
+Configure your own sentences to trigger any action in the automation editor
+
+Test sentence understanding with the Assist developer tool
+
+
+
+With hardware like the $13 [ATOM Echo], it was possible in Chapter 2 to [create a push-to-talk voice Assistant using ESPHome].
+
+Using the latest ESPHome, you can push a button to start speaking and let Home Assistant detect the end of the voice command. Continuous mode is also available, allowing multiple conversation turns with Assist similar to an analog phone.
+
+```yaml
+voice_assistant:
+ microphone: ...
+ speaker: ...
+
+binary_sensor:
+ - platform: gpio
+ pin: ...
+ on_click:
+ - if:
+ condition: voice_assistant.is_running
+ then:
+ - voice_assistant.stop:
+ else:
+ - voice_assistant.start_continuous:
+```
+[ESPHome Voice Assistant documentation](https://esphome.io/components/voice_assistant.html#click-to-converse)
+
+### Silence detection
+
+ESPHome's new voice modes use Home Assistant to detect the end of each voice command. In your device's configuration, you can now adjust how much silence is needed with "Finished speaking detection":
+
+
+ESPHome Voice Assistant have two config entities to automate it's behavior in Home Assistant
+
If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at homeassistant:8123 or `http://X.X.X.X:8123` (replace X.X.X.X with your Raspberry Pi’s IP address).
@@ -79,11 +79,11 @@ With the Home Assistant Operating System installed and accessible, you can now c
Use this procedure if Raspberry Pi Imager is not supported by your platform.
1. Insert the SD card into the computer. Note: the contents of the card will be overwritten.
-1. Download and start Balena Etcher. You may need to run it with administrator privileges on Windows.
-1. Select **Flash from URL**.
+2. Download and start Balena Etcher. You may need to run it with administrator privileges on Windows.
+3. Select **Flash from URL**.
-1. Copy the correct URL for the Raspberry Pi 3 or 4 (Note: there are 2 different links below!):
+4. Copy the correct URL for the Raspberry Pi 3 or 4 (Note: there are 2 different links below!):
{% tabbed_block %}
{% for variant in site.installation.types[page.installation_type].variants %}
@@ -101,13 +101,13 @@ _Select and copy the URL or use the "copy" button that appear when you hover it.
1. Paste the URL for the image into Balena Etcher and select **OK**.
-1. When Balena Etcher has downloaded the image, select **Select target**.
+2. When Balena Etcher has downloaded the image, select **Select target**.
-1. Select the SD card you want to use for your installation.
+3. Select the SD card you want to use for your installation.
-1. Select **Flash!** to start writing the image.
+4. Select **Flash!** to start writing the image.
-1. Once Balena Etcher has finished writing the image, you will see a confirmation.
+5. Once Balena Etcher has finished writing the image, you will see a confirmation.
diff --git a/source/more-info/unhealthy/supervisor.markdown b/source/more-info/unhealthy/supervisor.markdown
index 36d0c4d225d..3de8e025565 100644
--- a/source/more-info/unhealthy/supervisor.markdown
+++ b/source/more-info/unhealthy/supervisor.markdown
@@ -9,7 +9,7 @@ This can happen when there was a network issue during the startup of the Supervi
## The solution
-Manually update the Supervisor. This can be done from the {% my configuration title="Configuration" %} panel. On the card for "Supervisor", there is a button to update the Supervisor.
+Manually update the Supervisor, in case there is an update pending. This can be done from the {% my updates %} panel.
This can also be done with the CLI, by running the following command:
```bash
diff --git a/source/skyconnect/index.html b/source/skyconnect/index.html
index ff003239a03..c7c76d27ceb 100644
--- a/source/skyconnect/index.html
+++ b/source/skyconnect/index.html
@@ -258,6 +258,21 @@ frontpage_image: /images/skyconnect/skyconnect-cover.png
+
+
+
+
+
+
+
+ 🇨🇿
+ ALZA
+ Located in the Czech Republic
+
diff --git a/source/tag/index.markdown b/source/tag/index.markdown
index a49fc99341e..3ea422058d2 100644
--- a/source/tag/index.markdown
+++ b/source/tag/index.markdown
@@ -11,8 +11,8 @@ You've reached this page because you navigated to an NFC, QR Code, or other URL-
If you arrived here after scanning a tag on iOS, and you have the [Home Assistant Companion App](https://companion.home-assistant.io) installed, you may need to activate Universal Links:
1. Long-press on [this link](https://www.home-assistant.io/tag/example_from_documentation)
-1. Choose "Open in 'Home Assistant'"
-1. Attempt to scan the tag again
+2. Choose "Open in 'Home Assistant'"
+3. Attempt to scan the tag again
If you do not have it, you must [install the iOS app](https://apps.apple.com/us/app/home-assistant/id1099568401?mt=8) for these tags to function.
@@ -21,8 +21,8 @@ If you do not have it, you must [install the iOS app](https://apps.apple.com/us/
If you arrived here after scanning a tag on Android, and you have the [Home Assistant Companion App](https://companion.home-assistant.io) installed, you may need to change the link settings.
1. Launch Settings and navigate to "Apps & Notifications", revealing the "Advanced" section if necessary
-1. Navigate to "Default apps" and then "Opening links"
-1. Open the "Home Assistant" settings and choose "Clear defaults"
-1. Attempt to scan the tag again, choosing to open in Home Assistant
+2. Navigate to "Default apps" and then "Opening links"
+3. Open the "Home Assistant" settings and choose "Clear defaults"
+4. Attempt to scan the tag again, choosing to open in Home Assistant
If you do not have it, you must [install the Android app](https://play.google.com/store/apps/details?id=io.homeassistant.companion.android) for these tags to function.
diff --git a/source/tos/index.markdown b/source/tos/index.markdown
index c1080767738..55e42aaf668 100644
--- a/source/tos/index.markdown
+++ b/source/tos/index.markdown
@@ -16,15 +16,15 @@ If you create an account on the Website, you are responsible for maintaining the
If you post material to the Website, post links on the Website, or otherwise make (or allow any third party to make) material available by means of the Website (any such material, "Content"), You are entirely responsible for the content of, and any harm resulting from, that Content. That is the case regardless of whether the Content in question constitutes text, graphics, an audio file, or computer software. By making Content available, you represent and warrant that:
-* the downloading, copying and use of the Content will not infringe the proprietary rights, including but not limited to the copyright, patent, trademark or trade secret rights, of any third party;
-* if your employer has rights to intellectual property you create, you have either (i) received permission from your employer to post or make available the Content, including but not limited to any software, or (ii) secured from your employer a waiver as to all rights in or to the Content;
-* you have fully complied with any third-party licenses relating to the Content, and have done all things necessary to successfully pass through to end users any required terms;
-* the Content does not contain or install any viruses, worms, malware, Trojan horses or other harmful or destructive content;
-* the Content is not spam, is not machine- or randomly-generated, and does not contain unethical or unwanted commercial content designed to drive traffic to third party sites or boost the search engine rankings of third party sites, or to further unlawful acts (such as phishing) or mislead recipients as to the source of the material (such as spoofing);
-* the Content is not pornographic, does not contain threats or incite violence, and does not violate the privacy or publicity rights of any third party;
-* your content is not getting advertised via unwanted electronic messages such as spam links on newsgroups, email lists, blogs and web sites, and similar unsolicited promotional methods;
-* your content is not named in a manner that misleads your readers into thinking that you are another person or company; and
-* you have, in the case of Content that includes computer code, accurately categorized and/or described the type, nature, uses and effects of the materials, whether requested to do so by Home Assistant or otherwise.
+- the downloading, copying and use of the Content will not infringe the proprietary rights, including but not limited to the copyright, patent, trademark or trade secret rights, of any third party;
+- if your employer has rights to intellectual property you create, you have either (i) received permission from your employer to post or make available the Content, including but not limited to any software, or (ii) secured from your employer a waiver as to all rights in or to the Content;
+- you have fully complied with any third-party licenses relating to the Content, and have done all things necessary to successfully pass through to end users any required terms;
+- the Content does not contain or install any viruses, worms, malware, Trojan horses or other harmful or destructive content;
+- the Content is not spam, is not machine- or randomly-generated, and does not contain unethical or unwanted commercial content designed to drive traffic to third party sites or boost the search engine rankings of third party sites, or to further unlawful acts (such as phishing) or mislead recipients as to the source of the material (such as spoofing);
+- the Content is not pornographic, does not contain threats or incite violence, and does not violate the privacy or publicity rights of any third party;
+- your content is not getting advertised via unwanted electronic messages such as spam links on newsgroups, email lists, blogs and web sites, and similar unsolicited promotional methods;
+- your content is not named in a manner that misleads your readers into thinking that you are another person or company; and
+- you have, in the case of Content that includes computer code, accurately categorized and/or described the type, nature, uses and effects of the materials, whether requested to do so by Home Assistant or otherwise.
## 3. User Content License
diff --git a/source/voice_control/android.markdown b/source/voice_control/android.markdown
index 8362020498b..f7fbe58bfda 100644
--- a/source/voice_control/android.markdown
+++ b/source/voice_control/android.markdown
@@ -2,27 +2,135 @@
title: "Assist on Android"
---
+## Assist on Android phones
+
+Assist is available on Android phones and tablets using the [Home Assistant Companion App](https://companion.home-assistant.io/docs/getting_started/) for Android.
+
+### Prerequisites
+
+- The devices you want to control with Assist are [exposed to Assist](/voice_control/voice_remote_expose_devices/)
+
+### Setting up Home Assistant Assist as default assistant app on an Android phone
+
+This section was written using an Android 13. Depending on your flavor of Android, the exact steps may vary.
+
+To define Home Assistant Assist as default assistant app, follow these steps:
+
+1. On the Android phone, go to **Settings** > **Apps** > **Default apps**.
+2. Under **Digital assistant app**, select **Default digital assistant app**.
+ - On some Android versions, this might be under **Digital & voice input** > **Default digital assistant app** > **Voice Assistant**.
+3. Select **Home Assistant**.
+ - On some Android versions, you might be able to change the assistants language settings here by selecting the cogwheel.
+4. Go back one step. The **Default digital assistant app** should now show *Home Assistant* as the default.
+5. Leave the **Settings**.
+6. Start Assist using the gesture to start an assistant. The gesture may differ depending on the version.
+ - Swipe from the bottom left corner.
+ - Long press the power button.
+ - Hold the home button (square button at the bottom).
+7. You can now also start Assist from your lock screen.
+ 
-Assist is our feature to allow you to control Home Assistant using natural language. It is built on top of an open voice foundation and powered by knowledge provided by our community.
+Assist is our feature to allow you to control Home Assistant using natural language. It is built on top of an open voice foundation and powered by knowledge provided by our community.
_Want to use Home Assistant with Google Assistant or Amazon Alexa? Get started with [Home Assistant Cloud](https://www.nabucasa.com/config/)._
@@ -16,12 +16,13 @@ Assist is available to use on most platforms that can interface with Home Assist
- Inside the Home Assistant app in the top-right corner
- On Apple devices via [Siri and Assist shortcuts](/voice_control/apple)
-- On Wear OS watches using [Assist tile](/voice_control/android)
+- On Android phones as the default digital assistant or home screen shortcut
+- On Wear OS watches as the default digital assistant or using [Assist tile or complication](/voice_control/android)
Did Assist not understand your sentence? [Contribute them.](https://developers.home-assistant.io/docs/voice/intent-recognition/)
The Assist icon doesn't show up? Make sure the [conversation](/integrations/conversation/) integration is enabled. If you use YAML for configuration and have removed `default_config:`, the conversation integration may not be included in the config file.
-
+
_Assist was introduced in Home Assistant 2023.2._