@project-chip/matter-node.js-examples 0.7.5-alpha.0-20240222-8696097f → 0.8.0-alpha.1-20240308-033110a3

package/README.md

@@ -12,6 +12,50 @@ To better show how to use the library we provide some reference implementations
 
 For BLE usage please also see the [matter-node-ble.js README.md](../matter-node-ble.js/README.md)  for prerequisites and limitations!
 
+## Examples Overview
+The examples provided by this repository show different use cases demonstrating how to build different device types and show various ways to implement and interact with the matter.js structures. This section gives an overview regarding what the different examples demonstrate.
+
+### Legacy Device Examples
+These examples use the matter.js API up to 0.7, which is considered "Legacy" now because it will be replaced by a new API starting with 0.8. The functionality is still working, but should be considered deprecated and will be removed with a later release!
+The filenames of these examples were adjusted in 0.8 and a "Legacy" was added to the end of the filename and "-legacy" to the npm run script name (exception: DeviceNode is now called DeviceNodeFullLegacy). Other than that they are fully compatible with the pre-0.7 versions also regarding storage location and structure and can be directly used as before.
+
+All examples create a MatterServer instance to add Matter nodes to be announced on a definable port number (default 5540).
+
+* **BridgedDevicesNodeLegacy**: This example shows how to build a Matter-Bridge that offers multiple OnOff lights and/or sockets as a bridge. It can be configured via command line and allows for the specification of shell commands that will be executed for on and off commands on the numbered devices. For more details, see below.
+* **ComposedDeviceNodeLegacy**: This example shows how to build a "simple" composed device where multiple OnOff lights and sockets are combined as one composed device. The devices are all added on the root level, so no bridge is used. The composed device can be configured via command line and allows for the specification of shell commands that will be executed for on and off commands, on the numbered devices. For more details, see below.
+* **DeviceNodeFullLegacy**: This example shows how to build a simple Device node with just one socket or light endpoint. The shell commands to be executed by on/off commands can be configured via CLI. Additionally, this example also shows how to enable BLE for a device node and tweaks the announcement so that only BLE is announced in the beginning. This example also includes a dummy WifiNetworkCommissioning implementation that simulates Wi-Fi logic for the commissioner. Furthermore it also shows how to handle testEventTrigger calls on the GeneralDiagnostics cluster which might be needed for official device testing cases. It also implements the callbacks where implementers can get information on commissioning changes and session/connection changes to better know the status of the node.
+* **MultiDeviceNodeLegacy**: This example shows how to start multiple Matter nodes on one MatterServer where each node is run on its own Port, but share a single MDNS broadcaster and scanner in order to optimize resources. Each node can be configured via CLI to be an onoff socket or a light. CLI. Options also allow specification of shell commands to be executed for on and off commands.
+
+## New API Device Examples
+Some command line parameters, for example those used to set the level of logging or the MDNS interface are now included in the new environment processing. These can be set by generic command line arguments or by using environment variables. These parameters are processed automatically so are no longer handled by the new example code directly. These are:
+
+* `--log-level=...` or environment variable `MATTER_LOG_LEVEL` or in code `environment.vars.set('log.level', Level.DEBUG)`. Allowed values are: Level.FATAL ("fatal"), Level.ERROR ("error"), Level.WARN ("warn"), Level.NOTICE ("notice"), Level.INFO ("info"), Level.DEBUG ("debug")
+* `--log-format=...` or environment variable `MATTER_LOG_FORMAT` or `environment.vars.set('log.format', Format.PLAIN)`. Allowed values are: Format.PLAIN ("plain"), Format.HTML ("html"), Format.ANSI ("ansi")
+* `--storage-path=...` or environment variable `MATTER_STORAGE_PATH` or `environment.vars.set('storage.path', "...")` allows to set the storage location. By default, it will be stored in the users home directory in `.matter/...`. If specified, the given path will be used relative to the current working directory.
+* `--storage-clear` or environment variable `MATTER_STORAGE_CLEAR=1` or `environment.vars.set('storage.clear', true)` allows to define if the storage is reset on startup.
+* `--mdns-networkinterface=...` or environment variable `MATTER_MDNS_NETWORKINTERFACE` or `environment.vars.set('mdns.networkInterface', "...")` allows to limit the DNS announcements and scanning to one network interface. By default, all available interfaces are used.
+Additionally, all command line parameters now require to start with two dashes!
+
+* **BridgedDevicesNode**: This example shows how to build a Matter-Bridge that offers multiple OnOff lights and sockets as a bridge. It can be configured via command line and allows for specifications of shell commands to be executed when on and off commands are received at the numbered devices. For more details see below.
+* **ComposedDeviceNode**: This example shows how to build a "simple" composed device where multiple OnOff lights and sockets are combined as a single device. The devices are all added at the root level, so no bridge is used. It can be configured via command line and allows for specifications of shell commands to be executed when on and off commands are received at the numbered devices. For more details see below.
+* **DeviceNode**: This example shows how to build a simple minimalistic DeviceNode with just one socket or light endpoint. The shell commands to be executed by on/off commands can be configured via CLI.
+* **DeviceNodeFull**: This example shows how to build a simple Device node with just one socket or light endpoint. The shell commands to be executed by on/off commands can be configured via CLI. Additionally, this example also shows the following use cases:
+  * it shows how to enable BLE for a device node and tweaks the announcement so that BLE is only announced in the beginning. 
+  * it includes a dummy WifiNetworkCommissioning and a dummy ThreadNetworkCommissioning implementation that simulates Wi-Fi/Thread logic for the commissioner and logs the Wi-Fi/Thread credentials the commissioner sends to the device. 
+  * it enhances the GeneralDiagnostics and OnOff cluster to implement some commands with its own logic.
+  * it defines the ["My Fancy Functionality" custom cluster](./src/examples/cluster/MyFancyOwnFunctionality.ts) and adds this to the OnOff endpoint as additional cluster when the chosen vendorId is set to 0xfff4 (65524) 
+  * it implements the callbacks where developers can get information on commissioning changes and session/connection changes to better know the status of the node.
+* **MultiDeviceNode**: This example shows how to start multiple Matter nodes on one MatterServer where each node is run on its own Port, but share a single MDNS broadcaster and scanner in order to optimize resources. Each node can be configured via CLI to be an onoff socket or a light. CLI. Options also allow specification of shell commands to be executed for on and off commands.
+* * **SensorDeviceNode**: This example shows how to build a simple Sensor device with a temperature (default) or humidity (`--type humidity`) sensor. The sensor values are updated by default every 60 seconds, or the number of seconds specified via the CLI parameter `--interval`. The value can be defined by the output of a CLI script provided via parameter `--value` or, if no command is specified, are randomly set in the interval -50..+50. To read the Temperature of a Raspberry Pi as example use `--value ="echo \$((\$(</sys/class/thermal/thermal_zone0/temp)/10))"` or to read temperature of your location `--value="curl -s 'wttr.in/?format=%t\&m' | sed 's/°C//'| awk '{print \$1*100}'"` (or use `?format=%h` for humidity).
+
+Additionally, these two examples are not directly configurable by CLI and mainly show how to implement different combinations of devices:
+* **IlluminatedRollerShade**: This example implements the Window Covering cluster server logic and also overrides a OnOff cluster server to build a composed devices with a window covering nd a light.
+* **LightDevice**: This example shows how to run a Light device which is not configurable via CLI and only logs changes, so it is the most minimalistic example. It shows how to enhance the OnOff cluster server with own logic.
+
+## Controller example
+* **ControllerNode**: This example shows basically how a controller could be implemented by showing pairing and connections to a paired device. When there is an OnOff Endpoint with ID 1 then this is controlled and toggled.
+
+
 ## Installation
 
 ### From NPM

package/dist/esm/examples/BridgedDeviceNode.js

