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

package/dist/esm/examples/MultiDeviceNodeLegacy.js

@@ -0,0 +1,146 @@
+#!/usr/bin/env node
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { CommissioningServer, MatterServer } from "@project-chip/matter-node.js";
+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";
+import { VendorId } from "@project-chip/matter.js/datatype";
+const logger = Logger.get("MultiDevice");
+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;
+}
+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;
+}
+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 Device {
+  async start() {
+    logger.info(`node-matter`);
+    const storageManager = new StorageManager(storage);
+    await storageManager.initialize();
+    const netInterface = getParameter("netinterface");
+    const deviceStorage = storageManager.createContext("Device");
+    this.matterServer = new MatterServer(storageManager, { mdnsInterface: netInterface });
+    const commissioningServers = new Array();
+    let defaultPasscode = 20202021;
+    let defaultDiscriminator = 3840;
+    let defaultPort = 5550;
+    const numDevices = getIntParameter("num") || 2;
+    for (let i = 1; i <= numDevices; i++) {
+      if (deviceStorage.has(`isSocket${i}`)) {
+        logger.info("Device type found in storage. -type parameter is ignored.");
+      }
+      const isSocket = deviceStorage.get(`isSocket${i}`, getParameter(`type${i}`) === "socket");
+      const deviceName = `Matter ${getParameter(`type${i}`) ?? "light"} device ${i}`;
+      const deviceType = getParameter(`type${i}`) === "socket" ? DeviceTypes.ON_OFF_PLUGIN_UNIT.code : DeviceTypes.ON_OFF_LIGHT.code;
+      const vendorName = "matter-node.js";
+      const passcode = getIntParameter(`passcode${i}`) ?? deviceStorage.get(`passcode${i}`, defaultPasscode++);
+      const discriminator = getIntParameter(`discriminator${i}`) ?? deviceStorage.get(`discriminator${i}`, defaultDiscriminator++);
+      const vendorId = getIntParameter(`vendorid${i}`) ?? deviceStorage.get(`vendorid${i}`, 65521);
+      const productName = `node-matter OnOff-Device ${i}`;
+      const productId = getIntParameter(`productid${i}`) ?? deviceStorage.get(`productid${i}`, 32768);
+      const port = getIntParameter(`port${i}`) ?? defaultPort++;
+      const uniqueId = getIntParameter(`uniqueid${i}`) ?? deviceStorage.get(`uniqueid${i}`, `${i}-${Time.nowMs()}`);
+      deviceStorage.set(`passcode${i}`, passcode);
+      deviceStorage.set(`discriminator${i}`, discriminator);
+      deviceStorage.set(`vendorid${i}`, vendorId);
+      deviceStorage.set(`productid${i}`, productId);
+      deviceStorage.set(`isSocket${i}`, isSocket);
+      deviceStorage.set(`uniqueid${i}`, uniqueId);
+      const commissioningServer = new CommissioningServer({
+        port,
+        deviceName,
+        deviceType,
+        passcode,
+        discriminator,
+        basicInformation: {
+          vendorName,
+          vendorId: VendorId(vendorId),
+          nodeLabel: productName,
+          productName,
+          productLabel: productName,
+          productId,
+          serialNumber: `node-matter-${uniqueId}`
+        }
+      });
+      console.log(
+        `Added device ${i} on port ${port} and unique id ${uniqueId}: Passcode: ${passcode}, Discriminator: ${discriminator}`
+      );
+      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}`)?.());
+      commissioningServer.addDevice(onOffDevice);
+      await this.matterServer.addCommissioningServer(commissioningServer);
+      commissioningServers.push(commissioningServer);
+    }
+    await this.matterServer.start();
+    logger.info("Listening");
+    console.log();
+    commissioningServers.forEach((commissioningServer, index) => {
+      console.log("----------------------------");
+      console.log(`Device ${index + 1}:`);
+      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 ...");
+      }
+      console.log();
+    });
+  }
+  async stop() {
+    await this.matterServer?.close();
+  }
+}
+const device = new Device();
+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=MultiDeviceNodeLegacy.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/examples/MultiDeviceNodeLegacy.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 new device node that is composed of multiple devices.\n * It creates multiple endpoints on the server. When you want to add a composed devices to a Aggregator you need to\n * add all endpoints of the composed device to an \"ComposedDevice\" instance! (not shown in this 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 { CommissioningServer, MatterServer } from \"@project-chip/matter-node.js\";\n\nimport { 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\";\nimport { VendorId } from \"@project-chip/matter.js/datatype\";\n\nconst logger = Logger.get(\"MultiDevice\");\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 Device {\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        const netInterface = getParameter(\"netinterface\");\n\n        const deviceStorage = storageManager.createContext(\"Device\");\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        /**\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 commissioningServers = new Array<CommissioningServer>();\n\n        let defaultPasscode = 20202021;\n        let defaultDiscriminator = 3840;\n        let defaultPort = 5550;\n\n        const numDevices = getIntParameter(\"num\") || 2;\n        for (let i = 1; i <= numDevices; i++) {\n            if (deviceStorage.has(`isSocket${i}`)) {\n                logger.info(\"Device type found in storage. -type parameter is ignored.\");\n            }\n            const isSocket = deviceStorage.get(`isSocket${i}`, getParameter(`type${i}`) === \"socket\");\n            const deviceName = `Matter ${getParameter(`type${i}`) ?? \"light\"} device ${i}`;\n            const deviceType =\n                getParameter(`type${i}`) === \"socket\"\n                    ? DeviceTypes.ON_OFF_PLUGIN_UNIT.code\n                    : DeviceTypes.ON_OFF_LIGHT.code;\n            const vendorName = \"matter-node.js\";\n            const passcode = getIntParameter(`passcode${i}`) ?? deviceStorage.get(`passcode${i}`, defaultPasscode++);\n            const discriminator =\n                getIntParameter(`discriminator${i}`) ?? deviceStorage.get(`discriminator${i}`, defaultDiscriminator++);\n            // product name / id and vendor id should match what is in the device certificate\n            const vendorId = getIntParameter(`vendorid${i}`) ?? deviceStorage.get(`vendorid${i}`, 0xfff1);\n            const productName = `node-matter OnOff-Device ${i}`;\n            const productId = getIntParameter(`productid${i}`) ?? deviceStorage.get(`productid${i}`, 0x8000);\n\n            const port = getIntParameter(`port${i}`) ?? defaultPort++;\n\n            const uniqueId =\n                getIntParameter(`uniqueid${i}`) ?? deviceStorage.get(`uniqueid${i}`, `${i}-${Time.nowMs()}`);\n\n            deviceStorage.set(`passcode${i}`, passcode);\n            deviceStorage.set(`discriminator${i}`, discriminator);\n            deviceStorage.set(`vendorid${i}`, vendorId);\n            deviceStorage.set(`productid${i}`, productId);\n            deviceStorage.set(`isSocket${i}`, isSocket);\n            deviceStorage.set(`uniqueid${i}`, uniqueId);\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            console.log(\n                `Added device ${i} on port ${port} and unique id ${uniqueId}: Passcode: ${passcode}, Discriminator: ${discriminator}`,\n            );\n\n            const onOffDevice =\n                getParameter(`type${i}`) === \"socket\" ? new OnOffPluginUnitDevice() : new OnOffLightDevice();\n            onOffDevice.addFixedLabel(\"orientation\", getParameter(`orientation${i}`) ?? `orientation ${i}`);\n            onOffDevice.addOnOffListener(on => commandExecutor(on ? `on${i}` : `off${i}`)?.());\n            commissioningServer.addDevice(onOffDevice);\n\n            await this.matterServer.addCommissioningServer(commissioningServer);\n\n            commissioningServers.push(commissioningServer);\n        }\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        console.log();\n        commissioningServers.forEach((commissioningServer, index) => {\n            console.log(\"----------------------------\");\n            console.log(`Device ${index + 1}:`);\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            console.log();\n        });\n    }\n\n    async stop() {\n        await this.matterServer?.close();\n    }\n}\n\nconst device = new Device();\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;AAsBA,SAAS,qBAAqB,oBAAoB;AAElD,SAAS,aAAa,kBAAkB,6BAA6B;AACrE,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;AACP,SAAS,gBAAgB;AAEzB,MAAM,SAAS,OAAO,IAAI,aAAa;AAEvC,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,OAAO;AAAA,EAGT,MAAM,QAAQ;AACV,WAAO,KAAK,aAAa;AASzB,UAAM,iBAAiB,IAAI,eAAe,OAAO;AACjD,UAAM,eAAe,WAAW;AAYhC,UAAM,eAAe,aAAa,cAAc;AAEhD,UAAM,gBAAgB,eAAe,cAAc,QAAQ;AAe3D,SAAK,eAAe,IAAI,aAAa,gBAAgB,EAAE,eAAe,aAAa,CAAC;AAcpF,UAAM,uBAAuB,IAAI,MAA2B;AAE5D,QAAI,kBAAkB;AACtB,QAAI,uBAAuB;AAC3B,QAAI,cAAc;AAElB,UAAM,aAAa,gBAAgB,KAAK,KAAK;AAC7C,aAAS,IAAI,GAAG,KAAK,YAAY,KAAK;AAClC,UAAI,cAAc,IAAI,WAAW,CAAC,EAAE,GAAG;AACnC,eAAO,KAAK,2DAA2D;AAAA,MAC3E;AACA,YAAM,WAAW,cAAc,IAAI,WAAW,CAAC,IAAI,aAAa,OAAO,CAAC,EAAE,MAAM,QAAQ;AACxF,YAAM,aAAa,UAAU,aAAa,OAAO,CAAC,EAAE,KAAK,OAAO,WAAW,CAAC;AAC5E,YAAM,aACF,aAAa,OAAO,CAAC,EAAE,MAAM,WACvB,YAAY,mBAAmB,OAC/B,YAAY,aAAa;AACnC,YAAM,aAAa;AACnB,YAAM,WAAW,gBAAgB,WAAW,CAAC,EAAE,KAAK,cAAc,IAAI,WAAW,CAAC,IAAI,iBAAiB;AACvG,YAAM,gBACF,gBAAgB,gBAAgB,CAAC,EAAE,KAAK,cAAc,IAAI,gBAAgB,CAAC,IAAI,sBAAsB;AAEzG,YAAM,WAAW,gBAAgB,WAAW,CAAC,EAAE,KAAK,cAAc,IAAI,WAAW,CAAC,IAAI,KAAM;AAC5F,YAAM,cAAc,4BAA4B,CAAC;AACjD,YAAM,YAAY,gBAAgB,YAAY,CAAC,EAAE,KAAK,cAAc,IAAI,YAAY,CAAC,IAAI,KAAM;AAE/F,YAAM,OAAO,gBAAgB,OAAO,CAAC,EAAE,KAAK;AAE5C,YAAM,WACF,gBAAgB,WAAW,CAAC,EAAE,KAAK,cAAc,IAAI,WAAW,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,EAAE;AAE/F,oBAAc,IAAI,WAAW,CAAC,IAAI,QAAQ;AAC1C,oBAAc,IAAI,gBAAgB,CAAC,IAAI,aAAa;AACpD,oBAAc,IAAI,WAAW,CAAC,IAAI,QAAQ;AAC1C,oBAAc,IAAI,YAAY,CAAC,IAAI,SAAS;AAC5C,oBAAc,IAAI,WAAW,CAAC,IAAI,QAAQ;AAC1C,oBAAc,IAAI,WAAW,CAAC,IAAI,QAAQ;AAE1C,YAAM,sBAAsB,IAAI,oBAAoB;AAAA,QAChD;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,kBAAkB;AAAA,UACd;AAAA,UACA,UAAU,SAAS,QAAQ;AAAA,UAC3B,WAAW;AAAA,UACX;AAAA,UACA,cAAc;AAAA,UACd;AAAA,UACA,cAAc,eAAe,QAAQ;AAAA,QACzC;AAAA,MACJ,CAAC;AAED,cAAQ;AAAA,QACJ,gBAAgB,CAAC,YAAY,IAAI,kBAAkB,QAAQ,eAAe,QAAQ,oBAAoB,aAAa;AAAA,MACvH;AAEA,YAAM,cACF,aAAa,OAAO,CAAC,EAAE,MAAM,WAAW,IAAI,sBAAsB,IAAI,IAAI,iBAAiB;AAC/F,kBAAY,cAAc,eAAe,aAAa,cAAc,CAAC,EAAE,KAAK,eAAe,CAAC,EAAE;AAC9F,kBAAY,iBAAiB,QAAM,gBAAgB,KAAK,KAAK,CAAC,KAAK,MAAM,CAAC,EAAE,IAAI,CAAC;AACjF,0BAAoB,UAAU,WAAW;AAEzC,YAAM,KAAK,aAAa,uBAAuB,mBAAmB;AAElE,2BAAqB,KAAK,mBAAmB;AAAA,IACjD;AASA,UAAM,KAAK,aAAa,MAAM;AAS9B,WAAO,KAAK,WAAW;AACvB,YAAQ,IAAI;AACZ,yBAAqB,QAAQ,CAAC,qBAAqB,UAAU;AACzD,cAAQ,IAAI,8BAA8B;AAC1C,cAAQ,IAAI,UAAU,QAAQ,CAAC,GAAG;AAClC,UAAI,CAAC,oBAAoB,eAAe,GAAG;AACvC,cAAM,cAAc,oBAAoB,eAAe;AACvD,cAAM,EAAE,eAAe,kBAAkB,IAAI;AAE7C,gBAAQ,IAAI,OAAO,IAAI,aAAa,CAAC;AACrC,gBAAQ;AAAA,UACJ,gFAAgF,aAAa;AAAA,QACjG;AACA,gBAAQ,IAAI,wBAAwB,iBAAiB,EAAE;AAAA,MAC3D,OAAO;AACH,gBAAQ,IAAI,wEAAwE;AAAA,MACxF;AACA,cAAQ,IAAI;AAAA,IAChB,CAAC;AAAA,EACL;AAAA,EAEA,MAAM,OAAO;AACT,UAAM,KAAK,cAAc,MAAM;AAAA,EACnC;AACJ;AAEA,MAAM,SAAS,IAAI,OAAO;AAC1B,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/SensorDeviceNode.js

@@ -0,0 +1,167 @@
+/**
+ * @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 { DeviceTypeId, VendorId } from "@project-chip/matter.js/datatype";
+import { logEndpoint } from "@project-chip/matter.js/device";
+import { HumiditySensorDevice } from "@project-chip/matter.js/devices/HumiditySensorDevice";
+import { TemperatureSensorDevice } from "@project-chip/matter.js/devices/TemperatureSensorDevice";
+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);
+async function main() {
+  const {
+    isTemperature,
+    interval,
+    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(
+        isTemperature ? TemperatureSensorDevice.deviceType : HumiditySensorDevice.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
+    }
+  });
+  let endpoint;
+  if (isTemperature) {
+    endpoint = new Endpoint(TemperatureSensorDevice, {
+      id: "tempsensor",
+      temperatureMeasurement: { measuredValue: getIntValueFromCommandOrRandom("value") }
+    });
+  } else {
+    endpoint = new Endpoint(HumiditySensorDevice, {
+      id: "humsensor",
+      relativeHumidityMeasurement: { measuredValue: getIntValueFromCommandOrRandom("value", false) }
+    });
+  }
+  await server.add(endpoint);
+  logEndpoint(EndpointServer.forEndpoint(server));
+  const updateInterval = setInterval(() => {
+    let setter;
+    if (isTemperature) {
+      setter = endpoint.set({
+        temperatureMeasurement: {
+          measuredValue: getIntValueFromCommandOrRandom("value")
+        }
+      });
+    } else {
+      setter = endpoint.set({
+        relativeHumidityMeasurement: {
+          measuredValue: getIntValueFromCommandOrRandom("value", false)
+        }
+      });
+    }
+    setter.catch((error) => console.error("Error updating measured value:", error));
+  }, interval * 1e3);
+  server.lifecycle.offline.on(() => clearTimeout(updateInterval));
+  await server.run();
+}
+main().catch((error) => console.error(error));
+function getIntValueFromCommandOrRandom(scriptParamName, allowNegativeValues = true) {
+  const script = Environment.default.vars.string(scriptParamName);
+  if (script === void 0) {
+    if (!allowNegativeValues)
+      return Math.round(Math.random() * 100);
+    return (Math.round(Math.random() * 100) - 50) * 100;
+  }
+  let result = execSync(script).toString().trim();
+  if (result.startsWith("'") && result.endsWith("'") || result.startsWith('"') && result.endsWith('"'))
+    result = result.slice(1, -1);
+  console.log(`Command result: ${result}`);
+  let value = Math.round(parseFloat(result));
+  if (!allowNegativeValues && value < 0)
+    value = 0;
+  return value;
+}
+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 isTemperature = deviceStorage.get("isTemperature", environment.vars.get("type") !== "humidity");
+  if (deviceStorage.has("isTemperature")) {
+    console.log(
+      `Device type ${isTemperature ? "temperature" : "humidity"} found in storage. --type parameter is ignored.`
+    );
+  }
+  let interval = environment.vars.number("interval") ?? deviceStorage.get("interval", 60);
+  if (interval < 1) {
+    console.log(`Invalid Interval ${interval}, set to 60s`);
+    interval = 60;
+  }
+  const deviceName = "Matter test device";
+  const vendorName = "matter-node.js";
+  const passcode = environment.vars.number("passcode") ?? deviceStorage.get("passcode", 20202021);
+  const discriminator = environment.vars.number("discriminator") ?? deviceStorage.get("discriminator", 3840);
+  const vendorId = environment.vars.number("vendorid") ?? deviceStorage.get("vendorid", 65521);
+  const productName = `node-matter OnOff ${isTemperature ? "Temperature" : "Humidity"}`;
+  const productId = environment.vars.number("productid") ?? deviceStorage.get("productid", 32768);
+  const port = environment.vars.number("port") ?? 5540;
+  const uniqueId = environment.vars.string("uniqueid") ?? deviceStorage.get("uniqueid", Time.nowMs().toString());
+  deviceStorage.set("passcode", passcode);
+  deviceStorage.set("discriminator", discriminator);
+  deviceStorage.set("vendorid", vendorId);
+  deviceStorage.set("productid", productId);
+  deviceStorage.set("interval", interval);
+  deviceStorage.set("isTemperature", isTemperature);
+  deviceStorage.set("uniqueid", uniqueId);
+  return {
+    isTemperature,
+    interval,
+    deviceName,
+    vendorName,
+    passcode,
+    discriminator,
+    vendorId,
+    productName,
+    productId,
+    port,
+    uniqueId
+  };
+}
+//# sourceMappingURL=SensorDeviceNode.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/examples/SensorDeviceNode.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 simple Sensor Matter device as temperature or humidity device.\n * It can be used as CLI script and starting point for your own device node implementation.\n * This example is CJS conform and do not use top level await's.\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 { DeviceTypeId, VendorId } from \"@project-chip/matter.js/datatype\";\nimport { logEndpoint } from \"@project-chip/matter.js/device\";\nimport { HumiditySensorDevice } from \"@project-chip/matter.js/devices/HumiditySensorDevice\";\nimport { TemperatureSensorDevice } from \"@project-chip/matter.js/devices/TemperatureSensorDevice\";\nimport { Endpoint, EndpointServer } from \"@project-chip/matter.js/endpoint\";\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\nasync function main() {\n    /** Initialize configuration values */\n    const {\n        isTemperature,\n        interval,\n        deviceName,\n        vendorName,\n        passcode,\n        discriminator,\n        vendorId,\n        productName,\n        productId,\n        port,\n        uniqueId,\n    } = await getConfiguration();\n\n    /**\n     * Create a Matter ServerNode, which contains the Root Endpoint and all relevant data and configuration\n     */\n    const 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(\n                isTemperature ? TemperatureSensorDevice.deviceType : HumiditySensorDevice.deviceType,\n            ),\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 endpoint to the node. This example uses the\n     * OnOffLightDevice or OnOffPlugInUnitDevice depending on the value of the type parameter. It also assigns this Part a\n     * unique ID to store the endpoint number for it in the storage to restore the device on restart.\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    let endpoint: Endpoint;\n    if (isTemperature) {\n        endpoint = new Endpoint(TemperatureSensorDevice, {\n            id: \"tempsensor\",\n            temperatureMeasurement: { measuredValue: getIntValueFromCommandOrRandom(\"value\") },\n        });\n    } else {\n        endpoint = new Endpoint(HumiditySensorDevice, {\n            id: \"humsensor\",\n            relativeHumidityMeasurement: { measuredValue: getIntValueFromCommandOrRandom(\"value\", false) },\n        });\n    }\n\n    await server.add(endpoint);\n\n    /**\n     * Log the endpoint structure for debugging reasons and to allow to verify anything is correct\n     */\n    logEndpoint(EndpointServer.forEndpoint(server));\n\n    const updateInterval = setInterval(() => {\n        let setter: Promise<void>;\n        if (isTemperature) {\n            setter = endpoint.set({\n                temperatureMeasurement: {\n                    measuredValue: getIntValueFromCommandOrRandom(\"value\"),\n                },\n            });\n        } else {\n            setter = endpoint.set({\n                relativeHumidityMeasurement: {\n                    measuredValue: getIntValueFromCommandOrRandom(\"value\", false),\n                },\n            });\n        }\n        setter.catch(error => console.error(\"Error updating measured value:\", error));\n    }, interval * 1000);\n\n    // Cleanup our update interval when node goes offline\n    server.lifecycle.offline.on(() => clearTimeout(updateInterval));\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     */\n    await server.run();\n}\n\nmain().catch(error => console.error(error));\n\n/*********************************************************************************************************\n * Convenience Methods\n *********************************************************************************************************/\n\n/** Defined a shell command from an environment variable and execute it and log the response. */\n\nfunction getIntValueFromCommandOrRandom(scriptParamName: string, allowNegativeValues = true) {\n    const script = Environment.default.vars.string(scriptParamName);\n    if (script === undefined) {\n        if (!allowNegativeValues) return Math.round(Math.random() * 100);\n        return (Math.round(Math.random() * 100) - 50) * 100;\n    }\n    let result = execSync(script).toString().trim();\n    if ((result.startsWith(\"'\") && result.endsWith(\"'\")) || (result.startsWith('\"') && result.endsWith('\"')))\n        result = result.slice(1, -1);\n    console.log(`Command result: ${result}`);\n    let value = Math.round(parseFloat(result));\n    if (!allowNegativeValues && value < 0) value = 0;\n    return value;\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 isTemperature = deviceStorage.get(\"isTemperature\", environment.vars.get(\"type\") !== \"humidity\");\n    if (deviceStorage.has(\"isTemperature\")) {\n        console.log(\n            `Device type ${isTemperature ? \"temperature\" : \"humidity\"} found in storage. --type parameter is ignored.`,\n        );\n    }\n    let interval = environment.vars.number(\"interval\") ?? deviceStorage.get(\"interval\", 60);\n    if (interval < 1) {\n        console.log(`Invalid Interval ${interval}, set to 60s`);\n        interval = 60;\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 ${isTemperature ? \"Temperature\" : \"Humidity\"}`;\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(\"interval\", interval);\n    deviceStorage.set(\"isTemperature\", isTemperature);\n    deviceStorage.set(\"uniqueid\", uniqueId);\n\n    return {\n        isTemperature,\n        interval,\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;AAgBA,OAAO;AAEP,SAAS,6BAA6B;AACtC,SAAS,cAAc,gBAAgB;AACvC,SAAS,mBAAmB;AAC5B,SAAS,4BAA4B;AACrC,SAAS,+BAA+B;AACxC,SAAS,UAAU,sBAAsB;AACzC,SAAS,aAAa,sBAAsB;AAC5C,SAAS,kBAAkB;AAC3B,SAAS,YAAY;AACrB,SAAS,gBAAgB;AAEzB,sBAAsB,EAAE;AAExB,eAAe,OAAO;AAElB,QAAM;AAAA,IACF;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ,IAAI,MAAM,iBAAiB;AAK3B,QAAM,SAAS,MAAM,WAAW,OAAO;AAAA;AAAA,IAEnC,IAAI;AAAA;AAAA;AAAA,IAIJ,SAAS;AAAA,MACL;AAAA,IACJ;AAAA;AAAA;AAAA,IAIA,eAAe;AAAA,MACX;AAAA,MACA;AAAA,IACJ;AAAA;AAAA;AAAA,IAIA,oBAAoB;AAAA,MAChB,MAAM;AAAA,MACN,YAAY;AAAA,QACR,gBAAgB,wBAAwB,aAAa,qBAAqB;AAAA,MAC9E;AAAA,IACJ;AAAA;AAAA;AAAA,IAIA,kBAAkB;AAAA,MACd;AAAA,MACA,UAAU,SAAS,QAAQ;AAAA,MAC3B,WAAW;AAAA,MACX;AAAA,MACA,cAAc;AAAA,MACd;AAAA,MACA,cAAc,YAAY,QAAQ;AAAA,MAClC;AAAA,IACJ;AAAA,EACJ,CAAC;AASD,MAAI;AACJ,MAAI,eAAe;AACf,eAAW,IAAI,SAAS,yBAAyB;AAAA,MAC7C,IAAI;AAAA,MACJ,wBAAwB,EAAE,eAAe,+BAA+B,OAAO,EAAE;AAAA,IACrF,CAAC;AAAA,EACL,OAAO;AACH,eAAW,IAAI,SAAS,sBAAsB;AAAA,MAC1C,IAAI;AAAA,MACJ,6BAA6B,EAAE,eAAe,+BAA+B,SAAS,KAAK,EAAE;AAAA,IACjG,CAAC;AAAA,EACL;AAEA,QAAM,OAAO,IAAI,QAAQ;AAKzB,cAAY,eAAe,YAAY,MAAM,CAAC;AAE9C,QAAM,iBAAiB,YAAY,MAAM;AACrC,QAAI;AACJ,QAAI,eAAe;AACf,eAAS,SAAS,IAAI;AAAA,QAClB,wBAAwB;AAAA,UACpB,eAAe,+BAA+B,OAAO;AAAA,QACzD;AAAA,MACJ,CAAC;AAAA,IACL,OAAO;AACH,eAAS,SAAS,IAAI;AAAA,QAClB,6BAA6B;AAAA,UACzB,eAAe,+BAA+B,SAAS,KAAK;AAAA,QAChE;AAAA,MACJ,CAAC;AAAA,IACL;AACA,WAAO,MAAM,WAAS,QAAQ,MAAM,kCAAkC,KAAK,CAAC;AAAA,EAChF,GAAG,WAAW,GAAI;AAGlB,SAAO,UAAU,QAAQ,GAAG,MAAM,aAAa,cAAc,CAAC;AAO9D,QAAM,OAAO,IAAI;AACrB;AAEA,KAAK,EAAE,MAAM,WAAS,QAAQ,MAAM,KAAK,CAAC;AAQ1C,SAAS,+BAA+B,iBAAyB,sBAAsB,MAAM;AACzF,QAAM,SAAS,YAAY,QAAQ,KAAK,OAAO,eAAe;AAC9D,MAAI,WAAW,QAAW;AACtB,QAAI,CAAC;AAAqB,aAAO,KAAK,MAAM,KAAK,OAAO,IAAI,GAAG;AAC/D,YAAQ,KAAK,MAAM,KAAK,OAAO,IAAI,GAAG,IAAI,MAAM;AAAA,EACpD;AACA,MAAI,SAAS,SAAS,MAAM,EAAE,SAAS,EAAE,KAAK;AAC9C,MAAK,OAAO,WAAW,GAAG,KAAK,OAAO,SAAS,GAAG,KAAO,OAAO,WAAW,GAAG,KAAK,OAAO,SAAS,GAAG;AAClG,aAAS,OAAO,MAAM,GAAG,EAAE;AAC/B,UAAQ,IAAI,mBAAmB,MAAM,EAAE;AACvC,MAAI,QAAQ,KAAK,MAAM,WAAW,MAAM,CAAC;AACzC,MAAI,CAAC,uBAAuB,QAAQ;AAAG,YAAQ;AAC/C,SAAO;AACX;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,QAAM,gBAAgB,cAAc,IAAI,iBAAiB,YAAY,KAAK,IAAI,MAAM,MAAM,UAAU;AACpG,MAAI,cAAc,IAAI,eAAe,GAAG;AACpC,YAAQ;AAAA,MACJ,eAAe,gBAAgB,gBAAgB,UAAU;AAAA,IAC7D;AAAA,EACJ;AACA,MAAI,WAAW,YAAY,KAAK,OAAO,UAAU,KAAK,cAAc,IAAI,YAAY,EAAE;AACtF,MAAI,WAAW,GAAG;AACd,YAAQ,IAAI,oBAAoB,QAAQ,cAAc;AACtD,eAAW;AAAA,EACf;AAEA,QAAM,aAAa;AACnB,QAAM,aAAa;AACnB,QAAM,WAAW,YAAY,KAAK,OAAO,UAAU,KAAK,cAAc,IAAI,YAAY,QAAQ;AAC9F,QAAM,gBAAgB,YAAY,KAAK,OAAO,eAAe,KAAK,cAAc,IAAI,iBAAiB,IAAI;AAEzG,QAAM,WAAW,YAAY,KAAK,OAAO,UAAU,KAAK,cAAc,IAAI,YAAY,KAAM;AAC5F,QAAM,cAAc,qBAAqB,gBAAgB,gBAAgB,UAAU;AACnF,QAAM,YAAY,YAAY,KAAK,OAAO,WAAW,KAAK,cAAc,IAAI,aAAa,KAAM;AAE/F,QAAM,OAAO,YAAY,KAAK,OAAO,MAAM,KAAK;AAEhD,QAAM,WAAW,YAAY,KAAK,OAAO,UAAU,KAAK,cAAc,IAAI,YAAY,KAAK,MAAM,EAAE,SAAS,CAAC;AAG7G,gBAAc,IAAI,YAAY,QAAQ;AACtC,gBAAc,IAAI,iBAAiB,aAAa;AAChD,gBAAc,IAAI,YAAY,QAAQ;AACtC,gBAAc,IAAI,aAAa,SAAS;AACxC,gBAAc,IAAI,YAAY,QAAQ;AACtC,gBAAc,IAAI,iBAAiB,aAAa;AAChD,gBAAc,IAAI,YAAY,QAAQ;AAEtC,SAAO;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ;AACJ;",
+  "names": []
+}

package/dist/esm/examples/cluster/DummyThreadNetworkCommissioningServer.js

@@ -0,0 +1,115 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { GeneralCommissioningBehavior } from "@project-chip/matter.js/behavior/definitions/general-commissioning";
+import {
+  NetworkCommissioningBehavior
+} from "@project-chip/matter.js/behavior/definitions/network-commissioning";
+import { NetworkCommissioning } from "@project-chip/matter.js/cluster";
+import { Logger } from "@project-chip/matter.js/log";
+import { ByteArray } from "@project-chip/matter.js/util";
+const firstNetworkId = new ByteArray(32);
+class DummyThreadNetworkCommissioningServer extends NetworkCommissioningBehavior.with(
+  NetworkCommissioning.Feature.ThreadNetworkInterface
+) {
+  scanNetworks({ breadcrumb }) {
+    console.log(`---> scanNetworks called on NetworkCommissioning cluster: ${breadcrumb}`);
+    if (breadcrumb !== void 0) {
+      const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);
+      generalCommissioningCluster.state.breadcrumb = breadcrumb;
+    }
+    const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
+    this.state.lastNetworkingStatus = networkingStatus;
+    const threadScanResults = [
+      {
+        panId: this.endpoint.env.vars.number("ble.thread.panId"),
+        extendedPanId: BigInt(this.endpoint.env.vars.string("ble.thread.extendedPanId")),
+        networkName: this.endpoint.env.vars.string("ble.thread.networkName"),
+        channel: this.endpoint.env.vars.number("ble.thread.channel"),
+        version: 130,
+        extendedAddress: ByteArray.fromString(
+          (this.endpoint.env.vars.string("ble.thread.address") ?? "000000000000").toLowerCase()
+        ),
+        rssi: -50,
+        lqi: 50
+      }
+    ];
+    console.log(Logger.toJSON(threadScanResults));
+    return {
+      networkingStatus,
+      threadScanResults
+    };
+  }
+  addOrUpdateThreadNetwork({ operationalDataset, breadcrumb }) {
+    console.log(
+      `---> addOrUpdateWiFiNetwork called on NetworkCommissioning cluster: ${operationalDataset.toHex()} ${breadcrumb}`
+    );
+    this.session.context.assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
+    if (breadcrumb !== void 0) {
+      const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);
+      generalCommissioningCluster.state.breadcrumb = breadcrumb;
+    }
+    const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
+    this.state.lastNetworkingStatus = networkingStatus;
+    this.state.lastNetworkId = firstNetworkId;
+    return {
+      networkingStatus,
+      networkIndex: 0
+    };
+  }
+  removeNetwork({ networkId, breadcrumb }) {
+    console.log(`---> removeNetwork called on NetworkCommissioning cluster: ${networkId.toHex()} ${breadcrumb}`);
+    this.session.context.assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
+    if (breadcrumb !== void 0) {
+      const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);
+      generalCommissioningCluster.state.breadcrumb = breadcrumb;
+    }
+    const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
+    this.state.lastNetworkingStatus = networkingStatus;
+    this.state.lastNetworkId = firstNetworkId;
+    return {
+      networkingStatus,
+      networkIndex: 0
+    };
+  }
+  async connectNetwork({ networkId, breadcrumb }) {
+    console.log(`---> connectNetwork called on NetworkCommissioning cluster: ${networkId.toHex()} ${breadcrumb}`);
+    this.session.context.assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
+    if (breadcrumb !== void 0) {
+      const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);
+      generalCommissioningCluster.state.breadcrumb = breadcrumb;
+    }
+    this.state.networks[0].connected = true;
+    const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
+    this.state.lastNetworkingStatus = networkingStatus;
+    this.state.lastNetworkId = firstNetworkId;
+    this.state.lastConnectErrorValue = null;
+    const device = this.session.context;
+    await device.startAnnouncement();
+    return {
+      networkingStatus,
+      errorValue: null
+    };
+  }
+  reorderNetwork({ networkId, networkIndex, breadcrumb }) {
+    console.log(
+      `---> reorderNetwork called on NetworkCommissioning cluster: ${networkId.toHex()} ${networkIndex} ${breadcrumb}`
+    );
+    if (breadcrumb !== void 0) {
+      const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);
+      generalCommissioningCluster.state.breadcrumb = breadcrumb;
+    }
+    const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
+    this.state.lastNetworkingStatus = networkingStatus;
+    return {
+      networkingStatus,
+      networkIndex: 0
+    };
+  }
+}
+export {
+  DummyThreadNetworkCommissioningServer
+};
+//# sourceMappingURL=DummyThreadNetworkCommissioningServer.js.map

