@project-chip/matter-node.js-examples 0.11.0-alpha.0-20240911-db8f7c80 → 0.11.0-alpha.0-20241006-eccb81ae1

package/src/examples/cluster/DummyThreadNetworkCommissioningServer.ts

@@ -1,156 +0,0 @@
-/**
- * @license
- * Copyright 2022-2024 Matter.js Authors
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import { Bytes, Logger } from "@project-chip/matter.js-general";
-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";
-
-const firstNetworkId = new Uint8Array(32);
-
-/**
- * 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.
- */
-export class DummyThreadNetworkCommissioningServer extends NetworkCommissioningBehavior.with(
-    NetworkCommissioning.Feature.ThreadNetworkInterface,
-) {
-    override scanNetworks({
-        breadcrumb,
-    }: NetworkCommissioning.ScanNetworksRequest): NetworkCommissioning.ScanNetworksResponse {
-        console.log(`---> scanNetworks called on NetworkCommissioning cluster: ${breadcrumb}`);
-
-        // Simulate successful scan
-        if (breadcrumb !== undefined) {
-            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: Bytes.fromString(
-                    (this.endpoint.env.vars.string("ble.thread.address") ?? "000000000000").toLowerCase(),
-                ),
-                rssi: -50,
-                lqi: 50,
-            },
-        ];
-        console.log(Logger.toJSON(threadScanResults));
-
-        return {
-            networkingStatus,
-            threadScanResults,
-        };
-    }
-
-    override addOrUpdateThreadNetwork({
-        operationalDataset,
-        breadcrumb,
-    }: NetworkCommissioning.AddOrUpdateThreadNetworkRequest) {
-        console.log(
-            `---> addOrUpdateThreadNetwork called on NetworkCommissioning cluster: ${Bytes.toHex(operationalDataset)} ${breadcrumb}`,
-        );
-
-        this.session.context.assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
-
-        // Simulate successful add or update
-        if (breadcrumb !== undefined) {
-            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,
-        };
-    }
-
-    override removeNetwork({ networkId, breadcrumb }: NetworkCommissioning.RemoveNetworkRequest) {
-        console.log(
-            `---> removeNetwork called on NetworkCommissioning cluster: ${Bytes.toHex(networkId)} ${breadcrumb}`,
-        );
-
-        this.session.context.assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
-
-        // Simulate successful add or update
-        if (breadcrumb !== undefined) {
-            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,
-        };
-    }
-
-    override async connectNetwork({ networkId, breadcrumb }: NetworkCommissioning.ConnectNetworkRequest) {
-        console.log(
-            `---> connectNetwork called on NetworkCommissioning cluster: ${Bytes.toHex(networkId)} ${breadcrumb}`,
-        );
-
-        this.session.context.assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
-
-        // Simulate successful connection
-        if (breadcrumb !== undefined) {
-            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;
-
-        // Announce operational in IP network
-        const device = this.session.context;
-        await device.startAnnouncement();
-
-        return {
-            networkingStatus,
-            errorValue: null,
-        };
-    }
-
-    override reorderNetwork({ networkId, networkIndex, breadcrumb }: NetworkCommissioning.ReorderNetworkRequest) {
-        console.log(
-            `---> reorderNetwork called on NetworkCommissioning cluster: ${Bytes.toHex(networkId)} ${networkIndex} ${breadcrumb}`,
-        );
-
-        // Simulate successful connection
-        if (breadcrumb !== undefined) {
-            const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);
-            generalCommissioningCluster.state.breadcrumb = breadcrumb;
-        }
-
-        const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
-        this.state.lastNetworkingStatus = networkingStatus;
-
-        return {
-            networkingStatus,
-            networkIndex: 0,
-        };
-    }
-}

package/src/examples/cluster/DummyWifiNetworkCommissioningServer.ts