@@ -0,0 +1,147 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import "@project-chip/matter-node.js";
+import { requireMinNodeVersion } from "@project-chip/matter-node.js/util";
+import { BridgedDeviceBasicInformationServer } from "@project-chip/matter.js/behavior/definitions/bridged-device-basic-information";
+import { DeviceTypeId, VendorId } from "@project-chip/matter.js/datatype";
+import { logEndpoint } from "@project-chip/matter.js/device";
+import { OnOffLightDevice } from "@project-chip/matter.js/devices/OnOffLightDevice";
+import { OnOffPlugInUnitDevice } from "@project-chip/matter.js/devices/OnOffPlugInUnitDevice";
+import { Endpoint, EndpointServer } from "@project-chip/matter.js/endpoint";
+import { AggregatorEndpoint } from "@project-chip/matter.js/endpoint/definitions";
+import { Environment, StorageService } from "@project-chip/matter.js/environment";
+import { ServerNode } from "@project-chip/matter.js/node";
+import { Time } from "@project-chip/matter.js/time";
+import { execSync } from "child_process";
+requireMinNodeVersion(16);
+const { isSocket, deviceName, vendorName, passcode, discriminator, vendorId, productName, productId, port, uniqueId } = await getConfiguration();
+const server = await ServerNode.create({
+  // Required: Give the Node a unique ID which is used to store the state of this node
+  id: uniqueId,
+  // Provide Network relevant configuration like the port
+  // Optional when operating only one device on a host, Default port is 5540
+  network: {
+    port
+  },
+  // Provide Commissioning relevant settings
+  // Optional for development/testing purposes
+  commissioning: {
+    passcode,
+    discriminator
+  },
+  // Provide Node announcement settings
+  // Optional: If Ommitted some development defaults are used
+  productDescription: {
+    name: deviceName,
+    deviceType: DeviceTypeId(isSocket[0] ? OnOffPlugInUnitDevice.deviceType : OnOffLightDevice.deviceType)
+  },
+  // Provide defaults for the BasicInformation cluster on the Root endpoint
+  // Optional: If Omitted some development defaults are used
+  basicInformation: {
+    vendorName,
+    vendorId: VendorId(vendorId),
+    nodeLabel: productName,
+    productName,
+    productLabel: productName,
+    productId,
+    serialNumber: `matterjs-${uniqueId}`,
+    uniqueId
+  }
+});
+const aggregator = new Endpoint(AggregatorEndpoint, { id: "aggregator" });
+await server.add(aggregator);
+for (let idx = 0; idx < isSocket.length; idx++) {
+  const i = idx + 1;
+  const isASocket = isSocket[idx];
+  const name = `OnOff ${isASocket ? "Socket" : "Light"} ${i}`;
+  const endpoint = new Endpoint(
+    isASocket ? (
+      // For a Bridged Device we need to add a BridgedDeviceBasicInformation cluster as server
+      OnOffPlugInUnitDevice.with(BridgedDeviceBasicInformationServer)
+    ) : OnOffLightDevice.with(BridgedDeviceBasicInformationServer),
+    {
+      id: `onoff-${i}`,
+      bridgedDeviceBasicInformation: {
+        nodeLabel: name,
+        productName: name,
+        productLabel: name,
+        serialNumber: `node-matter-${uniqueId}-${i}`,
+        reachable: true
+      }
+    }
+  );
+  await aggregator.add(endpoint);
+  let isIdentifying = false;
+  endpoint.events.identify.identifyTime$Change.on((value) => {
+    if (value > 0 && !isIdentifying) {
+      isIdentifying = true;
+      console.log(`${name}: Run identify logic, ideally blink a light every 0.5s ...`);
+    } else if (value === 0) {
+      isIdentifying = false;
+      console.log(`${name}: Stop identify logic ...`);
+    }
+  });
+  endpoint.events.onOff.onOff$Change.on((value) => {
+    executeCommand(value ? `on${i}` : `off${i}`);
+    console.log(`${name} is now ${value ? "ON" : "OFF"}`);
+  });
+}
+await server.bringOnline();
+logEndpoint(EndpointServer.forEndpoint(server));
+function executeCommand(scriptParamName) {
+  const script = Environment.default.vars.string(scriptParamName);
+  if (script === void 0)
+    return void 0;
+  console.log(`${scriptParamName}: ${execSync(script).toString().slice(0, -1)}`);
+}
+async function getConfiguration() {
+  const environment = Environment.default;
+  const storageService = environment.get(StorageService);
+  console.log(`Storage location: ${storageService.location} (Directory)`);
+  console.log(
+    'Use the parameter "--storage-path=NAME-OR-PATH" to specify a different storage location in this directory, use --storage-clear to start with an empty storage.'
+  );
+  const deviceStorage = (await storageService.open("device")).createContext("data");
+  const isSocket2 = Array();
+  const numDevices = environment.vars.number("num") || 2;
+  if (deviceStorage.has("isSocket")) {
+    console.log(`Device types found in storage. --type parameter is ignored.`);
+    deviceStorage.get("isSocket").forEach((type) => isSocket2.push(type));
+  }
+  for (let i = 1; i <= numDevices; i++) {
+    if (isSocket2[i - 1] !== void 0)
+      continue;
+    isSocket2.push(environment.vars.string(`type${i}`) === "socket");
+  }
+  const deviceName2 = "Matter test device";
+  const vendorName2 = "matter-node.js";
+  const passcode2 = environment.vars.number("passcode") ?? deviceStorage.get("passcode", 20202021);
+  const discriminator2 = environment.vars.number("discriminator") ?? deviceStorage.get("discriminator", 3840);
+  const vendorId2 = environment.vars.number("vendorid") ?? deviceStorage.get("vendorid", 65521);
+  const productName2 = `node-matter OnOff ${isSocket2 ? "Socket" : "Light"}`;
+  const productId2 = environment.vars.number("productid") ?? deviceStorage.get("productid", 32768);
+  const port2 = environment.vars.number("port") ?? 5540;
+  const uniqueId2 = environment.vars.string("uniqueid") ?? deviceStorage.get("uniqueid", Time.nowMs().toString());
+  deviceStorage.set("passcode", passcode2);
+  deviceStorage.set("discriminator", discriminator2);
+  deviceStorage.set("vendorid", vendorId2);
+  deviceStorage.set("productid", productId2);
+  deviceStorage.set("isSocket", isSocket2);
+  deviceStorage.set("uniqueid", uniqueId2);
+  return {
+    isSocket: isSocket2,
+    deviceName: deviceName2,
+    vendorName: vendorName2,
+    passcode: passcode2,
+    discriminator: discriminator2,
+    vendorId: vendorId2,
+    productName: productName2,
+    productId: productId2,
+    port: port2,
+    uniqueId: uniqueId2
+  };
+}
+//# sourceMappingURL=BridgedDeviceNode.js.map

