matterbridge 1.2.22 → 1.3.0

package/CHANGELOG.md

@@ -2,6 +2,35 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.3.0] - 2024-06-16
+
+This release is all about Matter 1.3
+
+If you are wondering whether the controllers already support Matter 1.3, the answer is unfortunately no.
+
+Only Home Automation supports:
+- airQualitySensor (Matter 1.2)
+
+and (probably only like BooleanState cluster)
+- waterFreezeDetector (Matter 1.3)
+- waterLeakDetector (Matter 1.3)
+- rainSensor (Matter 1.3)
+
+### Changed
+- [matterbridge]: Updated dependencies
+- [matterbridge]: Default config and schema for the new plugin matterbridge-shelly (will be published after this release)
+
+### Added
+- [matterbridgeDevice]: Added waterFreezeDetector, waterLeakDetector, rainSensor, smokeCoAlarm, electricalSensor and deviceEnergyManagement device types as conformance to Matter 1.3
+- [matterbridgeDevice]: Added all clusters needed for the above Matter 1.3 device types 
+- [matterbridgeDevice]: Added FanControl cluster (rev. 2) helper methods for the Fan device type
+- [matterbridge]: Added parameter -matterlogger [debug | info | notice | warn | error | fatal] to set the matter.js Logger separately from the Matterbridge log
+- [frontend]: Added logger level settings to reflect -matterlogger [debug | info | notice | warn | error | fatal]
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
+</a>
+
 ## [1.2.22] - 2024-06-04
 
 ### Changed

package/README.md