@@ -1,154 +0,0 @@
-/**
- * @license
- * Copyright 2022-2024 Matter.js Authors
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import { Bytes } from "@project-chip/matter.js-general";
-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";
-
-const firstNetworkId = new Uint8Array(32);
-
-/**
- * This represents a Dummy version of a Wifi Network Commissioning Cluster Server without real Wifi 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.
- */
-export class DummyWifiNetworkCommissioningServer extends NetworkCommissioningBehavior.with(
-    NetworkCommissioning.Feature.WiFiNetworkInterface,
-) {
-    override scanNetworks({ ssid, breadcrumb }: NetworkCommissioning.ScanNetworksRequest) {
-        console.log(
-            `---> scanNetworks called on NetworkCommissioning cluster: ${ssid ? Bytes.toHex(ssid) : undefined} ${breadcrumb}`,
-        );
-
-        // Simulate successful scan
-        if (breadcrumb !== undefined) {
-            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 || Bytes.fromString(this.endpoint.env.vars.get("ble.wifi.scanSsid") ?? "TestSSID"), // Set a valid existing local Wi-Fi SSID here
-                    bssid: Bytes.fromString(this.endpoint.env.vars.get("ble.wifi.scanBssid") ?? "00:00:00:00:00:00"),
-                    channel: 1,
-                },
-            ],
-        };
-    }
-
-    override addOrUpdateWiFiNetwork({
-        ssid,
-        credentials,
-        breadcrumb,
-    }: NetworkCommissioning.AddOrUpdateWiFiNetworkRequest) {
-        console.log(
-            `---> addOrUpdateWiFiNetwork called on NetworkCommissioning cluster: ${Bytes.toHex(ssid)} ${Bytes.toHex(credentials)} ${breadcrumb}`,
-        );
-
-        this.session.context.assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
-
-        // Simulate successful add or update
-        if (breadcrumb !== undefined) {
-            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,
-        };
-    }
-
-    override removeNetwork({ networkId, breadcrumb }: NetworkCommissioning.RemoveNetworkRequest) {
-        console.log(
-            `---> removeNetwork called on NetworkCommissioning cluster: ${Bytes.toHex(networkId)} ${breadcrumb}`,
-        );
-
-        this.session.context.assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
-
-        // Simulate successful add or update
-        if (breadcrumb !== undefined) {
-            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,
-        };
-    }
-
-    override async connectNetwork({ networkId, breadcrumb }: NetworkCommissioning.ConnectNetworkRequest) {
-        console.log(
-            `---> connectNetwork called on NetworkCommissioning cluster: ${Bytes.toHex(networkId)} ${breadcrumb}`,
-        );
-
-        this.session.context.assertFailSafeArmed("Failsafe timer needs to be armed to add or update networks.");
-
-        // Simulate successful connection
-        if (breadcrumb !== undefined) {
-            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;
-
-        // Announce operational in IP network
-        const device = this.session.context;
-        await device.startAnnouncement();
-
-        return {
-            networkingStatus,
-            errorValue: null,
-        };
-    }
-
-    override reorderNetwork({ networkId, networkIndex, breadcrumb }: NetworkCommissioning.ReorderNetworkRequest) {
-        console.log(
-            `---> reorderNetwork called on NetworkCommissioning cluster: ${Bytes.toHex(networkId)} ${networkIndex} ${breadcrumb}`,
-        );
-
-        // Simulate successful connection
-        if (breadcrumb !== undefined) {
-            const generalCommissioningCluster = this.agent.get(GeneralCommissioningBehavior);
-            generalCommissioningCluster.state.breadcrumb = breadcrumb;
-        }
-
-        const networkingStatus = NetworkCommissioning.NetworkCommissioningStatus.Success;
-        this.state.lastNetworkingStatus = networkingStatus;
-
-        return {
-            networkingStatus,
-            networkIndex: 0,
-        };
-    }
-}

package/src/examples/cluster/MyFancyOwnFunctionality.ts