package/dist/esm/examples/BridgedDeviceNode.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/examples/BridgedDeviceNode.ts"],
+  "sourcesContent": ["/**\n * @license\n * Copyright 2022-2024 Matter.js Authors\n * SPDX-License-Identifier: Apache-2.0\n */\n\n/**\n * This example shows how to create a new device node that is composed of multiple devices.\n * It creates multiple endpoints on the server. For information on how to add a composed device to a bridge please\n * refer to the bridge example!\n * It can be used as CLI script and starting point for your own device node implementation.\n */\n\n/**\n * Import needed modules from @project-chip/matter-node.js\n */\n// Include this first to auto-register Crypto, Network and Time Node.js implementations\nimport \"@project-chip/matter-node.js\";\n\nimport { requireMinNodeVersion } from \"@project-chip/matter-node.js/util\";\nimport { BridgedDeviceBasicInformationServer } from \"@project-chip/matter.js/behavior/definitions/bridged-device-basic-information\";\nimport { DeviceTypeId, VendorId } from \"@project-chip/matter.js/datatype\";\nimport { logEndpoint } from \"@project-chip/matter.js/device\";\nimport { OnOffLightDevice } from \"@project-chip/matter.js/devices/OnOffLightDevice\";\nimport { OnOffPlugInUnitDevice } from \"@project-chip/matter.js/devices/OnOffPlugInUnitDevice\";\nimport { Endpoint, EndpointServer } from \"@project-chip/matter.js/endpoint\";\nimport { AggregatorEndpoint } from \"@project-chip/matter.js/endpoint/definitions\";\nimport { Environment, StorageService } from \"@project-chip/matter.js/environment\";\nimport { ServerNode } from \"@project-chip/matter.js/node\";\nimport { Time } from \"@project-chip/matter.js/time\";\nimport { execSync } from \"child_process\";\n\nrequireMinNodeVersion(16);\n\n/** Initialize configuration values */\nconst { isSocket, deviceName, vendorName, passcode, discriminator, vendorId, productName, productId, port, uniqueId } =\n    await getConfiguration();\n\n/**\n * Create a Matter ServerNode, which contains the Root Endpoint and all relevant data and configuration\n */\nconst server = await ServerNode.create({\n    // Required: Give the Node a unique ID which is used to store the state of this node\n    id: uniqueId,\n\n    // Provide Network relevant configuration like the port\n    // Optional when operating only one device on a host, Default port is 5540\n    network: {\n        port,\n    },\n\n    // Provide Commissioning relevant settings\n    // Optional for development/testing purposes\n    commissioning: {\n        passcode,\n        discriminator,\n    },\n\n    // Provide Node announcement settings\n    // Optional: If Ommitted some development defaults are used\n    productDescription: {\n        name: deviceName,\n        deviceType: DeviceTypeId(isSocket[0] ? OnOffPlugInUnitDevice.deviceType : OnOffLightDevice.deviceType),\n    },\n\n    // Provide defaults for the BasicInformation cluster on the Root endpoint\n    // Optional: If Omitted some development defaults are used\n    basicInformation: {\n        vendorName,\n        vendorId: VendorId(vendorId),\n        nodeLabel: productName,\n        productName,\n        productLabel: productName,\n        productId,\n        serialNumber: `matterjs-${uniqueId}`,\n        uniqueId,\n    },\n});\n\n/**\n * Matter Nodes are a composition of endpoints. Create and add a single multiple endpoint to the node to make it a\n * composed device. This example uses the OnOffLightDevice or OnOffPlugInUnitDevice depending on the value of the type\n * parameter. It also assigns each Endpoint a unique ID to store the endpoint number for it in the storage to restore\n * the device on restart.\n *\n * In this case we directly use the default command implementation from matter.js. Check out the DeviceNodeFull example\n * to see how to customize the command handlers.\n */\n\nconst aggregator = new Endpoint(AggregatorEndpoint, { id: \"aggregator\" });\nawait server.add(aggregator);\n\nfor (let idx = 0; idx < isSocket.length; idx++) {\n    const i = idx + 1;\n    const isASocket = isSocket[idx]; // Is the Device we add a Socket or a Light?\n\n    const name = `OnOff ${isASocket ? \"Socket\" : \"Light\"} ${i}`;\n\n    const endpoint = new Endpoint(\n        isASocket\n            ? // For a Bridged Device we need to add a BridgedDeviceBasicInformation cluster as server\n              OnOffPlugInUnitDevice.with(BridgedDeviceBasicInformationServer)\n            : OnOffLightDevice.with(BridgedDeviceBasicInformationServer),\n        {\n            id: `onoff-${i}`,\n            bridgedDeviceBasicInformation: {\n                nodeLabel: name,\n                productName: name,\n                productLabel: name,\n                serialNumber: `node-matter-${uniqueId}-${i}`,\n                reachable: true,\n            },\n        },\n    );\n    await aggregator.add(endpoint);\n\n    /**\n     * Register state change handlers of the endpoint for identify and onoff states to react to the commands.\n     *\n     * If the code in these change handlers fail then the change is also rolled back and not executed and an error is\n     * reported back to the controller.\n     */\n    let isIdentifying = false;\n    endpoint.events.identify.identifyTime$Change.on(value => {\n        // identifyTime is set when an identify commandf is called and then decreased every second while indenitfy logic runs.\n        if (value > 0 && !isIdentifying) {\n            isIdentifying = true;\n            console.log(`${name}: Run identify logic, ideally blink a light every 0.5s ...`);\n        } else if (value === 0) {\n            isIdentifying = false;\n            console.log(`${name}: Stop identify logic ...`);\n        }\n    });\n\n    endpoint.events.onOff.onOff$Change.on(value => {\n        executeCommand(value ? `on${i}` : `off${i}`);\n        console.log(`${name} is now ${value ? \"ON\" : \"OFF\"}`);\n    });\n}\n\n/**\n * In order to start the node and announce it into the network we use the run method which resolves when the node goes\n * offline again because we do not need anything more here. See the Full example for other starting options.\n * The QR Code is printed automatically.\n */\nawait server.bringOnline();\n\n/**\n * Log the endpoint structure for debugging reasons and to allow to verify anything is correct\n */\nlogEndpoint(EndpointServer.forEndpoint(server));\n\n/*\n  If you want to dynamically add another device during runtime you can do so by doing the following:\n\n    const name = `OnOff Light 3`;\n\n    const endpoint = new Endpoint(OnOffLightDevice.with(BridgedDeviceBasicInformationServer), {\n        id: `onoff-3`,\n        bridgedDeviceBasicInformation: {\n            nodeLabel: name,\n            productName: name,\n            productLabel: name,\n            serialNumber: `node-matter-${uniqueId}-3`,\n            reachable: true,\n        },\n    });\n    await aggregator.add(endpoint);\n\n    endpoint.events.onOff.onOff$Change.on(value => {\n        executeCommand(value ? `on3` : `off3`);\n        console.log(`${name} is now ${value ? \"ON\" : \"OFF\"}`);\n    });\n\n */\n\n/*\n   To remove a device during runtime you can do so by doing the following:\n        console.log(\"Removing Light 3 now!!\");\n\n        await endpoint.close();\n\n   This will automatically remove the endpoint from the bridge.\n */\n\n/*********************************************************************************************************\n * Convenience Methods\n *********************************************************************************************************/\n\n/** Defined a shell command from an environment variable and execute it and log the response. */\nfunction executeCommand(scriptParamName: string) {\n    const script = Environment.default.vars.string(scriptParamName);\n    if (script === undefined) return undefined;\n    console.log(`${scriptParamName}: ${execSync(script).toString().slice(0, -1)}`);\n}\n\nasync function getConfiguration() {\n    /**\n     * Collect all needed data\n     *\n     * This block collects all needed data from cli, environment or storage. Replace this with where ever your data come from.\n     *\n     * Note: This example uses the matter.js process storage system to store the device parameter data for convenience\n     * and easy reuse. When you also do that be careful to not overlap with Matter-Server own storage contexts\n     * (so maybe better not do it ;-)).\n     */\n    const environment = Environment.default;\n\n    const storageService = environment.get(StorageService);\n    console.log(`Storage location: ${storageService.location} (Directory)`);\n    console.log(\n        'Use the parameter \"--storage-path=NAME-OR-PATH\" to specify a different storage location in this directory, use --storage-clear to start with an empty storage.',\n    );\n    const deviceStorage = (await storageService.open(\"device\")).createContext(\"data\");\n\n    const isSocket = Array<boolean>();\n    const numDevices = environment.vars.number(\"num\") || 2;\n    if (deviceStorage.has(\"isSocket\")) {\n        console.log(`Device types found in storage. --type parameter is ignored.`);\n        deviceStorage.get<Array<boolean>>(\"isSocket\").forEach(type => isSocket.push(type));\n    }\n    for (let i = 1; i <= numDevices; i++) {\n        if (isSocket[i - 1] !== undefined) continue;\n        isSocket.push(environment.vars.string(`type${i}`) === \"socket\");\n    }\n\n    const deviceName = \"Matter test device\";\n    const vendorName = \"matter-node.js\";\n    const passcode = environment.vars.number(\"passcode\") ?? deviceStorage.get(\"passcode\", 20202021);\n    const discriminator = environment.vars.number(\"discriminator\") ?? deviceStorage.get(\"discriminator\", 3840);\n    // product name / id and vendor id should match what is in the device certificate\n    const vendorId = environment.vars.number(\"vendorid\") ?? deviceStorage.get(\"vendorid\", 0xfff1);\n    const productName = `node-matter OnOff ${isSocket ? \"Socket\" : \"Light\"}`;\n    const productId = environment.vars.number(\"productid\") ?? deviceStorage.get(\"productid\", 0x8000);\n\n    const port = environment.vars.number(\"port\") ?? 5540;\n\n    const uniqueId = environment.vars.string(\"uniqueid\") ?? deviceStorage.get(\"uniqueid\", Time.nowMs().toString());\n\n    // Persist basic data to keep them also on restart\n    deviceStorage.set(\"passcode\", passcode);\n    deviceStorage.set(\"discriminator\", discriminator);\n    deviceStorage.set(\"vendorid\", vendorId);\n    deviceStorage.set(\"productid\", productId);\n    deviceStorage.set(\"isSocket\", isSocket);\n    deviceStorage.set(\"uniqueid\", uniqueId);\n\n    return {\n        isSocket,\n        deviceName,\n        vendorName,\n        passcode,\n        discriminator,\n        vendorId,\n        productName,\n        productId,\n        port,\n        uniqueId,\n    };\n}\n"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAiBA,OAAO;AAEP,SAAS,6BAA6B;AACtC,SAAS,2CAA2C;AACpD,SAAS,cAAc,gBAAgB;AACvC,SAAS,mBAAmB;AAC5B,SAAS,wBAAwB;AACjC,SAAS,6BAA6B;AACtC,SAAS,UAAU,sBAAsB;AACzC,SAAS,0BAA0B;AACnC,SAAS,aAAa,sBAAsB;AAC5C,SAAS,kBAAkB;AAC3B,SAAS,YAAY;AACrB,SAAS,gBAAgB;AAEzB,sBAAsB,EAAE;AAGxB,MAAM,EAAE,UAAU,YAAY,YAAY,UAAU,eAAe,UAAU,aAAa,WAAW,MAAM,SAAS,IAChH,MAAM,iBAAiB;AAK3B,MAAM,SAAS,MAAM,WAAW,OAAO;AAAA;AAAA,EAEnC,IAAI;AAAA;AAAA;AAAA,EAIJ,SAAS;AAAA,IACL;AAAA,EACJ;AAAA;AAAA;AAAA,EAIA,eAAe;AAAA,IACX;AAAA,IACA;AAAA,EACJ;AAAA;AAAA;AAAA,EAIA,oBAAoB;AAAA,IAChB,MAAM;AAAA,IACN,YAAY,aAAa,SAAS,CAAC,IAAI,sBAAsB,aAAa,iBAAiB,UAAU;AAAA,EACzG;AAAA;AAAA;AAAA,EAIA,kBAAkB;AAAA,IACd;AAAA,IACA,UAAU,SAAS,QAAQ;AAAA,IAC3B,WAAW;AAAA,IACX;AAAA,IACA,cAAc;AAAA,IACd;AAAA,IACA,cAAc,YAAY,QAAQ;AAAA,IAClC;AAAA,EACJ;AACJ,CAAC;AAYD,MAAM,aAAa,IAAI,SAAS,oBAAoB,EAAE,IAAI,aAAa,CAAC;AACxE,MAAM,OAAO,IAAI,UAAU;AAE3B,SAAS,MAAM,GAAG,MAAM,SAAS,QAAQ,OAAO;AAC5C,QAAM,IAAI,MAAM;AAChB,QAAM,YAAY,SAAS,GAAG;AAE9B,QAAM,OAAO,SAAS,YAAY,WAAW,OAAO,IAAI,CAAC;AAEzD,QAAM,WAAW,IAAI;AAAA,IACjB;AAAA;AAAA,MAEM,sBAAsB,KAAK,mCAAmC;AAAA,QAC9D,iBAAiB,KAAK,mCAAmC;AAAA,IAC/D;AAAA,MACI,IAAI,SAAS,CAAC;AAAA,MACd,+BAA+B;AAAA,QAC3B,WAAW;AAAA,QACX,aAAa;AAAA,QACb,cAAc;AAAA,QACd,cAAc,eAAe,QAAQ,IAAI,CAAC;AAAA,QAC1C,WAAW;AAAA,MACf;AAAA,IACJ;AAAA,EACJ;AACA,QAAM,WAAW,IAAI,QAAQ;AAQ7B,MAAI,gBAAgB;AACpB,WAAS,OAAO,SAAS,oBAAoB,GAAG,WAAS;AAErD,QAAI,QAAQ,KAAK,CAAC,eAAe;AAC7B,sBAAgB;AAChB,cAAQ,IAAI,GAAG,IAAI,4DAA4D;AAAA,IACnF,WAAW,UAAU,GAAG;AACpB,sBAAgB;AAChB,cAAQ,IAAI,GAAG,IAAI,2BAA2B;AAAA,IAClD;AAAA,EACJ,CAAC;AAED,WAAS,OAAO,MAAM,aAAa,GAAG,WAAS;AAC3C,mBAAe,QAAQ,KAAK,CAAC,KAAK,MAAM,CAAC,EAAE;AAC3C,YAAQ,IAAI,GAAG,IAAI,WAAW,QAAQ,OAAO,KAAK,EAAE;AAAA,EACxD,CAAC;AACL;AAOA,MAAM,OAAO,YAAY;AAKzB,YAAY,eAAe,YAAY,MAAM,CAAC;AAwC9C,SAAS,eAAe,iBAAyB;AAC7C,QAAM,SAAS,YAAY,QAAQ,KAAK,OAAO,eAAe;AAC9D,MAAI,WAAW;AAAW,WAAO;AACjC,UAAQ,IAAI,GAAG,eAAe,KAAK,SAAS,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,EAAE,CAAC,EAAE;AACjF;AAEA,eAAe,mBAAmB;AAU9B,QAAM,cAAc,YAAY;AAEhC,QAAM,iBAAiB,YAAY,IAAI,cAAc;AACrD,UAAQ,IAAI,qBAAqB,eAAe,QAAQ,cAAc;AACtE,UAAQ;AAAA,IACJ;AAAA,EACJ;AACA,QAAM,iBAAiB,MAAM,eAAe,KAAK,QAAQ,GAAG,cAAc,MAAM;AAEhF,QAAMA,YAAW,MAAe;AAChC,QAAM,aAAa,YAAY,KAAK,OAAO,KAAK,KAAK;AACrD,MAAI,cAAc,IAAI,UAAU,GAAG;AAC/B,YAAQ,IAAI,6DAA6D;AACzE,kBAAc,IAAoB,UAAU,EAAE,QAAQ,UAAQA,UAAS,KAAK,IAAI,CAAC;AAAA,EACrF;AACA,WAAS,IAAI,GAAG,KAAK,YAAY,KAAK;AAClC,QAAIA,UAAS,IAAI,CAAC,MAAM;AAAW;AACnC,IAAAA,UAAS,KAAK,YAAY,KAAK,OAAO,OAAO,CAAC,EAAE,MAAM,QAAQ;AAAA,EAClE;AAEA,QAAMC,cAAa;AACnB,QAAMC,cAAa;AACnB,QAAMC,YAAW,YAAY,KAAK,OAAO,UAAU,KAAK,cAAc,IAAI,YAAY,QAAQ;AAC9F,QAAMC,iBAAgB,YAAY,KAAK,OAAO,eAAe,KAAK,cAAc,IAAI,iBAAiB,IAAI;AAEzG,QAAMC,YAAW,YAAY,KAAK,OAAO,UAAU,KAAK,cAAc,IAAI,YAAY,KAAM;AAC5F,QAAMC,eAAc,qBAAqBN,YAAW,WAAW,OAAO;AACtE,QAAMO,aAAY,YAAY,KAAK,OAAO,WAAW,KAAK,cAAc,IAAI,aAAa,KAAM;AAE/F,QAAMC,QAAO,YAAY,KAAK,OAAO,MAAM,KAAK;AAEhD,QAAMC,YAAW,YAAY,KAAK,OAAO,UAAU,KAAK,cAAc,IAAI,YAAY,KAAK,MAAM,EAAE,SAAS,CAAC;AAG7G,gBAAc,IAAI,YAAYN,SAAQ;AACtC,gBAAc,IAAI,iBAAiBC,cAAa;AAChD,gBAAc,IAAI,YAAYC,SAAQ;AACtC,gBAAc,IAAI,aAAaE,UAAS;AACxC,gBAAc,IAAI,YAAYP,SAAQ;AACtC,gBAAc,IAAI,YAAYS,SAAQ;AAEtC,SAAO;AAAA,IACH,UAAAT;AAAA,IACA,YAAAC;AAAA,IACA,YAAAC;AAAA,IACA,UAAAC;AAAA,IACA,eAAAC;AAAA,IACA,UAAAC;AAAA,IACA,aAAAC;AAAA,IACA,WAAAC;AAAA,IACA,MAAAC;AAAA,IACA,UAAAC;AAAA,EACJ;AACJ;",
+  "names": ["isSocket", "deviceName", "vendorName", "passcode", "discriminator", "vendorId", "productName", "productId", "port", "uniqueId"]
+}

