Merge pull request #131 from Luligu/dev

Release 2.0.0

Author: Luligu

CHANGELOG.md

@@ -6,6 +6,58 @@ 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.
 
+### Breaking Changes
+
+Since the plugin config got very complex and also confusing, from this release same options have been removed or simplified:
+
+Removed options:
+
+- exposeSwitch: the default is outlet (matter compliant). You can expose a device like a switch adding it it to the switchList or like a light adding it it to the lightList.
+- outletList: since the default is now outlet, outletList has been removed.
+
+- exposeInput: inputs are now disabled by default. You can still expose them adding the device to inputContactList, inputMomentaryList or inputLatchingList.
+- exposeInputEvent: inputs events are now disabled by default. You can expose them adding the device to inputMomentaryList.
+- inputEventList: use inputMomentaryList instead.
+
+- exposePowerMeter: electrical sensors are enabled by default on existing setups. You can disable them globally or on a per-device basis adding "PowerMeter" to entityBlackList or deviceEntityBlackList, see [COMPONENTS.md documentation.](https://github.com/Luligu/matterbridge-shelly/blob/main/COMPONENTS.md). On new setups the "PowerMeter" components are already globally disabled by default.
+
+New setups:
+
+- these components are blacklisted (with entityBlackList) by default: "PowerMeter", "Lux", "Illuminance", "Vibration", "Button". This allows to create simplified devices for the controllers that don't manage correctly composed devices (i.e. Alexa and SmartThings).
+- all switches are exposed like outlet (matter compliant).
+- shellyplusi4, shellyi4g3, shellyix3 and shellybutton1 are automatically added to inputMomentaryList when discovered.
+- expertMode is disabled. This makes the config showing only username, password and blackList.
+
+Expert mode:
+
+The expertMode option has been added to show an advanced or simplified config.
+
+## [2.0.0] - 2025-02-27
+
+### Added
+
+- [platform]: Optimized memory and memory release.
+- [shelly]: Optimized memory and memory release.
+- [shelly]: Added online offline status on matter.
+- [BLU]: Verified firmware 1.0.21.
+- [TRV]: Verified firmware 1.2.0.
+- [WIFI]: Verified firmware 1.5.0.
+
+### Changed
+
+- [package]: Updated package.
+- [package]: Updated dependencies.
+- [plugin]: Requires Matterbridge 2.2.0.
+
+### Fixed
+
+- [platform]: Removed coiot component from Select.
+- [select]: Fix bthomesensor_event with select Button.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
+</a>
+
 ## [1.1.6] - 2025-02-11
 
 ### Added

COMPONENTS.md

@@ -47,3 +47,15 @@ To expose only the temperature and humidity components while blacklisting all se
 ```
 "deviceEntityBlackList": { "7c:c6:b6:65:2d:87": ["Button"] }
 ```
+
+## Example 5: How to disable for all devices the electrical measurements
+
+```
+"entityBlackList": ["PowerMeter"]
+```
+
+## Example 6: How to disable for a single device
+
+```
+"deviceEntityBlackList": { "shellyplusrgbwpm-ECC9FF4CEAF0": ["PowerMeter"] }
+```

README.md

@@ -145,30 +145,21 @@ Wait that the plugin has been configured before changing the config.
 
 ### username
 
-If your devices are password protected put there the username. It must be unique for all the devices.
+If your devices are password protected put here the username. It must be unique for all the devices.
+
 It is only used for gen 1 devices. Gen 2 and 3 devices have always admin.
 
 ### password
 
-If your devices are password protected put there the password. It must be unique for all the devices.
-
-### exposeSwitch
-
-Choose how to expose on Matter the shelly switches: as a switch (don't use it with Alexa), light or outlet.
-
-You can then configure one or more devices to be exposed differently. See the switchList, lightList and outletList.
+If your devices are password protected put here the password. It must be unique for all the devices.
 
 ### switchList
 
-The devices in the list will be exposed as switches, regardless of the main option "exposeSwitch".
+The devices in the list will be exposed as switches (don't use it for Alexa).
 
 ### lightList
 
-The devices in the list will be exposed as lights, regardless of the main option "exposeSwitch".
-
-### outletList
-
-The devices in the list will be exposed as outlets, regardless of the main option "exposeSwitch".
+The devices in the list will be exposed as lights.
 
 ### exposeInput
 
@@ -178,36 +169,20 @@ Is useful only if you create automations on the controller side or you need the
 
 ### inputContactList
 
-The devices in the list will expose the Input event component as a contact sensor, regardless of the main option (you can disable the Input component globally and enable it only for single devices like the shellyplusi4).
+The devices in the list will expose the Input component as a contact sensor.
 
 ### inputMomentaryList
 
-The devices in the list will expose the Input event component as a momentary switch, regardless of the main option (you can disable the Input component globally and enable it only for single devices like the shellyplusi4).
+The devices in the list will expose the Input component as a momentary switch.
 
 In Matter a momentary switch is button that can be pressed or released.
 
 ### inputLatchingList
 
-The devices in the list will expose the Input event component as a latching switch, regardless of the main option (you can disable the Input component globally and enable it only for single devices like the shellyplusi4).
+The devices in the list will expose the Input component as a latching switch (latching switches are not supported by all controllers).
 
 In Matter a latching switch is a switch that keeps its position open or closed.
 
-### exposeInputEvent
-
-Choose how to expose the shelly input events: momentary switch or disabled (default momentary).
-
-This type of Input is used by devices like shellybutton1 or by Gen 2/3 devices with Input type=button.
-
-Is useful only if you create automations on the controller side or you need the controller history.
-
-### inputEventList
-
-The devices in the list will expose the Input event component as a momentary switch, regardless of the main option (you can disable the Input event component globally and enable it only for single devices).
-
-### exposePowerMeter
-
-Choose how to expose the shelly power meters: disabled, matter13 (it uses Matter 1.3 electricalSensor device type that is supported only by Home Assistant so far). Unless your controller supports it, set it to disabled.
-
 ### blackList
 
 If the blackList is defined the devices included in the list will not be exposed to Matter.
@@ -255,8 +230,11 @@ E.g. "shelly1minig3-543204547478": "192.168.1.221".
 ### enableMdnsDiscover
 
 Should always be enabled to discover new devices. It turns off automatically after 10 minutes to reduce network traffic.
+
 Once a device is discovered, it is added to the shelly storage.
 
+Once all the devices are loaded and stored, it is possible to disable this setting to reduce the network traffic.
+
 ### enableStorageDiscover
 
 Should always be enabled to automatically add all the devices previously discovered.
@@ -269,6 +247,8 @@ Reset the storage discovery on the next restart (it will clear the storage of al
 
 Should be enabled only if the mdns is not working in your network. It adds the devices defined in deviceIp.
 
+Once all the devices are loaded and stored, disable this setting.
+
 ### enableBleDiscover
 
 Should be enabled to discover the shelly BLU devices (it will register the BLU devices paired in each ble gateway, see https://github.com/Luligu/matterbridge-shelly/blob/dev/BLU.md for more informations).

eslint.config.js

@@ -2,13 +2,14 @@
 
 import eslint from '@eslint/js';
 import tseslint from 'typescript-eslint';
-import jesteslint from 'eslint-plugin-jest';
+import eslintPluginJest from 'eslint-plugin-jest';
 import eslintPluginPrettier from 'eslint-plugin-prettier/recommended';
+import eslintPluginN from 'eslint-plugin-n';
 
 export default [
   {
     name: 'global ignores',
-    ignores: ['**/dist/', '**/build/', '**/node_modules/', '**/coverage/', '**/frontend/', '**/rock-s0/'],
+    ignores: ['dist/', 'build/', 'node_modules/', 'coverage/', 'frontend/', 'rock-s0/'],
   },
   eslint.configs.recommended,
   ...tseslint.configs.strict,
@@ -28,7 +29,6 @@ export default [
       'no-console': 'warn',
       'no-undef': 'off',
       'spaced-comment': ['error', 'always'],
-      'no-useless-constructor': 'off',
     },
   },
   {
@@ -52,18 +52,25 @@ export default [
     plugins: {
       '@typescript-eslint': tseslint.plugin,
     },
-    rules: {
-      '@typescript-eslint/no-useless-constructor': 'off',
-    },
   },
   {
     name: 'jest',
     files: ['**/__test__/*', '**/*.test.ts', '**/*.spec.ts'],
     plugins: {
       '@typescript-eslint': tseslint.plugin,
-      jest: jesteslint,
+      jest: eslintPluginJest,
     },
     ...tseslint.configs.disableTypeChecked,
-    ...jesteslint.configs['flat/recommended'],
+    ...eslintPluginJest.configs['flat/recommended'],
+  },
+  {
+    name: 'node',
+    files: ['**/*.ts'],
+    plugins: {
+      n: eslintPluginN,
+    },
+    rules: {
+      'n/prefer-node-protocol': 'error',
+    },
   },
 ];

jest.config.js

@@ -26,4 +26,6 @@ export default {
     ],
   },
   transformIgnorePatterns: ['/node_modules/'],
+  testPathIgnorePatterns: ['/node_modules/', '/dist/', '/frontend/'],
+  coveragePathIgnorePatterns: ['/node_modules/', '/dist/', '/frontend/', '/src/mock/'],
 };

matterbridge-shelly.schema.json

@@ -14,21 +14,15 @@
       "readOnly": true
     },
     "username": {
-      "description": "Username (used only for gen 1 devices)",
+      "description": "Username for password protected shelly devices (used only for gen 1 devices)",
       "type": "string"
     },
     "password": {
-      "description": "Password (must be unique for all the devices)",
+      "description": "Password for password protected shelly devices (must be unique for all the devices)",
       "type": "string"
     },
-    "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"],
-      "default": "outlet"
-    },
     "switchList": {
-      "description": "The devices in the list will be exposed as switches, regardless of the main option.",
+      "description": "The devices in the list will be exposed as switches (don't use it for Alexa).",
       "type": "array",
       "items": {
         "type": "string"
@@ -37,31 +31,16 @@
       "selectFrom": "serial"
     },
     "lightList": {
-      "description": "The devices in the list will be exposed as lights, regardless of the main option.",
-      "type": "array",
-      "items": {
-        "type": "string"
-      },
-      "uniqueItems": true,
-      "selectFrom": "serial"
-    },
-    "outletList": {
-      "description": "The devices in the list will be exposed as outlets, regardless of the main option.",
+      "description": "The devices in the list will be exposed as lights.",
       "type": "array",
       "items": {
         "type": "string"
       },
       "uniqueItems": true,
       "selectFrom": "serial"
     },
-    "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"],
-      "default": "disabled"
-    },
     "inputContactList": {
-      "description": "The devices in the list will expose the Input event component as a contact sensor, regardless of the main option (you can disable the Input component globally and enable it only for single devices).",
+      "description": "The devices in the list will expose the Input component as a contact sensor.",
       "type": "array",
       "items": {
         "type": "string"
@@ -70,7 +49,7 @@
       "selectFrom": "serial"
     },
     "inputMomentaryList": {
-      "description": "The devices in the list will expose the Input event component as a momentary switch, regardless of the main option (you can disable the Input component globally and enable it only for single devices).",
+      "description": "The devices in the list will expose the Input component as a momentary switch.",
       "type": "array",
       "items": {
         "type": "string"
@@ -79,35 +58,14 @@
       "selectFrom": "serial"
     },
     "inputLatchingList": {
-      "description": "The devices in the list will expose the Input event component as a latching switch, regardless of the main option (you can disable the Input component globally and enable it only for single devices).",
+      "description": "The devices in the list will expose the Input component as a latching switch.",
       "type": "array",
       "items": {
         "type": "string"
       },
       "uniqueItems": true,
       "selectFrom": "serial"
     },
-    "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"],
-      "default": "disabled"
-    },
-    "inputEventList": {
-      "description": "The devices in the list will expose the Input event component as a momentary switch, regardless of the main option (you can disable the Input event component globally and enable it only for single devices).",
-      "type": "array",
-      "items": {
-        "type": "string"
-      },
-      "uniqueItems": true,
-      "selectFrom": "serial"
-    },
-    "exposePowerMeter": {
-      "description": "Choose how to expose the shelly power meters: disabled, matter13 (will use Matter 1.3 electricalSensor)",
-      "type": "string",
-      "enum": ["disabled", "matter13"],
-      "default": "disabled"
-    },
     "blackList": {
       "description": "The devices in the list will not be exposed. Use the device id (e.g. shellyplus2pm-5443B23D81F8) or BLU addr (i.e. 7c:c6:b6:65:2d:87)",
       "type": "array",
@@ -160,7 +118,7 @@
       "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). Enable enableConfigDiscover to load the devices from this setting.",
+      "description": "Set the IP address for each device that is not discovered automatically. 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",
@@ -184,7 +142,7 @@
       "default": false
     },
     "enableConfigDiscover": {
-      "description": "Enable config discovery for shelly devices (it will load the devices from deviceIp config setting)",
+      "description": "Enable config discovery for shelly devices (it will load the devices from deviceIp config setting). It is only needed if a device is not discovered on your network. Once they are loaded and stored, disable this setting.",
       "type": "boolean",
       "default": false
     },
@@ -203,6 +161,11 @@
       "type": "string",
       "default": ""
     },
+    "expertMode": {
+      "description": "Enable the expert mode for the plugin configuration (restart required)",
+      "type": "boolean",
+      "default": false
+    },
     "debug": {
       "description": "Enable the debug for the plugin (development only)",
       "type": "boolean",
@@ -223,10 +186,6 @@
       "type": "boolean",
       "default": false
     },
-    "interfaceName": {
-      "description": "Network interface name for shellies (development only)",
-      "type": "string"
-    },
     "unregisterOnShutdown": {
       "description": "Unregister all devices on shutdown (development only)",
       "type": "boolean",