matterbridge 3.2.3-dev-20250820-d283e3d → 3.2.3-dev-20250821-ef6a4eb
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.
- package/CHANGELOG.md +2 -1
- package/README-DEV.md +88 -0
- package/npm-shrinkwrap.json +2 -2
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -8,7 +8,7 @@ If you like this project and find it useful, please consider giving it a star on
|
|
|
8
8
|
<img src="bmc-button.svg" alt="Buy me a coffee" width="120">
|
|
9
9
|
</a>
|
|
10
10
|
|
|
11
|
-
## [3.2.3] - 2025-08
|
|
11
|
+
## [3.2.3] - 2025-08-20
|
|
12
12
|
|
|
13
13
|
### Added
|
|
14
14
|
|
|
@@ -18,6 +18,7 @@ If you like this project and find it useful, please consider giving it a star on
|
|
|
18
18
|
- [Refrigerator]: Added Refrigerator() class and Jest test. It is not supported by the Home app.
|
|
19
19
|
- [Pages]: Added first draft of https://luligu.github.io/matterbridge.
|
|
20
20
|
- [Matter]: Added Matter Specification Version 1.0, 1.1, 1.2, 1.3, 1.4 and 1.4.1 pdf files.
|
|
21
|
+
- [Development]: Improved README-DEV.md.
|
|
21
22
|
|
|
22
23
|
### Changed
|
|
23
24
|
|
package/README-DEV.md
CHANGED
|
@@ -288,6 +288,11 @@ All default cluster helpers are available as methods of MatterbridgeEndpoint.
|
|
|
288
288
|
|
|
289
289
|
## MatterbridgeEndpointOptions
|
|
290
290
|
|
|
291
|
+
- @param {Semtag[]} [tagList] - The tagList of the endpoint.
|
|
292
|
+
- @param {'server' | 'matter'} [mode] - The mode for the endpoint.
|
|
293
|
+
- @param {string} [id] - The unique storage key for the endpoint. If not provided, a default key will be used.
|
|
294
|
+
- @param {EndpointNumber} [number] - The endpoint number for the endpoint. If not provided, the endpoint will be created with the next available endpoint number.
|
|
295
|
+
|
|
291
296
|
```typescript
|
|
292
297
|
const robot = new RoboticVacuumCleaner('Robot Vacuum', 'RVC1238777820', 'server');
|
|
293
298
|
```
|
|
@@ -298,6 +303,89 @@ The mode=`server` property of MatterbridgeEndpointOptions, allows to create an i
|
|
|
298
303
|
|
|
299
304
|
The mode=`matter` property of MatterbridgeEndpointOptions, allows to create a (not bridged) Matter device that is added to the Matterbridge server node alongside the aggregator.
|
|
300
305
|
|
|
306
|
+
## MatterbridgeEndpoint single class devices
|
|
307
|
+
|
|
308
|
+
For the device types listed below there are single class provided to createa a fully functional device.
|
|
309
|
+
|
|
310
|
+
For a working example refer to the 'matterbridge-example-dynamic-platform'.
|
|
311
|
+
|
|
312
|
+
### Chapter 12. Robotic Device Types - Single class device types
|
|
313
|
+
|
|
314
|
+
```typescript
|
|
315
|
+
const robot = new RoboticVacuumCleaner('Robot Vacuum', 'RVC1238777820', 'server');
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
### Chapter 13. Appliances Device Types - Single class device types
|
|
319
|
+
|
|
320
|
+
```typescript
|
|
321
|
+
this.laundryWasher = new LaundryWasher('Laundry Washer', 'LW1234567890');
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
```typescript
|
|
325
|
+
this.laundryDryer = new LaundryDryer('Laundry Dryer', 'LDW1235227890');
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
```typescript
|
|
329
|
+
this.dishwasher = new Dishwasher('Dishwasher', 'DW1234567890');
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
```typescript
|
|
333
|
+
this.extractorHood = new ExtractorHood('Extractor Hood', 'EH1234567893');
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
```typescript
|
|
337
|
+
this.microwaveOven = new MicrowaveOven('Microwave Oven', 'MO1234567893');
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
The Oven is always a composed device. You create the Oven and add one or more cabinet.
|
|
341
|
+
|
|
342
|
+
```typescript
|
|
343
|
+
this.oven = new Oven('Oven', 'OV1234567890');
|
|
344
|
+
this.oven.addCabinet('Upper Cabinet', [{ mfgCode: null, namespaceId: PositionTag.Top.namespaceId, tag: PositionTag.Top.tag, label: PositionTag.Top.label }]);
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
The Cooktop is always a composed device. You create the Cooktop and add one or more surface.
|
|
348
|
+
|
|
349
|
+
```typescript
|
|
350
|
+
this.cooktop = new Cooktop('Cooktop', 'CT1234567890');
|
|
351
|
+
this.cooktop.addSurface('Surface Top Left', [
|
|
352
|
+
{ mfgCode: null, namespaceId: PositionTag.Top.namespaceId, tag: PositionTag.Top.tag, label: PositionTag.Top.label },
|
|
353
|
+
{ mfgCode: null, namespaceId: PositionTag.Left.namespaceId, tag: PositionTag.Left.tag, label: PositionTag.Left.label },
|
|
354
|
+
]);
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
The Refrigerator is always a composed device. You create the Refrigerator and add one or more cabinet.
|
|
358
|
+
|
|
359
|
+
```typescript
|
|
360
|
+
const refrigerator = new Refrigerator('Refrigerator', 'RE1234567890');
|
|
361
|
+
refrigerator.addCabinet('Refrigerator Top', [
|
|
362
|
+
{ mfgCode: null, namespaceId: PositionTag.Top.namespaceId, tag: PositionTag.Top.tag, label: 'Refrigerator Top' },
|
|
363
|
+
{ mfgCode: null, namespaceId: RefrigeratorTag.Refrigerator.namespaceId, tag: RefrigeratorTag.Refrigerator.tag, label: RefrigeratorTag.Refrigerator.label },
|
|
364
|
+
]);
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
### Chapter 14. Energy Device Types - Single class device types
|
|
368
|
+
|
|
369
|
+
```typescript
|
|
370
|
+
const waterHeater = new WaterHeater('Water Heater', 'WH3456177820');
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
```typescript
|
|
374
|
+
const evse = new Evse('Evse', 'EV3456127820');
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
```typescript
|
|
378
|
+
const solarPower = new SolarPower('Solar Power', 'SP3456127821');
|
|
379
|
+
```
|
|
380
|
+
|
|
381
|
+
```typescript
|
|
382
|
+
const batteryStorage = new BatteryStorage('Battery Storage', 'BS3456127822');
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
```typescript
|
|
386
|
+
const heatPump = new HeatPump('Heat Pump', 'HP1234567890');
|
|
387
|
+
```
|
|
388
|
+
|
|
301
389
|
## Plugin config file
|
|
302
390
|
|
|
303
391
|
Each plugin has a minimal default config file injected by Matterbridge when it is loaded:
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "matterbridge",
|
|
3
|
-
"version": "3.2.3-dev-
|
|
3
|
+
"version": "3.2.3-dev-20250821-ef6a4eb",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "matterbridge",
|
|
9
|
-
"version": "3.2.3-dev-
|
|
9
|
+
"version": "3.2.3-dev-20250821-ef6a4eb",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@matter/main": "0.15.3",
|
package/package.json
CHANGED