+
+
+
\ No newline at end of file
diff --git a/source/_integrations/enigma2.markdown b/source/_integrations/enigma2.markdown
index e917968c9f9..6460dff7f6c 100644
--- a/source/_integrations/enigma2.markdown
+++ b/source/_integrations/enigma2.markdown
@@ -14,8 +14,84 @@ ha_platforms:
ha_integration_type: device
---
-The `enigma2` platform allows you to control a Linux based set-top box which is running [Enigma2](https://github.com/oe-alliance/oe-alliance-enigma2) with the OpenWebif plugin installed.
+The **Enigma2** {% term integration %} allows you to control a Linux based set-top box which is running [Enigma2](https://github.com/oe-alliance/oe-alliance-enigma2) with the OpenWebif plugin installed.
-[OpenWebif](https://github.com/E2OpenPlugins/e2openplugin-OpenWebif) is an open source web interface for Enigma2 based set-top boxes.
+[OpenWebif](https://github.com/E2OpenPlugins/e2openplugin-OpenWebif) is an open-source web interface for Enigma2 based set-top boxes.
+
+### Prerequisites
+
+Your device needs to have the OpenWebif plugin installed. On most devices it is installed by default, if not, it is available via the Plugins menu within your Enigma2 distribution.
+
+Please beware that the OpenWebif setting "Require client cert for HTTPS" is not supported.
{% include integrations/config_flow.md %}
+
+{% configuration_basic %}
+Host:
+ description: "The IP address or hostname of your device."
+Port:
+ description: "The port number of the OpenWebif service running. (default: 80)."
+Username:
+ description: "The username, if HTTP(S) authentication is enabled."
+Password:
+ description: "The password, if HTTP(S) authentication is enabled."
+Uses an SSL certificate:
+ description: "Whether HTTPS is enabled."
+Verify SSL certificate:
+ description: "Whether the SSL certificate should be verified."
+{% endconfiguration_basic %}
+
+## Configuration options
+
+The integration provides the following configuration options:
+
+{% configuration_basic %}
+Turn off to deep standby:
+ description: "Shuts the device down (called Deep Standby) on turning off the device. **Important**: When the device is in *Deep Standby*, it can no longer be reached! Turning on the device is only possible via one of the following methods: Wake on LAN, Power button on the device, or the Remote control."
+Bouquet to use as media source:
+ description: "Sets the bouquet to use for the source list."
+{% endconfiguration_basic %}
+
+## Entities
+
+Currently, the following entity is exposed:
+
+### Media player
+
+The following actions are supported:
+
+- Play/Pause
+- Channel up and down (using the previous/next track buttons in the media player controls)
+- Volume control
+- Channel switching via source list
+
+The bouquet for the source list can be configured via the Configuration options.
+
+## Data updates
+
+This integration fetches data from the device every 15 seconds by default.
+
+## Troubleshooting
+
+### Getting a 403.6 IP address rejected error on setup
+
+#### Description
+
+OpenWebif has a protection by default, so that only devices in the same subnet can connect to the device.
+
+#### Resolution
+
+There are two possible solutions to resolve this problem:
+
+- Enable HTTP(S) authentication (recommended for security)
+- Enable the OpenWebif setting "Enable access from VPNs"
+
+{% note %}
+If you choose to enable VPN access without authentication, ensure your network is properly secured as OpenWebif is not designed for publicly facing the internet.
+{% endnote %}
+
+## Remove integration
+
+This integration follows standard integration removal, no extra steps are required.
+
+{% include integrations/remove_device_service.md %}
diff --git a/source/_integrations/google_travel_time.markdown b/source/_integrations/google_travel_time.markdown
index 0d844ccd1fb..e7b798ca2b9 100644
--- a/source/_integrations/google_travel_time.markdown
+++ b/source/_integrations/google_travel_time.markdown
@@ -24,6 +24,8 @@ You need to register for an API key by following the instructions [here](https:/
A quota can be set against the API to avoid exceeding the free credit amount. Set the 'Elements per day' to a limit of 645 or less. Details on how to configure a quota can be found [here](https://developers.google.com/maps/documentation/distance-matrix/usage-and-billing#set-caps)
+**Starting March 2025** Google will change the pricing scheme from the US$200 per month credit to 10,000 free requests. You should adjust your limit to 322 or less. You can find more information on the pricing changes in the [Google developer documentation](https://developers.google.com/maps/billing-and-pricing/faq#pricing-sheet).
+
{% include integrations/config_flow.md %}
Notes:
diff --git a/source/_integrations/mqtt.markdown b/source/_integrations/mqtt.markdown
index 09bb23b667a..d7894cd04db 100644
--- a/source/_integrations/mqtt.markdown
+++ b/source/_integrations/mqtt.markdown
@@ -368,12 +368,12 @@ The component specific options are placed as mappings under the `components` key
"mdl": "xya",
"sw": "1.0",
"sn": "ea334450945afc",
- "hw": "1.0rev2",
+ "hw": "1.0rev2"
},
"o": {
"name":"bla2mqtt",
"sw": "2.1",
- "url": "https://bla2mqtt.example.com/support",
+ "url": "https://bla2mqtt.example.com/support"
},
"cmps": {
"some_unique_component_id1": {
@@ -381,18 +381,18 @@ The component specific options are placed as mappings under the `components` key
"device_class":"temperature",
"unit_of_measurement":"°C",
"value_template":"{% raw %}{{ value_json.temperature}}{% endraw %}",
- "unique_id":"temp01ae_t",
+ "unique_id":"temp01ae_t"
},
"some_unique_id2": {
"p": "sensor",
"device_class":"humidity",
"unit_of_measurement":"%",
"value_template":"{% raw %}{{ value_json.humidity}}{% endraw %}",
- "unique_id":"temp01ae_h",
+ "unique_id":"temp01ae_h"
}
},
"state_topic":"sensorBedroom/state",
- "qos": 2,
+ "qos": 2
}
```
@@ -411,12 +411,12 @@ An empty config can be published as an update to remove a single component from
"mdl": "xya",
"sw": "1.0",
"sn": "ea334450945afc",
- "hw": "1.0rev2",
+ "hw": "1.0rev2"
},
"o": {
"name":"bla2mqtt",
"sw": "2.1",
- "url": "https://bla2mqtt.example.com/support",
+ "url": "https://bla2mqtt.example.com/support"
},
"cmps": {
"some_unique_component_id1": {
@@ -424,14 +424,14 @@ An empty config can be published as an update to remove a single component from
"device_class":"temperature",
"unit_of_measurement":"°C",
"value_template":"{% raw %}{{ value_json.temperature}}{% endraw %}",
- "unique_id":"temp01ae_t",
+ "unique_id":"temp01ae_t"
},
"some_unique_id2": {
- "p": "sensor",
+ "p": "sensor"
}
},
"state_topic":"sensorBedroom/state",
- "qos": 2,
+ "qos": 2
}
```
@@ -448,12 +448,12 @@ After removing a component, you should send another update with the removed comp
"mdl": "xya",
"sw": "1.0",
"sn": "ea334450945afc",
- "hw": "1.0rev2",
+ "hw": "1.0rev2"
},
"o": {
"name":"bla2mqtt",
"sw": "2.1",
- "url": "https://bla2mqtt.example.com/support",
+ "url": "https://bla2mqtt.example.com/support"
},
"cmps": {
"some_unique_component_id1": {
@@ -461,11 +461,11 @@ After removing a component, you should send another update with the removed comp
"device_class":"temperature",
"unit_of_measurement":"°C",
"value_template":"{% raw %}{{ value_json.temperature}}{% endraw %}",
- "unique_id":"temp01ae_t",
+ "unique_id":"temp01ae_t"
}
},
"state_topic":"sensorBedroom/state",
- "qos": 2,
+ "qos": 2
}
```
@@ -583,7 +583,7 @@ Discovery payload device:
"state_topic": "foobar/sensor/sensor1",
"unique_id": "bla_sensor001"
}
- },
+ }
}
```
@@ -626,19 +626,19 @@ Example discovery payload:
"mdl": "xya",
"sw": "1.0",
"sn": "ea334450945afc",
- "hw": "1.0rev2",
+ "hw": "1.0rev2"
},
"o": {
"name":"bla2mqtt",
"sw": "2.1",
- "url": "https://bla2mqtt.example.com/support",
+ "url": "https://bla2mqtt.example.com/support"
},
"device_class":"temperature",
"unit_of_measurement":"°C",
"value_template":"{% raw %}{{ value_json.temperature}}{% endraw %}",
"unique_id":"temp01ae_t",
"state_topic":"sensorBedroom/state",
- "qos": 2,
+ "qos": 2
}
```
@@ -1297,12 +1297,12 @@ Setting up a [light that takes JSON payloads](/integrations/light.mqtt/#json-sch
"mdl_id": "ABC123",
"sw": "1.0",
"sn": "ea334450945afc",
- "hw": "1.0rev2",
+ "hw": "1.0rev2"
},
"o": {
"name":"bla2mqtt",
"sw": "2.1",
- "url": "https://bla2mqtt.example.com/support",
+ "url": "https://bla2mqtt.example.com/support"
}
}
```
diff --git a/source/_integrations/nest.markdown b/source/_integrations/nest.markdown
index 02dbd94583f..5f5992f5748 100644
--- a/source/_integrations/nest.markdown
+++ b/source/_integrations/nest.markdown
@@ -38,15 +38,11 @@ Cameras and doorbells use [Automation and device triggers](#automation-and-devic
You are in control of the information and capabilities exposed to Home Assistant. You can authorize a single device, multiple devices, or different levels of functionality such as motion events, live streams, for any particular device. The integration is flexible enough to adapt based on what you allow.
-{% caution %}
-The Nest Smart Device Management (SDM) API **requires a US$5 fee**. Before buying, make sure your device is [supported](https://developers.google.com/nest/device-access/supported-devices).
-{% endcaution %}
+# Prerequisites
-{% note %}
-The Google Nest integration uses a Cloud Pub/Sub subscription with a 15-minute retention period by default. The Google Cloud Pub/Sub billing changes, effective June 30, 2024, do not apply. The billing changes only apply to subscriptions with a 24-hour retention period. See the [Pub/Sub console](https://console.cloud.google.com/cloudpubsub/subscription/list) to view your subscriptions if you previously created one manually.
-{% endnote %}
+- The Nest Device Access Console Pub/Sub setup process has changed as of January 23rd 2025. **Please make sure you are using the latest version of Home Assistant.**
-
+- The Nest Smart Device Management (SDM) API **requires a US$5 fee**. Before buying, make sure your device is [supported](https://developers.google.com/nest/device-access/supported-devices).
## Configuration
@@ -163,24 +159,78 @@ Now that you have authentication configured, you will create a Nest Device Acces
Read the warnings on the page before proceeding, including Google Account type limitations.
{% endnote %}
-1. Click on the button **[Go to the Device Access Console](https://console.nest.google.com/device-access/)**.
+2. Select the button **[Go to the Device Access Console](https://console.nest.google.com/device-access/)**.

-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).
+3. Check the box to "Accept the Terms of Service" and select **Continue to Payment** where you need to pay a fee (currently US$5).

-3. Now the [Device Access Console](https://console.nest.google.com/device-access/project-list) should be visible. Click on **Create project**.
+4. Now the [Device Access Console](https://console.nest.google.com/device-access/project-list) should be visible. Select **Create project**.
-4. Give your Device Access project a name and click **Next**.
+5. Give your Device Access project a name and select **Next**.

-5. Next you will be asked for an *OAuth client ID* which you created in the previous step and click **Next**.
+6. Next you will be asked for an **OAuth client ID** which you created in the previous step and select **Next**.

-6. Enable Events by clicking on **Enable** and **Create project**.
- 
+7. Leave **Enable Events** unchecked for now and **Create project**. You need a Pub/Sub topic
+ (created in the next section) to enable events. This requires additional setup in the
+ Google Cloud Pub/Sub console so we will skip that step for now then come back to it in
+ the next section.
-7. You now have a *Device Access Project ID* needed by Home Assistant.
+8. You now have a *Device Access Project ID* needed by Home Assistant.
+
+{% enddetails %}
+
+{% details "Enable events and Pub/Sub topic [Device Access & Cloud Console]" %}
+
+The Nest Device Access Console Pub/Sub setup process has changed as of January 23rd 2025. **Please make sure you are using the latest version of Home Assistant.**.
+
+This section describes how to configure your Device Access Project with a Pub/Sub topic
+to publish events for devices in your home. Home Assistant and the Device Access Project must be configured to use the *Topic Name* otherwise you will not receive events.
+
+If you previously set up events, then your Device Access Project may have already created a topic for you and you can use that topic name. For new projects, or if you disable events, you need to create the topic yourself following the instructions below.
+
+1. Go to the [Pub/Sub Google Cloud Console](https://console.cloud.google.com/cloudpubsub/topic/list).
+
+2. Select **Create Topic**.
+
+3. Enter a **Topic ID** such as `home-assistant-nest`. You may leave the default settings.
+
+ 
+
+4. Select **Create** to create the topic.
+
+5. You now have a **Topic Name** needed by the Device Access Console and Home Assistant. The full **Topic Name** that contains your Cloud Project ID and the **Topic ID** such as `projects//topics/home-assistant-nest`.
+
+6. Next, you need to give the Device Access Console permission to publish to your Topic. From the Pub/Sub Topic page select **Add Principal**.
+
+ 
+
+7. In **New Principals** enter `sdm-publisher@googlegroups.com`
+
+8. In **Select a Role** under **Pub/Sub** select **Pub/Sub Publisher** and **Create**.
+
+ 
+
+9. Next you can configure the Device Access Console to use this topic. Visit the [Device Access Console](https://console.nest.google.com/device-access/).
+
+10. Select the Device Access Project you previously created. It should show the Pub/Sub topic
+ as disabled. If there is an existing topic shown, then you may delete it and use
+ the one you just created to avoid getting them mixed up.
+
+ 
+
+11. Select *...* next to **Pub/Sub topic**, then **Enable events with PubSub topic**.
+
+12. Enter the full Pub/Sub **Topic Name** and select **Add & Validate**. If you see an error, then
+ review the previous steps again and configure the topic and permissions.
+
+ 
+
+13. You have successfully configured events and the Pub/Sub topic used by Home Assistant.
+
+ 
{% enddetails %}
@@ -190,9 +240,6 @@ In this section you will authorize Home Assistant to access your account by gene
See [Troubleshooting](#troubleshooting) below for steps to resolve the common misconfigurations that result in errors such as *Can't link...* or *Error 400* from Google.
-Note that *OAuth for Apps* has been [deprecated](https://developers.googleblog.com/2022/02/making-oauth-flows-safer.html) by Google and will break by October 2022.
-
-
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.
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.
@@ -216,7 +263,19 @@ Note that *OAuth for Apps* has been [deprecated](https://developers.googleblog.c
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.
-9. If all went well, you are ready to go!
+9. If all went well, you will next configure events and Pub/Sub topic. Nest will attempt
+ to automatically find a Pub/sub topic either created by the Device Access Console
+ or manually by you.
+
+ 
+
+10. If you instead see the error message *No eligible Pub/Sub topics found, please ensure Device Access Console has a Pub/Sub topic.* then follow the steps in the previous section to enable events and create a Pub/Sub topic in another browser tab. Once you have created and configured the topic, you may press on this screen **Submit** to refresh the list of topics and continue.
+
+11. Home Assistant uses a *Subscription* to subscribe to device events published on the topic. You can select the subscription you created in the Device Access Console or the integration will automatically create one for you if you don't have one already.
+ 
+
+
+12. If all went well, you are ready to go!

@@ -465,56 +524,6 @@ This feature is enabled by the following permissions:
{% endnote %}
-## Deprecated App Auth Credentials
-
-To improve security and reduce phishing risk Google has [deprecated](https://developers.googleblog.com/2022/02/making-oauth-flows-safer.html) a previous authentication method used by Home Assistant. **This requires action by you to resolve** if you previously configured *Nest* using *App Auth*.
-
-{% details "Reconfigure the integration" %}
-
-1. Make sure to upgrade to the latest version of Home Assistant.
-2. Go to **{% my integrations title="Settings > Devices & services" %}**.
-3. The **Nest** integration should appear with alert.
-
- 
-
-4. Click **Reconfigure**.
-
- 
-
-
-If the *Nest* integration does not have an Alert then you probably used *Web Auth* and have nothing to do.
-
-{% enddetails %}
-
-{% 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.
-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/)
-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 %}
-
-Once you have completed the above steps, you can continue through the flow to re-authorize *Home Assistant* to restore access to your Nest Devices.
-
## Troubleshooting
- *No access to partner information* "Information could not be retrieved" error message during the setup wizard means that the Google Account used is not able to access the Home. Please ensure that you have successfully migrated your Nest Account to a Google Account using the Google Nest App. Additionally, if your home has multiple members, please note that the individual who initially set up the home must complete the migration of their Nest Account to a Google Account before you can establish a connection with Home Assistant.
diff --git a/source/_integrations/plugwise.markdown b/source/_integrations/plugwise.markdown
index 67bcd9ff75d..3f209efb304 100644
--- a/source/_integrations/plugwise.markdown
+++ b/source/_integrations/plugwise.markdown
@@ -14,7 +14,6 @@ ha_release: 0.98
ha_codeowners:
- '@CoMPaTech'
- '@bouwew'
- - '@frenck'
ha_config_flow: true
ha_domain: plugwise
ha_zeroconf: true
@@ -28,6 +27,7 @@ ha_platforms:
- sensor
- switch
ha_integration_type: hub
+ha_quality_scale: platinum
---
[Plugwise](https://www.plugwise.com) provides smart home devices that allow you to monitor and control your climate, energy (including gas) consumption, and energy production. The energy information can be used for the [energy dashboard](/home-energy-management).
diff --git a/source/_integrations/ring.markdown b/source/_integrations/ring.markdown
index 84a978fdc41..8b4dd8bba3e 100644
--- a/source/_integrations/ring.markdown
+++ b/source/_integrations/ring.markdown
@@ -1,6 +1,6 @@
---
title: Ring
-description: Instructions on how to integrate your Ring.com devices within Home Assistant.
+description: Instructions on integrating Ring.com devices with Home Assistant.
ha_category:
- Binary sensor
- Button
@@ -32,36 +32,56 @@ ha_codeowners:
- '@sdb9696'
---
-The Ring integration allows you to integrate your [Ring.com](https://ring.com/) devices in Home Assistant. Due to recent authentication changes of Ring, you will need to run at least Home Assistant 0.104.
+The Ring integration allows you to control your [Ring.com](https://ring.com/) doorbell, stick up cam, chime, and intercom devices in Home Assistant.
-There is currently support for the following device types within Home Assistant:
+## How you can use this integration
-- [Binary sensor](#binary-sensor)
-- [Button](#button)
-- [Camera](#camera)
- - [Saving the videos captured by your Ring Door Bell](#saving-the-videos-captured-by-your-ring-door-bell)
-- [Event](#event)
- - [Realtime event stability](#realtime-event-stability)
-- [Sensor](#sensor)
-- [Siren](#siren)
-- [Switch](#switch)
-- [Light](#light)
-- [Number](#number)
+The Ring integration lets you do many things, such as switching devices on and off based on schedules or events, viewing live camera feeds, and controlling device configurations manually or via automations.
+## Prerequisites
+
+You need to provision your newly purchased devices via the Ring application, which will require creating a Ring account at [Ring.com](https://ring.com/) or via the official application.
+After that, you will use your Ring account credentials to log on to the Ring cloud in Home Assistant.
{% include integrations/config_flow.md %}
-## Binary sensor
+{% configuration_basic %}
+
+Username:
+ description: |
+ Your Ring account username.
+Password:
+ description: |
+ Your Ring account password.
+2fa:
+ description: |
+ Account verification code via the method selected in your Ring account settings.
+
+{% endconfiguration_basic %}
+
+## Supported devices
+
+There is currently support for the following device types within Home Assistant:
+
+- **Doorbells**: Doorbell, Doorbell 2, Doorbell 3, Doorbell 3 Plus, Doorbell 4, Doorbell Pro, Doorbell Pro 2, Doorbell Elite, Doorbell Wired, Battery Doorbell, Doorbell (2nd Gen), Peephole Cam
+- **Stickup cams**: Floodlight Cam, Floodlight Cam Pro, Floodlight Cam Plus, Indoor Cam, Indoor Cam (2nd Gen), Spotlight Cam Battery, Spotlight Cam Wired, Spotlight Cam Plus, Spotlight Cam Pro, Stick Up Cam, Stick Up Battery, Stick Up Wired, Stick Up Cam (3rd Gen)
+- **Chimes**: Chime, Chime Pro
+- **Intercoms**: Intercom
+
+
+## Supported functionality
+
+### Binary sensor
The binary sensor switches off and on when motion, doorbell rings, and intercom unlock events occur.
The binary sensor is being replaced with the event entity, and you should migrate any automations to the event entity by release 2025.4.0.
-## Button
+### Button
Once you have enabled the [Ring integration](/integrations/ring), you can start using the button platform. Currently, it supports intercom to open the door.
-## Camera
+### Camera
Once you have enabled the [Ring integration](/integrations/ring), you can start using the camera platform.
Currently, it supports doorbells and stickup cameras.
@@ -72,6 +92,134 @@ Two camera entities are provided: `live_view` and `last_recording`.
Please note that downloading and playing Ring video from the `last_recording` camera will require a Ring Protect plan.
{% endimportant %}
+### Event
+
+The event entity captures events like doorbell rings, motion alerts, and intercom unlocking.
+
+### Sensor
+
+Once you have enabled the [Ring integration](/integrations/ring), you can start using the sensor platform. Currently, it supports battery level and Wi-Fi signal.
+
+The volume sensors are being replaced with the number entity, which allows setting the volume. You should migrate any automations using the volume sensors to the number entity by release 2025.4.0.
+
+### Siren
+
+- Adds a siren entity for every camera that supports a siren. Note the siren will only turn on for 30 seconds before automatically turning off.
+- Adds a siren entity for chimes to play the test sound.
+
+### Switch
+
+Once you have enabled the [Ring integration](/integrations/ring), you can start using the switch platform.
+
+- Motion detection - Switches motion detection on and off for cameras.
+- In-home chime - Switches on and off a mechanical or digital chime connected to a ring doorbell.
+
+### Light
+
+Once you have enabled the [Ring integration](/integrations/ring), you can start using the light platform. This will add a light for every camera that supports a light (such as a floodlight).
+
+### Number
+
+Once you have enabled the [Ring integration](/integrations/ring), you can start using the number platform.
+Currently, it supports showing and setting the volume of the doorbell/chime ring, intercom voice volume, and intercom microphone volume.
+
+## Data updates
+
+The Ring cloud API is {% term polling polled %} for data updates every 60 seconds. When you make changes through Home Assistant (for example by switching motion detection on), the device's state is updated immediately rather than waiting for the next {% term polling poll %}.
+The Ring integration does not connect locally to devices, all communication goes via the cloud.
+
+## Known limitations
+
+### Two-way audio
+
+Two-way audio in camera live view is not currently supported.
+
+### Last recording
+
+To view the last recording entity you will need a Ring subscription.
+
+### Multiple alerts
+
+Some device models send two alerts for a single doorbell ring event.
+The integration will provide a workaround for this in a future release.
+
+## Troubleshooting
+
+### Realtime event stability
+
+Home Assistant requires outbound TCP access to port 5228 to connect to Ring's real-time event service.
+Ensure your firewall and network configuration allow this connection.
+
+Below are steps to follow if realtime events are not working.
+
+#### Step 1
+
+Issues with Ring alerts may be caused by having too many authenticated devices on your Ring account. Before version 2023.12.0, the Home Assistant Ring integration would register a new entry in `Authorized Client Devices` in the `Control Center` at [ring.com](https://account.ring.com/account/control-center/authorized-devices) on every restart.
+
+{% important %}
+When cleaning up devices:
+
+1. Only delete entries that start with `ring-doorbell:HomeAssistant` or `Python`.
+2. Do NOT delete entries for your phones or other Ring apps.
+3. If there are too many devices to delete individually, you can use the **Remove all devices** option, but you'll need to re-authorize all your devices afterward.
+
+{% endimportant %}
+
+#### Step 2
+
+If you're still experiencing issues after Step 1, try generating a new unique ID for the Home Assistant Ring integration instance.
+To do this, select the three dots {% icon "mdi:dots-vertical" %} menu on the integration entry and select the **Reconfigure** option.
+Do not try this step before clearing down all the excess `Authorized Client Devices` as per Step 1, or it will simply invalidate the reconfigured entry.
+
+#### Step 3
+
+If alerts are still not working after Steps 1 and 2, try toggling the Motion Warning setting:
+
+1. Go to [ring.com](https://ring.com) and sign in.
+2. Select your device.
+3. Navigate to **Device Settings**.
+4. Find the **Motion Warning** toggle.
+5. Turn it off and wait for 30 seconds.
+6. Turn it back on.
+
+This has successfully restored alerts for many users.
+
+## Examples
+
+### Automation ideas
+
+- Turn on motion detection for internal cameras when you leave home (with geofencing) and turn off when you get home.
+- Start a live feed on a device when the doorbell rings.
+- Turn up the volume on a digital chime when you are in the garden.
+
+### Setting up doorbell alerts
+
+You can set an automation up in the Home Assistant UI.
+
+1. Find the correct **event** entity under **Entity triggers**.
+2. For **From** choose the setting **Any state (ignoring attribute changes)**.
+3. Then add a **Send notification** action under **Notifications**.
+
+This will result in yaml similar to the following:
+
+```yaml
+alias: Doorbell alerts
+description: ""
+triggers:
+ - trigger: state
+ entity_id:
+ - event.front_door_ding
+ from: null
+conditions: []
+actions:
+ - device_id: internalhadeviceid
+ domain: mobile_app
+ type: notify
+ message: Front door ding
+ title: Front door ding
+mode: single
+```
+
### Saving the videos captured by your Ring Door Bell
You can save locally the latest video captured by your Ring Door Bell using the [downloader](/integrations/downloader) along with either an [automation](/integrations/automation) or [python_script](/integrations/python_script).
@@ -148,69 +296,8 @@ data = {
hass.services.call("downloader", "download_file", data)
```
-## Event
+## Removing the integration
-The event entity captures events like doorbell rings, motion alerts, and intercom unlocking.
+This integration follows standard integration removal. No extra steps are required.
-### Realtime event stability
-
-Home Assistant requires outbound TCP access to port 5228 to connect to Ring's real-time event service.
-Ensure your firewall and network configuration allow this connection.
-
-Below are steps to follow if realtime events are not working.
-
-#### Step 1
-
-Issues with Ring alerts may be caused by having too many authenticated devices on your Ring account. Before version 2023.12.0, the Home Assistant Ring integration would register a new entry in `Authorized Client Devices` in the `Control Center` at [ring.com](https://account.ring.com/account/control-center/authorized-devices) on every restart.
-{% warning %}
-When cleaning up devices:
-1. Only delete entries that start with `ring-doorbell:HomeAssistant` or `Python`
-2. Do NOT delete entries for your phones or other Ring apps
-3. If there are too many devices to delete individually, you can use the `Remove all devices` option, but you'll need to re-authorize all your devices afterward
-{% endwarning %}
-
-#### Step 2
-
-If you're still experiencing issues after Step 1, try generating a new unique ID for the Home Assistant Ring integration instance.
-To do this, click the three-dot menu on the integration entry and select the `Reconfigure` option.
-Do not try this step before clearing down all the excess `Authorized Client Devices` as per Step 1, or it will simply invalidate the reconfigured entry.
-
-#### Step 3
-
-If alerts are still not working after Steps 1 and 2, try toggling the Motion Warning setting:
-
-1. Go to [ring.com](https://ring.com) and sign in
-2. Select your device
-3. Navigate to Device Settings
-4. Find the Motion Warning toggle
-5. Turn it off, wait 30 seconds
-6. Turn it back on
-
-This has successfully restored alerts for many users.
-
-## Sensor
-
-Once you have enabled the [Ring integration](/integrations/ring), you can start using the sensor platform. Currently, it supports battery level and Wi-Fi signal.
-
-The volume sensors are being replaced with the number entity which allows setting the volume. You should migrate any automations using the volume sensors to the number entity by release 2025.4.0.
-
-## Siren
-
-- Adds a siren entity for every camera that supports a siren. Note the siren will only turn on for 30 seconds before automatically turning off.
-- Adds a siren entity for chimes to play the test sound.
-
-## Switch
-
-Once you have enabled the [Ring integration](/integrations/ring), you can start using the switch platform.
-
-- Motion detection - Switches motion detection on and off for cameras.
-- In-home chime - Switches on and off a mechanical or digital chime connected to a ring doorbell.
-
-## Light
-
-Once you have enabled the [Ring integration](/integrations/ring), you can start using the light platform. This will add a light for every camera that supports a light (such as a floodlight).
-
-## Number
-
-Once you have enabled the [Ring integration](/integrations/ring), you can start using the number platform.
-Currently, it supports showing and setting the volume of the doorbell/chime ring, intercom voice volume, and intercom microphone volume.
+{% include integrations/remove_device_service.md %}
diff --git a/source/_integrations/template.markdown b/source/_integrations/template.markdown
index 67be19f7cb5..b69c87a2b32 100644
--- a/source/_integrations/template.markdown
+++ b/source/_integrations/template.markdown
@@ -137,15 +137,15 @@ unique_id:
required: false
type: string
condition:
- description: Define conditions that have to be met after a trigger fires and before any actions are executed or sensor updates are performed. Optional. [See condition documentation](/docs/automation/condition).
+ description: Define conditions that have to be met after a trigger fires and before any actions are executed or sensor updates are performed (for trigger-based entities only). Optional. [See condition documentation](/docs/automation/condition).
required: false
type: list
action:
- description: Define actions to be executed when the trigger fires. Optional. Variables set by the action script are available when evaluating entity templates. This can be used to interact with anything using actions, in particular actions with [response data](/docs/scripts/perform-actions#use-templates-to-handle-response-data). [See action documentation](/docs/automation/action).
+ description: Define actions to be executed when the trigger fires (for trigger-based entities only). Optional. Variables set by the action script are available when evaluating entity templates. This can be used to interact with anything using actions, in particular actions with [response data](/docs/scripts/perform-actions#use-templates-to-handle-response-data). [See action documentation](/docs/automation/action).
required: false
type: list
variables:
- description: Key-value pairs of variable definitions which can be referenced and used in the templates below. Mostly used by blueprints.
+ description: Key-value pairs of variable definitions which can be referenced and used in the templates below (for trigger-based entities only). Mostly used by blueprints.
required: false
type: map
keys:
diff --git a/source/connectzbt1/index.html b/source/connectzbt1/index.html
index 0f2deb3cf03..3c755d55c99 100644
--- a/source/connectzbt1/index.html
+++ b/source/connectzbt1/index.html
@@ -102,7 +102,7 @@ frontpage_image: /images/frontpage/feature-zbt1.jpg
-