package/dist/esm/examples/cluster/DummyThreadNetworkCommissioningServer.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/examples/cluster/DummyThreadNetworkCommissioningServer.ts"],
+  "sourcesContent": ["/**\n * @license\n * Copyright 2022-2024 Matter.js Authors\n * SPDX-License-Identifier: Apache-2.0\n */\n\nimport { GeneralCommissioningBehavior } from \"@project-chip/matter.js/behavior/definitions/general-commissioning\";\nimport {\n    AddOrUpdateThreadNetworkRequest,\n    ConnectNetworkRequest,\n    NetworkCommissioningBehavior,\n    RemoveNetworkRequest,\n    ReorderNetworkRequest,\n    ScanNetworksRequest,\n    ScanNetworksResponse,\n} from \"@project-chip/matter.js/behavior/definitions/network-commissioning\";\nimport { NetworkCommissioning } from \"@project-chip/matter.js/cluster\";\nimport { Logger } from \"@project-chip/matter.js/log\";\nimport { ByteArray } from \"@project-chip/matter.js/util\";\n\nconst firstNetworkId = new ByteArray(32);\n\n/**\n * This represents a Dummy version of a Wifi Network Commissioning Cluster Server without real Wifi related logic, beside\n * returning some values provided as CLI parameters. This dummy implementation is only there for tests/as showcase for BLE\n * commissioning of a device.\n */\nexport class DummyThreadNetworkCommissioningServer extends NetworkCommissioningBehavior.with(\n    NetworkCommissioning.Feature.ThreadNetworkInterface,\n) {\n    override scanNetworks({ breadcrumb }: ScanNetworksRequest): ScanNetworksResponse {\n        console.log(`---> scanNetworks called on NetworkCommissioning cluster: ${breadcrumb}`);\n\n        // Simulate successful scan\n        if (breadcrumb !== undefined) {\n            const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);\n            generalCommissioningCluster.state.breadcrumb = breadcrumb;\n        }\n\n        const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;\n        this.state.lastNetworkingStatus = networkingStatus;\n\n        const threadScanResults = [\n            {\n                panId: this.endpoint.env.vars.number(\"ble.thread.panId\"),\n                extendedPanId: BigInt(this.endpoint.env.vars.string(\"ble.thread.extendedPanId\")),\n                networkName: this.endpoint.env.vars.string(\"ble.thread.networkName\"),\n                channel: this.endpoint.env.vars.number(\"ble.thread.channel\"),\n                version: 130,\n                extendedAddress: ByteArray.fromString(\n                    (this.endpoint.env.vars.string(\"ble.thread.address\") ?? \"000000000000\").toLowerCase(),\n                ),\n                rssi: -50,\n                lqi: 50,\n            },\n        ];\n        console.log(Logger.toJSON(threadScanResults));\n\n        return {\n            networkingStatus,\n            threadScanResults,\n        };\n    }\n\n    override addOrUpdateThreadNetwork({ operationalDataset, breadcrumb }: AddOrUpdateThreadNetworkRequest) {\n        console.log(\n            `---> addOrUpdateWiFiNetwork called on NetworkCommissioning cluster: ${operationalDataset.toHex()} ${breadcrumb}`,\n        );\n\n        this.session.context.assertFailSafeArmed(\"Failsafe timer needs to be armed to add or update networks.\");\n\n        // Simulate successful add or update\n        if (breadcrumb !== undefined) {\n            const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);\n            generalCommissioningCluster.state.breadcrumb = breadcrumb;\n        }\n\n        const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;\n        this.state.lastNetworkingStatus = networkingStatus;\n        this.state.lastNetworkId = firstNetworkId;\n\n        return {\n            networkingStatus,\n            networkIndex: 0,\n        };\n    }\n\n    override removeNetwork({ networkId, breadcrumb }: RemoveNetworkRequest) {\n        console.log(`---> removeNetwork called on NetworkCommissioning cluster: ${networkId.toHex()} ${breadcrumb}`);\n\n        this.session.context.assertFailSafeArmed(\"Failsafe timer needs to be armed to add or update networks.\");\n\n        // Simulate successful add or update\n        if (breadcrumb !== undefined) {\n            const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);\n            generalCommissioningCluster.state.breadcrumb = breadcrumb;\n        }\n\n        const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;\n        this.state.lastNetworkingStatus = networkingStatus;\n        this.state.lastNetworkId = firstNetworkId;\n\n        return {\n            networkingStatus,\n            networkIndex: 0,\n        };\n    }\n\n    override async connectNetwork({ networkId, breadcrumb }: ConnectNetworkRequest) {\n        console.log(`---> connectNetwork called on NetworkCommissioning cluster: ${networkId.toHex()} ${breadcrumb}`);\n\n        this.session.context.assertFailSafeArmed(\"Failsafe timer needs to be armed to add or update networks.\");\n\n        // Simulate successful connection\n        if (breadcrumb !== undefined) {\n            const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);\n            generalCommissioningCluster.state.breadcrumb = breadcrumb;\n        }\n\n        this.state.networks[0].connected = true;\n\n        const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;\n        this.state.lastNetworkingStatus = networkingStatus;\n        this.state.lastNetworkId = firstNetworkId;\n        this.state.lastConnectErrorValue = null;\n\n        // Announce operational in IP network\n        const device = this.session.context;\n        await device.startAnnouncement();\n\n        return {\n            networkingStatus,\n            errorValue: null,\n        };\n    }\n\n    override reorderNetwork({ networkId, networkIndex, breadcrumb }: ReorderNetworkRequest) {\n        console.log(\n            `---> reorderNetwork called on NetworkCommissioning cluster: ${networkId.toHex()} ${networkIndex} ${breadcrumb}`,\n        );\n\n        // Simulate successful connection\n        if (breadcrumb !== undefined) {\n            const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);\n            generalCommissioningCluster.state.breadcrumb = breadcrumb;\n        }\n\n        const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;\n        this.state.lastNetworkingStatus = networkingStatus;\n\n        return {\n            networkingStatus,\n            networkIndex: 0,\n        };\n    }\n}\n"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,SAAS,oCAAoC;AAC7C;AAAA,EAGI;AAAA,OAKG;AACP,SAAS,4BAA4B;AACrC,SAAS,cAAc;AACvB,SAAS,iBAAiB;AAE1B,MAAM,iBAAiB,IAAI,UAAU,EAAE;AAOhC,MAAM,8CAA8C,6BAA6B;AAAA,EACpF,qBAAqB,QAAQ;AACjC,EAAE;AAAA,EACW,aAAa,EAAE,WAAW,GAA8C;AAC7E,YAAQ,IAAI,6DAA6D,UAAU,EAAE;AAGrF,QAAI,eAAe,QAAW;AAC1B,YAAM,8BAA8B,KAAK,MAAM,IAAI,4BAA4B;AAC/E,kCAA4B,MAAM,aAAa;AAAA,IACnD;AAEA,UAAM,mBAAmB,qBAAqB,2BAA2B;AACzE,SAAK,MAAM,uBAAuB;AAElC,UAAM,oBAAoB;AAAA,MACtB;AAAA,QACI,OAAO,KAAK,SAAS,IAAI,KAAK,OAAO,kBAAkB;AAAA,QACvD,eAAe,OAAO,KAAK,SAAS,IAAI,KAAK,OAAO,0BAA0B,CAAC;AAAA,QAC/E,aAAa,KAAK,SAAS,IAAI,KAAK,OAAO,wBAAwB;AAAA,QACnE,SAAS,KAAK,SAAS,IAAI,KAAK,OAAO,oBAAoB;AAAA,QAC3D,SAAS;AAAA,QACT,iBAAiB,UAAU;AAAA,WACtB,KAAK,SAAS,IAAI,KAAK,OAAO,oBAAoB,KAAK,gBAAgB,YAAY;AAAA,QACxF;AAAA,QACA,MAAM;AAAA,QACN,KAAK;AAAA,MACT;AAAA,IACJ;AACA,YAAQ,IAAI,OAAO,OAAO,iBAAiB,CAAC;AAE5C,WAAO;AAAA,MACH;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA,EAES,yBAAyB,EAAE,oBAAoB,WAAW,GAAoC;AACnG,YAAQ;AAAA,MACJ,uEAAuE,mBAAmB,MAAM,CAAC,IAAI,UAAU;AAAA,IACnH;AAEA,SAAK,QAAQ,QAAQ,oBAAoB,6DAA6D;AAGtG,QAAI,eAAe,QAAW;AAC1B,YAAM,8BAA8B,KAAK,MAAM,IAAI,4BAA4B;AAC/E,kCAA4B,MAAM,aAAa;AAAA,IACnD;AAEA,UAAM,mBAAmB,qBAAqB,2BAA2B;AACzE,SAAK,MAAM,uBAAuB;AAClC,SAAK,MAAM,gBAAgB;AAE3B,WAAO;AAAA,MACH;AAAA,MACA,cAAc;AAAA,IAClB;AAAA,EACJ;AAAA,EAES,cAAc,EAAE,WAAW,WAAW,GAAyB;AACpE,YAAQ,IAAI,8DAA8D,UAAU,MAAM,CAAC,IAAI,UAAU,EAAE;AAE3G,SAAK,QAAQ,QAAQ,oBAAoB,6DAA6D;AAGtG,QAAI,eAAe,QAAW;AAC1B,YAAM,8BAA8B,KAAK,MAAM,IAAI,4BAA4B;AAC/E,kCAA4B,MAAM,aAAa;AAAA,IACnD;AAEA,UAAM,mBAAmB,qBAAqB,2BAA2B;AACzE,SAAK,MAAM,uBAAuB;AAClC,SAAK,MAAM,gBAAgB;AAE3B,WAAO;AAAA,MACH;AAAA,MACA,cAAc;AAAA,IAClB;AAAA,EACJ;AAAA,EAEA,MAAe,eAAe,EAAE,WAAW,WAAW,GAA0B;AAC5E,YAAQ,IAAI,+DAA+D,UAAU,MAAM,CAAC,IAAI,UAAU,EAAE;AAE5G,SAAK,QAAQ,QAAQ,oBAAoB,6DAA6D;AAGtG,QAAI,eAAe,QAAW;AAC1B,YAAM,8BAA8B,KAAK,MAAM,IAAI,4BAA4B;AAC/E,kCAA4B,MAAM,aAAa;AAAA,IACnD;AAEA,SAAK,MAAM,SAAS,CAAC,EAAE,YAAY;AAEnC,UAAM,mBAAmB,qBAAqB,2BAA2B;AACzE,SAAK,MAAM,uBAAuB;AAClC,SAAK,MAAM,gBAAgB;AAC3B,SAAK,MAAM,wBAAwB;AAGnC,UAAM,SAAS,KAAK,QAAQ;AAC5B,UAAM,OAAO,kBAAkB;AAE/B,WAAO;AAAA,MACH;AAAA,MACA,YAAY;AAAA,IAChB;AAAA,EACJ;AAAA,EAES,eAAe,EAAE,WAAW,cAAc,WAAW,GAA0B;AACpF,YAAQ;AAAA,MACJ,+DAA+D,UAAU,MAAM,CAAC,IAAI,YAAY,IAAI,UAAU;AAAA,IAClH;AAGA,QAAI,eAAe,QAAW;AAC1B,YAAM,8BAA8B,KAAK,MAAM,IAAI,4BAA4B;AAC/E,kCAA4B,MAAM,aAAa;AAAA,IACnD;AAEA,UAAM,mBAAmB,qBAAqB,2BAA2B;AACzE,SAAK,MAAM,uBAAuB;AAElC,WAAO;AAAA,MACH;AAAA,MACA,cAAc;AAAA,IAClB;AAAA,EACJ;AACJ;",
+  "names": []
+}