@@ -1,185 +0,0 @@
-/**
- * @license
- * Copyright 2022-2024 Matter.js Authors
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import { Identity, MaybePromise } from "@project-chip/matter.js-general";
-import {
-    AttributeElement,
-    ClusterElement,
-    ClusterModel,
-    CommandElement,
-    EventElement,
-    FieldElement,
-} from "@project-chip/matter.js-model";
-import { ClusterBehavior } from "@project-chip/matter.js/behavior/cluster";
-import {
-    Attribute,
-    ClusterRegistry,
-    Command,
-    Event,
-    EventPriority,
-    MutableCluster,
-} from "@project-chip/matter.js/cluster";
-import { ClusterId, VendorId } from "@project-chip/matter.js/datatype";
-import { TlvField, TlvInt16, TlvNullable, TlvObject, TlvString, TypeFromSchema } from "@project-chip/matter.js/tlv";
-
-/** Define the Cluster ID, custom clusters use a special extended formt that also contains the Vendor Id */
-const myFancyClusterId = ClusterId.buildVendorSpecific(VendorId(0xfff4), 0xfc00);
-
-/**
- * Defines the Cluster on Tlv Schema level in a special namespace structure to match the official cluster
- * structures of matter.js.
- * All places that contains "MyFancy..." belong to the custom cluster details, all rest can be left statically like the
- * given names.
- * For more examples and usages of features in such clusters and how the code should look then check the standard
- * cluster Tlv definitions in packages/matter.js/cluster/definitions/*
- */
-export namespace MyFancyOwnFunctionality {
-    /**
-     * Input to the MyFancyOwnFunctionality myFancyCommand command
-     */
-    export const TlvMyFancyCommandRequest = TlvObject({ value: TlvField(0, TlvString) });
-
-    /**
-     * Response of the MyFancyOwnFunctionality myFancyCommand command
-     */
-    export const TlvMyFancyCommandResponse = TlvObject({ response: TlvField(0, TlvString) });
-
-    /**
-     * Event for the MyFancyOwnFunctionality myFancyEvent event
-     */
-    export const TlvMyFancyEvent = TlvObject({ eventValue: TlvField(0, TlvString) });
-
-    /**
-     * @see {@link Cluster}
-     */
-    export const ClusterInstance = MutableCluster({
-        id: myFancyClusterId,
-        name: "MyFancyOwnFunctionality",
-        revision: 1,
-
-        attributes: {
-            /** My fancy attribute */
-            myFancyValue: Attribute(0x0, TlvNullable(TlvInt16)),
-        },
-
-        commands: {
-            /** My fancy command */
-            myFancyCommand: Command(0x1, TlvMyFancyCommandRequest, 0x2, TlvMyFancyCommandResponse),
-        },
-
-        events: {
-            /** My fancy event */
-            myFancyEvent: Event(0x5, EventPriority.Info, TlvMyFancyEvent),
-        },
-    });
-
-    /**
-     * My Fancy Cluster
-     *
-     * This cluster provides an interface to some fancy custom functions.
-     */
-    export interface Cluster extends Identity<typeof ClusterInstance> {}
-
-    export const Cluster: Cluster = ClusterInstance;
-
-    export const Complete = Cluster;
-}
-
-export type MyFancyOwnFunctionalityCluster = MyFancyOwnFunctionality.Cluster;
-export const MyFancyOwnFunctionalityCluster = MyFancyOwnFunctionality.Cluster;
-ClusterRegistry.register(MyFancyOwnFunctionality.Complete);
-
-/**
- * matter.js Model Schema for the cluster, need to match with the Tlv Schema above.
- * See more details in packages/matter.js/behavior/definitions/*
- */
-const MyFancySchema = ClusterElement({
-    name: "MyFancyOwnFunctionality",
-    id: myFancyClusterId,
-    classification: "application",
-    description: "My Fancy Functionality",
-
-    children: [
-        AttributeElement({ name: "ClusterRevision", id: 0xfffd, type: "ClusterRevision", default: 1 }),
-
-        AttributeElement({
-            name: "MyFancyValue",
-            id: 0x0,
-            type: "int16",
-            access: "R V",
-            conformance: "M",
-            quality: "X",
-        }),
-
-        CommandElement({
-            name: "MyFancyCommand",
-            id: 0x1,
-            access: "O",
-            conformance: "M",
-            direction: "request",
-            response: "MyFancyCommandResponse",
-
-            children: [FieldElement({ name: "value", id: 0x0, type: "string", conformance: "M" })],
-        }),
-        CommandElement({
-            name: "MyFancyCommandResponse",
-            id: 0x2,
-            conformance: "M",
-            direction: "request",
-
-            children: [FieldElement({ name: "response", id: 0x0, type: "string", conformance: "M" })],
-        }),
-
-        EventElement({
-            name: "MyFancyEvent",
-            id: 0x5,
-            access: "V",
-            conformance: "O",
-            priority: "info",
-            children: [
-                FieldElement({
-                    name: "EventValue",
-                    id: 0x0,
-                    type: "string",
-                    conformance: "M",
-                }),
-            ],
-        }),
-    ],
-});
-
-/**
- * Interface definitions - exposes the Implementation interface for the cluster and some types to be used in the
- * cluster implementations.
- */
-export type MyFancyCommandRequest = TypeFromSchema<typeof MyFancyOwnFunctionality.TlvMyFancyCommandRequest>;
-export type MyFancyCommandResponse = TypeFromSchema<typeof MyFancyOwnFunctionality.TlvMyFancyCommandResponse>;
-export type MyFancyEvent = TypeFromSchema<typeof MyFancyOwnFunctionality.TlvMyFancyEvent>;
-
-export namespace MyFancyOwnFunctionalityInterface {
-    export interface Base {
-        myFancyCommand(request: MyFancyCommandRequest): MaybePromise<MyFancyCommandResponse>;
-    }
-}
-
-export type MyFancyOwnFunctionalityInterface = {
-    components: [{ flags: {}; methods: MyFancyOwnFunctionalityInterface.Base }];
-};
-
-/**
- * Behavior definition for the cluster command handler implementation
- */
-export const MyFancyOwnFunctionalityBehavior = ClusterBehavior.withInterface<MyFancyOwnFunctionalityInterface>().for(
-    MyFancyOwnFunctionality.Cluster,
-    new ClusterModel(MyFancySchema),
-);
-
-type MyFancyOwnFunctionalityBehaviorType = InstanceType<typeof MyFancyOwnFunctionalityBehavior>;
-export interface MyFancyOwnFunctionalityBehavior extends MyFancyOwnFunctionalityBehaviorType {}
-type StateType = InstanceType<typeof MyFancyOwnFunctionalityBehavior.State>;
-export namespace MyFancyOwnFunctionalityBehavior {
-    export interface State extends StateType {}
-}

