Merge pull request #120 from Luligu/dev

Release 1.1.4

Author: Luligu

CHANGELOG.md

@@ -6,6 +6,27 @@ If you like this project and find it useful, please consider giving it a star on
 
 You can also sponsor Tamer here https://buymeacoffee.com/6sjde6vkzl for his invaluable contribution to this project.
 
+## [1.1.4] - 2025-01-20
+
+### Added
+
+- [platform]: Refactor onStart to await device creation to address some cases where the controller reset the configuration on slow host.
+- [selectDevice]: Added selectDevice to deviceIp to get the components names from a list in the config editor.
+- [em1data]: Added update for total_act_energy in onConfigure.
+- [package]: Requires matterbridge 1.7.3.
+
+### Changed
+
+- [package]: Updated dependencies.
+
+### Fixed
+
+- [em1data]: Fixed typo em1data.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
+</a>
+
 ## [1.1.3] - 2025-01-11
 
 ### Added

COMPONENTS.md

@@ -2,7 +2,6 @@
 
 All components for all devices are exposed to Matter, but it is possible to exclude certain components globally or on a per-device basis.
 
-
 ## Example 1: How to Blacklist a Component on a shellyplusrgbwpm Device
 
 Given the components of a shellyplusrgbwpm device (as shown in the logs from the console or frontend):
@@ -25,7 +24,6 @@ To blacklist only the third (input:2) and fourth (input:3) Input components of t
 "deviceEntityBlackList": { "shellyplusrgbwpm-ECC9FF4CEAF0": ["input:2", "input:3"] }
 ```
 
-
 ## Example 2: How to Blacklist all secondary components on a BLU Motion Device with address 7c:c6:b6:65:2d:99
 
 To expose only the motion component while blacklisting all secondary components, use the component names as shown below:
@@ -34,7 +32,6 @@ To expose only the motion component while blacklisting all secondary components,
 "deviceEntityBlackList": { "7c:c6:b6:65:2d:99": ["Illuminance", "Button"] }
 ```
 
-
 ## Example 3: How to Blacklist all secondary components on a BLU DoorWindow with address 0c:ef:f6:f1:d7:7b
 
 To expose only the contact component while blacklisting all secondary components, use the component names as shown below:
