From f10362d126d89b915c74a8c7ba4d7e9f364d69c3 Mon Sep 17 00:00:00 2001 From: Maciej Bieniek Date: Tue, 4 Feb 2025 08:22:29 +0100 Subject: [PATCH] Add information about Shelly BLU TRV and Gen4 devices (#37279) * Add information about Gen4 devices and BLU TRV * Wording * Typo * Wording * Apply coderabbit suggestions --- source/_integrations/shelly.markdown | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/source/_integrations/shelly.markdown b/source/_integrations/shelly.markdown index 6ada2d20a97..4f601660591 100644 --- a/source/_integrations/shelly.markdown +++ b/source/_integrations/shelly.markdown @@ -51,7 +51,9 @@ Integrate [Shelly devices](https://shelly.com) into Home Assistant. ## Shelly device generations -There are three generations of devices and all generations are supported by this integration. There are some differences in how devices should be configured and in the naming of entities and devices between generations. +There are four generations of devices and all generations are supported by this integration. There are some differences in how devices should be configured and in the naming of entities and devices between generations. + +Shelly BLU series devices (e.g. Shelly BLU H&T) are not supported; please use BTHome integration to configure such devices with Home Assistant. The exception to this is Shelly BLU TRV, which is supported by this integration via Shelly BLU Gateway Gen3. ## Shelly device configuration (generation 1) @@ -70,9 +72,9 @@ The list below will help you diagnose and fix the problem: - The missing push updates may be related to the WiFi network range. If using a WiFi network with several access points, enable **Internet & Security** >> **WiFi Client AP Roaming** option. Consider moving Shelly device closer to the WiFi access point. Consider adding another WiFi access point, which will improve the connection quality with the device. - If you think your Shelly devices are working correctly and don't want to change your network/configuration, you can ignore the repair issue. Still, you must know you are giving up the best experience of using first-generation Shelly devices with Home Assistant. -## Shelly device configuration (generation 2 and 3) +## Shelly device configuration (generation 2+) -Generation 2 and 3 devices use the `RPC` protocol to communicate with the integration. **Battery-operated devices** (even if USB connected) may need manual outbound WebSocket configuration if Home Assistant cannot correctly determine your instance's internal URL or the outbound WebSocket was previously configured for a different Home Assistant instance. In this case, navigate to the local IP address of your Shelly device, **Settings** >> **Connectivity** >> **Outbound WebSocket** and check the box **Enable Outbound WebSocket**, under server enter the following address: +Generation 2+ devices use the `RPC` protocol to communicate with the integration. **Battery-operated devices** (even if USB connected) may need manual outbound WebSocket configuration if Home Assistant cannot correctly determine your instance's internal URL or the outbound WebSocket was previously configured for a different Home Assistant instance. In this case, navigate to the local IP address of your Shelly device, **Settings** >> **Connectivity** >> **Outbound WebSocket** and check the box **Enable Outbound WebSocket**, under server enter the following address: `ws://` + `Home_Assistant_local_ip_address:Port` + `/api/shelly/ws` (for example: `ws://192.168.1.100:8123/api/shelly/ws`), click **Apply** to save the settings. In case your installation is set up to use SSL encryption (HTTP**S** with certificate), an additional `s` needs to be added to the WebSocket protocol, too, so that it reads `wss://` (for example: `wss://192.168.1.100:8123/api/shelly/ws`). @@ -83,13 +85,13 @@ Integration is communicating directly with the device; cloud connection is not n ## Bluetooth Support -Shelly generation 2 and 3 devices not battery-powered can act as a Bluetooth proxy for advertisements. Active or passive listening can be enabled in the options flow. +Shelly generation 2+ devices not battery-powered can act as a Bluetooth proxy for advertisements. Active or passive listening can be enabled in the options flow. {% include integrations/option_flow.md %} ## Range Extender Support -Shelly generation 2 and 3 devices that are not battery-powered can act as a Range Extender. +Shelly generation 2+ devices that are not battery-powered can act as a Range Extender. Devices of the same generations can be configured via those Range Extenders specifying a custom TCP port during the configuration flow. Currently, only static IP or DHCP reserved IP are supported for the main device. @@ -119,7 +121,7 @@ Names are set from the device web page: - Channel name for single-channel devices can be set in **Settings** >> **CHANNEL NAME** - Channel name for multi-channel devices can be set in **Settings** >> **CHANNEL NAME** after selecting the channel, by clicking on the channel name. -## Entity naming (generation 2 and 3) +## Entity naming (generation 2+) The integration uses the following strategy to name its entities: @@ -140,15 +142,15 @@ Shelly 2PM Gen3 supports `tilt` for `cover` entities. To enable this feature, yo Depending on how a device's button type is configured, the integration will create binary sensors corresponding to those inputs. binary sensors are not created when the button type is `momentary` or `momentary_on_release`, for these types you need to use events for your automations. -### Binary input sensors (generation 2 and 3) +### Binary input sensors (generation 2+) -For generation 2 and 3 hardware it's possible to select if a device's input is connected to a button or a switch. Binary sensors are created only if the input mode is set to `switch`. When the input is of type `button` you need to use events for your automations. +For generation 2+ hardware, it's possible to select if a device's input is connected to a button or a switch. Binary sensors are created only if the input mode is set to `switch`. When the input is of type `button` you need to use events for your automations. ## Event entities (generation 1) If the **BUTTON TYPE** of the switch connected to the device is set to `momentary` or `detached switch`, the integration creates an event entity for this switch. You can use this entity in your automations. -## Event entities (generation 2 and 3) +## Event entities (generation 2+) If the **Input Mode** of the switch connected to the device is set to `Button`, the integration creates an event entity for this switch. You can use this entity in your automations. @@ -245,7 +247,7 @@ Not all devices support all input events. You can check on [Shelly API Reference Shelly device relays are added to Home Assistant by default as `switch` entities. A relay can be added as a `light` entity if **Settings** >> **APPLIANCE TYPE** value is set to `light`. -## Consumption type (generation 2 and 3) +## Consumption type (generation 2+) Shelly device relays are added to Home Assistant by default as `switch` entities. A relay can be added as a `light` entity if **EXTERNAL CONSUMPTION TYPE** value is set to `light`. @@ -329,7 +331,7 @@ The integration supports the following virtual components: - `text` in `field` mode, for which a `text` platform entity is created - `text` in `label` mode, for which a `sensor` platform entity is created -## Scripts (generation 2 and 3) +## Scripts (generation 2+) For each device script, the integration creates a `switch` entity that allows you to control the script. These entities are disabled by default.