package/dist/esm/examples/{BridgedDevicesNode.js → BridgedDevicesNodeLegacy.js}

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 /**
  * @license
- * Copyright 2022 The node-matter Authors
+ * Copyright 2022-2024 Matter.js Authors
  * SPDX-License-Identifier: Apache-2.0
  */
 import { CommissioningServer, MatterServer } from "@project-chip/matter-node.js";
@@ -138,4 +138,4 @@ process.on("SIGINT", () => {
     storage.close().then(() => process.exit(0)).catch((err) => console.error(err));
   }).catch((err) => console.error(err));
 });
-//# sourceMappingURL=BridgedDevicesNode.js.map
+//# sourceMappingURL=BridgedDevicesNodeLegacy.js.map

package/dist/esm/examples/BridgedDevicesNodeLegacy.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/examples/BridgedDevicesNodeLegacy.ts"],
+  "sourcesContent": ["#!/usr/bin/env node\n/**\n * @license\n * Copyright 2022-2024 Matter.js Authors\n * SPDX-License-Identifier: Apache-2.0\n */\n\n/**\n * IMPORTANT: This example uses a Legacy API which will be deprecated in the future.\n * It is just still here to support developers in converting their code to the new API!\n */\n\n/**\n * This example shows how to create a device bridge that exposed multiple devices.\n * It can be used as CLI script and starting point for your own device node implementation.\n */\n\n/**\n * Import needed modules from @project-chip/matter-node.js\n */\n// Include this first to auto-register Crypto, Network and Time Node.js implementations\nimport { CommissioningServer, MatterServer } from \"@project-chip/matter-node.js\";\n\nimport { VendorId } from \"@project-chip/matter-node.js/datatype\";\nimport { Aggregator, DeviceTypes, OnOffLightDevice, OnOffPluginUnitDevice } from \"@project-chip/matter-node.js/device\";\nimport { Format, Level, Logger } from \"@project-chip/matter-node.js/log\";\nimport { QrCode } from \"@project-chip/matter-node.js/schema\";\nimport { StorageBackendDisk, StorageManager } from \"@project-chip/matter-node.js/storage\";\nimport { Time } from \"@project-chip/matter-node.js/time\";\nimport {\n    commandExecutor,\n    getIntParameter,\n    getParameter,\n    hasParameter,\n    requireMinNodeVersion,\n} from \"@project-chip/matter-node.js/util\";\n\nconst logger = Logger.get(\"Device\");\n\nrequireMinNodeVersion(16);\n\n/** Configure logging */\nswitch (getParameter(\"loglevel\")) {\n    case \"fatal\":\n        Logger.defaultLogLevel = Level.FATAL;\n        break;\n    case \"error\":\n        Logger.defaultLogLevel = Level.ERROR;\n        break;\n    case \"warn\":\n        Logger.defaultLogLevel = Level.WARN;\n        break;\n    case \"info\":\n        Logger.defaultLogLevel = Level.INFO;\n        break;\n}\n\nswitch (getParameter(\"logformat\")) {\n    case \"plain\":\n        Logger.format = Format.PLAIN;\n        break;\n    case \"html\":\n        Logger.format = Format.HTML;\n        break;\n    default:\n        if (process.stdin?.isTTY) Logger.format = Format.ANSI;\n}\n\nconst storageLocation = getParameter(\"store\") ?? \".device-node\";\nconst storage = new StorageBackendDisk(storageLocation, hasParameter(\"clearstorage\"));\nlogger.info(`Storage location: ${storageLocation} (Directory)`);\nlogger.info(\n    'Use the parameter \"-store NAME\" to specify a different storage location, use -clearstorage to start with an empty storage.',\n);\n\nclass BridgedDevice {\n    private matterServer: MatterServer | undefined;\n\n    async start() {\n        logger.info(`node-matter`);\n\n        /**\n         * Initialize the storage system.\n         *\n         * The storage manager is then also used by the Matter server, so this code block in general is required,\n         * but you can choose a different storage backend as long as it implements the required API.\n         */\n\n        const storageManager = new StorageManager(storage);\n        await storageManager.initialize();\n\n        /**\n         * Collect all needed data\n         *\n         * This block makes sure to collect all needed data from cli or storage. Replace this with where ever your data\n         * come from.\n         *\n         * Note: This example also uses the initialized storage system to store the device parameter data for convenience\n         * and easy reuse. When you also do that be careful to not overlap with Matter-Server own contexts\n         * (so maybe better not ;-)).\n         */\n\n        const deviceStorage = storageManager.createContext(\"Device\");\n\n        const deviceName = \"Matter Bridge device\";\n        const deviceType = DeviceTypes.AGGREGATOR.code;\n        const vendorName = \"matter-node.js\";\n        const passcode = getIntParameter(\"passcode\") ?? deviceStorage.get(\"passcode\", 20202021);\n        const discriminator = getIntParameter(\"discriminator\") ?? deviceStorage.get(\"discriminator\", 3840);\n        // product name / id and vendor id should match what is in the device certificate\n        const vendorId = getIntParameter(\"vendorid\") ?? deviceStorage.get(\"vendorid\", 0xfff1);\n        const productName = `node-matter OnOff-Bridge`;\n        const productId = getIntParameter(\"productid\") ?? deviceStorage.get(\"productid\", 0x8000);\n\n        const netInterface = getParameter(\"netinterface\");\n        const port = getIntParameter(\"port\") ?? 5540;\n\n        const uniqueId = getIntParameter(\"uniqueid\") ?? deviceStorage.get(\"uniqueid\", Time.nowMs());\n\n        deviceStorage.set(\"passcode\", passcode);\n        deviceStorage.set(\"discriminator\", discriminator);\n        deviceStorage.set(\"vendorid\", vendorId);\n        deviceStorage.set(\"productid\", productId);\n        deviceStorage.set(\"uniqueid\", uniqueId);\n\n        /**\n         * Create Matter Server and CommissioningServer Node\n         *\n         * To allow the device to be announced, found, paired and operated we need a MatterServer instance and add a\n         * commissioningServer to it and add the just created device instance to it.\n         * The CommissioningServer node defines the port where the server listens for the UDP packages of the Matter protocol\n         * and initializes deice specific certificates and such.\n         *\n         * The below logic also adds command handlers for commands of clusters that normally are handled internally\n         * like testEventTrigger (General Diagnostic Cluster) that can be implemented with the logic when these commands\n         * are called.\n         */\n\n        this.matterServer = new MatterServer(storageManager, { mdnsInterface: netInterface });\n\n        const commissioningServer = new CommissioningServer({\n            port,\n            deviceName,\n            deviceType,\n            passcode,\n            discriminator,\n            basicInformation: {\n                vendorName,\n                vendorId: VendorId(vendorId),\n                nodeLabel: productName,\n                productName,\n                productLabel: productName,\n                productId,\n                serialNumber: `node-matter-${uniqueId}`,\n            },\n        });\n\n        /**\n         * Create Device instance and add needed Listener\n         *\n         * Create an instance of the matter device class you want to use.\n         * This example uses the OnOffLightDevice or OnOffPluginUnitDevice depending on the value of the type  parameter.\n         * To execute the on/off scripts defined as parameters a listener for the onOff attribute is registered via the\n         * device specific API.\n         *\n         * The below logic also adds command handlers for commands of clusters that normally are handled device internally\n         * like identify that can be implemented with the logic when these commands are called.\n         */\n\n        const aggregator = new Aggregator();\n\n        const numDevices = getIntParameter(\"num\") || 2;\n        for (let i = 1; i <= numDevices; i++) {\n            const onOffDevice =\n                getParameter(`type${i}`) === \"socket\" ? new OnOffPluginUnitDevice() : new OnOffLightDevice();\n\n            onOffDevice.addOnOffListener(on => commandExecutor(on ? `on${i}` : `off${i}`)?.());\n            onOffDevice.addCommandHandler(\"identify\", async ({ request: { identifyTime } }) =>\n                console.log(\n                    `Identify called for OnOffDevice ${onOffDevice.name} with id: ${i} and identifyTime: ${identifyTime}`,\n                ),\n            );\n\n            const name = `OnOff ${onOffDevice instanceof OnOffPluginUnitDevice ? \"Socket\" : \"Light\"} ${i}`;\n            aggregator.addBridgedDevice(onOffDevice, {\n                nodeLabel: name,\n                productName: name,\n                productLabel: name,\n                serialNumber: `node-matter-${uniqueId}-${i}`,\n                reachable: true,\n            });\n        }\n\n        commissioningServer.addDevice(aggregator);\n\n        await this.matterServer.addCommissioningServer(commissioningServer);\n\n        /**\n         * Start the Matter Server\n         *\n         * After everything was plugged together we can start the server. When not delayed announcement is set for the\n         * CommissioningServer node then this command also starts the announcement of the device into the network.\n         */\n\n        await this.matterServer.start();\n\n        /**\n         * Print Pairing Information\n         *\n         * If the device is not already commissioned (this info is stored in the storage system) then get and print the\n         * pairing details. This includes the QR code that can be scanned by the Matter app to pair the device.\n         */\n\n        logger.info(\"Listening\");\n        if (!commissioningServer.isCommissioned()) {\n            const pairingData = commissioningServer.getPairingCode();\n            const { qrPairingCode, manualPairingCode } = pairingData;\n\n            console.log(QrCode.get(qrPairingCode));\n            console.log(\n                `QR Code URL: https://project-chip.github.io/connectedhomeip/qrcode.html?data=${qrPairingCode}`,\n            );\n            console.log(`Manual pairing code: ${manualPairingCode}`);\n        } else {\n            console.log(\"Device is already commissioned. Waiting for controllers to connect ...\");\n        }\n    }\n\n    async stop() {\n        await this.matterServer?.close();\n    }\n}\n\nconst device = new BridgedDevice();\ndevice\n    .start()\n    .then(() => {\n        /* done */\n    })\n    .catch(err => console.error(err));\n\nprocess.on(\"SIGINT\", () => {\n    // Clean up on CTRL-C\n    device\n        .stop()\n        .then(() => {\n            // Pragmatic way to make sure the storage is correctly closed before the process ends.\n            storage\n                .close()\n                .then(() => process.exit(0))\n                .catch(err => console.error(err));\n        })\n        .catch(err => console.error(err));\n});\n"],
+  "mappings": ";AACA;AAAA;AAAA;AAAA;AAAA;AAoBA,SAAS,qBAAqB,oBAAoB;AAElD,SAAS,gBAAgB;AACzB,SAAS,YAAY,aAAa,kBAAkB,6BAA6B;AACjF,SAAS,QAAQ,OAAO,cAAc;AACtC,SAAS,cAAc;AACvB,SAAS,oBAAoB,sBAAsB;AACnD,SAAS,YAAY;AACrB;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAEP,MAAM,SAAS,OAAO,IAAI,QAAQ;AAElC,sBAAsB,EAAE;AAGxB,QAAQ,aAAa,UAAU,GAAG;AAAA,EAC9B,KAAK;AACD,WAAO,kBAAkB,MAAM;AAC/B;AAAA,EACJ,KAAK;AACD,WAAO,kBAAkB,MAAM;AAC/B;AAAA,EACJ,KAAK;AACD,WAAO,kBAAkB,MAAM;AAC/B;AAAA,EACJ,KAAK;AACD,WAAO,kBAAkB,MAAM;AAC/B;AACR;AAEA,QAAQ,aAAa,WAAW,GAAG;AAAA,EAC/B,KAAK;AACD,WAAO,SAAS,OAAO;AACvB;AAAA,EACJ,KAAK;AACD,WAAO,SAAS,OAAO;AACvB;AAAA,EACJ;AACI,QAAI,QAAQ,OAAO;AAAO,aAAO,SAAS,OAAO;AACzD;AAEA,MAAM,kBAAkB,aAAa,OAAO,KAAK;AACjD,MAAM,UAAU,IAAI,mBAAmB,iBAAiB,aAAa,cAAc,CAAC;AACpF,OAAO,KAAK,qBAAqB,eAAe,cAAc;AAC9D,OAAO;AAAA,EACH;AACJ;AAEA,MAAM,cAAc;AAAA,EAGhB,MAAM,QAAQ;AACV,WAAO,KAAK,aAAa;AASzB,UAAM,iBAAiB,IAAI,eAAe,OAAO;AACjD,UAAM,eAAe,WAAW;AAahC,UAAM,gBAAgB,eAAe,cAAc,QAAQ;AAE3D,UAAM,aAAa;AACnB,UAAM,aAAa,YAAY,WAAW;AAC1C,UAAM,aAAa;AACnB,UAAM,WAAW,gBAAgB,UAAU,KAAK,cAAc,IAAI,YAAY,QAAQ;AACtF,UAAM,gBAAgB,gBAAgB,eAAe,KAAK,cAAc,IAAI,iBAAiB,IAAI;AAEjG,UAAM,WAAW,gBAAgB,UAAU,KAAK,cAAc,IAAI,YAAY,KAAM;AACpF,UAAM,cAAc;AACpB,UAAM,YAAY,gBAAgB,WAAW,KAAK,cAAc,IAAI,aAAa,KAAM;AAEvF,UAAM,eAAe,aAAa,cAAc;AAChD,UAAM,OAAO,gBAAgB,MAAM,KAAK;AAExC,UAAM,WAAW,gBAAgB,UAAU,KAAK,cAAc,IAAI,YAAY,KAAK,MAAM,CAAC;AAE1F,kBAAc,IAAI,YAAY,QAAQ;AACtC,kBAAc,IAAI,iBAAiB,aAAa;AAChD,kBAAc,IAAI,YAAY,QAAQ;AACtC,kBAAc,IAAI,aAAa,SAAS;AACxC,kBAAc,IAAI,YAAY,QAAQ;AAetC,SAAK,eAAe,IAAI,aAAa,gBAAgB,EAAE,eAAe,aAAa,CAAC;AAEpF,UAAM,sBAAsB,IAAI,oBAAoB;AAAA,MAChD;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,kBAAkB;AAAA,QACd;AAAA,QACA,UAAU,SAAS,QAAQ;AAAA,QAC3B,WAAW;AAAA,QACX;AAAA,QACA,cAAc;AAAA,QACd;AAAA,QACA,cAAc,eAAe,QAAQ;AAAA,MACzC;AAAA,IACJ,CAAC;AAcD,UAAM,aAAa,IAAI,WAAW;AAElC,UAAM,aAAa,gBAAgB,KAAK,KAAK;AAC7C,aAAS,IAAI,GAAG,KAAK,YAAY,KAAK;AAClC,YAAM,cACF,aAAa,OAAO,CAAC,EAAE,MAAM,WAAW,IAAI,sBAAsB,IAAI,IAAI,iBAAiB;AAE/F,kBAAY,iBAAiB,QAAM,gBAAgB,KAAK,KAAK,CAAC,KAAK,MAAM,CAAC,EAAE,IAAI,CAAC;AACjF,kBAAY;AAAA,QAAkB;AAAA,QAAY,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MACzE,QAAQ;AAAA,UACJ,mCAAmC,YAAY,IAAI,aAAa,CAAC,sBAAsB,YAAY;AAAA,QACvG;AAAA,MACJ;AAEA,YAAM,OAAO,SAAS,uBAAuB,wBAAwB,WAAW,OAAO,IAAI,CAAC;AAC5F,iBAAW,iBAAiB,aAAa;AAAA,QACrC,WAAW;AAAA,QACX,aAAa;AAAA,QACb,cAAc;AAAA,QACd,cAAc,eAAe,QAAQ,IAAI,CAAC;AAAA,QAC1C,WAAW;AAAA,MACf,CAAC;AAAA,IACL;AAEA,wBAAoB,UAAU,UAAU;AAExC,UAAM,KAAK,aAAa,uBAAuB,mBAAmB;AASlE,UAAM,KAAK,aAAa,MAAM;AAS9B,WAAO,KAAK,WAAW;AACvB,QAAI,CAAC,oBAAoB,eAAe,GAAG;AACvC,YAAM,cAAc,oBAAoB,eAAe;AACvD,YAAM,EAAE,eAAe,kBAAkB,IAAI;AAE7C,cAAQ,IAAI,OAAO,IAAI,aAAa,CAAC;AACrC,cAAQ;AAAA,QACJ,gFAAgF,aAAa;AAAA,MACjG;AACA,cAAQ,IAAI,wBAAwB,iBAAiB,EAAE;AAAA,IAC3D,OAAO;AACH,cAAQ,IAAI,wEAAwE;AAAA,IACxF;AAAA,EACJ;AAAA,EAEA,MAAM,OAAO;AACT,UAAM,KAAK,cAAc,MAAM;AAAA,EACnC;AACJ;AAEA,MAAM,SAAS,IAAI,cAAc;AACjC,OACK,MAAM,EACN,KAAK,MAAM;AAEZ,CAAC,EACA,MAAM,SAAO,QAAQ,MAAM,GAAG,CAAC;AAEpC,QAAQ,GAAG,UAAU,MAAM;AAEvB,SACK,KAAK,EACL,KAAK,MAAM;AAER,YACK,MAAM,EACN,KAAK,MAAM,QAAQ,KAAK,CAAC,CAAC,EAC1B,MAAM,SAAO,QAAQ,MAAM,GAAG,CAAC;AAAA,EACxC,CAAC,EACA,MAAM,SAAO,QAAQ,MAAM,GAAG,CAAC;AACxC,CAAC;",
+  "names": []
+}

