@project-chip/matter-node.js-examples 0.5.0 → 0.5.1-alpha.0-20231006-78029b2

package/src/examples/ControllerNode.ts

@@ -0,0 +1,294 @@
+#!/usr/bin/env node
+
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * This example shows how to create a Matter controller to pair with a device and interfact with it.
+ * It can be used as CLI script, but is more thought as a starting point for your own controller implementation
+ * because you need to adjust the code in any way depending on your use case.
+ */
+
+/**
+ * Import needed modules from @project-chip/matter-node.js
+ */
+// Include this first to auto-register Crypto, Network and Time Node.js implementations
+import { CommissioningController, MatterServer } from "@project-chip/matter-node.js";
+
+import { BleNode } from "@project-chip/matter-node-ble.js/ble";
+import { Ble } from "@project-chip/matter-node.js/ble";
+import {
+    BasicInformationCluster,
+    DescriptorCluster,
+    GeneralCommissioning,
+    OnOffCluster,
+} from "@project-chip/matter-node.js/cluster";
+import { logEndpoint } from "@project-chip/matter-node.js/device";
+import { Format, Level, Logger } from "@project-chip/matter-node.js/log";
+import { CommissioningOptions } from "@project-chip/matter-node.js/protocol";
+import { ManualPairingCodeCodec } from "@project-chip/matter-node.js/schema";
+import { StorageBackendDisk, StorageManager } from "@project-chip/matter-node.js/storage";
+import {
+    getIntParameter,
+    getParameter,
+    hasParameter,
+    requireMinNodeVersion,
+    singleton,
+} from "@project-chip/matter-node.js/util";
+
+const logger = Logger.get("Controller");
+
+requireMinNodeVersion(16);
+
+/** Configure logging */
+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;
+}
+
+if (hasParameter("ble")) {
+    // Initialize Ble
+    Ble.get = singleton(
+        () =>
+            new BleNode({
+                hciId: getIntParameter("ble-hci-id"),
+            }),
+    );
+}
+
+const storageLocation = getParameter("store") ?? ".controller-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 ControllerNode {
+    async start() {
+        logger.info(`node-matter Controller started`);
+
+        /**
+         * Initialize the storage system.
+         *
+         * The storage manager is then also used by the Matter server, so this code block in general is required,
+         * but you can choose a different storage backend as long as it implements the required API.
+         */
+
+        const storageManager = new StorageManager(storage);
+        await storageManager.initialize();
+
+        /**
+         * Collect all needed data
+         *
+         * This block makes sure to collect all needed data from cli or storage. Replace this with where ever your data
+         * come from.
+         *
+         * Note: This example also uses the initialized storage system to store the device parameter data for convenience
+         * and easy reuse. When you also do that be careful to not overlap with Matter-Server own contexts
+         * (so maybe better not ;-)).
+         */
+
+        const controllerStorage = storageManager.createContext("Controller");
+        const ip = controllerStorage.has("ip") ? controllerStorage.get<string>("ip") : getParameter("ip");
+        const port = controllerStorage.has("port") ? controllerStorage.get<number>("port") : getIntParameter("port");
+
+        const pairingCode = getParameter("pairingcode");
+        let longDiscriminator, setupPin, shortDiscriminator;
+        if (pairingCode !== undefined) {
+            const pairingCodeCodec = ManualPairingCodeCodec.decode(pairingCode);
+            shortDiscriminator = pairingCodeCodec.shortDiscriminator;
+            longDiscriminator = undefined;
+            setupPin = pairingCodeCodec.passcode;
+            logger.debug(`Data extracted from pairing code: ${Logger.toJSON(pairingCodeCodec)}`);
+        } else {
+            longDiscriminator =
+                getIntParameter("longDiscriminator") ?? controllerStorage.get("longDiscriminator", 3840);
+            if (longDiscriminator > 4095) throw new Error("Discriminator value must be less than 4096");
+            setupPin = getIntParameter("pin") ?? controllerStorage.get("pin", 20202021);
+        }
+        if ((shortDiscriminator === undefined && longDiscriminator === undefined) || setupPin === undefined) {
+            throw new Error(
+                "Please specify the longDiscriminator of the device to commission with -longDiscriminator or provide a valid passcode with -passcode",
+            );
+        }
+
+        // Collect commissioning options from commandline parameters
+        const commissioningOptions: CommissioningOptions = {
+            regulatoryLocation: GeneralCommissioning.RegulatoryLocationType.IndoorOutdoor,
+            regulatoryCountryCode: "XX",
+        };
+        if (hasParameter("ble")) {
+            const wifiSsid = getParameter("ble-wifi-ssid");
+            const wifiCredentials = getParameter("ble-wifi-credentials");
+            const threadNetworkName = getParameter("ble-thread-networkname");
+            const threadOperationalDataset = getParameter("ble-thread-operationaldataset");
+            if (wifiSsid !== undefined && wifiCredentials !== undefined) {
+                logger.info(`Registering Commissioning over BLE with WiFi: ${wifiSsid}`);
+                commissioningOptions.wifiNetwork = {
+                    wifiSsid: wifiSsid,
+                    wifiCredentials: wifiCredentials,
+                };
+            }
+            if (threadNetworkName !== undefined && threadOperationalDataset !== undefined) {
+                logger.info(`Registering Commissioning over BLE with Thread: ${threadNetworkName}`);
+                commissioningOptions.threadNetwork = {
+                    networkName: threadNetworkName,
+                    operationalDataset: threadOperationalDataset,
+                };
+            }
+        }
+
+        /**
+         * Create Matter Server and Controller Node
+         *
+         * To allow the device to be announced, found, paired and operated we need a MatterServer instance and add a
+         * CommissioningController to it and add the just created device instance to it.
+         * The Controller node defines the port where the server listens for the UDP packages of the Matter protocol
+         * and initializes deice specific certificates and such.
+         *
+         * The below logic also adds command handlers for commands of clusters that normally are handled internally
+         * like testEventTrigger (General Diagnostic Cluster) that can be implemented with the logic when these commands
+         * are called.
+         */
+
+        const matterServer = new MatterServer(storageManager);
+        const commissioningController = new CommissioningController({
+            serverAddress: ip !== undefined && port !== undefined ? { ip, port, type: "udp" } : undefined,
+            longDiscriminator,
+            shortDiscriminator,
+            passcode: setupPin,
+            delayedPairing: true,
+            commissioningOptions,
+            subscribeAllAttributes: true,
+        });
+        matterServer.addCommissioningController(commissioningController);
+
+        /**
+         * Start the Matter Server
+         *
+         * After everything was plugged together we can start the server. When not delayed announcement is set for the
+         * CommissioningServer node then this command also starts the announcement of the device into the network.
+         */
+
+        await matterServer.start();
+
+        /**
+         * TBD
+         */
+        try {
+            await commissioningController.connect();
+
+            if (commissioningController.serverAddress !== undefined) {
+                const { ip, port } = commissioningController.serverAddress;
+                controllerStorage.set("ip", ip);
+                controllerStorage.set("port", port);
+            }
+            if (longDiscriminator !== undefined) {
+                controllerStorage.set("longDiscriminator", longDiscriminator);
+            }
+            controllerStorage.set("pin", setupPin);
+
+            // Important: This is a temporary API to proof the methods working and this will change soon and is NOT stable!
+            // It is provided to proof the concept
+
+            logEndpoint(commissioningController.getRootEndpoint());
+
+            // Example to initialize a ClusterClient and access concrete fields as API methods
+            const descriptor = commissioningController.getRootClusterClient(DescriptorCluster);
+            if (descriptor !== undefined) {
+                console.log(await descriptor.attributes.deviceTypeList.get()); // you can call that way
+                console.log(await descriptor.getServerListAttribute()); // or more convenient that way
+            } else {
+                console.log("No Descriptor Cluster found. This should never happen!");
+            }
+
+            // Example to subscribe to a field and get the value
+            const info = commissioningController.getRootClusterClient(BasicInformationCluster);
+            if (info !== undefined) {
+                console.log(await info.getProductNameAttribute()); // This call is executed remotely
+                //console.log(await info.subscribeProductNameAttribute(value => console.log("productName", value), 5, 30));
+                //console.log(await info.getProductNameAttribute()); // This call is resolved locally because we have subscribed to the value!
+            } else {
+                console.log("No BasicInformation Cluster found. This should never happen!");
+            }
+
+            // Example to get all Attributes of the commissioned node: */*/*
+            //const attributesAll = await interactionClient.getAllAttributes();
+            //console.log("Attributes-All:", Logger.toJSON(attributesAll));
+
+            // Example to get all Attributes of all Descriptor Clusters of the commissioned node: */DescriptorCluster/*
+            //const attributesAllDescriptor = await interactionClient.getMultipleAttributes([{ clusterId: DescriptorCluster.id} ]);
+            //console.log("Attributes-Descriptor:", JSON.stringify(attributesAllDescriptor, null, 2));
+
+            // Example to get all Attributes of the Basic Information Cluster of endpoint 0 of the commissioned node: 0/BasicInformationCluster/*
+            //const attributesBasicInformation = await interactionClient.getMultipleAttributes([{ endpointId: 0, clusterId: BasicInformationCluster.id} ]);
+            //console.log("Attributes-BasicInformation:", JSON.stringify(attributesBasicInformation, null, 2));
+
+            const devices = commissioningController.getDevices();
+            if (devices[0] && devices[0].id === 1) {
+                // Example to subscribe to all Attributes of endpoint 1 of the commissioned node: */*/*
+                //await interactionClient.subscribeMultipleAttributes([{ endpointId: 1, /* subscribe anything from endpoint 1 */ }], 0, 180, data => {
+                //    console.log("Subscribe-All Data:", Logger.toJSON(data));
+                //});
+
+                const onOff = devices[0].getClusterClient(OnOffCluster);
+                if (onOff !== undefined) {
+                    let onOffStatus = await onOff.getOnOffAttribute();
+                    console.log("initial onOffStatus", onOffStatus);
+
+                    onOff.addOnOffAttributeListener(value => {
+                        console.log("subscription onOffStatus", value);
+                        onOffStatus = value;
+                    });
+                    // read data every minute to keep up the connection to show the subscription is working
+                    setInterval(() => {
+                        onOff
+                            .toggle()
+                            .then(() => {
+                                onOffStatus = !onOffStatus;
+                                console.log("onOffStatus", onOffStatus);
+                            })
+                            .catch(error => logger.error(error));
+                    }, 60000);
+                }
+            }
+        } finally {
+            //await matterServer.close(); // Comment out when subscribes are used, else the connection will be closed
+            setTimeout(() => process.exit(0), 1000000);
+        }
+    }
+}
+
+new ControllerNode().start().catch(error => logger.error(error));
+
+process.on("SIGINT", () => {
+    // Pragmatic way to make sure the storage is correctly closed before the process ends.
+    storage
+        .close()
+        .then(() => process.exit(0))
+        .catch(() => process.exit(1));
+});