package/src/tutorial/example01.ts

@@ -1,6 +0,0 @@
-import "@project-chip/matter.js-nodejs";
-import { ServerNode } from "@project-chip/matter.js/node";
-
-const node = await ServerNode.create();
-
-await node.run();

package/src/tutorial/example02.ts

@@ -1,9 +0,0 @@
-import "@project-chip/matter.js-nodejs";
-import { OnOffLightDevice } from "@project-chip/matter.js/devices/OnOffLightDevice";
-import { ServerNode } from "@project-chip/matter.js/node";
-
-const node = await ServerNode.create();
-
-await node.add(OnOffLightDevice);
-
-await node.run();

package/src/tutorial/example03.ts

@@ -1,19 +0,0 @@
-import "@project-chip/matter.js-nodejs";
-import { OnOffLightDevice, OnOffLightRequirements } from "@project-chip/matter.js/devices/OnOffLightDevice";
-import { ServerNode } from "@project-chip/matter.js/node";
-
-class MyOnOffServer extends OnOffLightRequirements.OnOffServer {
-    override on() {
-        console.log("Turning on");
-    }
-
-    override off() {
-        console.log("Turning off");
-    }
-}
-
-const node = await ServerNode.create();
-
-await node.add(OnOffLightDevice.with(MyOnOffServer));
-
-await node.run();

package/src/tutorial/example04.ts

@@ -1,13 +0,0 @@
-import "@project-chip/matter.js-nodejs";
-import { OnOffLightDevice } from "@project-chip/matter.js/devices/OnOffLightDevice";
-import { ServerNode } from "@project-chip/matter.js/node";
-
-const node = await ServerNode.create();
-
-const light = await node.add(OnOffLightDevice);
-
-light.events.onOff.onOff$Changed.on(newValue => {
-    console.log(`Light is ${newValue ? "on" : "off"}`);
-});
-
-await node.run();

package/src/tutorial/example05.ts

@@ -1,19 +0,0 @@
-import "@project-chip/matter.js-nodejs";
-import { OnOffLightDevice } from "@project-chip/matter.js/devices/OnOffLightDevice";
-import { ServerNode } from "@project-chip/matter.js/node";
-
-const node = await ServerNode.create();
-
-const light = await node.add(OnOffLightDevice);
-
-await node.start();
-
-await light.act(async agent => {
-    await agent.onOff.toggle();
-    console.log("On/off state after first toggle", agent.onOff.state);
-
-    await agent.onOff.toggle();
-    console.log("On/off state after second toggle", agent.onOff.state);
-});
-
-await node.close();