matterbridge-zigbee2mqtt 2.0.5 → 2.0.7

package/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.0.7] - 2024-04-11
+
+### Added
+- [config.featureBlackList] z2m features with name in the list will be ignored (e.g. device_temperature) (https://github.com/nitaybz).
+- [config.switchList] Device with friendly name in the list will be exposed like switch.
+- [config.lightList] Device with friendly name in the list will be exposed like light.
+- [config.outletList] Devices with friendly name in the list will be exposed like outlet.
+
+### Fixed
+
+- [payload]: Fixed the case when z2m sends null or undefined in the payload (https://github.com/khaidakin).
+
+## [2.0.6] - 2024-04-09
+
+### Added
+- [electrical] Added support for voltage current power energy (right now they show up only in Home Assistant)
+- [multiendpoint]: Added the support for electrical measurements and temperature (thanks https://github.com/khaidakin).
+
+### Changed
+- [discovery]: Refactored the zigbee2mqtt discovery: now multi endpoints devices (mostly DIY devices) are supported.
+
 ## [2.0.5] - 2024-04-01
 
 ### Added

package/README.md

@@ -11,16 +11,32 @@
 
 ---
 
-Matterbridge zigbee2mqtt is production-level plugin that expose all zigbee2mqtt devices and groups to Matter.
+Matterbridge zigbee2mqtt is a matterbridge production-level plugin that expose all zigbee2mqtt devices and groups to Matter.
+
+No hub or dedicated hardware needed.
 
 ## Prerequisites
 
 ### Matterbridge
 
-See the guidelines on [Matterbridge](https://github.com/Luligu/matterbridge/blob/main/README.md) for more information.
+Follow these steps to install or update Matterbridge if it is not already installed and up to date:
+
+on Windows:
+```
+npm install -g matterbridge
+```
+
+on Linux (you need the necessary permissions):
+```
+sudo npm install -g matterbridge
+```
+
+See the complete guidelines on [Matterbridge](https://github.com/Luligu/matterbridge/blob/main/README.md) for more information.
 
 ### Zigbee2mqtt
 
+A fully working installation of zigbee2MQTT is required.
+
 See the guidelines on [zigbee2mqtt](https://github.com/Koenkk/zigbee2mqtt/blob/master/README.md) for more information.
 
 ## How to install
@@ -41,6 +57,10 @@ sudo npm install -g matterbridge-zigbee2mqtt
 matterbridge -add matterbridge-zigbee2mqtt
 ```
 
+Then start Matterbridge
+```
+matterbridge -bridge
+```
 
 ### If you want to contribute to the plugin 
 
@@ -64,6 +84,11 @@ npm run build
 matterbridge -add ./
 ```
 
+Then start Matterbridge
+```
+matterbridge -bridge
+```
+
 # Config file
 
 If needed you can configure the mqtt host, port, topic, username and password.
@@ -87,7 +112,11 @@ These are the default vules:
   "username": "",
   "password": "",
   "whiteList": [],
-  "blackList": []
+  "blackList": [],
+  "switchList": [],
+  "lightList": [],
+  "outletList": [],
+  "featureBlackList": []
 }
 ```
 
@@ -105,10 +134,32 @@ cd ~/.matterbridge
 nano matterbridge-zigbee2mqtt.config.json
 ```
 
+# Frequently Asked Questions
+
+## What is supported?
+
+Out of the box, this plugin supports all possible conversion from zigbee2mqtt to Matter 1.1.
+
+The latest release also supports all clusters in the multi endpoints devices (e.g. DIY devices or the double channel switches/dimmers).
+
+Since the Matter support in the available ecosystems (controllers) is very limited and, when available, only covers Matter 1.1 specifications, some z2m devices cannot be exposed properly or cannot be exposed at all.
+
+We discoverd that Matter support in Home Assistant is instead advanced and includes some clusters not supported by other ecosystems. These clusters like EveHistory have been added so with HA you can see Voltage, Current, Consumption and TotalConsumption (screenshot https://github.com/Luligu/matterbridge/blob/main/screenshot/Screenshot%20HA%20sm-dc-power-m.png).
+## Unsupported devices
+
+If one of your devices is not supported out of the box, open an issue and we will try to support it if possible.
+
 # Known issues
 
 ## Conversion issues between zigbee2MQTT and Matter ecosystems
 
-### action 
-The action feature of zigbee is translated in a Matter momentary Switch but due to a bug in matter.js the events are not trasmitted to the controller.
+### action (scene buttons)
+The action feature of z2m is translated in a Matter momentary Switch but due to a bug in matter.js the events are not trasmitted to the controller. These devices (like the Aqara WXKG11LM) show up, but they cannot always send the actions (events) to the controller. The fix has already been merged to matter.js. It will be available in the next matter.js release.
+
+## Apple Home issues
+
+### DoorLock
+The DoorLock cluster in the Home app takes a while to get online. The Home app shows no response for 1 or 2 seconds but then the accessory goes online.
+
+## Home Assistant issues (Matter Server for HA is still in Beta)
 

package/TODO.md

@@ -0,0 +1,3 @@
+- Done! All clusters in child endpoint 
+- All command handlers with child endpoints support
+

package/dist/entity.d.ts

@@ -21,14 +21,14 @@
  * limitations under the License. *
  */
 /// <reference types="node" resolution-mode="require"/>
-import { DeviceTypeDefinition, MatterbridgeDevice, ClusterId, AtLeastOne, EndpointNumber } from 'matterbridge';
+import { DeviceTypeDefinition, MatterbridgeDevice, ClusterId, Endpoint, AtLeastOne, EndpointNumber } from 'matterbridge';
 import { AnsiLogger } from 'node-ansi-logger';
 import { ZigbeePlatform } from './platform.js';
 import { BridgeDevice, BridgeGroup } from './zigbee2mqttTypes.js';
 import { Payload } from './payloadTypes.js';
 import EventEmitter from 'events';
 export declare class ZigbeeEntity extends EventEmitter {
-    protected log: AnsiLogger;
+    log: AnsiLogger;
     protected platform: ZigbeePlatform;
     device: BridgeDevice | undefined;
     group: BridgeGroup | undefined;
@@ -38,7 +38,9 @@ export declare class ZigbeeEntity extends EventEmitter {
     protected en: string;
     protected ien: string;
     bridgedDevice: BridgedBaseDevice | undefined;
+    eidn: string;
     constructor(platform: ZigbeePlatform, entity: BridgeDevice | BridgeGroup);
+    protected updateAttributeIfChanged(endpoint: Endpoint, endpointName: string | undefined, clusterId: number, attributeName: string, value: any): void;
     protected publishCommand(command: string, entityName: string, payload: Payload): void;
 }
 export declare class ZigbeeGroup extends ZigbeeEntity {
@@ -48,6 +50,7 @@ export declare class ZigbeeDevice extends ZigbeeEntity {
     constructor(platform: ZigbeePlatform, device: BridgeDevice);
 }
 export declare class BridgedBaseDevice extends MatterbridgeDevice {
+    log: AnsiLogger;
     hasEndpoints: boolean;
     isRouter: boolean;
     noUpdate: boolean;
@@ -76,9 +79,9 @@ export declare class BridgedBaseDevice extends MatterbridgeDevice {
      * @param includeClientList List of clusters to include
      */
     protected addDeviceClusterClient(includeClientList?: ClusterId[]): void;
-    addDeviceTypeAndClusterServer(deviceType: DeviceTypeDefinition, serverList: ClusterId[]): void;
-    addChildDeviceTypeAndClusterServer(endpointName: string, state: string, deviceType: DeviceTypeDefinition, includeServerList: ClusterId[]): void;
-    getChildStatePayload(endpointNumber: EndpointNumber | undefined, command: string): Payload;
+    addDeviceTypeAndClusterServer(deviceType: DeviceTypeDefinition | undefined, serverList: ClusterId[]): void;
+    addChildDeviceTypeAndClusterServer(endpointName: string, state: string, deviceType: DeviceTypeDefinition | undefined, includeServerList: ClusterId[]): Endpoint;
+    getChildPayload(endpointNumber: EndpointNumber | undefined, key: string, value: string): Payload;
     configure(): void;
 }
 //# sourceMappingURL=entity.d.ts.map

package/dist/entity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../src/entity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;AAGH,OAAO,EAEL,oBAAoB,EAGpB,kBAAkB,EAoBlB,SAAS,EAcT,UAAU,EAEV,cAAc,EAEf,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,UAAU,EAA6E,MAAM,kBAAkB,CAAC;AACzH,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,YAAY,MAAM,QAAQ,CAAC;AAGlC,qBAAa,YAAa,SAAQ,YAAY;IAC5C,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC;IAC1B,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC;IAC5B,MAAM,EAAE,YAAY,GAAG,SAAS,CAAC;IACjC,KAAK,EAAE,WAAW,GAAG,SAAS,CAAC;IACtC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAM;IAC9B,QAAQ,EAAE,OAAO,CAAS;IAC1B,OAAO,EAAE,OAAO,CAAS;IAChC,SAAS,CAAC,EAAE,SAAM;IAClB,SAAS,CAAC,GAAG,SAAM;IACZ,aAAa,EAAE,iBAAiB,GAAG,SAAS,CAAC;gBAExC,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY,GAAG,WAAW;IA6OxE,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAM/E;AAED,qBAAa,WAAY,SAAQ,YAAY;gBAC/B,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,WAAW;CAwBzD;AA0CD,qBAAa,YAAa,SAAQ,YAAY;gBAChC,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY;CAkP3D;AAED,qBAAa,iBAAkB,SAAQ,kBAAkB;IAChD,YAAY,UAAS;IACrB,QAAQ,UAAS;IACjB,QAAQ,UAAS;gBAEZ,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,CAAC,oBAAoB,CAAC,EAAE,iBAAiB,GAAE,SAAS,EAAO,EAAE,iBAAiB,CAAC,EAAE,SAAS,EAAE;IAgCpJ;;;;;;OAMG;IACH,SAAS,CAAC,uCAAuC,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAInI;;;;;;OAMG;IAEH,SAAS,CAAC,sBAAsB,CAAC,iBAAiB,GAAE,SAAS,EAAO;IA4DpE;;;;;;OAMG;IAGH,SAAS,CAAC,sBAAsB,CAAC,iBAAiB,GAAE,SAAS,EAAO;IAI7D,6BAA6B,CAAC,UAAU,EAAE,oBAAoB,EAAE,UAAU,EAAE,SAAS,EAAE;IAKvF,kCAAkC,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,SAAS,EAAE;IAiE/I,oBAAoB,CAAC,cAAc,EAAE,cAAc,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO;IAmB1F,SAAS;CAiBV"}
+{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../src/entity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;AAGH,OAAO,EAEL,oBAAoB,EAGpB,kBAAkB,EAoBlB,SAAS,EAQT,QAAQ,EACR,UAAU,EAEV,cAAc,EAKf,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,UAAU,EAAyE,MAAM,kBAAkB,CAAC;AACrH,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,YAAY,MAAM,QAAQ,CAAC;AAGlC,qBAAa,YAAa,SAAQ,YAAY;IACrC,GAAG,EAAE,UAAU,CAAC;IACvB,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC;IAC5B,MAAM,EAAE,YAAY,GAAG,SAAS,CAAC;IACjC,KAAK,EAAE,WAAW,GAAG,SAAS,CAAC;IACtC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAM;IAC9B,QAAQ,EAAE,OAAO,CAAS;IAC1B,OAAO,EAAE,OAAO,CAAS;IAChC,SAAS,CAAC,EAAE,SAAM;IAClB,SAAS,CAAC,GAAG,SAAM;IACZ,aAAa,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAC7C,IAAI,SAAqB;gBAEpB,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY,GAAG,WAAW;IAoOxE,SAAS,CAAC,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAwB7I,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAM/E;AAED,qBAAa,WAAY,SAAQ,YAAY;gBAC/B,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,WAAW;CAwBzD;AAuDD,qBAAa,YAAa,SAAQ,YAAY;gBAChC,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY;CAoR3D;AAED,qBAAa,iBAAkB,SAAQ,kBAAkB;IAChD,GAAG,EAAE,UAAU,CAAC;IAChB,YAAY,UAAS;IACrB,QAAQ,UAAS;IACjB,QAAQ,UAAS;gBAEZ,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,CAAC,oBAAoB,CAAC,EAAE,iBAAiB,GAAE,SAAS,EAAO,EAAE,iBAAiB,CAAC,EAAE,SAAS,EAAE;IAqCpJ;;;;;;OAMG;IACH,SAAS,CAAC,uCAAuC,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAInI;;;;;;OAMG;IAEH,SAAS,CAAC,sBAAsB,CAAC,iBAAiB,GAAE,SAAS,EAAO;IAsEpE;;;;;;OAMG;IAGH,SAAS,CAAC,sBAAsB,CAAC,iBAAiB,GAAE,SAAS,EAAO;IAI7D,6BAA6B,CAAC,UAAU,EAAE,oBAAoB,GAAG,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE;IAMnG,kCAAkC,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,oBAAoB,GAAG,SAAS,EAAE,iBAAiB,EAAE,SAAS,EAAE;IAgF3J,eAAe,CAAC,cAAc,EAAE,cAAc,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IA+BhG,SAAS;CAcV"}