@@ -43,7 +40,6 @@ To expose only the contact component while blacklisting all secondary components
 "deviceEntityBlackList": { "0c:ef:f6:f1:d7:7b": ["Illuminance"] }
 ```
 
-
 ## Example 4: How to Blacklist all secondary components on a BLU HT 7c:c6:b6:65:2d:87 with address 7c:c6:b6:65:2d:87
 
 To expose only the temperature and humidity components while blacklisting all secondary components, use the component names as shown below:

README.md

@@ -28,8 +28,8 @@ Features:
 - Shelly Gen 1 devices are controlled using the CoIoT protocol (see the note below).
 - Shelly Gen 2 and Gen 3 devices are controlled using WebSocket.
 - The Matter device takes the name configured in the Shelly device's web page.
-- Each device can be blacklisted or whitelisted using its name, id or mac address.
-- Device components can be blacklisted globally or on a per-device basis.
+- Each device can be blacklisted or whitelisted using its name, id or mac address. Refer to the [COMPONENTS.md documentation.](https://github.com/Luligu/matterbridge-shelly/blob/main/COMPONENTS.md)
+- Device components can be blacklisted globally or on a per-device basis. Refer to the [COMPONENTS.md documentation.](https://github.com/Luligu/matterbridge-shelly/blob/main/COMPONENTS.md)
 - Devices ids can be selected from a list in the config editor.
 - If the device has a firmware update available, a message is displayed.
 - If the device's CoIoT protocol is not correctly configured, a message is displayed.
@@ -102,10 +102,8 @@ Follow these guidelines for specific devices.
 
 There are two ways to have the wifi device IP stable:
 
-1) In your router configuration find, in the DHCP settings, the option to reserve an ip address for all your shelly wifi devices.
-   
-2) In the device web UI (or Shelly app) go to Settings / WiFi and set a static IP for Wi-Fi 1 settings.
-
+1. In your router configuration find, in the DHCP settings, the option to reserve an ip address for all your shelly wifi devices.
+2. In the device web UI (or Shelly app) go to Settings / WiFi and set a static IP for Wi-Fi 1 settings.
 
 ## How to install the plugin
 
@@ -141,7 +139,7 @@ matterbridge
 
 You may need to set some config values in the frontend.
 
-Changing configuration after the controller is already paired may cause the controller to see the device as new devices and reset their configuration. You may need to wait a few minutes that the controller reads again all endpoints. 
+Changing configuration after the controller is already paired may cause the controller to see the device as new devices and reset their configuration. You may need to wait a few minutes that the controller reads again all endpoints.
 
 Wait that the plugin has been configured before changing the config.
 
@@ -174,7 +172,7 @@ The devices in the list will be exposed as outlets, regardless of the main optio
 
 ### exposeInput
 
-Choose how to expose the shelly inputs: disabled, contact, momentary or latching switch (default momentary). 
+Choose how to expose the shelly inputs: disabled, contact, momentary or latching switch (default momentary).
 
 Is useful only if you create automations on the controller side or you need the controller history.
 
@@ -212,15 +210,15 @@ Choose how to expose the shelly power meters: disabled, matter13 (it uses Matter
 
 ### blackList
 
-If the blackList is defined the devices included in the list will not be exposed to Matter. 
+If the blackList is defined the devices included in the list will not be exposed to Matter.
 
 For shelly wifi devices use the device name (i.e. the name defined in the device web UI), the device id (i.e. shellyplus2pm-5443B23D81F8) or the device mac (i.e. 5443B23D81F8).
 
 For shelly BLU devices use the device name (i.e. the name defined in the device gateway web UI) or the device mac addr (i.e. 7c:c6:b6:65:2d:87).
 
 ### whiteList
 
-If the whiteList is defined only the devices included in the list are exposed to Matter. 
+If the whiteList is defined only the devices included in the list are exposed to Matter.
 
 For shelly wifi devices use the device name (i.e. the name defined in the device web UI), the device id (i.e. shellyplus2pm-5443B23D81F8) or the device mac (i.e. 5443B23D81F8).
 

matterbridge-shelly.schema.json

@@ -24,11 +24,7 @@
     "exposeSwitch": {
       "description": "Choose how to expose the shelly switches: as a switch (don't use it for Alexa), light or outlet",
       "type": "string",
-      "enum": [
-        "switch",
-        "light",
-        "outlet"
-      ],
+      "enum": ["switch", "light", "outlet"],
       "default": "outlet"
     },
     "switchList": {
@@ -61,12 +57,7 @@
     "exposeInput": {
       "description": "Choose how to expose the shelly inputs: disabled, contact, momentary or latching switch (you may need to pair again the controller when changed)",
       "type": "string",
-      "enum": [
-        "disabled",
-        "contact",
-        "momentary",
-        "latching"
-      ],
+      "enum": ["disabled", "contact", "momentary", "latching"],
       "default": "disabled"
     },
     "inputContactList": {
@@ -99,10 +90,7 @@
     "exposeInputEvent": {
       "description": "Choose weather to expose the shelly input events: momentary or disabled (you may need to pair again the controller when changed)",
       "type": "string",
-      "enum": [
-        "momentary",
-        "disabled"
-      ],
+      "enum": ["momentary", "disabled"],
       "default": "disabled"
     },
     "inputEventList": {
@@ -117,10 +105,7 @@
     "exposePowerMeter": {
       "description": "Choose how to expose the shelly power meters: disabled, matter13 (will use Matter 1.3 electricalSensor)",
       "type": "string",
-      "enum": [
-        "disabled",
-        "matter13"
-      ],
+      "enum": ["disabled", "matter13"],
       "default": "disabled"
     },
     "blackList": {
@@ -175,8 +160,10 @@
       "selectFrom": "serial"
     },
     "deviceIp": {
-      "description": "Set the IP address for each device. Enter in the first field the shelly ID of the device and in the second field the IP address. (e.g. shelly1minig3-543204547478: 192.168.1.221)",
+      "description": "Set the IP address for each device. Enter in the first field the shelly ID of the device and in the second field the IP address. (e.g. shelly1minig3-543204547478: 192.168.1.221). Enable enableConfigDiscover to load the devices from this setting.",
       "type": "object",
+      "uniqueItems": true,
+      "selectFrom": "serial",
       "additionalProperties": {
         "type": "string"
       }
@@ -246,4 +233,4 @@
       "default": false
     }
   }
-}
+}