@@ -2,9 +2,10 @@
 
 [![npm version](https://img.shields.io/npm/v/matterbridge.svg)](https://www.npmjs.com/package/matterbridge)
 [![npm downloads](https://img.shields.io/npm/dt/matterbridge.svg)](https://www.npmjs.com/package/matterbridge)
+[![Docker Version](https://img.shields.io/docker/v/luligu/matterbridge?label=docker%20version&sort=semver)](https://hub.docker.com/r/luligu/matterbridge)
+[![Docker Pulls](https://img.shields.io/docker/pulls/luligu/matterbridge.svg)](https://hub.docker.com/r/luligu/matterbridge)
 ![Node.js CI](https://github.com/Luligu/matterbridge/actions/workflows/build.yml/badge.svg)
 
-
 [![power by](https://img.shields.io/badge/powered%20by-matter--history-blue)](https://www.npmjs.com/package/matter-history)
 [![power by](https://img.shields.io/badge/powered%20by-node--ansi--logger-blue)](https://www.npmjs.com/package/node-ansi-logger)
 [![power by](https://img.shields.io/badge/powered%20by-node--persist--manager-blue)](https://www.npmjs.com/package/node-persist-manager)
@@ -329,7 +330,7 @@ After=network-online.target
 
 [Service]
 Type=simple
-ExecStart=/usr/bin/matterbridge -bridge -service -port 5550
+ExecStart=/usr/bin/matterbridge -bridge -service
 WorkingDirectory=/home/<USER>/Matterbridge
 StandardOutput=inherit
 StandardError=inherit
@@ -473,42 +474,73 @@ docker logs matterbridge
 docker logs --tail 1000 -f matterbridge
 ```
 
-# Known issues
+# Known general issues
 
 ## Session XYZ does not exist 
 This message may appear after Matterbridge restarts, indicating that the controller is still using a session from the previous connection that has since been closed.
 After some time, the controller will reconnect. 
 In this context, the message is not indicative of a problem.
 
-## Apple Home issues
+## Apple Home
 
 The HomePods, being a WiFi devices, sometimes pruduce message trasmission errors. The Apple TV with network cable is more reliable (but also more expensive).
 
 Solved with the version 17.5 of the HomePod/AppleTV. Now they are stable.
 
-### DoorLock
+### DoorLock issue
 
 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. With the Eve app or the Controller app this issue is not present.
 
 Solved with the version 17.5 of the HomePod/AppleTV.
 
+## Home Assistant 
+
+So far is the only controller supporting some Matter 1.3 device type:
+- air quality sensor
+
+HA also support electrical measurements from EveHistoryCluster (used in Matterbridge plugins)
+
 ## Home Assistant issues (Matter Server for HA is still in Beta)
 
-- If HA doesn't show all devices just reload the HA Matter Server or reboot HA
-- Home Assistant doesn't seem to react when a device is removed from the bridge: they remain like unavailable forever...
+- If HA doesn't show all devices just reload the Matter Server or reboot HA
+- Home Assistant doesn't seem to react when a device is removed from the bridge: they remain in HA unavailable forever...
 - In the Home Assistant Core log you can see sometimes error messages relating to unique id not found but it seems to be an issue related to missing some matter packet during the commissioning and subscription phase...
 - Version 6.1.0 is more stable and has solved the problem of the commissioning window: now pairing is again easy. Use Apple Home when you have to choose the controller type even if you pair Matterbridge directly with HA.
 
 ## Google Home
 
+No issues reported so far.
+
 ## Alexa
 
+Tested by Tamer Salah
+
+Alexa needs the standard port 5540 to pair (from matter.js readme).
+
+There is no support for these Matter device types:
+- pressure sensor
+- flow sensor
+- light sensor
+
+In the zigbee2mqtt and shelly plugins select the option to expose 
+the switch devices like light or outlet cause they don't show up like switch
+(Matterbridge uses a modified switch device type without client cluster).
+
 ## SmartThings
 
+Tested by Tamer Salah
+
+No issues reported so far.
+
 ## eWeLink
 
+Tested by Tamer Salah
+
+eWeLink needs the standard port 5540 for commissioning.
+
 ## Tuya/Smart Life
 
+Check the matter.js readme.
 
 # Contribution Guidelines
 
@@ -524,7 +556,7 @@ I warmly welcome contributions to this project! Whether it's reporting bugs, pro
 
 ## Submitting Changes
 
-- Create a new pull request from my repository and I'll be glad to check it out
+- Create a new pull request against the dev from my repository and I'll be glad to check it out
 - Be sure to follow the existing code style
 - Add unit tests for any new or changed functionality if possible
 - In your pull request, do describe what your changes do and how they work

package/dist/cluster/AirQualityCluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AirQualityCluster.d.ts","sourceRoot":"","sources":["../../src/cluster/AirQualityCluster.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAmB,cAAc,EAAE,MAAM,sCAAsC,CAAC;AACvF,OAAO,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,qCAAqC,CAAC;AAE9D,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAE7D,yBAAiB,UAAU,CAAC;IAC1B,KAAY,cAAc;QACxB,OAAO,IAAI;QACX,IAAI,IAAI;QACR,IAAI,IAAI;QACR,QAAQ,IAAI;QACZ,IAAI,IAAI;QACR,QAAQ,IAAI;QACZ,aAAa,IAAI;KAClB;IAEM,MAAM,uBAAuB;;;;KAIlC,CAAC;IACI,MAAM,2BAA2B;;;;KAItC,CAAC;IACI,MAAM,2BAA2B;;;;KAItC,CAAC;IACI,MAAM,gCAAgC;;;;KAI3C,CAAC;IAEH,KAAY,OAAO;QACjB,cAAc,mBAAmB;QACjC,kBAAkB,uBAAuB;QACzC,kBAAkB,uBAAuB;QACzC,uBAAuB,4BAA4B;KACpD;IAEM,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAsBf,CAAC;IAEI,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAsC,CAAC;IAGnE,UAAiB,OAAQ,SAAQ,QAAQ,CAAC,OAAO,eAAe,CAAC;KAAG;IAE7D,MAAM,OAAO,EAAE,OAAyB,CAAC;IAEzC,MAAM,gBAAgB;;;;;;;;;;;;;MAS3B,CAAC;IAGH,UAAiB,QAAS,SAAQ,QAAQ,CAAC,OAAO,gBAAgB,CAAC;KAAG;IAE/D,MAAM,QAAQ,EAAE,QAA2B,CAAC;CACpD;AAED,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,CAAC;AACnD,eAAO,MAAM,iBAAiB,oBAAqB,CAAC"}

package/dist/cluster/AirQualityCluster.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AirQualityCluster.js","sourceRoot":"","sources":["../../src/cluster/AirQualityCluster.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,oDAAoD;AACpD,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AACvF,OAAO,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,qCAAqC,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,kCAAkC,CAAC;AAG3D,MAAM,KAAW,UAAU,CAqF1B;AArFD,WAAiB,UAAU;IACzB,IAAY,cAQX;IARD,WAAY,cAAc;QACxB,yDAAW,CAAA;QACX,mDAAQ,CAAA;QACR,mDAAQ,CAAA;QACR,2DAAY,CAAA;QACZ,mDAAQ,CAAA;QACR,2DAAY,CAAA;QACZ,qEAAiB,CAAA;IACnB,CAAC,EARW,cAAc,GAAd,yBAAc,KAAd,yBAAc,QAQzB;IAEY,kCAAuB,GAAG,cAAc,CAAC,SAAS,CAAC;QAC9D,UAAU,EAAE;YACV,UAAU,EAAE,SAAS,CAAC,GAAG,EAAE,OAAO,EAAkB,CAAC;SACtD;KACF,CAAC,CAAC;IACU,sCAA2B,GAAG,cAAc,CAAC,SAAS,CAAC;QAClE,UAAU,EAAE;YACV,UAAU,EAAE,SAAS,CAAC,GAAG,EAAE,OAAO,EAAkB,CAAC;SACtD;KACF,CAAC,CAAC;IACU,sCAA2B,GAAG,cAAc,CAAC,SAAS,CAAC;QAClE,UAAU,EAAE;YACV,UAAU,EAAE,SAAS,CAAC,GAAG,EAAE,OAAO,EAAkB,CAAC;SACtD;KACF,CAAC,CAAC;IACU,2CAAgC,GAAG,cAAc,CAAC,SAAS,CAAC;QACvE,UAAU,EAAE;YACV,UAAU,EAAE,SAAS,CAAC,GAAG,EAAE,OAAO,EAAkB,CAAC;SACtD;KACF,CAAC,CAAC;IAEH,IAAY,OAKX;IALD,WAAY,OAAO;QACjB,4CAAiC,CAAA;QACjC,oDAAyC,CAAA;QACzC,oDAAyC,CAAA;QACzC,8DAAmD,CAAA;IACrD,CAAC,EALW,OAAO,GAAP,kBAAO,KAAP,kBAAO,QAKlB;IAEY,eAAI,GAAG,cAAc,CAAC,SAAS,CAAC;QAC3C,EAAE,EAAE,MAAM;QACV,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE,CAAC;QAEX,QAAQ,EAAE;YACR,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;YAC1B,kBAAkB,EAAE,OAAO,CAAC,CAAC,CAAC;YAC9B,kBAAkB,EAAE,OAAO,CAAC,CAAC,CAAC;YAC9B,uBAAuB,EAAE,OAAO,CAAC,CAAC,CAAC;SACpC;QAED,UAAU,EAAE;YACV,UAAU,EAAE,SAAS,CAAC,GAAG,EAAE,OAAO,EAAkB,CAAC;SACtD;QAED,UAAU,EAAE,cAAc,CAAC,UAAU,CACnC,EAAE,KAAK,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,WAAA,uBAAuB,EAAE,EACvE,EAAE,KAAK,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,WAAA,2BAA2B,EAAE,EAC/E,EAAE,KAAK,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,WAAA,2BAA2B,EAAE,EAC/E,EAAE,KAAK,EAAE,EAAE,uBAAuB,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,WAAA,gCAAgC,EAAE,CAC1F;KACF,CAAC,CAAC;IAEU,0BAAe,GAAG,cAAc,CAAC,cAAc,CAAC,WAAA,IAAI,CAAC,CAAC;IAKtD,kBAAO,GAAY,WAAA,eAAe,CAAC;IAEnC,2BAAgB,GAAG,cAAc,CAAC;QAC7C,EAAE,EAAE,WAAA,IAAI,CAAC,EAAE;QACX,IAAI,EAAE,WAAA,IAAI,CAAC,IAAI;QACf,QAAQ,EAAE,WAAA,IAAI,CAAC,QAAQ;QACvB,QAAQ,EAAE,WAAA,IAAI,CAAC,QAAQ;QAEvB,UAAU,EAAE;YACV,GAAG,WAAA,IAAI,CAAC,UAAU;SACnB;KACF,CAAC,CAAC;IAKU,mBAAQ,GAAa,WAAA,gBAAgB,CAAC;AACrD,CAAC,EArFgB,UAAU,KAAV,UAAU,QAqF1B;AAGD,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,CAAC;AACpD,eAAe,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC"}