matterbridge 1.6.8-dev.2 → 1.6.8-dev.21

package/CHANGELOG.md

@@ -6,7 +6,7 @@ If you like this project and find it useful, please consider giving it a star on
 
 ### Home Assistant
 
-If you want to run Matterbridge in Home Assistant please use the official add-on https://github.com/Luligu/matterbridge-home-assistant-addon that also has Ingress and side panel. 
+If you want to run Matterbridge in Home Assistant please use the official add-on https://github.com/Luligu/matterbridge-home-assistant-addon that also has Ingress and side panel.
 It is also available the official Matterbridge Home Assistant plugin https://github.com/Luligu/matterbridge-hass.
 
 ### Discord
@@ -15,14 +15,26 @@ Tamer (https://github.com/tammeryousef1006) has created the Matterbridge Discord
 
 ### Breaking Changes
 
-In this release some device types and the OnOff, LevelControl and ColorControl have been updated to be fully compliant with Matter 1.3 specifications.
-It is possible that some controllers see them as new devices or need time to read the new clusters. It can be useful after the upgrade to power off the controller, wait a few minutes and power it on again.
+Matterbridge edge is now released. The default mode is still the normal mode to allow the storage conversion. See https://github.com/Luligu/matterbridge/blob/dev/README-EDGE.md to manually switch to edge mode after the conversion is done.
+
+The frontend has a new dark and a light mode. The dark mode is now the default mode. 
+It is possible to change the mode (Classic, Dark or Light) in Settings, Matterbridge settings.
 
-## [1.6.8-dev.2] - 2024-12-16
+## [1.6.8-dev.21] - 2024-12-31
 
 ### Added
 
+- [edge]: Added guide https://github.com/Luligu/matterbridge/blob/dev/README-EDGE.md.
+- [storage]: Added conversion from old matter storage to the new api format with fabrics, resumptionRecords, network, commissioning, operationalCredentials, acl and parts number. The conversion is triggered every time you shutdown or restart matterbridge till the new storage has been used with matterbridge edge. 
+- [storage]: Added conversion for child endpoint numbers. 
+- [storage]: Added conversion for childbridge mode. 
 - [package]: Update README.md and README-SERVICE.md to include instructions for using SSL on port 443.
+- [platform]: Added checkEndpointNumbers() to detect endpoint numbers changes.
+- [frontend]: Added dark and light mode to the frontend. Dark mode is now the default mode. It is possible to change the mode in Settings, Matterbridge settings.
+- [frontend]: Custom rfjsreact-jsonschema-form for the config editor.
+- [unregister]: Added unregister for Matterbridge edge. 
+- [reset]: Added reset for Matterbridge edge. 
+- [factoryreset]: Added factoryreset for Matterbridge edge. 
 
 ### Changed
 
@@ -31,12 +43,19 @@ It is possible that some controllers see them as new devices or need time to rea
 
 ### Fixed
 
+- [frontend]: Fixed device/cluster api that was not working in Ingress.
+
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
 </a>
 
 ## [1.6.7] - 2024-12-15
 
+### Breaking Changes
+
+In this release some device types and the OnOff, LevelControl and ColorControl have been updated to be fully compliant with Matter 1.3 specifications.
+It is possible that some controllers see them as new devices or need time to read the new clusters. It can be useful after the upgrade to power off the controller, wait a few minutes and power it on again.
+
 ### Added
 
 - [readme]: Update README to clarify Node.js installation instructions and emphasize LTS version.

package/README-DOCKER.md

@@ -40,12 +40,14 @@ sudo groupadd docker
 sudo usermod -aG docker $USER
 ```
 
+After adding your user to the docker group, you need to log out and log back in for the changes to take effect. This ensures that your current session recognizes the group membership change.
+
 ### Run the Docker container and start it
 
 The container must have full access to the host network (needed for mdns).
 
 ```
-docker run --name matterbridge \
+sudo docker run --name matterbridge \
   -v ${HOME}/Matterbridge:/root/Matterbridge \
   -v ${HOME}/.matterbridge:/root/.matterbridge \
   --network host --restart always -d luligu/matterbridge:latest
@@ -61,12 +63,12 @@ The docker-compose.yml file is available in the docker directory of the package
 services:
   matterbridge:
     container_name: matterbridge
-    image: luligu/matterbridge:latest # Matterbridge image with the latest tag
-    network_mode: host # Ensures the Matter mdns works
-    restart: always # Ensures the container always restarts automatically
+    image: luligu/matterbridge:latest                     # Matterbridge image with the latest tag
+    network_mode: host                                    # Ensures the Matter mdns works
+    restart: always                                       # Ensures the container always restarts automatically
     volumes:
-      - "${HOME}/Matterbridge:/root/Matterbridge" # Mounts the Matterbridge plugin directory
-      - "${HOME}/.matterbridge:/root/.matterbridge" # Mounts the Matterbridge storage directory
+      - "${HOME}/Matterbridge:/root/Matterbridge"         # Mounts the Matterbridge plugin directory
+      - "${HOME}/.matterbridge:/root/.matterbridge"       # Mounts the Matterbridge storage directory
 ```
 
 copy it in the home directory or edit the existing one to add the matterbridge service.

package/README-EDGE.md

@@ -0,0 +1,76 @@
+# <img src="https://github.com/Luligu/matterbridge/blob/main/frontend/public/matterbridge%2064x64.png" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge
+
+# Matterbridge edge
+
+Matterbridge Edge is the version of Matterbridge running with the new Matter.js API.
+
+After months of work, the migration of Matterbridge from the old API to the new API is now complete. This includes the conversion of the entire old storage format to the new API storage format, encompassing fabrics, resumption records, network, commissioning, operational credentials, ACL, and part numbers.
+
+A special thanks goes to Apollon for answering my countless questions and helping to resolve the many small issues that arose during this process.
+
+I also want to express my gratitude to Tamer, who continues to test everything daily to ensure we reach a level of confidence needed to release the update with the latest tag.
+
+## Storage conversion
+
+Starting from version 1.7.0 (1.6.8-dev.11 before it is published as 1.7.0 with tag latest), the conversion process is automatic and is triggered each time you shut down, restart, or update Matterbridge using the frontend.
+
+A message is displayed to inform the user when the conversion is complete.
+
+Once the user run Matterbridge in Edge mode for the first time, the conversion will no longer be triggered.
+
+The conversion only creates a new storage directory in the new format. It does not modify the old storage in any way, so there is no risk in trying Edge mode before its official release. You can also revert to normal mode by simply removing the -edge parameter. After the conversion is complete, the two storages will be identical. However, once you start using Edge mode, any changes made to one storage will not be reflected in the other. Therefore, it is recommended to let the conversion complete, switch to Edge mode, and continue using it exclusively.
+There is no conversion back to the old storage.
+
+## When it will be released
+
+Matterbridge Edge will be officially released as version 2.0.0, as it represents a major update.
+
+## How to run matterbridge in edge mode 
+
+To start Matterbridge in Edge mode before its official release, you need to add the -edge parameter to the command line or Docker command.
+
+### When you run matterbridge from a terminal
+
+```
+matterbridge -edge
+```
+
+### When you run matterbridge with systemctl
+
+Modify your /etc/systemd/system/matterbridge.service
+
+```
+ExecStart=matterbridge -service -edge
+```
+
+Then run:
+
+```
+sudo systemctl daemon-reload
+sudo systemctl restart matterbridge
+```
+
+### When you run matterbridge with docker
+
+```
+sudo docker run --name matterbridge \
+  -v ${HOME}/Matterbridge:/root/Matterbridge \
+  -v ${HOME}/.matterbridge:/root/.matterbridge \
+  --network host --restart always -d luligu/matterbridge:latest \
+  matterbridge -docker -edge
+```
+
+### When you run matterbridge with docker compose
+
+```
+services:
+  matterbridge:
+    container_name: matterbridge
+    image: luligu/matterbridge:latest                   # Matterbridge image with the latest tag
+    network_mode: host                                  # Ensures the Matter mdns works
+    restart: always                                     # Ensures the container always restarts automatically
+    volumes:
+      - "${HOME}/Matterbridge:/root/Matterbridge"       # Mounts the Matterbridge plugin directory
+      - "${HOME}/.matterbridge:/root/.matterbridge"     # Mounts the Matterbridge storage directory
+    command: [ "matterbridge", "-docker", "-edge" ]     # Override the image command adding -edge
+```

package/README-SERVICE.md

@@ -49,14 +49,14 @@ After=network-online.target
 [Service]
 Type=simple
 ExecStart=matterbridge -service
-WorkingDirectory=/home/<USER>/Matterbridge  # Replace <USER> with your system username
+WorkingDirectory=/home/<USER>/Matterbridge  
 StandardOutput=inherit
 StandardError=inherit
 Restart=always
 RestartSec=10s
 TimeoutStopSec=30s
-User=<USER>                                 # Replace <USER> with your system username
-Group=<USER>                                # Replace <USER> with your system username
+User=<USER>                                 
+Group=<USER>
 
 [Install]
 WantedBy=multi-user.target

package/README.md

@@ -46,7 +46,7 @@ A special thank to Apollon77 for his incredible work.
 
 To run Matterbridge, you need either a [Node.js](https://nodejs.org/en) environment or [Docker](https://docs.docker.com/get-started/get-docker/) installed on your system.
 
-If you don't have Node.js already install, please use this method to install it on a debian device: https://github.com/nodesource/distributions. 
+If you don't have Node.js already install, please use this method to install it on a debian device: https://github.com/nodesource/distributions.
 The supported versions of node are 18, 20 and 22. Please install node 22 LTS.
 Nvm is not a good choice and should not be used for production.
 
@@ -179,15 +179,18 @@ Features:
 - Shelly wifi battery-powered devices with sleep_mode are supported.
 - Shelly BLU devices are supported through local devices configured as ble gateway.
 - Discovered shellies are stored in local storage for quick loading on startup.
-- The components exposed are Light (with brightness and RGB color), Switch, Relay, Roller, Cover, PowerMeter, Temperature, Humidity and Input.
-- All components expose the electrical measurements with the EveHistory cluster (displayed on HA), waiting for the controllers to upgrade to the Matter 1.3 specs.
+- The components exposed are Light (with brightness and RGB color), Switch, Relay, Roller, Cover, PowerMeter, Temperature, Humidity, Illuminance, Thermostat, Button and Input.
+- PowerMeters expose the electrical measurements with the electricalSensor device type (suppoerted by Home Assistant and partially by SmartThings), waiting for the controllers to upgrade to the Matter 1.3 specs.
 - Shellies are controlled locally, eliminating the need for cloud or MQTT (which can both be disabled).
-- Shelly Gen 1 devices are controlled using the CoIoT protocol (see the note below).
+- Shelly Gen 1 devices are controlled using the CoIoT protocol.
 - 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.
 - 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.
 - If the device cover/roller component is not calibrated, a message is displayed.
+- If a device changes its ip address on the network, a message is displayed and the new address is stored.
 - A 10-minute timer checks if the device has reported within that time frame, and fetch un update.
 
 ### Zigbee2MQTT

package/dist/cli.js

@@ -1,27 +1,4 @@
 #!/usr/bin/env node
-/**
- * This file contains the CLI entry point of Matterbridge.
- *
- * @file cli.ts
- * @author Luca Liguori
- * @date 2023-12-29
- * @version 1.0.11
- *
- * Copyright 2023, 2024, 2025 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
-/* eslint-disable no-console */
 import { Matterbridge } from './matterbridge.js';
 import { MatterbridgeEdge } from './matterbridgeEdge.js';
 let instance;
@@ -64,7 +41,6 @@ async function restart() {
 async function update() {
     if (process.argv.includes('-debug'))
         console.log(cli + 'CLI: received update event, updating...' + rs);
-    // TODO: Implement update logic outside of matterbridge
     if (process.argv.includes('-edge'))
         instance = await MatterbridgeEdge.loadInstance();
     else
@@ -72,8 +48,6 @@ async function update() {
     registerHandlers();
 }
 process.title = 'matterbridge';
-// Run the main function
 main().catch((error) => {
     console.error(er + `CLI: Matterbridge.loadInstance() failed with error: ${error}` + rs);
 });
-//# sourceMappingURL=cli.js.map

package/dist/cluster/export.js

@@ -1,3 +1 @@
 export {};
-// Nothing to export right now
-//# sourceMappingURL=export.js.map

package/dist/defaultConfigSchema.js

@@ -1,25 +1,3 @@
-/**
- * This file contains the default config for the plugins.
- *
- * @file defaultConfigSchema.ts
- * @author Luca Liguori
- * @date 2024-05-07
- * @version 1.0.1
- *
- * Copyright 2024, 2025, 2026 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
 export const zigbee2mqtt_config = {
     name: 'matterbridge-zigbee2mqtt',
     type: 'DynamicPlatform',
@@ -55,7 +33,7 @@ export const shelly_config = {
     type: 'DynamicPlatform',
     username: '',
     password: '',
-    exposeSwitch: 'switch',
+    exposeSwitch: 'outlet',
     switchList: [],
     lightList: [],
     outletList: [],
@@ -68,6 +46,8 @@ export const shelly_config = {
     exposePowerMeter: 'matter13',
     blackList: [],
     whiteList: [],
+    entityBlackList: [],
+    deviceEntityBlackList: {},
     nocacheList: [],
     deviceIp: {},
     enableMdnsDiscover: true,
@@ -83,4 +63,3 @@ export const shelly_config = {
     debugWs: false,
     unregisterOnShutdown: false,
 };
-//# sourceMappingURL=defaultConfigSchema.js.map

package/dist/deviceManager.js

@@ -1,26 +1,3 @@
-/**
- * This file contains the DeviceManager class.
- *
- * @file devices.ts
- * @author Luca Liguori
- * @date 2024-07-26
- * @version 1.0.8
- *
- * Copyright 2024, 2025, 2026 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
-// NodeStorage and AnsiLogger modules
 import { AnsiLogger, BLUE, er } from 'node-ansi-logger';
 import { dev } from './matterbridgeTypes.js';
 export class DeviceManager {
@@ -31,7 +8,7 @@ export class DeviceManager {
     constructor(matterbridge, nodeContext) {
         this.matterbridge = matterbridge;
         this.nodeContext = nodeContext;
-        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: matterbridge.log.logLevel });
+        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4, logLevel: matterbridge.log.logLevel });
         this.log.debug('Matterbridge device manager starting...');
     }
     get length() {
@@ -77,7 +54,6 @@ export class DeviceManager {
             }
             catch (error) {
                 this.log.error(`Error processing forEach device ${dev}${device.deviceName}${er} serialNumber ${BLUE}${device.serialNumber}${er} uniqueId: ${BLUE}${device.uniqueId}${er}:`, error);
-                // throw error;
             }
         });
         await Promise.all(tasks);
@@ -89,4 +65,3 @@ export class DeviceManager {
         this.log.logLevel = logLevel;
     }
 }
-//# sourceMappingURL=deviceManager.js.map

package/dist/index.js

@@ -1,36 +1,10 @@
-/**
- * This file contains the entry point of Matterbridge.
- *
- * @file index.ts
- * @author Luca Liguori
- * @date 2023-12-29
- * @version 1.0.6
- *
- * Copyright 2023, 2024, 2025 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
 import { Matterbridge } from './matterbridge.js';
 import { MatterbridgeEdge } from './matterbridgeEdge.js';
-// @matter
-// export { Identity, AtLeastOne } from '@matter/main';
 export * from '@matter/main/clusters';
 export * from '@matter/main/types';
 export { SemanticNamespace, ClosureTag, CompassDirectionTag, CompassLocationTag, DirectionTag, ElectricalMeasurementTag, LaundryTag, LevelTag, LocationTag, NumberTag, PositionTag, PowerSourceTag, RefrigeratorTag, RoomAirConditionerTag, SwitchesTag, } from '@matter/node';
-// @project-chip
 export * from '@project-chip/matter.js/device';
 export * from '@project-chip/matter.js/cluster';
-// Matterbridge
 export * from './matterbridge.js';
 export * from './matterbridgeTypes.js';
 export * from './matterbridgeDevice.js';
@@ -43,19 +17,15 @@ const cli = '\u001B[32m';
 const er = '\u001B[38;5;9m';
 const rs = '\u001B[40;0m';
 async function main() {
-    // eslint-disable-next-line no-console
     if (process.argv.includes('-debug'))
         console.log(cli + 'MAIN: Matterbridge.loadInstance() called' + rs);
     if (process.argv.includes('-edge'))
         await MatterbridgeEdge.loadInstance();
     else
         await Matterbridge.loadInstance();
-    // eslint-disable-next-line no-console
     if (process.argv.includes('-debug'))
         console.log(cli + 'MAIN: Matterbridge.loadInstance() exited' + rs);
 }
 main().catch((error) => {
-    // eslint-disable-next-line no-console
     console.error(er + `MAIN: Matterbridge.loadInstance() failed with error: ${error}` + rs);
 });
-//# sourceMappingURL=index.js.map

package/dist/logger/export.js

@@ -1,2 +1 @@
 export * from 'node-ansi-logger';
-//# sourceMappingURL=export.js.map

package/dist/matter/export.js

@@ -8,4 +8,3 @@ export * from '../matterbridgeDeviceTypes.js';
 export * from '../matterbridgeEndpoint.js';
 export * from '../matterbridgeBehaviors.js';
 export * from '../matterbridgeEdge.js';
-//# sourceMappingURL=export.js.map