docs: add missing docs for shelly integrations

related to #441
xaviml · May 13, 2022 · 3df7832 · 3df7832
1 parent 3a4682a
commit 3df7832
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -9,6 +9,8 @@ PRERELEASE_NOTE
 ## :pencil2: Features
 
 - Add following predefined actions `on_min_max_brightness`, `on_max_min_brightness`, `on_min_max_color_temp` and `on_max_min_color_temp`. [ #472 ] @sabaatworld
+- Add [`shelly` integration](https://xaviml.github.io/controllerx/start/integrations/#shelly).
+- Add [`shellyforhass` integration](https://xaviml.github.io/controllerx/start/integrations/#shellyforhass).
 
 <!--
 ## :hammer: Fixes
@@ -29,3 +31,6 @@ PRERELEASE_NOTE
 ## :video_game: New devices
 
 - [ROB2000070](https://xaviml.github.io/controllerx/controllers/ROB2000070) - add device with Z2M support. [ #482 ] @hrak
+- [ShellyI3](https://xaviml.github.io/controllerx/controllers/ShellyI3) - add device with ShellyForHASS support. [ #441 ]
+- [ShellyPlusI4](https://xaviml.github.io/controllerx/controllers/ShellyPlusI4) - add device with Shelly support. [ #441 ]
+- [Shelly25](https://xaviml.github.io/controllerx/controllers/Shelly25) - add device with Shelly support. [ #441 ]
diff --git a/docs/docs/others/extract-controller-id.md b/docs/docs/others/extract-controller-id.md
@@ -11,16 +11,24 @@ The name you need to add to the `controller` parameter can be found in `Configur
 
 #### deCONZ
 
-In case of deCONZ, you can go to `Developer Tools > Events` then down the bottom you can subscribe for `deconz_event` and start listening. Then press any button and you will see event of the button, you will need to copy the `id` inside the `data` object.
+In case of deCONZ, you can go to `Developer Tools > Events` then down the bottom you can subscribe for `deconz_event` and start listening. Then, press any button and you will see event of the button, you will need to copy the `id` inside the `data` object.
 
 #### ZHA
 
-In case of ZHA, you can go to `Developer Tools > Events` then down the bottom you can subscribe for `zha_event` and start listening. Then press any button and you will see event of the button, you will need to copy the `device_ieee` inside the `data` object. It is a number like the following 00:67:88:56:06:78:9b:3f.
+In case of ZHA, you can go to `Developer Tools > Events` then down the bottom you can subscribe for `zha_event` and start listening. Then, press any button and you will see event of the button, you will need to copy the `device_ieee` inside the `data` object. It is a number like the following 00:67:88:56:06:78:9b:3f.
 
 #### MQTT
 
 In case of using MQTT integration, the `controller` attribute must have the MQTT topic to listen from. It is important that the topic payload contains directly the action name and not a JSON. This means that in case of using the MQTT integration with a z2m controller, then the topic to listen to must be `zigbee2mqtt/<friendly name>/action` or `zigbee2mqtt/<friendly name>/click`. You can see the topic on the Zigbee2MQTT logs.
 
 #### Homematic
 
-In case of Homematic, you can go to `Developer Tools > Events` then down the bottom you can subscribe for `homematic.keypress` and start listening. Then press any button and you will see event of the button, you will need to copy the `name` inside the `data` object.
+In case of Homematic, you can go to `Developer Tools > Events` then down the bottom you can subscribe for `homematic.keypress` and start listening. Then, press any button and you will see event of the button, you will need to copy the `name` inside the `data` object.
+
+#### Shelly
+
+In case of Shelly, you can go to `Developer Tools > Events` then down the bottom you can subscribe for `shelly.click` and start listening. Then, press any button and you will see event of the button, you will need to copy the `device` inside the `data` object. You can read more about the event [here](https://www.home-assistant.io/integrations/shelly/#events).
+
+#### ShellyForHASS
+
+In case of ShellyForHASS, you can go to `Developer Tools > Events` then down the bottom you can subscribe for `shellyforhass.click` and start listening. Then, press any button and you will see event of the button, you will need to copy the `entity_id` inside the `data` object. You can read more about the event [here](https://github.com/StyraHem/ShellyForHASS#shellyforhassclick-020).