@project-chip/matter-node.js-examples 0.5.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,215 @@
+# matter-node.js-examples
+
+[![license](https://img.shields.io/badge/license-Apache2-green.svg?style=flat)](https://raw.githubusercontent.com/mfucci/node-matter/master/LICENSE)
+
+This project provides a set of reference implementations to offer several types of Matter device nodes or also a controller.
+
+> This package requires Node 16+ for the required Crypto primitives
+
+# matter-node.js Usage examples / Reference implementations
+
+To better show how to use the library we provide some reference implementations in the examples directory. They are usable as CLI scripts without changes in the first place but are very simple. They are meant to be used as a starting point for your own implementation, or to experiment with Matter at all in a first place.
+
+For BLE usage please also see the [matter-node-ble.js README.md](../matter-node-ble.js/README.md)  for prerequisites and limitations!
+
+## Installation
+
+### From NPM
+
+```bash
+npm i -g @project-chip/matter-node.js-examples
+```
+
+### Use from Cloned MatterServer.js Repository
+
+When you clone the matter.js repository you can also use matter-node.js. To do this you need to execute `npm install` in the matter.js root directory once to install all dependencies and build all packages.
+
+Then after `cd packages/matter-node.js-examples` you can use `npm run matter-device` to run the matter-node.js server. Please see the next section for more details.
+
+## CLI usage
+
+### Common CLI parameter for all examples
+The following CLI parameters are the same for all examples:
+
+* -clearstorage: the storage location will be reset on start of the process. The sorage location is set via parameter "-store" (see concrete examples below)
+* -loglevel: the log level to use (default: debug, possible values: fatal, error, warn, info, debug)
+* -logformat: the log format to use (default: ansi (if executed in a shell/tty), else plain, possible values: ansi, plain, html)
+
+### Start a simple Matter Device Node
+
+> The code for this example is in [src/examples/DeviceNode.ts](./src/examples/DeviceNode.ts).
+
+To run from the build files:
+
+```bash
+matter-device
+```
+
+To run directly from Typescript files with on the fly compilation:
+
+```bash
+npm run matter-device
+```
+
+This starts a MatterServer (DeviceNode) server listening on port 5540 and announce it as socket device.
+
+This first version only includes the OnOff cluster (on/off smart thing, like a plug or a bulb).
+You can use -on and -off parameter to run a script to control something.
+For instance, on a Raspberry Pi, this will turn on / off the red LED:
+
+```bash
+matter-device -type socket -on "echo 255 > /sys/class/leds/led1/brightness" -off "echo 0 > /sys/class/leds/led1/brightness"
+```
+
+or when starting from TS files:
+
+```bash
+npm run matter-device -- -type socket -on "echo 255 > /sys/class/leds/led1/brightness" -off "echo 0 > /sys/class/leds/led1/brightness"
+```
+(Please note the "--" to separate commandline parameters between the npm run and the executed script.
+
+The following parameters are available:
+* -passcode: the passcode to use for pairing (default: 20202021)
+* -discriminator: the discriminator to use for pairing (default: 3840, value between 0 and 4095)
+* -vendorid: the vendor ID as number to use for pairing (default: 65521 (0xFFF1))
+* -productid: the product ID as number to use for pairing (default: 32768 (0x8000))
+* -uniqueid: a unique ID for this device to be used in naming and to store structure information (default: ms time now)
+* -type: the device type to use for pairing (default: light, alternative value is "socket")
+* -announceinterface: limit mdns announcements to the provided network interface, e.g. "en0" (default: all interfaces available)
+* -ble: enable BLE support (default: false) If this is enabled the device will announce itself _only_ via BLE if not commissioned and also presents a "Wifi only" device for commissioning to show this feature!
+* -ble-hci-id: Optionally, HCI ID to use (Linux only, default 0)
+* -port: the port to listen on for the device (default: 5540)
+* -store: the storage location (directory) to use for storing the pairing information (default: .device-node). Ideally use names starting with a ".". Delete the directory or provide an alternative name to reset the device
+* -on: the command to run when the device is turned on (see example above)
+* -off: the command to run when the device is turned off (see example above)
+
+Additionally, there are some Testing parameters:
+* -ble-wifi-scan-ssid: The Wi-Fi SSID returned by the "ScanNetworks" call of the Wifi Network commissioning cluster used when using BLE commissioning (default: "TestSSID"). Ideally use a really existing SSID that also the commissioner (Apple, Alexa, ...) knows to make it easier to commission. Else you could get errors while commissioning.
+* -ble-wifi-scan-bssid: The Wi-Fi BSSID returned by the "ScanNetworks" call of the Wifi Network commissioning cluster used when using BLE commissioning (default: "00:00:00:00:00:00").
+
+### Start a Matter Bridge
+
+> The code for this example is in [src/examples/BridgedDevicesNode.ts](./src/examples/BridgedDevicesNode.ts).
+
+A Bridge is used to expose multiple devices at once.
+
+The usage and parameter are comparable to above. but the bridge adds support for multiple types and on/off commands:
+
+The usage is as above but with modified parameters:
+* -num X: number of devices to expose (default 2)
+* -typeX socket: type of the devices to expose as device number X (default Light bulb)
+* -onX "script": script to run when the device number X is turned on
+* -offX "script": script to run when the device number X is turned off
+
+**Please especially use the -uniqueidX parameters to assign unique own IDs to the single deices in order to remember their structure in the bridge. Such an ID should never be reused if you ever remove or add new devices! If you do not use -uniqueidX then the order you added them here is not allowed to ever change.**
+
+```bash
+matter-bridge -num 2 -on1 "echo 255 > /sys/class/leds/led1/brightness" -off1 "echo 0 > /sys/class/leds/led1/brightness" -type2 socket -on2 "echo 255 > /sys/class/leds/led2/brightness" -off2 "echo 0 > /sys/class/leds/led2/brightness"
+```
+
+or when starting from TS files:
+
+```bash
+npm run matter-bridge -- -num 2 -on1 "echo 255 > /sys/class/leds/led1/brightness" -off1 "echo 0 > /sys/class/leds/led1/brightness" -type2 socket -on2 "echo 255 > /sys/class/leds/led2/brightness" -off2 "echo 0 > /sys/class/leds/led2/brightness"
+```
+(Please note the "--" to separate commandline parameters between the npm run and the executed script.
+
+The above command exposes two devices under the bridge, one as light, one as socket and executes the respective commands when the devices are turned on or off.
+
+### Start a Matter Composed Device
+
+> The code for this example is in [src/examples/ComposedDeviceNode.ts](./src/examples/ComposedDeviceNode.ts).
+
+A composed device is one device with multiple different device types combined. This is useful for devices that have multiple functions, e.g. a light bulb with a temperature sensor.
+
+The parameters are like with the bridge but with an added "-type light/socket" parameter to define the type of the composed device itself.
+
+```bash
+matter-composeddevice -type socket -num 2 -on1 "echo 255 > /sys/class/leds/led1/brightness" -off1 "echo 0 > /sys/class/leds/led1/brightness" -type2 socket -on2 "echo 255 > /sys/class/leds/led2/brightness" -off2 "echo 0 > /sys/class/leds/led2/brightness"
+```
+
+or when starting from TS files:
+
+```bash
+npm run matter-composeddevice -- -type socket -num 2 -on1 "echo 255 > /sys/class/leds/led1/brightness" -off1 "echo 0 > /sys/class/leds/led1/brightness" -type2 socket -on2 "echo 255 > /sys/class/leds/led2/brightness" -off2 "echo 0 > /sys/class/leds/led2/brightness"
+```
+(Please note the "--" to separate commandline parameters between the npm run and the executed script.
+
+The above command exposes a composed device with a socket and a light device and executes the respective commands when the devices are turned on or off.
+
+### Start multiple Matter Devices in one process
+
+> The code for this example is in [src/examples/MultiDeviceNode.ts](./src/examples/MultiDeviceNode.ts).
+
+matter.js also allows it to start multiple devices in one process. With this especially the MDNS functionalities are shared between these processes and it should use less resources. How many devices you acn add in one process depends on the load they produce and how many devices run in the single Node.js thread.
+
+The parameters are like with the composed device or bridge.
+
+```bash
+matter-multidevice -type socket -num 2 -on1 "echo 255 > /sys/class/leds/led1/brightness" -off1 "echo 0 > /sys/class/leds/led1/brightness" -type2 socket -on2 "echo 255 > /sys/class/leds/led2/brightness" -off2 "echo 0 > /sys/class/leds/led2/brightness"
+```
+
+or when starting from TS files:
+
+```bash
+npm run matter-multidevice -- -type socket -num 2 -on1 "echo 255 > /sys/class/leds/led1/brightness" -off1 "echo 0 > /sys/class/leds/led1/brightness" -type2 socket -on2 "echo 255 > /sys/class/leds/led2/brightness" -off2 "echo 0 > /sys/class/leds/led2/brightness"
+```
+(Please note the "--" to separate commandline parameters between the npm run and the executed script.
+
+The above command exposes two single light devices (one socket and on light) and executes the respective commands when the devices are turned on or off.
+
+### Start a Matter Controller
+
+> The code for this example is in [src/examples/ControllerNode.ts](./src/examples/ControllerNode.ts).
+
+**Experimental**
+The current controller implementation is no CLI tool, but shows the pairing of devices and resuming the connection and also showcase the existing low-level controller API. It is just intended to be used for debugging, during development! The code contains some commented-out examples of how to use the low level controller API.
+Please **do not** use this for production, we will replace the API soon!
+
+The controller currently is not discovering the device to pair, but directly connects to the IP/port defined bin the command line parameters.
+
+To run from the build files:
+
+```bash
+matter-controller -pairingcode 12345678901
+```
+
+To run directly from Typescript files with on the fly compilation:
+
+```bash
+npm run matter-controller -- -pairingcode 12345678901
+```
+
+This will commission a MatterServer device (for debugging/capability showing purpose only for now).
+
+The following parameters are available and used to initially commission a device (they can be omitted after this):
+* If the IP and Port of the device is known (should be only the case in testing cases) you can use the following parameters:
+  * -ip: the IP address of the device to commission (can be used but discovery via pairingcode or discriminator or also just pin (passode) is most likely better)
+  * -port the port of the device to commission (default: 5540)
+* Device identification options:
+  * -pairingcode: code to use for pairing (-longDiscriminator and -pin will be ignored) - usually the code below the QR Code on the device or displayed in the app!
+  * -longDiscriminator: the discriminator to use for pairing (default: 3840, value between 0 and 4095)
+  * -pin: the pin to use for pairing (default: 20202021)
+* When the device to commission is not already in the IP network and also not an Ethernet device commission can be done via ble. In this case the following parameters are used:
+  * -ble: enable BLE support (default: false) If this is enabled the controller will try to connect via BLE first (15s timeout) and then via IP if not commissioned yet!
+  * -ble-hci-id: Optionally, HCI ID to use (Linux only, default 0)
+  * -ble-wifi-ssid: SSID/Name of the Wifi network to connect to - The device will scan especially for this network and commissioning will fail if not found
+  * -ble-wifi-credentials: Credentials for the Wifi network to connect to
+  * -ble-thread-networkname: Name of the Thread network to connect to - The device will verify that a thread network with this name is reachable by the device and commissioning will fail if not found
+  * -ble-thread-operationaldataset: Operational dataset as hex string to use for commissioning (of using OTBR use `ot-ctl dataset active -x` to get the value)
+* Storage configuration parameter
+  * -store: the storage location (directory) to use for storing the pairing information (default: .controller-node). Ideally use names with "." at the beginning. Delete the directory or provide an alternative name to reset the controller
+  * -clearstorage: the storage location will be reset on start of the process
+
+## Development on basis of the examples
+
+The code of the examples is written so that you can use them as basis for your own scripts also outside of this library in your own package. YOu just need to add a dependency to @project-chip/matter-node.js. The examples are already using these imports for more easy adoption.
+
+### Development Device/Composed-device/Bridge
+
+The code is structured by comment blocks to better see what belongs to what. It always has code which is just collecting relevant information and data, then the code which is setting up the device and then the code which is starting the device.
+
+## Building
+
+* `npm run build`: Build all code and create CommonJS and ES6 variants in dist directory. This will built incrementally and only build the changed files.
+* `npm run build-clean`: Clean the dist directory and build all code from scratch

package/dist/examples/BridgedDevicesNode.js

@@ -0,0 +1,218 @@
+#!/usr/bin/env node
+"use strict";
+/**
+ * @license
+ * Copyright 2022 The node-matter Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var _a, _b;
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * This example shows how to create a device bridge that exposed multiple devices.
+ * It can be used as CLI script and starting point for your own device node implementation.
+ */
+/**
+ * Import needed modules from @project-chip/matter-node.js
+ */
+// Include this first to auto-register Crypto, Network and Time Node.js implementations
+const matter_node_js_1 = require("@project-chip/matter-node.js");
+const device_1 = require("@project-chip/matter-node.js/device");
+const log_1 = require("@project-chip/matter-node.js/log");
+const storage_1 = require("@project-chip/matter-node.js/storage");
+const time_1 = require("@project-chip/matter-node.js/time");
+const util_1 = require("@project-chip/matter-node.js/util");
+const datatype_1 = require("@project-chip/matter.js/datatype");
+const logger = log_1.Logger.get("Device");
+(0, util_1.requireMinNodeVersion)(16);
+/** Configure logging */
+switch ((0, util_1.getParameter)("loglevel")) {
+    case "fatal":
+        log_1.Logger.defaultLogLevel = log_1.Level.FATAL;
+        break;
+    case "error":
+        log_1.Logger.defaultLogLevel = log_1.Level.ERROR;
+        break;
+    case "warn":
+        log_1.Logger.defaultLogLevel = log_1.Level.WARN;
+        break;
+    case "info":
+        log_1.Logger.defaultLogLevel = log_1.Level.INFO;
+        break;
+}
+switch ((0, util_1.getParameter)("logformat")) {
+    case "plain":
+        log_1.Logger.format = log_1.Format.PLAIN;
+        break;
+    case "html":
+        log_1.Logger.format = log_1.Format.HTML;
+        break;
+    default:
+        if ((_a = process.stdin) === null || _a === void 0 ? void 0 : _a.isTTY)
+            log_1.Logger.format = log_1.Format.ANSI;
+}
+const storageLocation = (_b = (0, util_1.getParameter)("store")) !== null && _b !== void 0 ? _b : ".device-node";
+const storage = new storage_1.StorageBackendDisk(storageLocation, (0, util_1.hasParameter)("clearstorage"));
+logger.info(`Storage location: ${storageLocation} (Directory)`);
+logger.info('Use the parameter "-store NAME" to specify a different storage location, use -clearstorage to start with an empty storage.');
+class BridgedDevice {
+    start() {
+        var _a, _b, _c, _d, _e, _f;
+        return __awaiter(this, void 0, void 0, function* () {
+            logger.info(`node-matter`);
+            /**
+             * Initialize the storage system.
+             *
+             * The storage manager is then also used by the Matter server, so this code block in general is required,
+             * but you can choose a different storage backend as long as it implements the required API.
+             */
+            const storageManager = new storage_1.StorageManager(storage);
+            yield storageManager.initialize();
+            /**
+             * Collect all needed data
+             *
+             * This block makes sure to collect all needed data from cli or storage. Replace this with where ever your data
+             * come from.
+             *
+             * Note: This example also uses the initialized storage system to store the device parameter data for convenience
+             * and easy reuse. When you also do that be careful to not overlap with Matter-Server own contexts
+             * (so maybe better not ;-)).
+             */
+            const deviceStorage = storageManager.createContext("Device");
+            const deviceName = "Matter Bridge device";
+            const deviceType = device_1.DeviceTypes.AGGREGATOR.code;
+            const vendorName = "matter-node.js";
+            const passcode = (_a = (0, util_1.getIntParameter)("passcode")) !== null && _a !== void 0 ? _a : deviceStorage.get("passcode", 20202021);
+            const discriminator = (_b = (0, util_1.getIntParameter)("discriminator")) !== null && _b !== void 0 ? _b : deviceStorage.get("discriminator", 3840);
+            // product name / id and vendor id should match what is in the device certificate
+            const vendorId = (_c = (0, util_1.getIntParameter)("vendorid")) !== null && _c !== void 0 ? _c : deviceStorage.get("vendorid", 0xfff1);
+            const productName = `node-matter OnOff-Bridge`;
+            const productId = (_d = (0, util_1.getIntParameter)("productid")) !== null && _d !== void 0 ? _d : deviceStorage.get("productid", 0x8000);
+            const netAnnounceInterface = (0, util_1.getParameter)("announceinterface");
+            const port = (_e = (0, util_1.getIntParameter)("port")) !== null && _e !== void 0 ? _e : 5540;
+            const uniqueId = (_f = (0, util_1.getIntParameter)("uniqueid")) !== null && _f !== void 0 ? _f : deviceStorage.get("uniqueid", time_1.Time.nowMs());
+            deviceStorage.set("passcode", passcode);
+            deviceStorage.set("discriminator", discriminator);
+            deviceStorage.set("vendorid", vendorId);
+            deviceStorage.set("productid", productId);
+            deviceStorage.set("uniqueid", uniqueId);
+            /**
+             * Create Matter Server and CommissioningServer Node
+             *
+             * To allow the device to be announced, found, paired and operated we need a MatterServer instance and add a
+             * commissioningServer to it and add the just created device instance to it.
+             * The CommissioningServer node defines the port where the server listens for the UDP packages of the Matter protocol
+             * and initializes deice specific certificates and such.
+             *
+             * The below logic also adds command handlers for commands of clusters that normally are handled internally
+             * like testEventTrigger (General Diagnostic Cluster) that can be implemented with the logic when these commands
+             * are called.
+             */
+            this.matterServer = new matter_node_js_1.MatterServer(storageManager, netAnnounceInterface);
+            const commissioningServer = new matter_node_js_1.CommissioningServer({
+                port,
+                deviceName,
+                deviceType,
+                passcode,
+                discriminator,
+                basicInformation: {
+                    vendorName,
+                    vendorId: (0, datatype_1.VendorId)(vendorId),
+                    nodeLabel: productName,
+                    productName,
+                    productLabel: productName,
+                    productId,
+                    serialNumber: `node-matter-${uniqueId}`,
+                },
+            });
+            /**
+             * Create Device instance and add needed Listener
+             *
+             * Create an instance of the matter device class you want to use.
+             * This example uses the OnOffLightDevice or OnOffPluginUnitDevice depending on the value of the type  parameter.
+             * To execute the on/off scripts defined as parameters a listener for the onOff attribute is registered via the
+             * device specific API.
+             *
+             * The below logic also adds command handlers for commands of clusters that normally are handled device internally
+             * like identify that can be implemented with the logic when these commands are called.
+             */
+            const aggregator = new device_1.Aggregator();
+            const numDevices = (0, util_1.getIntParameter)("num") || 2;
+            for (let i = 1; i <= numDevices; i++) {
+                const onOffDevice = (0, util_1.getParameter)(`type${i}`) === "socket" ? new device_1.OnOffPluginUnitDevice() : new device_1.OnOffLightDevice();
+                onOffDevice.addOnOffListener(on => { var _a; return (_a = (0, util_1.commandExecutor)(on ? `on${i}` : `off${i}`)) === null || _a === void 0 ? void 0 : _a(); });
+                onOffDevice.addCommandHandler("identify", ({ request: { identifyTime } }) => __awaiter(this, void 0, void 0, function* () {
+                    return console.log(`Identify called for OnOffDevice ${onOffDevice.name} with id: ${i} and identifyTime: ${identifyTime}`);
+                }));
+                const name = `OnOff ${onOffDevice instanceof device_1.OnOffPluginUnitDevice ? "Socket" : "Light"} ${i}`;
+                aggregator.addBridgedDevice(onOffDevice, {
+                    nodeLabel: name,
+                    productName: name,
+                    productLabel: name,
+                    serialNumber: `node-matter-${uniqueId}-${i}`,
+                    reachable: true,
+                });
+            }
+            commissioningServer.addDevice(aggregator);
+            this.matterServer.addCommissioningServer(commissioningServer);
+            /**
+             * Start the Matter Server
+             *
+             * After everything was plugged together we can start the server. When not delayed announcement is set for the
+             * CommissioningServer node then this command also starts the announcement of the device into the network.
+             */
+            yield this.matterServer.start();
+            /**
+             * Print Pairing Information
+             *
+             * If the device is not already commissioned (this info is stored in the storage system) then get and print the
+             * pairing details. This includes the QR code that can be scanned by the Matter app to pair the device.
+             */
+            logger.info("Listening");
+            if (!commissioningServer.isCommissioned()) {
+                const pairingData = commissioningServer.getPairingCode();
+                const { qrCode, qrPairingCode, manualPairingCode } = pairingData;
+                console.log(qrCode);
+                console.log(`QR Code URL: https://project-chip.github.io/connectedhomeip/qrcode.html?data=${qrPairingCode}`);
+                console.log(`Manual pairing code: ${manualPairingCode}`);
+            }
+            else {
+                console.log("Device is already commissioned. Waiting for controllers to connect ...");
+            }
+        });
+    }
+    stop() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield ((_a = this.matterServer) === null || _a === void 0 ? void 0 : _a.close());
+        });
+    }
+}
+const device = new BridgedDevice();
+device
+    .start()
+    .then(() => {
+    /* done */
+})
+    .catch(err => console.error(err));
+process.on("SIGINT", () => {
+    device
+        .stop()
+        .then(() => {
+        // Pragmatic way to make sure the storage is correctly closed before the process ends.
+        storage
+            .close()
+            .then(() => process.exit(0))
+            .catch(err => console.error(err));
+    })
+        .catch(err => console.error(err));
+});
+//# sourceMappingURL=BridgedDevicesNode.js.map

package/dist/examples/BridgedDevicesNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BridgedDevicesNode.js","sourceRoot":"","sources":["../../src/examples/BridgedDevicesNode.ts"],"names":[],"mappings":";;AACA;;;;GAIG;;;;;;;;;;;;AAEH;;;GAGG;AAEH;;GAEG;AACH,uFAAuF;AACvF,iEAAiF;AAEjF,gEAAuH;AACvH,0DAAyE;AACzE,kEAA0F;AAC1F,4DAAyD;AACzD,4DAM2C;AAC3C,+DAA4D;AAE5D,MAAM,MAAM,GAAG,YAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAEpC,IAAA,4BAAqB,EAAC,EAAE,CAAC,CAAC;AAE1B,wBAAwB;AACxB,QAAQ,IAAA,mBAAY,EAAC,UAAU,CAAC,EAAE;IAC9B,KAAK,OAAO;QACR,YAAM,CAAC,eAAe,GAAG,WAAK,CAAC,KAAK,CAAC;QACrC,MAAM;IACV,KAAK,OAAO;QACR,YAAM,CAAC,eAAe,GAAG,WAAK,CAAC,KAAK,CAAC;QACrC,MAAM;IACV,KAAK,MAAM;QACP,YAAM,CAAC,eAAe,GAAG,WAAK,CAAC,IAAI,CAAC;QACpC,MAAM;IACV,KAAK,MAAM;QACP,YAAM,CAAC,eAAe,GAAG,WAAK,CAAC,IAAI,CAAC;QACpC,MAAM;CACb;AAED,QAAQ,IAAA,mBAAY,EAAC,WAAW,CAAC,EAAE;IAC/B,KAAK,OAAO;QACR,YAAM,CAAC,MAAM,GAAG,YAAM,CAAC,KAAK,CAAC;QAC7B,MAAM;IACV,KAAK,MAAM;QACP,YAAM,CAAC,MAAM,GAAG,YAAM,CAAC,IAAI,CAAC;QAC5B,MAAM;IACV;QACI,IAAI,MAAA,OAAO,CAAC,KAAK,0CAAE,KAAK;YAAE,YAAM,CAAC,MAAM,GAAG,YAAM,CAAC,IAAI,CAAC;CAC7D;AAED,MAAM,eAAe,GAAG,MAAA,IAAA,mBAAY,EAAC,OAAO,CAAC,mCAAI,cAAc,CAAC;AAChE,MAAM,OAAO,GAAG,IAAI,4BAAkB,CAAC,eAAe,EAAE,IAAA,mBAAY,EAAC,cAAc,CAAC,CAAC,CAAC;AACtF,MAAM,CAAC,IAAI,CAAC,qBAAqB,eAAe,cAAc,CAAC,CAAC;AAChE,MAAM,CAAC,IAAI,CACP,4HAA4H,CAC/H,CAAC;AAEF,MAAM,aAAa;IAGT,KAAK;;;YACP,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAE3B;;;;;eAKG;YAEH,MAAM,cAAc,GAAG,IAAI,wBAAc,CAAC,OAAO,CAAC,CAAC;YACnD,MAAM,cAAc,CAAC,UAAU,EAAE,CAAC;YAElC;;;;;;;;;eASG;YAEH,MAAM,aAAa,GAAG,cAAc,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAE7D,MAAM,UAAU,GAAG,sBAAsB,CAAC;YAC1C,MAAM,UAAU,GAAG,oBAAW,CAAC,UAAU,CAAC,IAAI,CAAC;YAC/C,MAAM,UAAU,GAAG,gBAAgB,CAAC;YACpC,MAAM,QAAQ,GAAG,MAAA,IAAA,sBAAe,EAAC,UAAU,CAAC,mCAAI,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YACxF,MAAM,aAAa,GAAG,MAAA,IAAA,sBAAe,EAAC,eAAe,CAAC,mCAAI,aAAa,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YACnG,iFAAiF;YACjF,MAAM,QAAQ,GAAG,MAAA,IAAA,sBAAe,EAAC,UAAU,CAAC,mCAAI,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YACtF,MAAM,WAAW,GAAG,0BAA0B,CAAC;YAC/C,MAAM,SAAS,GAAG,MAAA,IAAA,sBAAe,EAAC,WAAW,CAAC,mCAAI,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;YAEzF,MAAM,oBAAoB,GAAG,IAAA,mBAAY,EAAC,mBAAmB,CAAC,CAAC;YAC/D,MAAM,IAAI,GAAG,MAAA,IAAA,sBAAe,EAAC,MAAM,CAAC,mCAAI,IAAI,CAAC;YAE7C,MAAM,QAAQ,GAAG,MAAA,IAAA,sBAAe,EAAC,UAAU,CAAC,mCAAI,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE,WAAI,CAAC,KAAK,EAAE,CAAC,CAAC;YAE5F,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YACxC,aAAa,CAAC,GAAG,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;YAClD,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YACxC,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;YAC1C,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAExC;;;;;;;;;;;eAWG;YAEH,IAAI,CAAC,YAAY,GAAG,IAAI,6BAAY,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;YAE3E,MAAM,mBAAmB,GAAG,IAAI,oCAAmB,CAAC;gBAChD,IAAI;gBACJ,UAAU;gBACV,UAAU;gBACV,QAAQ;gBACR,aAAa;gBACb,gBAAgB,EAAE;oBACd,UAAU;oBACV,QAAQ,EAAE,IAAA,mBAAQ,EAAC,QAAQ,CAAC;oBAC5B,SAAS,EAAE,WAAW;oBACtB,WAAW;oBACX,YAAY,EAAE,WAAW;oBACzB,SAAS;oBACT,YAAY,EAAE,eAAe,QAAQ,EAAE;iBAC1C;aACJ,CAAC,CAAC;YAEH;;;;;;;;;;eAUG;YAEH,MAAM,UAAU,GAAG,IAAI,mBAAU,EAAE,CAAC;YAEpC,MAAM,UAAU,GAAG,IAAA,sBAAe,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC,EAAE,EAAE;gBAClC,MAAM,WAAW,GACb,IAAA,mBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,8BAAqB,EAAE,CAAC,CAAC,CAAC,IAAI,yBAAgB,EAAE,CAAC;gBAEjG,WAAW,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE,WAAC,OAAA,MAAA,IAAA,sBAAe,EAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,2CAAI,CAAA,EAAA,CAAC,CAAC;gBACnF,WAAW,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAO,EAAE,OAAO,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE;oBAC9E,OAAA,OAAO,CAAC,GAAG,CACP,mCAAmC,WAAW,CAAC,IAAI,aAAa,CAAC,sBAAsB,YAAY,EAAE,CACxG,CAAA;kBAAA,CACJ,CAAC;gBAEF,MAAM,IAAI,GAAG,SAAS,WAAW,YAAY,8BAAqB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC;gBAC/F,UAAU,CAAC,gBAAgB,CAAC,WAAW,EAAE;oBACrC,SAAS,EAAE,IAAI;oBACf,WAAW,EAAE,IAAI;oBACjB,YAAY,EAAE,IAAI;oBAClB,YAAY,EAAE,eAAe,QAAQ,IAAI,CAAC,EAAE;oBAC5C,SAAS,EAAE,IAAI;iBAClB,CAAC,CAAC;aACN;YAED,mBAAmB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAE1C,IAAI,CAAC,YAAY,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;YAE9D;;;;;eAKG;YAEH,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;YAEhC;;;;;eAKG;YAEH,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzB,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,EAAE;gBACvC,MAAM,WAAW,GAAG,mBAAmB,CAAC,cAAc,EAAE,CAAC;gBACzD,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,iBAAiB,EAAE,GAAG,WAAW,CAAC;gBAEjE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,OAAO,CAAC,GAAG,CACP,gFAAgF,aAAa,EAAE,CAClG,CAAC;gBACF,OAAO,CAAC,GAAG,CAAC,wBAAwB,iBAAiB,EAAE,CAAC,CAAC;aAC5D;iBAAM;gBACH,OAAO,CAAC,GAAG,CAAC,wEAAwE,CAAC,CAAC;aACzF;;KACJ;IAEK,IAAI;;;YACN,MAAM,CAAA,MAAA,IAAI,CAAC,YAAY,0CAAE,KAAK,EAAE,CAAA,CAAC;;KACpC;CACJ;AAED,MAAM,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;AACnC,MAAM;KACD,KAAK,EAAE;KACP,IAAI,CAAC,GAAG,EAAE;IACP,UAAU;AACd,CAAC,CAAC;KACD,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;AAEtC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,MAAM;SACD,IAAI,EAAE;SACN,IAAI,CAAC,GAAG,EAAE;QACP,sFAAsF;QACtF,OAAO;aACF,KAAK,EAAE;aACP,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aAC3B,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1C,CAAC,CAAC;SACD,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;AAC1C,CAAC,CAAC,CAAC"}