package/dist/esm/examples/cluster/DummyWifiNetworkCommissioningServer.js

@@ -0,0 +1,115 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { GeneralCommissioningBehavior } from "@project-chip/matter.js/behavior/definitions/general-commissioning";
+import {
+  NetworkCommissioningBehavior
+} from "@project-chip/matter.js/behavior/definitions/network-commissioning";
+import { NetworkCommissioning } from "@project-chip/matter.js/cluster";
+import { ByteArray } from "@project-chip/matter.js/util";
+const firstNetworkId = new ByteArray(32);
+class DummyWifiNetworkCommissioningServer extends NetworkCommissioningBehavior.with(
+  NetworkCommissioning.Feature.WiFiNetworkInterface
+) {
+  scanNetworks({ ssid, breadcrumb }) {
+    console.log(`---> scanNetworks called on NetworkCommissioning cluster: ${ssid?.toHex()} ${breadcrumb}`);
+    if (breadcrumb !== void 0) {
+      const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);
+      generalCommissioningCluster.state.breadcrumb = breadcrumb;
+    }
+    const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
+    this.state.lastNetworkingStatus = networkingStatus;
+    return {
+      networkingStatus,
+      wiFiScanResults: [
+        {
+          security: {
+            unencrypted: false,
+            wep: false,
+            wpaPersonal: false,
+            wpa2Personal: true,
+            wpa3Personal: true
+          },
+          ssid: ssid || ByteArray.fromString(this.endpoint.env.vars.get("ble.wifi.scanSsid") ?? "TestSSID"),
+          // Set a valid existing local Wi-Fi SSID here
+          bssid: ByteArray.fromString(
+            this.endpoint.env.vars.get("ble.wifi.scanBssid") ?? "00:00:00:00:00:00"
+          ),
+          channel: 1
+        }
+      ]
+    };
+  }
+  addOrUpdateWiFiNetwork({ ssid, credentials, breadcrumb }) {
+    console.log(
+      `---> addOrUpdateWiFiNetwork called on NetworkCommissioning cluster: ${ssid.toHex()} ${credentials.toHex()} ${breadcrumb}`
+    );
+    this.session.context.assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
+    if (breadcrumb !== void 0) {
+      const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);
+      generalCommissioningCluster.state.breadcrumb = breadcrumb;
+    }
+    const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
+    this.state.lastNetworkingStatus = networkingStatus;
+    this.state.lastNetworkId = firstNetworkId;
+    return {
+      networkingStatus,
+      networkIndex: 0
+    };
+  }
+  removeNetwork({ networkId, breadcrumb }) {
+    console.log(`---> removeNetwork called on NetworkCommissioning cluster: ${networkId.toHex()} ${breadcrumb}`);
+    this.session.context.assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
+    if (breadcrumb !== void 0) {
+      const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);
+      generalCommissioningCluster.state.breadcrumb = breadcrumb;
+    }
+    const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
+    this.state.lastNetworkingStatus = networkingStatus;
+    this.state.lastNetworkId = firstNetworkId;
+    return {
+      networkingStatus,
+      networkIndex: 0
+    };
+  }
+  async connectNetwork({ networkId, breadcrumb }) {
+    console.log(`---> connectNetwork called on NetworkCommissioning cluster: ${networkId.toHex()} ${breadcrumb}`);
+    this.session.context.assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
+    if (breadcrumb !== void 0) {
+      const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);
+      generalCommissioningCluster.state.breadcrumb = breadcrumb;
+    }
+    this.state.networks[0].connected = true;
+    const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
+    this.state.lastNetworkingStatus = networkingStatus;
+    this.state.lastNetworkId = firstNetworkId;
+    this.state.lastConnectErrorValue = null;
+    const device = this.session.context;
+    await device.startAnnouncement();
+    return {
+      networkingStatus,
+      errorValue: null
+    };
+  }
+  reorderNetwork({ networkId, networkIndex, breadcrumb }) {
+    console.log(
+      `---> reorderNetwork called on NetworkCommissioning cluster: ${networkId.toHex()} ${networkIndex} ${breadcrumb}`
+    );
+    if (breadcrumb !== void 0) {
+      const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);
+      generalCommissioningCluster.state.breadcrumb = breadcrumb;
+    }
+    const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
+    this.state.lastNetworkingStatus = networkingStatus;
+    return {
+      networkingStatus,
+      networkIndex: 0
+    };
+  }
+}
+export {
+  DummyWifiNetworkCommissioningServer
+};
+//# sourceMappingURL=DummyWifiNetworkCommissioningServer.js.map