package/dist/esm/examples/ComposedDeviceNode.js

@@ -1,138 +1,127 @@
-#!/usr/bin/env node
 /**
  * @license
- * Copyright 2022 The node-matter Authors
+ * Copyright 2022-2024 Matter.js Authors
  * SPDX-License-Identifier: Apache-2.0
  */
-import { CommissioningServer, MatterServer } from "@project-chip/matter-node.js";
-import { VendorId } from "@project-chip/matter-node.js/datatype";
-import { DeviceTypes, OnOffLightDevice, OnOffPluginUnitDevice } from "@project-chip/matter-node.js/device";
-import { Format, Level, Logger } from "@project-chip/matter-node.js/log";
-import { QrCode } from "@project-chip/matter-node.js/schema";
-import { StorageBackendDisk, StorageManager } from "@project-chip/matter-node.js/storage";
-import { Time } from "@project-chip/matter-node.js/time";
-import {
-  commandExecutor,
-  getIntParameter,
-  getParameter,
-  hasParameter,
-  requireMinNodeVersion
-} from "@project-chip/matter-node.js/util";
-const logger = Logger.get("Device");
+import "@project-chip/matter-node.js";
+import { requireMinNodeVersion } from "@project-chip/matter-node.js/util";
+import { DeviceTypeId, VendorId } from "@project-chip/matter.js/datatype";
+import { logEndpoint } from "@project-chip/matter.js/device";
+import { OnOffLightDevice } from "@project-chip/matter.js/devices/OnOffLightDevice";
+import { OnOffPlugInUnitDevice } from "@project-chip/matter.js/devices/OnOffPlugInUnitDevice";
+import { Endpoint, EndpointServer } from "@project-chip/matter.js/endpoint";
+import { Environment, StorageService } from "@project-chip/matter.js/environment";
+import { ServerNode } from "@project-chip/matter.js/node";
+import { Time } from "@project-chip/matter.js/time";
+import { execSync } from "child_process";
 requireMinNodeVersion(16);
