matterbridge 1.6.7 → 1.6.8-dev.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (97) hide show
  1. package/CHANGELOG.md +23 -3
  2. package/README-SERVICE.md +12 -3
  3. package/README.md +3 -1
  4. package/dist/cli.js +0 -26
  5. package/dist/cluster/export.js +0 -2
  6. package/dist/defaultConfigSchema.js +3 -24
  7. package/dist/deviceManager.js +1 -26
  8. package/dist/index.js +0 -30
  9. package/dist/logger/export.js +0 -1
  10. package/dist/matter/export.js +5 -1
  11. package/dist/matterbridge.js +239 -661
  12. package/dist/matterbridgeAccessoryPlatform.js +0 -33
  13. package/dist/matterbridgeBehaviors.js +1 -29
  14. package/dist/matterbridgeDevice.js +24 -986
  15. package/dist/matterbridgeDeviceTypes.js +11 -82
  16. package/dist/matterbridgeDynamicPlatform.js +0 -33
  17. package/dist/matterbridgeEdge.js +3 -534
  18. package/dist/matterbridgeEndpoint.js +26 -1111
  19. package/dist/matterbridgePlatform.js +65 -95
  20. package/dist/matterbridgeTypes.js +0 -24
  21. package/dist/matterbridgeWebsocket.js +0 -45
  22. package/dist/pluginManager.js +3 -238
  23. package/dist/storage/export.js +0 -1
  24. package/dist/utils/colorUtils.js +2 -205
  25. package/dist/utils/export.js +0 -1
  26. package/dist/utils/utils.js +7 -252
  27. package/npm-shrinkwrap.json +17 -81
  28. package/package.json +1 -2
  29. package/dist/cli.d.ts +0 -25
  30. package/dist/cli.d.ts.map +0 -1
  31. package/dist/cli.js.map +0 -1
  32. package/dist/cluster/export.d.ts +0 -2
  33. package/dist/cluster/export.d.ts.map +0 -1
  34. package/dist/cluster/export.js.map +0 -1
  35. package/dist/defaultConfigSchema.d.ts +0 -27
  36. package/dist/defaultConfigSchema.d.ts.map +0 -1
  37. package/dist/defaultConfigSchema.js.map +0 -1
  38. package/dist/deviceManager.d.ts +0 -46
  39. package/dist/deviceManager.d.ts.map +0 -1
  40. package/dist/deviceManager.js.map +0 -1
  41. package/dist/index.d.ts +0 -40
  42. package/dist/index.d.ts.map +0 -1
  43. package/dist/index.js.map +0 -1
  44. package/dist/logger/export.d.ts +0 -2
  45. package/dist/logger/export.d.ts.map +0 -1
  46. package/dist/logger/export.js.map +0 -1
  47. package/dist/matter/export.d.ts +0 -6
  48. package/dist/matter/export.d.ts.map +0 -1
  49. package/dist/matter/export.js.map +0 -1
  50. package/dist/matterbridge.d.ts +0 -466
  51. package/dist/matterbridge.d.ts.map +0 -1
  52. package/dist/matterbridge.js.map +0 -1
  53. package/dist/matterbridgeAccessoryPlatform.d.ts +0 -39
  54. package/dist/matterbridgeAccessoryPlatform.d.ts.map +0 -1
  55. package/dist/matterbridgeAccessoryPlatform.js.map +0 -1
  56. package/dist/matterbridgeBehaviors.d.ts +0 -942
  57. package/dist/matterbridgeBehaviors.d.ts.map +0 -1
  58. package/dist/matterbridgeBehaviors.js.map +0 -1
  59. package/dist/matterbridgeDevice.d.ts +0 -7063
  60. package/dist/matterbridgeDevice.d.ts.map +0 -1
  61. package/dist/matterbridgeDevice.js.map +0 -1
  62. package/dist/matterbridgeDeviceTypes.d.ts +0 -109
  63. package/dist/matterbridgeDeviceTypes.d.ts.map +0 -1
  64. package/dist/matterbridgeDeviceTypes.js.map +0 -1
  65. package/dist/matterbridgeDynamicPlatform.d.ts +0 -39
  66. package/dist/matterbridgeDynamicPlatform.d.ts.map +0 -1
  67. package/dist/matterbridgeDynamicPlatform.js.map +0 -1
  68. package/dist/matterbridgeEdge.d.ts +0 -92
  69. package/dist/matterbridgeEdge.d.ts.map +0 -1
  70. package/dist/matterbridgeEdge.js.map +0 -1
  71. package/dist/matterbridgeEndpoint.d.ts +0 -10164
  72. package/dist/matterbridgeEndpoint.d.ts.map +0 -1
  73. package/dist/matterbridgeEndpoint.js.map +0 -1
  74. package/dist/matterbridgePlatform.d.ts +0 -114
  75. package/dist/matterbridgePlatform.d.ts.map +0 -1
  76. package/dist/matterbridgePlatform.js.map +0 -1
  77. package/dist/matterbridgeTypes.d.ts +0 -162
  78. package/dist/matterbridgeTypes.d.ts.map +0 -1
  79. package/dist/matterbridgeTypes.js.map +0 -1
  80. package/dist/matterbridgeWebsocket.d.ts +0 -49
  81. package/dist/matterbridgeWebsocket.d.ts.map +0 -1
  82. package/dist/matterbridgeWebsocket.js.map +0 -1
  83. package/dist/pluginManager.d.ts +0 -238
  84. package/dist/pluginManager.d.ts.map +0 -1
  85. package/dist/pluginManager.js.map +0 -1
  86. package/dist/storage/export.d.ts +0 -2
  87. package/dist/storage/export.d.ts.map +0 -1
  88. package/dist/storage/export.js.map +0 -1
  89. package/dist/utils/colorUtils.d.ts +0 -61
  90. package/dist/utils/colorUtils.d.ts.map +0 -1
  91. package/dist/utils/colorUtils.js.map +0 -1
  92. package/dist/utils/export.d.ts +0 -3
  93. package/dist/utils/export.d.ts.map +0 -1
  94. package/dist/utils/export.js.map +0 -1
  95. package/dist/utils/utils.d.ts +0 -221
  96. package/dist/utils/utils.d.ts.map +0 -1
  97. package/dist/utils/utils.js.map +0 -1
