From 2ac5c94ba9bd2d0465a120fd4a561d30205b1001 Mon Sep 17 00:00:00 2001 From: mib1185 Date: Sun, 7 Nov 2021 12:04:07 +0000 Subject: [PATCH 1/6] add ota service --- source/_integrations/shelly.markdown | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/source/_integrations/shelly.markdown b/source/_integrations/shelly.markdown index 790d52df6bf9..b53474fd6deb 100644 --- a/source/_integrations/shelly.markdown +++ b/source/_integrations/shelly.markdown @@ -20,6 +20,7 @@ ha_config_flow: true ha_zeroconf: true ha_platforms: - binary_sensor + - button - cover - light - sensor @@ -58,7 +59,7 @@ The integration uses the following strategy to name its entities if the device h Examples: | Device Name | Channel Name | Entity Name | -| ----------- | -------------- | --------------------------------| +| ----------- | -------------- | ------------------------------- | | `Not set` | `Not Set` | shellyswitch25-ABC123 Channel 1 | | `Not set` | Kids Room Bulb | Kids Room Bulb | | Kitchen | `Not Set` | Kitchen Channel 1 | @@ -152,7 +153,7 @@ You can also create automations using YAML, for example: ### Possible values for `click_type` | Shelly input event | Click Type | -| ------------------ | --------------| +| ------------------ | ------------- | | `S` | `single` | | `SS` | `double` | | `SSS` | `triple` | @@ -199,6 +200,29 @@ The firmware limits the transition time to 5 seconds. +## Device services + +The integration offers device services, which can be triggered by a configuration entity (_button_) or a service call. + +### OTA update + +It is possible to trigger a so called OTA firmware update of your devices, where you can select between the stable (_default_) and the beta channel. + +#### Device configuration entities + +- **Button** OTA Update + - triggers the OTA update process on device +- **Switch** OTA Update beta channel + - enables the beta channel, so OTA update will install newest available beta firmware on your device + +#### Service call + +| Service Data Attribute | Required | Description | +| ---------------------- | -------- | --------------------------------------------------------- | +| `area_id` | no | Area ID (_or list of area IDs_) to select the devices | +| `device_id` | no | Device ID (_or list of device IDs_) to select the devices | +| `beta` | no | Enables (`true`) the beta channel (_if available_) | + ## CoAP port (generation 1) In some cases, it may be needed to customize the CoAP port (default: `5683`) your Home Assistant instance is listening to. From 42179517320dc7d7c6965149d466a3f2f2c3d397 Mon Sep 17 00:00:00 2001 From: mib1185 Date: Thu, 11 Nov 2021 19:42:09 +0000 Subject: [PATCH 2/6] remove the service overhead, just use a button --- source/_integrations/shelly.markdown | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/source/_integrations/shelly.markdown b/source/_integrations/shelly.markdown index b53474fd6deb..ea2fec04ef1f 100644 --- a/source/_integrations/shelly.markdown +++ b/source/_integrations/shelly.markdown @@ -202,7 +202,7 @@ The firmware limits the transition time to 5 seconds. ## Device services -The integration offers device services, which can be triggered by a configuration entity (_button_) or a service call. +The integration offers device services, which can be triggered by a configuration (_button_) entity. ### OTA update @@ -215,14 +215,6 @@ It is possible to trigger a so called OTA firmware update of your devices, where - **Switch** OTA Update beta channel - enables the beta channel, so OTA update will install newest available beta firmware on your device -#### Service call - -| Service Data Attribute | Required | Description | -| ---------------------- | -------- | --------------------------------------------------------- | -| `area_id` | no | Area ID (_or list of area IDs_) to select the devices | -| `device_id` | no | Device ID (_or list of device IDs_) to select the devices | -| `beta` | no | Enables (`true`) the beta channel (_if available_) | - ## CoAP port (generation 1) In some cases, it may be needed to customize the CoAP port (default: `5683`) your Home Assistant instance is listening to. From 7ac46953e9db4634d125cbfcc65067e203438e89 Mon Sep 17 00:00:00 2001 From: mib1185 Date: Thu, 11 Nov 2021 21:21:48 +0000 Subject: [PATCH 3/6] add known limitation for battery-powered devices --- source/_integrations/shelly.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/shelly.markdown b/source/_integrations/shelly.markdown index ea2fec04ef1f..9f2e20e23891 100644 --- a/source/_integrations/shelly.markdown +++ b/source/_integrations/shelly.markdown @@ -239,3 +239,4 @@ Please check from the device Web UI that the configured server is reachable. - Generation 1 "Shelly 4Pro" and "Shelly Sense" are not supported (devices based on old CoAP v1 protocol) - Device authentication for generation 2 devices is not supported - Before set up, battery-powered devices must be woken up by pressing the button on the device. +- Battery-powered devices are not supported by the OTA update service, yet From 1547865d195fb0a416d8b1b6e242eecce0f83ac0 Mon Sep 17 00:00:00 2001 From: Michael <35783820+mib1185@users.noreply.github.com> Date: Thu, 11 Nov 2021 23:25:22 +0100 Subject: [PATCH 4/6] Apply suggestions from code review Co-authored-by: Shay Levy --- source/_integrations/shelly.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/shelly.markdown b/source/_integrations/shelly.markdown index 9f2e20e23891..a041d76a3be7 100644 --- a/source/_integrations/shelly.markdown +++ b/source/_integrations/shelly.markdown @@ -239,4 +239,4 @@ Please check from the device Web UI that the configured server is reachable. - Generation 1 "Shelly 4Pro" and "Shelly Sense" are not supported (devices based on old CoAP v1 protocol) - Device authentication for generation 2 devices is not supported - Before set up, battery-powered devices must be woken up by pressing the button on the device. -- Battery-powered devices are not supported by the OTA update service, yet +- OTA update service does not support battery-powered devices From 10b8be203d05c4987ecf1ecd5f73b141b14f807c Mon Sep 17 00:00:00 2001 From: Michael <35783820+mib1185@users.noreply.github.com> Date: Tue, 16 Nov 2021 22:36:18 +0100 Subject: [PATCH 5/6] update docs accordingly --- source/_integrations/shelly.markdown | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/source/_integrations/shelly.markdown b/source/_integrations/shelly.markdown index a041d76a3be7..c3ef64a4cdcd 100644 --- a/source/_integrations/shelly.markdown +++ b/source/_integrations/shelly.markdown @@ -202,18 +202,18 @@ The firmware limits the transition time to 5 seconds. ## Device services -The integration offers device services, which can be triggered by a configuration (_button_) entity. +The integration offers device services, which can be triggered by a configuration button. ### OTA update -It is possible to trigger a so called OTA firmware update of your devices, where you can select between the stable (_default_) and the beta channel. +It is possible to trigger a so called OTA firmware update of your devices. -#### Device configuration entities +#### Buttons -- **Button** OTA Update - - triggers the OTA update process on device -- **Switch** OTA Update beta channel - - enables the beta channel, so OTA update will install newest available beta firmware on your device +- OTA Update + - triggers the OTA update process for latest stable version +- OTA Update Beta (_disabled by default_) + - triggers the OTA update process for latest beta version ## CoAP port (generation 1) From 94e6b29829bdafcf431c1c2d3cf6710727ca65ec Mon Sep 17 00:00:00 2001 From: Michael <35783820+mib1185@users.noreply.github.com> Date: Mon, 22 Nov 2021 21:48:56 +0100 Subject: [PATCH 6/6] Apply suggestions from code review Co-authored-by: Shay Levy --- source/_integrations/shelly.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_integrations/shelly.markdown b/source/_integrations/shelly.markdown index c3ef64a4cdcd..fb48d201edf3 100644 --- a/source/_integrations/shelly.markdown +++ b/source/_integrations/shelly.markdown @@ -202,11 +202,11 @@ The firmware limits the transition time to 5 seconds. ## Device services -The integration offers device services, which can be triggered by a configuration button. +The integration offers device services which can be triggered by a configuration button. ### OTA update -It is possible to trigger a so called OTA firmware update of your devices. +Trigger device OTA firmware update. #### Buttons