-switch (getParameter("loglevel")) {
-  case "fatal":
-    Logger.defaultLogLevel = Level.FATAL;
-    break;
-  case "error":
-    Logger.defaultLogLevel = Level.ERROR;
-    break;
-  case "warn":
-    Logger.defaultLogLevel = Level.WARN;
-    break;
-  case "info":
-    Logger.defaultLogLevel = Level.INFO;
-    break;
+const { isSocket, deviceName, vendorName, passcode, discriminator, vendorId, productName, productId, port, uniqueId } = await getConfiguration();
+const server = await ServerNode.create({
+  // Required: Give the Node a unique ID which is used to store the state of this node
+  id: uniqueId,
+  // Provide Network relevant configuration like the port
+  // Optional when operating only one device on a host, Default port is 5540
+  network: {
+    port
+  },
+  // Provide Commissioning relevant settings
+  // Optional for development/testing purposes
+  commissioning: {
+    passcode,
+    discriminator
+  },
+  // Provide Node announcement settings
+  // Optional: If Ommitted some development defaults are used
+  productDescription: {
+    name: deviceName,
+    deviceType: DeviceTypeId(isSocket[0] ? OnOffPlugInUnitDevice.deviceType : OnOffLightDevice.deviceType)
+  },
+  // Provide defaults for the BasicInformation cluster on the Root endpoint
+  // Optional: If Omitted some development defaults are used
+  basicInformation: {
+    vendorName,
+    vendorId: VendorId(vendorId),
+    nodeLabel: productName,
+    productName,
+    productLabel: productName,
+    productId,
+    serialNumber: `matterjs-${uniqueId}`,
+    uniqueId
+  }
+});
+for (let idx = 0; idx < isSocket.length; idx++) {
+  const i = idx + 1;
+  const isASocket = isSocket[idx];
+  const endpoint = new Endpoint(isASocket ? OnOffPlugInUnitDevice : OnOffLightDevice, { id: `onoff-${i}` });
+  await server.add(endpoint);
+  let isIdentifying = false;
+  endpoint.events.identify.identifyTime$Change.on((value) => {
+    if (value > 0 && !isIdentifying) {
+      isIdentifying = true;
+      console.log(`OnOff ${i}: Run identify logic, ideally blink a light every 0.5s ...`);
+    } else if (value === 0) {
+      isIdentifying = false;
+      console.log(`OnOff ${i}: Stop identify logic ...`);
+    }
+  });
+  endpoint.events.onOff.onOff$Change.on((value) => {
+    executeCommand(value ? `on${i}` : `off${i}`);
+    console.log(`OnOff ${i} is now ${value ? "ON" : "OFF"}`);
+  });
 }
-switch (getParameter("logformat")) {
-  case "plain":
-    Logger.format = Format.PLAIN;
-    break;
-  case "html":
-    Logger.format = Format.HTML;
-    break;
-  default:
-    if (process.stdin?.isTTY)
-      Logger.format = Format.ANSI;
+logEndpoint(EndpointServer.forEndpoint(server));
+await server.run();
+function executeCommand(scriptParamName) {
+  const script = Environment.default.vars.string(scriptParamName);
+  if (script === void 0)
+    return void 0;
+  console.log(`${scriptParamName}: ${execSync(script).toString().slice(0, -1)}`);
 }
-const storageLocation = getParameter("store") ?? ".device-node";
-const storage = new StorageBackendDisk(storageLocation, 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 ComposedDevice {
-  async start() {
-    logger.info(`node-matter`);
-    const storageManager = new StorageManager(storage);
-    await storageManager.initialize();
-    const deviceStorage = storageManager.createContext("Device");
-    if (deviceStorage.has("isSocket")) {
-      logger.info("Device type found in storage. -type parameter is ignored.");
-    }
-    const isSocket = deviceStorage.get("isSocket", getParameter("type") === "socket");
-    const deviceName = "Matter composed device";
-    const deviceType = getParameter("type") === "socket" ? DeviceTypes.ON_OFF_PLUGIN_UNIT.code : DeviceTypes.ON_OFF_LIGHT.code;
-    const vendorName = "matter-node.js";
-    const passcode = getIntParameter("passcode") ?? deviceStorage.get("passcode", 20202021);
-    const discriminator = getIntParameter("discriminator") ?? deviceStorage.get("discriminator", 3840);
-    const vendorId = getIntParameter("vendorid") ?? deviceStorage.get("vendorid", 65521);
-    const productName = `node-matter OnOff-Bridge`;
-    const productId = getIntParameter("productid") ?? deviceStorage.get("productid", 32768);
-    const netInterface = getParameter("netinterface");
-    const port = getIntParameter("port") ?? 5540;
-    const uniqueId = getIntParameter("uniqueid") ?? deviceStorage.get("uniqueid", Time.nowMs());
-    deviceStorage.set("passcode", passcode);
-    deviceStorage.set("discriminator", discriminator);
-    deviceStorage.set("vendorid", vendorId);
-    deviceStorage.set("productid", productId);
-    deviceStorage.set("isSocket", isSocket);
-    deviceStorage.set("uniqueid", uniqueId);
-    this.matterServer = new MatterServer(storageManager, { mdnsInterface: netInterface });
-    const commissioningServer = new CommissioningServer({
-      port,
-      deviceName,
-      deviceType,
-      passcode,
-      discriminator,
-      basicInformation: {
-        vendorName,
-        vendorId: VendorId(vendorId),
-        nodeLabel: productName,
-        productName,
-        productLabel: productName,
-        productId,
-        serialNumber: `node-matter-${uniqueId}`
-      }
-    });
-    const numDevices = getIntParameter("num") || 2;
-    for (let i = 1; i <= numDevices; i++) {
-      const onOffDevice = getParameter(`type${i}`) === "socket" ? new OnOffPluginUnitDevice() : new OnOffLightDevice();
-      onOffDevice.addFixedLabel("orientation", getParameter(`orientation${i}`) ?? `orientation ${i}`);
-      onOffDevice.addOnOffListener((on) => commandExecutor(on ? `on${i}` : `off${i}`)?.());
-      onOffDevice.addCommandHandler(
-        "identify",
-        async ({ request: { identifyTime } }) => console.log(
-          `Identify called for OnOffDevice ${onOffDevice.name} with id: ${i} and identifyTime: ${identifyTime}`
-        )
-      );
-      commissioningServer.addDevice(onOffDevice);
-    }
-    await this.matterServer.addCommissioningServer(commissioningServer);
-    await this.matterServer.start();
-    logger.info("Listening");
-    if (!commissioningServer.isCommissioned()) {
-      const pairingData = commissioningServer.getPairingCode();
-      const { qrPairingCode, manualPairingCode } = pairingData;
-      console.log(QrCode.get(qrPairingCode));
-      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 ...");
-    }
+async function getConfiguration() {
+  const environment = Environment.default;
+  const storageService = environment.get(StorageService);
+  console.log(`Storage location: ${storageService.location} (Directory)`);
+  console.log(
+    'Use the parameter "--storage-path=NAME-OR-PATH" to specify a different storage location in this directory, use --storage-clear to start with an empty storage.'
+  );
+  const deviceStorage = (await storageService.open("device")).createContext("data");
+  const isSocket2 = Array();
+  const numDevices = environment.vars.number("num") || 2;
+  if (deviceStorage.has("isSocket")) {
+    console.log(`Device types found in storage. --type parameter is ignored.`);
+    deviceStorage.get("isSocket").forEach((type) => isSocket2.push(type));
   }
-  async stop() {
-    await this.matterServer?.close();
+  for (let i = 1; i < numDevices; i++) {
+    if (isSocket2[i - 1] !== void 0)
+      continue;
+    isSocket2.push(environment.vars.string(`type${i}`) === "socket");
   }
+  const deviceName2 = "Matter test device";
+  const vendorName2 = "matter-node.js";
+  const passcode2 = environment.vars.number("passcode") ?? deviceStorage.get("passcode", 20202021);
+  const discriminator2 = environment.vars.number("discriminator") ?? deviceStorage.get("discriminator", 3840);
+  const vendorId2 = environment.vars.number("vendorid") ?? deviceStorage.get("vendorid", 65521);
+  const productName2 = `node-matter OnOff ${isSocket2 ? "Socket" : "Light"}`;
+  const productId2 = environment.vars.number("productid") ?? deviceStorage.get("productid", 32768);
+  const port2 = environment.vars.number("port") ?? 5540;
+  const uniqueId2 = environment.vars.string("uniqueid") ?? deviceStorage.get("uniqueid", Time.nowMs().toString());
+  deviceStorage.set("passcode", passcode2);
+  deviceStorage.set("discriminator", discriminator2);
+  deviceStorage.set("vendorid", vendorId2);
+  deviceStorage.set("productid", productId2);
+  deviceStorage.set("isSocket", isSocket2);
+  deviceStorage.set("uniqueid", uniqueId2);
+  return {
+    isSocket: isSocket2,
+    deviceName: deviceName2,
+    vendorName: vendorName2,
+    passcode: passcode2,
+    discriminator: discriminator2,
+    vendorId: vendorId2,
+    productName: productName2,
+    productId: productId2,
+    port: port2,
+    uniqueId: uniqueId2
+  };
 }
-const device = new ComposedDevice();
-device.start().then(() => {
-}).catch((err) => console.error(err));
-process.on("SIGINT", () => {
-  device.stop().then(() => {
-    storage.close().then(() => process.exit(0)).catch((err) => console.error(err));
-  }).catch((err) => console.error(err));
-});
 //# sourceMappingURL=ComposedDeviceNode.js.map