package/src/examples/DeviceNode.ts

@@ -0,0 +1,288 @@
+#!/usr/bin/env node
+/**
+ * @license
+ * Copyright 2022 The node-matter Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * This example shows how to create a simple on-off Matter device.
+ * It can be used as CLI script and starting point for your own device node implementation.
+ */
+
+/**
+ * Import needed modules from @project-chip/matter-node.js
+ */
+// Include this first to auto-register Crypto, Network and Time Node.js implementations
+import { CommissioningServer, MatterServer } from "@project-chip/matter-node.js";
+
+import { BleNode } from "@project-chip/matter-node-ble.js/ble";
+import { Ble } from "@project-chip/matter-node.js/ble";
+import { OnOffLightDevice, OnOffPluginUnitDevice, logEndpoint } from "@project-chip/matter-node.js/device";
+import { Format, Level, Logger } from "@project-chip/matter-node.js/log";
+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,
+    singleton,
+} from "@project-chip/matter-node.js/util";
+import { DeviceTypeId, VendorId } from "@project-chip/matter.js/datatype";
+import DummyWifiNetworkCommissioningClusterServer from "./cluster/DummyWifiNetworkCommissioningClusterServer.js";
+
+const logger = Logger.get("Device");
+
+requireMinNodeVersion(16);
+
+/** Configure logging */
+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;
+}
+
+if (hasParameter("ble")) {
+    // Initialize Ble
+    Ble.get = singleton(
+        () =>
+            new BleNode({
+                hciId: getIntParameter("ble-hci-id"),
+            }),
+    );
+}
+
+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 {
+    private matterServer: MatterServer | undefined;
+
+    async start() {
+        logger.info(`node-matter`);
+
+        /**
+         * Initialize the storage system.
+         *
+         * The storage manager is then also used by the Matter server, so this code block in general is required,
+         * but you can choose a different storage backend as long as it implements the required API.
+         */
+
+        const storageManager = new StorageManager(storage);
+        await storageManager.initialize();
+
+        /**
+         * Collect all needed data
+         *
+         * This block makes sure to collect all needed data from cli or storage. Replace this with where ever your data
+         * come from.
+         *
+         * Note: This example also uses the initialized storage system to store the device parameter data for convenience
+         * and easy reuse. When you also do that be careful to not overlap with Matter-Server own contexts
+         * (so maybe better not ;-)).
+         */
+
+        const deviceStorage = storageManager.createContext("Device");
+
+        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 test device";
+        const vendorName = "matter-node.js";
+        const passcode = getIntParameter("passcode") ?? deviceStorage.get("passcode", 20202021);
+        const discriminator = getIntParameter("discriminator") ?? deviceStorage.get("discriminator", 3840);
+        // product name / id and vendor id should match what is in the device certificate
+        const vendorId = getIntParameter("vendorid") ?? deviceStorage.get("vendorid", 0xfff1);
+        const productName = `node-matter OnOff ${isSocket ? "Socket" : "Light"}`;
+        const productId = getIntParameter("productid") ?? deviceStorage.get("productid", 0x8000);
+
+        const netAnnounceInterface = getParameter("announceinterface");
+        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);
+
+        /**
+         * Create Device instance and add needed Listener
+         *
+         * Create an instance of the matter device class you want to use.
+         * This example uses the OnOffLightDevice or OnOffPluginUnitDevice depending on the value of the type  parameter.
+         * To execute the on/off scripts defined as parameters a listener for the onOff attribute is registered via the
+         * device specific API.
+         *
+         * The below logic also adds command handlers for commands of clusters that normally are handled device internally
+         * like identify that can be implemented with the logic when these commands are called.
+         */
+
+        const onOffDevice = isSocket ? new OnOffPluginUnitDevice() : new OnOffLightDevice();
+        onOffDevice.addOnOffListener(on => commandExecutor(on ? "on" : "off")?.());
+
+        onOffDevice.addCommandHandler("identify", async ({ request: { identifyTime } }) =>
+            logger.info(`Identify called for OnOffDevice: ${identifyTime}`),
+        );
+
+        /**
+         * Create Matter Server and CommissioningServer Node
+         *
+         * To allow the device to be announced, found, paired and operated we need a MatterServer instance and add a
+         * commissioningServer to it and add the just created device instance to it.
+         * The CommissioningServer node defines the port where the server listens for the UDP packages of the Matter protocol
+         * and initializes deice specific certificates and such.
+         *
+         * The below logic also adds command handlers for commands of clusters that normally are handled internally
+         * like testEventTrigger (General Diagnostic Cluster) that can be implemented with the logic when these commands
+         * are called.
+         */
+
+        this.matterServer = new MatterServer(storageManager, { mdnsAnnounceInterface: netAnnounceInterface });
+
+        const commissioningServer = new CommissioningServer({
+            port,
+            deviceName,
+            deviceType: DeviceTypeId(onOffDevice.deviceType),
+            passcode,
+            discriminator,
+            basicInformation: {
+                vendorName,
+                vendorId: VendorId(vendorId),
+                nodeLabel: productName,
+                productName,
+                productLabel: productName,
+                productId,
+                serialNumber: `node-matter-${uniqueId}`,
+            },
+            delayedAnnouncement: hasParameter("ble"), // Delay announcement when BLE is used to show how limited advertisement works
+        });
+
+        // optionally add a listener for the testEventTrigger command from the GeneralDiagnostics cluster
+        commissioningServer.addCommandHandler("testEventTrigger", async ({ request: { enableKey, eventTrigger } }) =>
+            logger.info(`testEventTrigger called on GeneralDiagnostic cluster: ${enableKey} ${eventTrigger}`),
+        );
+
+        /**
+         * Modify automatically added clusters of the Root endpoint if needed
+         * In this example we change the networkCommissioning cluster into one for "Wifi only" devices when BLE is used
+         * for commissioning, to demonstrate how to do this.
+         * If you want to implement Ethernet only devices that get connected to the network via LAN/Ethernet cable,
+         * then all this is not needed.
+         * The same as shown here for Wi-Fi is also possible theoretical for Thread only or combined devices.
+         */
+
+        if (hasParameter("ble")) {
+            // matter.js will create a Ethernet-only device by default when ut comes to Network Commissioning Features.
+            // To offer e.g. a "Wi-Fi only device" (or any other combination) we need to override the Network Commissioning
+            // cluster and implement all the need handling here. This is a "static implementation" for pure demonstration
+            // purposes and just "simulates" the actions to be done. In a real world implementation this would be done by
+            // the device implementor based on the relevant networking stack.
+            // The NetworkCommissioningCluster and all logics are described in Matter Core Specifications section 11.8
+            commissioningServer.addRootClusterServer(DummyWifiNetworkCommissioningClusterServer);
+        }
+
+        commissioningServer.addDevice(onOffDevice);
+
+        this.matterServer.addCommissioningServer(commissioningServer);
+
+        /**
+         * Start the Matter Server
+         *
+         * After everything was plugged together we can start the server. When not delayed announcement is set for the
+         * CommissioningServer node then this command also starts the announcement of the device into the network.
+         */
+
+        await this.matterServer.start();
+
+        logEndpoint(commissioningServer.getRootEndpoint());
+
+        // When we want to limit the initial announcement to one medium (e.g. BLE) then we need to delay the
+        // announcement and provide the limiting information.
+        // Without delaying the announcement is directly triggered with the above "start()" call.
+        if (hasParameter("ble")) {
+            // Announce operational in BLE network only if we have ble enabled, else everywhere
+            await commissioningServer.advertise({ ble: true });
+        }
+
+        /**
+         * Print Pairing Information
+         *
+         * If the device is not already commissioned (this info is stored in the storage system) then get and print the
+         * pairing details. This includes the QR code that can be scanned by the Matter app to pair the device.
+         */
+
+        logger.info("Listening");
+        if (!commissioningServer.isCommissioned()) {
+            const pairingData = commissioningServer.getPairingCode({
+                ble: hasParameter("ble"),
+                softAccessPoint: false,
+                onIpNetwork: false,
+            });
+
+            const { qrCode, qrPairingCode, manualPairingCode } = pairingData;
+
+            console.log(qrCode);
+            logger.info(
+                `QR Code URL: https://project-chip.github.io/connectedhomeip/qrcode.html?data=${qrPairingCode}`,
+            );
+            logger.info(`Manual pairing code: ${manualPairingCode}`);
+        } else {
+            logger.info("Device is already commissioned. Waiting for controllers to connect ...");
+        }
+    }
+
+    async stop() {
+        await this.matterServer?.close();
+    }
+}
+
+const device = new Device();
+device
+    .start()
+    .then(() => {
+        /* done */
+    })
+    .catch(err => console.error(err));
+
+process.on("SIGINT", () => {
+    device
+        .stop()
+        .then(() => {
+            // Pragmatic way to make sure the storage is correctly closed before the process ends.
+            storage
+                .close()
+                .then(() => process.exit(0))
+                .catch(err => console.error(err));
+        })
+        .catch(err => console.error(err));
+});