@project-chip/matter-node.js-examples 0.8.0-alpha.1-20240308-033110a3 → 0.8.1-alpha.0-20240401-c87f2ece

package/src/examples/SensorDeviceNode.ts

@@ -186,13 +186,13 @@ async function getConfiguration() {
     );
     const deviceStorage = (await storageService.open("device")).createContext("data");
 
-    const isTemperature = deviceStorage.get("isTemperature", environment.vars.get("type") !== "humidity");
-    if (deviceStorage.has("isTemperature")) {
+    const isTemperature = await deviceStorage.get("isTemperature", environment.vars.get("type") !== "humidity");
+    if (await 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);
+    let interval = environment.vars.number("interval") ?? (await deviceStorage.get("interval", 60));
     if (interval < 1) {
         console.log(`Invalid Interval ${interval}, set to 60s`);
         interval = 60;
@@ -200,25 +200,28 @@ async function getConfiguration() {
 
     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 passcode = environment.vars.number("passcode") ?? (await deviceStorage.get("passcode", 20202021));
+    const discriminator = environment.vars.number("discriminator") ?? (await deviceStorage.get("discriminator", 3840));
     // product name / id and vendor id should match what is in the device certificate
-    const vendorId = environment.vars.number("vendorid") ?? deviceStorage.get("vendorid", 0xfff1);
+    const vendorId = environment.vars.number("vendorid") ?? (await deviceStorage.get("vendorid", 0xfff1));
     const productName = `node-matter OnOff ${isTemperature ? "Temperature" : "Humidity"}`;
-    const productId = environment.vars.number("productid") ?? deviceStorage.get("productid", 0x8000);
+    const productId = environment.vars.number("productid") ?? (await deviceStorage.get("productid", 0x8000));
 
     const port = environment.vars.number("port") ?? 5540;
 
-    const uniqueId = environment.vars.string("uniqueid") ?? deviceStorage.get("uniqueid", Time.nowMs().toString());
+    const uniqueId =
+        environment.vars.string("uniqueid") ?? (await deviceStorage.get("uniqueid", Time.nowMs().toString()));
 
     // Persist basic data to keep them also on restart
-    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);
+    await deviceStorage.set({
+        passcode,
+        discriminator,
+        vendorid: vendorId,
+        productid: productId,
+        interval,
+        isTemperature,
+        uniqueid: uniqueId,
+    });
 
     return {
         isTemperature,

package/src/examples/cluster/DummyThreadNetworkCommissioningServer.ts

@@ -21,7 +21,7 @@ import { ByteArray } from "@project-chip/matter.js/util";
 const firstNetworkId = new ByteArray(32);
 
 /**
- * This represents a Dummy version of a Wifi Network Commissioning Cluster Server without real Wifi related logic, beside
+ * This represents a Dummy version of a Thread Network Commissioning Cluster Server without real thread related logic, beside
  * returning some values provided as CLI parameters. This dummy implementation is only there for tests/as showcase for BLE
  * commissioning of a device.
  */
@@ -64,7 +64,7 @@ export class DummyThreadNetworkCommissioningServer extends NetworkCommissioningB
 
     override addOrUpdateThreadNetwork({ operationalDataset, breadcrumb }: AddOrUpdateThreadNetworkRequest) {
         console.log(
-            `---> addOrUpdateWiFiNetwork called on NetworkCommissioning cluster: ${operationalDataset.toHex()} ${breadcrumb}`,
+            `---> addOrUpdateThreadNetwork called on NetworkCommissioning cluster: ${operationalDataset.toHex()} ${breadcrumb}`,
         );
 
         this.session.context.assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");

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

@@ -1,7 +0,0 @@
-{
-  "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"]
-}