package/CHANGELOG.md CHANGED
@@ -6,20 +6,40 @@ If you like this project and find it useful, please consider giving it a star on
6
6
 
7
7
  ### Home Assistant
8
8
 
9
- 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.
9
+ 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.
10
10
  It is also available the official Matterbridge Home Assistant plugin https://github.com/Luligu/matterbridge-hass.
11
11
 
12
12
  ### Discord
13
13
 
14
14
  Tamer (https://github.com/tammeryousef1006) has created the Matterbridge Discord group: https://discord.gg/QX58CDe6hd.
15
15
 
16
+ ## [1.6.8-dev.10] - 2024-12-21
17
+
18
+ ### Added
19
+
20
+ - [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.
21
+ - [storage]: Added conversion for child endpoint numbers.
22
+ - [package]: Update README.md and README-SERVICE.md to include instructions for using SSL on port 443.
23
+ - [platform]: Added checkEndpointNumbers() to detect endpoint numbers changes.
24
+
25
+ ### Changed
26
+
27
+ - [edge]: Fixes to edge mode.
28
+ - [package]: Update dependencies.
29
+
30
+ ### Fixed
31
+
32
+ <a href="https://www.buymeacoffee.com/luligugithub">
33
+ <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
34
+ </a>
35
+
36
+ ## [1.6.7] - 2024-12-15
37
+
16
38
  ### Breaking Changes
17
39
 
18
40
  In this release some device types and the OnOff, LevelControl and ColorControl have been updated to be fully compliant with Matter 1.3 specifications.
19
41
  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.
20
42
 
21
- ## [1.6.7] - 2024-12-15
22
-
23
43
  ### Added
24
44
 
25
45
  - [readme]: Update README to clarify Node.js installation instructions and emphasize LTS version.
package/README-SERVICE.md CHANGED
@@ -35,7 +35,7 @@ Create a systemctl configuration file for Matterbridge
35
35
  sudo nano /etc/systemd/system/matterbridge.service
36
36
  ```
37
37
 
38
- Add the following to this file, replacing twice (!) USER with your user name (e.g. WorkingDirectory=/home/pi/Matterbridge and User=pi):
38
+ Add the following to this file, replacing 3 times (!) USER with your user name (e.g. WorkingDirectory=/home/pi/Matterbridge, User=pi and Group=pi):
39
39
 
40
40
  You may need to adapt the configuration to your setup:
41
41
 
@@ -49,18 +49,27 @@ After=network-online.target
49
49
  [Service]
50
50
  Type=simple
51
51
  ExecStart=matterbridge -service
52
- WorkingDirectory=/home/<USER>/Matterbridge
52
+ WorkingDirectory=/home/<USER>/Matterbridge # Replace <USER> with your system username
53
53
  StandardOutput=inherit
54
54
  StandardError=inherit
55
55
  Restart=always
56
56
  RestartSec=10s
57
57
  TimeoutStopSec=30s
58
- User=<USER>
58
+ User=<USER> # Replace <USER> with your system username
59
+ Group=<USER> # Replace <USER> with your system username
59
60
 
60
61
  [Install]
61
62
  WantedBy=multi-user.target
62
63
  ```
63
64
 
65
+ If you use the frontend with -ssl -frontend 443 and get an error message: "Port 443 requires elevated privileges",
66
+ add this:
67
+
68
+ ```
69
+ [Service]
70
+ AmbientCapabilities=CAP_NET_BIND_SERVICE
71
+ ```
72
+
64
73
  If you modify it after, then run:
65
74
 
66
75
  ```
package/README.md CHANGED
@@ -46,7 +46,7 @@ A special thank to Apollon77 for his incredible work.
46
46
 
47
47
  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.
48
48
 
49
- 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.
49
+ 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.
50
50
  The supported versions of node are 18, 20 and 22. Please install node 22 LTS.
51
51
  Nvm is not a good choice and should not be used for production.
52
52
 
@@ -116,6 +116,8 @@ Here's how to specify a different port number:
116
116
  matterbridge -frontend [port number]
117
117
  ```
118
118
 
119
+ To use the frontend with ssl place the certificates in the .matterbridge/certs directory: cert.pem, key.pem and ca.pem (optional).
120
+
119
121
  From the frontend you can do all operations in an easy way.
120
122
 
121
123
  Home page:
package/dist/cli.js CHANGED
@@ -1,27 +1,4 @@
1
1
  #!/usr/bin/env node
2
- /**
3
- * This file contains the CLI entry point of Matterbridge.
4
- *
5
- * @file cli.ts
6
- * @author Luca Liguori
7
- * @date 2023-12-29
8
- * @version 1.0.11
9
- *
10
- * Copyright 2023, 2024, 2025 Luca Liguori.
11
- *
12
- * Licensed under the Apache License, Version 2.0 (the "License");
13
- * you may not use this file except in compliance with the License.
14
- * You may obtain a copy of the License at
15
- *
16
- * http://www.apache.org/licenses/LICENSE-2.0
17
- *
18
- * Unless required by applicable law or agreed to in writing, software
19
- * distributed under the License is distributed on an "AS IS" BASIS,
20
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21
- * See the License for the specific language governing permissions and
22
- * limitations under the License. *
23
- */
24
- /* eslint-disable no-console */
25
2
  import { Matterbridge } from './matterbridge.js';
26
3
  import { MatterbridgeEdge } from './matterbridgeEdge.js';
27
4
  let instance;
@@ -64,7 +41,6 @@ async function restart() {
64
41
  async function update() {
65
42
  if (process.argv.includes('-debug'))
66
43
  console.log(cli + 'CLI: received update event, updating...' + rs);
67
- // TODO: Implement update logic outside of matterbridge
68
44
  if (process.argv.includes('-edge'))
69
45
  instance = await MatterbridgeEdge.loadInstance();
70
46
  else
@@ -72,8 +48,6 @@ async function update() {
72
48
  registerHandlers();
73
49
  }
74
50
  process.title = 'matterbridge';
75
- // Run the main function
76
51
  main().catch((error) => {
77
52
  console.error(er + `CLI: Matterbridge.loadInstance() failed with error: ${error}` + rs);
78
53
  });
79
- //# sourceMappingURL=cli.js.map
@@ -1,3 +1 @@
1
1
  export {};
2
- // Nothing to export right now
3
- //# sourceMappingURL=export.js.map
@@ -1,25 +1,3 @@
1
- /**
2
- * This file contains the default config for the plugins.
3
- *
4
- * @file defaultConfigSchema.ts
5
- * @author Luca Liguori
6
- * @date 2024-05-07
7
- * @version 1.0.1
8
- *
9
- * Copyright 2024, 2025, 2026 Luca Liguori.
10
- *
11
- * Licensed under the Apache License, Version 2.0 (the "License");
12
- * you may not use this file except in compliance with the License.
13
- * You may obtain a copy of the License at
14
- *
15
- * http://www.apache.org/licenses/LICENSE-2.0
16
- *
17
- * Unless required by applicable law or agreed to in writing, software
18
- * distributed under the License is distributed on an "AS IS" BASIS,
19
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20
- * See the License for the specific language governing permissions and
21
- * limitations under the License. *
22
- */
23
1
  export const zigbee2mqtt_config = {
24
2
  name: 'matterbridge-zigbee2mqtt',
25
3
  type: 'DynamicPlatform',
@@ -55,7 +33,7 @@ export const shelly_config = {
55
33
  type: 'DynamicPlatform',
56
34
  username: '',
57
35
  password: '',
58
- exposeSwitch: 'switch',
36
+ exposeSwitch: 'outlet',
59
37
  switchList: [],
60
38
  lightList: [],
61
39
  outletList: [],
@@ -68,6 +46,8 @@ export const shelly_config = {
68
46
  exposePowerMeter: 'matter13',
69
47
  blackList: [],
70
48
  whiteList: [],
49
+ entityBlackList: [],
50
+ deviceEntityBlackList: {},
71
51
  nocacheList: [],
72
52
  deviceIp: {},
73
53
  enableMdnsDiscover: true,
@@ -83,4 +63,3 @@ export const shelly_config = {
83
63
  debugWs: false,
84
64
  unregisterOnShutdown: false,
85
65
  };
86
- //# sourceMappingURL=defaultConfigSchema.js.map
@@ -1,26 +1,3 @@
1
- /**
2
- * This file contains the DeviceManager class.
3
- *
4
- * @file devices.ts
5
- * @author Luca Liguori
6
- * @date 2024-07-26
7
- * @version 1.0.8
8
- *
9
- * Copyright 2024, 2025, 2026 Luca Liguori.
10
- *
11
- * Licensed under the Apache License, Version 2.0 (the "License");
12
- * you may not use this file except in compliance with the License.
13
- * You may obtain a copy of the License at
14
- *
15
- * http://www.apache.org/licenses/LICENSE-2.0
16
- *
17
- * Unless required by applicable law or agreed to in writing, software
18
- * distributed under the License is distributed on an "AS IS" BASIS,
19
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20
- * See the License for the specific language governing permissions and
21
- * limitations under the License. *
22
- */
23
- // NodeStorage and AnsiLogger modules
24
1
  import { AnsiLogger, BLUE, er } from 'node-ansi-logger';
25
2
  import { dev } from './matterbridgeTypes.js';
26
3
  export class DeviceManager {
@@ -31,7 +8,7 @@ export class DeviceManager {
31
8
  constructor(matterbridge, nodeContext) {
32
9
  this.matterbridge = matterbridge;
33
10
  this.nodeContext = nodeContext;
34
- this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: matterbridge.log.logLevel });
11
+ this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4, logLevel: matterbridge.log.logLevel });
35
12
  this.log.debug('Matterbridge device manager starting...');
36
13
  }
37
14
  get length() {
@@ -77,7 +54,6 @@ export class DeviceManager {
77
54
  }
78
55
  catch (error) {
79
56
  this.log.error(`Error processing forEach device ${dev}${device.deviceName}${er} serialNumber ${BLUE}${device.serialNumber}${er} uniqueId: ${BLUE}${device.uniqueId}${er}:`, error);
80
- // throw error;
81
57
  }
82
58
  });
83
59
  await Promise.all(tasks);
@@ -89,4 +65,3 @@ export class DeviceManager {
89
65
  this.log.logLevel = logLevel;
90
66
  }
91
67
  }
92
- //# sourceMappingURL=deviceManager.js.map
package/dist/index.js CHANGED
@@ -1,36 +1,10 @@
1
- /**
2
- * This file contains the entry point of Matterbridge.
3
- *
4
- * @file index.ts
5
- * @author Luca Liguori
6
- * @date 2023-12-29
7
- * @version 1.0.6
8
- *
9
- * Copyright 2023, 2024, 2025 Luca Liguori.
10
- *
11
- * Licensed under the Apache License, Version 2.0 (the "License");
12
- * you may not use this file except in compliance with the License.
13
- * You may obtain a copy of the License at
14
- *
15
- * http://www.apache.org/licenses/LICENSE-2.0
16
- *
17
- * Unless required by applicable law or agreed to in writing, software
18
- * distributed under the License is distributed on an "AS IS" BASIS,
19
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20
- * See the License for the specific language governing permissions and
21
- * limitations under the License. *
22
- */
23
1
  import { Matterbridge } from './matterbridge.js';
24
2
  import { MatterbridgeEdge } from './matterbridgeEdge.js';
25
- // @matter
26
- // export { Identity, AtLeastOne } from '@matter/main';
27
3
  export * from '@matter/main/clusters';
28
4
  export * from '@matter/main/types';
29
5
  export { SemanticNamespace, ClosureTag, CompassDirectionTag, CompassLocationTag, DirectionTag, ElectricalMeasurementTag, LaundryTag, LevelTag, LocationTag, NumberTag, PositionTag, PowerSourceTag, RefrigeratorTag, RoomAirConditionerTag, SwitchesTag, } from '@matter/node';
30
- // @project-chip
31
6
  export * from '@project-chip/matter.js/device';
32
7
  export * from '@project-chip/matter.js/cluster';
33
- // Matterbridge
34
8
  export * from './matterbridge.js';
35
9
  export * from './matterbridgeTypes.js';
36
10
  export * from './matterbridgeDevice.js';
@@ -43,19 +17,15 @@ const cli = '\u001B[32m';
43
17
  const er = '\u001B[38;5;9m';
44
18
  const rs = '\u001B[40;0m';
45
19
  async function main() {
46
- // eslint-disable-next-line no-console
47
20
  if (process.argv.includes('-debug'))
48
21
  console.log(cli + 'MAIN: Matterbridge.loadInstance() called' + rs);
49
22
  if (process.argv.includes('-edge'))
50
23
  await MatterbridgeEdge.loadInstance();
51
24
  else
52
25
  await Matterbridge.loadInstance();
53
- // eslint-disable-next-line no-console
54
26
  if (process.argv.includes('-debug'))
55
27
  console.log(cli + 'MAIN: Matterbridge.loadInstance() exited' + rs);
56
28
  }
57
29
  main().catch((error) => {
58
- // eslint-disable-next-line no-console
59
30
  console.error(er + `MAIN: Matterbridge.loadInstance() failed with error: ${error}` + rs);
60
31
  });
61
- //# sourceMappingURL=index.js.map
@@ -1,2 +1 @@
1
1
  export * from 'node-ansi-logger';
2
- //# sourceMappingURL=export.js.map
@@ -1,6 +1,10 @@
1
1
  export * from '@matter/main';
2
+ export { AggregatorEndpoint } from '@matter/main/endpoints';
3
+ export * from '@matter/main/devices';
4
+ export * from '@matter/main/behaviors';
5
+ export { FabricAction, MdnsService, PaseClient } from '@matter/main/protocol';
2
6
  export { AttributeElement, ClusterElement, ClusterModel, CommandElement, EventElement, FieldElement } from '@matter/main/model';
3
7
  export * from '../matterbridgeDeviceTypes.js';
4
8
  export * from '../matterbridgeEndpoint.js';
5
9
  export * from '../matterbridgeBehaviors.js';
6
- //# sourceMappingURL=export.js.map
10
+ export * from '../matterbridgeEdge.js';