@project-chip/matter.js 0.2.1 → 0.3.0

package/dist/es/cluster/NetworkCommissioningCluster.d.ts

@@ -0,0 +1,170 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, Command, OptionalAttribute, OptionalCommand, WritableAttribute } from "./Cluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 11.8.6.5 */
+export declare const enum NetworkCommissioningStatus {
+    /** OK, no error. */
+    Success = 0,
+    /** Value Outside Range. */
+    OutOfRange = 1,
+    /** A collection would exceed its size limit. */
+    BoundsExceeded = 2,
+    /** The NetworkID is not among the collection of added networks. */
+    NetworkIDNotFound = 3,
+    /** The NetworkID is already among the collection of added networks. */
+    DuplicateNetworkID = 4,
+    /** Cannot find AP: SSID Not found. */
+    NetworkNotFound = 5,
+    /** Cannot find AP: Mismatch on band/channels/regulatory domain / 2.4GHz vs 5GHz. */
+    RegulatoryError = 6,
+    /** Cannot associate due to authentication failure. */
+    AuthFailure = 7,
+    /** Cannot associate due to unsupported security mode. */
+    UnsupportedSecurity = 8,
+    /** Other association failure. */
+    OtherConnectionFailure = 9,
+    /** Failure to generate an IPv6 address. */
+    IPV6Failed = 10,
+    /** Failure to bind Wi-Fi <-> IP interfaces. */
+    IPBindFailed = 11,
+    /** Unknown error. */
+    UnknownError = 12
+}
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 11.8.6.2 */
+export declare const enum WiFiBand {
+    /** 2.4GHz - 2.401GHz to 2.495GHz (802.11b/g/n/ax) */
+    '2G4' = 0,
+    /** 3.65GHz - 3.655GHz to 3.695GHz (802.11y) */
+    '3G65' = 1,
+    /** 5GHz - 5.150GHz to 5.895GHz (802.11a/n/ac/ax) */
+    '5G' = 2,
+    /** 6GHz - 5.925GHz to 7.125GHz (802.11ax / WiFi 6E) */
+    '6G' = 3,
+    /** 60GHz - 57.24GHz to 70.20GHz (802.11ad/ay) */
+    '60G' = 4
+}
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 11.8.6.1 */
+export declare const TlvWiFiSecurity: import("../tlv/TlvWrapper.js").TlvWrapper<import("../schema/BitmapSchema.js").TypeFromBitSchema<{
+    Unencrypted: BitFlag;
+    Wep: BitFlag;
+    'WPA-PERSONAL': BitFlag;
+    'WPA2-PERSONAL': BitFlag;
+    'WPA3-PERSONAL': BitFlag;
+}>, number>;
+/**
+ * This cluster is used to associate a Node with or manage a Node’s one or more network interfaces.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.8
+ */
+export declare const NetworkCommissioningCluster: Cluster<{
+    wifi: BitFlag;
+    thread: BitFlag;
+    ethernet: BitFlag;
+}, {
+    maxNetworks: Attribute<number>;
+    networks: Attribute<{
+        networkId: Uint8Array;
+        connected: boolean;
+    }[]>;
+    scanMaxTimeSeconds: OptionalAttribute<number>;
+    connectMaxTimeSeconds: OptionalAttribute<number>;
+    interfaceEnabled: WritableAttribute<boolean>;
+    lastNetworkingStatus: Attribute<NetworkCommissioningStatus | null>;
+    lastNetworkId: Attribute<Uint8Array | null>;
+    lastConnectErrorValue: Attribute<number | null>;
+    clusterRevision: Attribute<number>;
+    featureMap: Attribute<import("../schema/BitmapSchema.js").TypeFromBitSchema<{
+        wifi: BitFlag;
+        thread: BitFlag;
+        ethernet: BitFlag;
+    }>>;
+    attributeList: Attribute<import("../datatype/AttributeId.js").AttributeId[]>;
+    eventList: Attribute<import("../datatype/EventId.js").EventId[]>;
+    acceptedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+    generatedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+}, {
+    /** Determine the set of networks the device sees as available. */
+    scanNetworks: Command<{
+        breadcrumb?: number | bigint | undefined;
+        ssid?: Uint8Array | null | undefined;
+    }, {
+        networkingStatus: NetworkCommissioningStatus;
+        debugText?: string | undefined;
+        wiFiScanResults?: {
+            security: import("../schema/BitmapSchema.js").TypeFromBitSchema<{
+                Unencrypted: BitFlag;
+                Wep: BitFlag;
+                'WPA-PERSONAL': BitFlag;
+                'WPA2-PERSONAL': BitFlag;
+                'WPA3-PERSONAL': BitFlag;
+            }>;
+            ssid: Uint8Array;
+            bssid: Uint8Array;
+            channel: number;
+            wiFiBand?: WiFiBand | undefined;
+            rssi?: number | undefined;
+        }[] | undefined;
+        threadScanResults?: {
+            channel: number;
+            rssi: number;
+            panId: number;
+            extendedPanId: number | bigint;
+            networkName: string;
+            version: number;
+            extendedAddress: Uint8Array;
+            lqi: number;
+        }[] | undefined;
+    }>;
+    /** Add or update the credentials for a given Wi-Fi network. */
+    addOrUpdateWiFiNetwork: OptionalCommand<{
+        ssid: Uint8Array;
+        credentials: Uint8Array;
+        breadcrumb?: number | bigint | undefined;
+    }, {
+        networkingStatus: NetworkCommissioningStatus;
+        debugText?: string | undefined;
+        networkIndex?: number | undefined;
+    }>;
+    /** Add or update the credentials for a given Thread network. */
+    addOrUpdateThreadNetwork: OptionalCommand<{
+        OperationalDataset: Uint8Array;
+        breadcrumb?: number | bigint | undefined;
+    }, {
+        networkingStatus: NetworkCommissioningStatus;
+        debugText?: string | undefined;
+        networkIndex?: number | undefined;
+    }>;
+    /** Remove the definition of a given network (including its credentials). */
+    removeNetwork: Command<{
+        networkId: Uint8Array;
+        breadcrumb?: number | bigint | undefined;
+    }, {
+        networkingStatus: NetworkCommissioningStatus;
+        debugText?: string | undefined;
+        networkIndex?: number | undefined;
+    }>;
+    /** Connect to the specified network, using previously-defined credentials. */
+    connectNetwork: Command<{
+        networkId: Uint8Array;
+        breadcrumb?: number | bigint | undefined;
+    }, {
+        networkingStatus: NetworkCommissioningStatus;
+        errorValue: number | null;
+        debugText?: string | undefined;
+    }>;
+    /** Modify the order in which networks will be presented in the Networks attribute. */
+    reorderNetwork: Command<{
+        networkId: Uint8Array;
+        networkIndex: number;
+        breadcrumb?: number | bigint | undefined;
+    }, {
+        networkingStatus: NetworkCommissioningStatus;
+        debugText?: string | undefined;
+        networkIndex?: number | undefined;
+    }>;
+}, import("./Cluster.js").Events>;
+//# sourceMappingURL=NetworkCommissioningCluster.d.ts.map

package/dist/es/cluster/NetworkCommissioningCluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkCommissioningCluster.d.ts","sourceRoot":"","sources":["../../../src/cluster/NetworkCommissioningCluster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAClH,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAUpD,wEAAwE;AACxE,0BAAkB,0BAA0B;IACxC,oBAAoB;IACpB,OAAO,IAAI;IACX,2BAA2B;IAC3B,UAAU,IAAI;IAEd,gDAAgD;IAChD,cAAc,IAAI;IAElB,mEAAmE;IACnE,iBAAiB,IAAI;IAErB,uEAAuE;IACvE,kBAAkB,IAAI;IAEtB,sCAAsC;IACtC,eAAe,IAAI;IAEnB,oFAAoF;IACpF,eAAe,IAAI;IAEnB,sDAAsD;IACtD,WAAW,IAAI;IAEf,yDAAyD;IACzD,mBAAmB,IAAI;IAEvB,iCAAiC;IACjC,sBAAsB,IAAI;IAE1B,2CAA2C;IAC3C,UAAU,KAAK;IAEf,+CAA+C;IAC/C,YAAY,KAAK;IAEjB,qBAAqB;IACrB,YAAY,KAAK;CACpB;AAED,wEAAwE;AACxE,0BAAkB,QAAQ;IACtB,qDAAqD;IACrD,KAAK,IAAI;IACT,+CAA+C;IAC/C,MAAM,IAAI;IACV,oDAAoD;IACpD,IAAI,IAAI;IACR,uDAAuD;IACvD,IAAI,IAAI;IACR,iDAAiD;IACjD,KAAK,IAAI;CACZ;AAED,wEAAwE;AACxE,eAAO,MAAM,eAAe;;;;;;WAM1B,CAAC;AA6IH;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;IAqChC,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAGlE,+DAA+D;;;;;;;;;;IAG/D,gEAAgE;;;;;;;;;IAGhE,4EAA4E;;;;;;;;;IAG5E,8EAA8E;;;;;;;;;IAG9E,sFAAsF;;;;;;;;;;iCAG5F,CAAC"}

package/dist/es/cluster/NetworkCommissioningCluster.js

@@ -0,0 +1,175 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, Command, OptionalAttribute, OptionalCommand, WritableAttribute } from "./Cluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { TlvBitmap, TlvEnum, TlvInt32, TlvInt8, TlvUInt16, TlvUInt64, TlvUInt8 } from "../tlv/TlvNumber.js";
+import { TlvField, TlvObject, TlvOptionalField } from "../tlv/TlvObject.js";
+import { TlvByteString, TlvString } from "../tlv/TlvString.js";
+import { TlvBoolean } from "../tlv/TlvBoolean.js";
+import { TlvNullable } from "../tlv/TlvNullable.js";
+import { TlvArray } from "../tlv/TlvArray.js";
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 11.8.6.1 */
+export const TlvWiFiSecurity = TlvBitmap(TlvUInt8, {
+    Unencrypted: BitFlag(0),
+    Wep: BitFlag(1),
+    'WPA-PERSONAL': BitFlag(2),
+    'WPA2-PERSONAL': BitFlag(3),
+    'WPA3-PERSONAL': BitFlag(4),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.8.6.4 */
+const TlvWiFiInterfaceScanResult = TlvObject({
+    security: TlvField(0, TlvWiFiSecurity),
+    ssid: TlvField(1, TlvByteString.bound({ maxLength: 32 })),
+    bssid: TlvField(2, TlvByteString.bound({ length: 6 })),
+    channel: TlvField(3, TlvUInt16),
+    /** Used to differentiate overlapping channel number values across different Wi-Fi frequency bands. */
+    wiFiBand: TlvOptionalField(4, TlvEnum()),
+    /** Denote the signal strength in dBm of the associated scan result. */
+    rssi: TlvOptionalField(5, TlvInt8),
+});
+// TODO: Move to TlvString.ts in matter.js!
+const TlvHardwareAddress = TlvByteString.bound({ minLength: 6, maxLength: 8 });
+/** @see {@link MatterCoreSpecificationV1_0} § 11.8.6.4 */
+const TlThreadInterfaceScanResult = TlvObject({
+    panId: TlvField(0, TlvUInt16.bound({ min: 0, max: 65534 })),
+    extendedPanId: TlvField(1, TlvUInt64),
+    networkName: TlvField(2, TlvString.bound({ minLength: 1, maxLength: 16 })),
+    channel: TlvField(3, TlvUInt16),
+    version: TlvField(4, TlvUInt8),
+    /** IEEE 802.15.4 Extended Address */
+    extendedAddress: TlvField(5, TlvHardwareAddress),
+    rssi: TlvField(6, TlvInt8),
+    lqi: TlvField(7, TlvUInt8),
+});
+/** @see {@link MatterCoreSpecificationV1_0} §  */
+const TlvNetworkInfo = TlvObject({
+    /** Unique identifier for the network. */
+    networkId: TlvField(0, TlvByteString.bound({ minLength: 1, maxLength: 32 })),
+    /** Connected status of the asscoiated network. */
+    connected: TlvField(1, TlvBoolean),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.8.8.2 */
+const TlvScanNetworksRequest = TlvObject({
+    /** SSID for a directed scan of that particular Wi-Fi SSID. */
+    ssid: TlvOptionalField(0, TlvNullable(TlvByteString.bound({ minLength: 1, maxLength: 32 }))),
+    /** Sets the Breadcrumb attribute in the General Commissioning cluster on success of the associated command. */
+    breadcrumb: TlvOptionalField(1, TlvUInt64),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.8.8.3 */
+const TlvScanNetworksResponse = TlvObject({
+    /** Status of the last scan operation. */
+    networkingStatus: TlvField(0, TlvEnum()),
+    /** Error information which can be communicated to the user in case the NetworkingStatus was not Success. */
+    debugText: TlvOptionalField(1, TlvString.bound({ maxLength: 512 })),
+    /** Wi-Fi network scan results. */
+    wiFiScanResults: TlvOptionalField(2, TlvArray(TlvWiFiInterfaceScanResult)),
+    /** Thread network scan results. */
+    threadScanResults: TlvOptionalField(3, TlvArray(TlThreadInterfaceScanResult)),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.8.8.4 */
+const TlvAddOrUpdateWiFiNetworkRequest = TlvObject({
+    /** SSID to which to attempt connection. */
+    ssid: TlvField(0, TlvByteString.bound({ maxLength: 32 })),
+    /** Passphrase or PSK for the network (if any is needed). */
+    credentials: TlvField(1, TlvByteString.bound({ maxLength: 64 })),
+    /** Sets the Breadcrumb attribute in the General Commissioning cluster on success of the associated command. */
+    breadcrumb: TlvOptionalField(2, TlvUInt64),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.8.8.5 */
+const TlvAddOrUpdateThreadNetworkRequest = TlvObject({
+    /** Thread Network Parameters. */
+    OperationalDataset: TlvField(0, TlvByteString.bound({ length: 254 })),
+    /** Sets the Breadcrumb attribute in the General Commissioning cluster on success of the associated command. */
+    breadcrumb: TlvOptionalField(1, TlvUInt64),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.8.8.8 */
+const TlvRemoveNetworkRequest = TlvObject({
+    /** NetworkID for the entry to remove: the SSID for Wi-Fi and XPAN ID for Thread. */
+    networkId: TlvField(0, TlvByteString.bound({ minLength: 1, maxLength: 32 })),
+    /** Sets the Breadcrumb attribute in the General Commissioning cluster on success of the associated command. */
+    breadcrumb: TlvOptionalField(1, TlvUInt64),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.8.8.9 */
+const TlvNetworkConfigResponse = TlvObject({
+    /** Status of the last operation attempting to modify the Networks attribute configuration. */
+    networkingStatus: TlvField(0, TlvEnum()),
+    /** Error information which can be communicated to the user in case the NetworkingStatus was not Success. */
+    debugText: TlvOptionalField(1, TlvString.bound({ maxLength: 512 })),
+    /** The 0-based index of the entry in the Networks attribute that was last added, updated or removed successfully. */
+    networkIndex: TlvOptionalField(2, TlvUInt8),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.8.8.10 */
+const TlvConnectNetworkRequest = TlvObject({
+    /** NetworkID for the entry used to configure the connection: the SSID for Wi-Fi and XPAN ID for Thread. */
+    networkId: TlvField(0, TlvByteString.bound({ minLength: 1, maxLength: 32 })),
+    /** Sets the Breadcrumb attribute in the General Commissioning cluster on success of the associated command. */
+    breadcrumb: TlvOptionalField(1, TlvUInt64),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.8.8.11 */
+const TlvConnectNetworkResponse = TlvObject({
+    /** Status of the last connection attempt. */
+    networkingStatus: TlvField(0, TlvEnum()),
+    /** Error information which can be communicated to the user in case the NetworkingStatus was not Success. */
+    debugText: TlvOptionalField(1, TlvString),
+    /** Wi-Fi association errors. */
+    errorValue: TlvField(2, TlvNullable(TlvInt32)),
+});
+/** @see {@link MatterCoreSpecificationV1_0} § 11.8.8.12 */
+const TlvReorderNetworkRequest = TlvObject({
+    /** NetworkID for the entry to reorder: the SSID for Wi-Fi and XPAN ID for Thread. */
+    networkId: TlvField(0, TlvByteString.bound({ minLength: 1, maxLength: 32 })),
+    /** 0-based index of the new desired position of the entry in the Networks attribute. */
+    networkIndex: TlvField(1, TlvUInt8),
+    /** Sets the Breadcrumb attribute in the General Commissioning cluster on success of the associated command. */
+    breadcrumb: TlvOptionalField(2, TlvUInt64),
+});
+/**
+ * This cluster is used to associate a Node with or manage a Node’s one or more network interfaces.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.8
+ */
+export const NetworkCommissioningCluster = Cluster({
+    id: 0x31,
+    name: "NetworkCommissioning",
+    revision: 1,
+    features: {
+        wifi: BitFlag(0),
+        thread: BitFlag(1),
+        ethernet: BitFlag(2),
+    },
+    attributes: {
+        /** Maximum number of network configuration entries that can be added, based on available device resources. */
+        maxNetworks: Attribute(0, TlvUInt8.bound({ min: 1 })),
+        /** Network configurations that are usable on the network interface. */
+        networks: Attribute(1, TlvArray(TlvNetworkInfo), { default: [] }),
+        /** Maximum duration taken, in seconds, to provide scan results. */
+        scanMaxTimeSeconds: OptionalAttribute(2, TlvUInt8),
+        /** Maximum duration taken, in seconds, to report a successful or failed network connection indication. */
+        connectMaxTimeSeconds: OptionalAttribute(3, TlvUInt8),
+        /** Indicates whether the associated network interface is enabled or not. */
+        interfaceEnabled: WritableAttribute(4, TlvBoolean, { default: true }),
+        /** Status of the last attempt either scan or connect to an operational network. */
+        lastNetworkingStatus: Attribute(5, TlvNullable(TlvEnum()), { default: null }),
+        /** NetworkID used in the last attempt to connect to an operational network. */
+        lastNetworkId: Attribute(6, TlvNullable(TlvByteString.bound({ minLength: 1, maxLength: 32 })), { default: null }),
+        /** ErrorValue used in the last failed attempt to connect to an operational network. */
+        lastConnectErrorValue: Attribute(7, TlvNullable(TlvInt32), { default: null }), /* read = admin */
+    },
+    commands: {
+        /** Determine the set of networks the device sees as available. */
+        scanNetworks: Command(0, TlvScanNetworksRequest, 1, TlvScanNetworksResponse),
+        /** Add or update the credentials for a given Wi-Fi network. */
+        addOrUpdateWiFiNetwork: OptionalCommand(2, TlvAddOrUpdateWiFiNetworkRequest, 5, TlvNetworkConfigResponse),
+        /** Add or update the credentials for a given Thread network. */
+        addOrUpdateThreadNetwork: OptionalCommand(3, TlvAddOrUpdateThreadNetworkRequest, 5, TlvNetworkConfigResponse),
+        /** Remove the definition of a given network (including its credentials). */
+        removeNetwork: Command(4, TlvRemoveNetworkRequest, 5, TlvNetworkConfigResponse),
+        /** Connect to the specified network, using previously-defined credentials. */
+        connectNetwork: Command(6, TlvConnectNetworkRequest, 7, TlvConnectNetworkResponse),
+        /** Modify the order in which networks will be presented in the Networks attribute. */
+        reorderNetwork: Command(8, TlvReorderNetworkRequest, 5, TlvNetworkConfigResponse),
+    },
+});

package/dist/es/cluster/OccupancySensingCluster.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, OptionalWritableAttribute, Cluster } from "./Cluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 2.7.5.1 */
+export declare const OccupancyBitmap: import("../tlv/TlvWrapper.js").TlvWrapper<import("../schema/BitmapSchema.js").TypeFromBitSchema<{
+    occupied: BitFlag;
+}>, number>;
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 2.7.5.2 */
+export declare const enum OccupancySensorType {
+    PIR = 0,
+    Ultrasonic = 1,
+    PIRAndUltrasonic = 2,
+    PhysicalContact = 3
+}
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 2.7.5.3 */
+export declare const OccupancySensorTypeBitmap: import("../tlv/TlvWrapper.js").TlvWrapper<import("../schema/BitmapSchema.js").TypeFromBitSchema<{
+    PIR: BitFlag;
+    ultrasonic: BitFlag;
+    physicalContact: BitFlag;
+}>, number>;
+/**
+ * Attributes and commands for Occupancy Detection.
+ *
+ * @see {@link MatterApplicationClusterSpecificationV1_0} § 2.7
+ */
+export declare const OccupancySensingCluster: Cluster<import("../schema/BitmapSchema.js").BitSchema, {
+    occupancy: Attribute<import("../schema/BitmapSchema.js").TypeFromBitSchema<{
+        occupied: BitFlag;
+    }>>;
+    occupancySensorType: Attribute<OccupancySensorType>;
+    occupancySensorTypeBitmap: Attribute<import("../schema/BitmapSchema.js").TypeFromBitSchema<{
+        PIR: BitFlag;
+        ultrasonic: BitFlag;
+        physicalContact: BitFlag;
+    }>>;
+    pirOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number>;
+    pirUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number>;
+    pirUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number>;
+    ultrasonicOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number>;
+    ultrasonicUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number>;
+    ultrasonicUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number>;
+    physicalContactOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number | null>;
+    physicalContactUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number | null>;
+    physicalContactUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number>;
+    clusterRevision: Attribute<number>;
+    featureMap: Attribute<import("../schema/BitmapSchema.js").TypeFromBitSchema<import("../schema/BitmapSchema.js").BitSchema>>;
+    attributeList: Attribute<import("../datatype/AttributeId.js").AttributeId[]>;
+    eventList: Attribute<import("../datatype/EventId.js").EventId[]>;
+    acceptedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+    generatedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+}, import("./Cluster.js").Commands, import("./Cluster.js").Events>;
+//# sourceMappingURL=OccupancySensingCluster.d.ts.map

package/dist/es/cluster/OccupancySensingCluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OccupancySensingCluster.d.ts","sourceRoot":"","sources":["../../../src/cluster/OccupancySensingCluster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAE,yBAAyB,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAKpD,uEAAuE;AACvE,eAAO,MAAM,eAAe;;WAE1B,CAAC;AAEH,uEAAuE;AACvE,0BAAkB,mBAAmB;IACjC,GAAG,IAAI;IACP,UAAU,IAAI;IACd,gBAAgB,IAAI;IACpB,eAAe,IAAI;CACtB;AAED,uEAAuE;AACvE,eAAO,MAAM,yBAAyB;;;;WAIpC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;kEA2ClC,CAAC"}

package/dist/es/cluster/OccupancySensingCluster.js

@@ -0,0 +1,59 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, OptionalWritableAttribute, Cluster } from "./Cluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { TlvBitmap, TlvEnum, TlvUInt16, TlvUInt8 } from "../tlv/TlvNumber.js";
+import { TlvNullable } from "../tlv/TlvNullable.js";
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 2.7.5.1 */
+export const OccupancyBitmap = TlvBitmap(TlvUInt8, {
+    occupied: BitFlag(0),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 2.7.5.3 */
+export const OccupancySensorTypeBitmap = TlvBitmap(TlvUInt8, {
+    PIR: BitFlag(0),
+    ultrasonic: BitFlag(1),
+    physicalContact: BitFlag(2)
+});
+/**
+ * Attributes and commands for Occupancy Detection.
+ *
+ * @see {@link MatterApplicationClusterSpecificationV1_0} § 2.7
+ */
+export const OccupancySensingCluster = Cluster({
+    id: 0x0406,
+    name: "OccupancySensing",
+    revision: 3,
+    /** @see {@link MatterApplicationClusterSpecificationV1_0} § 2.7.5 */
+    attributes: {
+        /** Bitmap, with only Bit 0 used.  1 = occupied, 0 = unoccupied. */
+        occupancy: Attribute(0x0000, OccupancyBitmap),
+        /**  specifies the type of the occupancy sensor  */
+        occupancySensorType: Attribute(0x0001, TlvEnum()),
+        /** bitmap allowing for specification of combination of sensor types */
+        occupancySensorTypeBitmap: Attribute(0x0002, OccupancySensorTypeBitmap),
+        // @see {@link MatterApplicationClusterSpecificationV1_0} § 2.7.6
+        /** delay in seconds before the sensor changes back to unoccupied state. */
+        pirOccupiedToUnoccupiedDelay: OptionalWritableAttribute(0x0010, TlvUInt16, { default: 0 }),
+        /** delay in seconds before the sensor changes to its occupied state after detection */
+        pirUnoccupiedToOccupiedDelay: OptionalWritableAttribute(0x0011, TlvUInt16, { default: 0 }),
+        /** number of events in the period pirUnoccupiedToOccupiedDelay before the sensor changes to occupied */
+        pirUnoccupiedToOccupiedThreshold: OptionalWritableAttribute(0x0012, TlvUInt8.bound({ min: 1, max: 254 }), { default: 1 }),
+        // @see {@link MatterApplicationClusterSpecificationV1_0} § 2.7.7
+        /** delay, in seconds, before the sensor changes back to unoccupied state. */
+        ultrasonicOccupiedToUnoccupiedDelay: OptionalWritableAttribute(0x0020, TlvUInt16, { default: 0 }),
+        /** delay in seconds before the sensor changes to its occupied state after detection */
+        ultrasonicUnoccupiedToOccupiedDelay: OptionalWritableAttribute(0x0021, TlvUInt16, { default: 0 }),
+        /** number of events in the period ultrasonicOnoccupiedToOccupiedDelay before the sensor changes to occupied */
+        ultrasonicUnoccupiedToOccupiedThreshold: OptionalWritableAttribute(0x0022, TlvUInt8.bound({ min: 1, max: 254 }), { default: 1 }),
+        // @see {@link MatterApplicationClusterSpecificationV1_0} § 2.7.8
+        /** delay in seconds before the sensor changes back to unoccupied state. */
+        physicalContactOccupiedToUnoccupiedDelay: OptionalWritableAttribute(0x0030, TlvNullable(TlvUInt16), { default: 0 }),
+        /** delay in seconds before the sensor changes to its occupied state after detection */
+        physicalContactUnoccupiedToOccupiedDelay: OptionalWritableAttribute(0x0031, TlvNullable(TlvUInt16), { default: 0 }),
+        /** number of events in the period physicalContactToOccupiedDelay before the sensor changes to occupied */
+        physicalContactUnoccupiedToOccupiedThreshold: OptionalWritableAttribute(0x0032, TlvUInt8.bound({ min: 1, max: 254 }), { default: 1 }),
+    },
+});

package/dist/es/cluster/OnOffCluster.d.ts

@@ -0,0 +1,90 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { Attribute, Cluster, Command } from "./Cluster.js";
+/**
+ * Defined how the devices should behave when it is powered on.
+ * If the value is null, the OnOff attribute is set to its previous value when the device starts up.
+ *
+ * @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.5.1
+ */
+export declare const enum StartUpOnOff {
+    /** Set the OnOff attribute to FALSE when the device starts up. */
+    Off = 0,
+    /** Set the OnOff attribute to TRUE when the device starts up. */
+    On = 1,
+    /**
+     * If the previous value of the OnOff attribute is equal to FALSE, set the OnOff
+     * attribute to TRUE. If the previous value of the OnOff attribute is equal to TRUE,
+     * set the OnOff attribute to FALSE (toggle).
+     */
+    Toggle = 2
+}
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.4.1 */
+export declare const enum OnOffEffectIdentifier {
+    DelayedAllOff = 0,
+    DyingLight = 1
+}
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.4.2 */
+export declare const enum DelayedAllOffEffectVariant {
+    /** Fade to off in 0.8 seconds. */
+    Fade = 0,
+    /** Don't fade, turn off immediately. */
+    NoFade = 1,
+    /** 50% dim down in 0.8 seconds then fade to off in 12 seconds. */
+    DimDownThenFade = 2
+}
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.4.2 */
+export declare const enum DyingLightEffectVariant {
+    /** 20% dim up in 0.5s then fade to off in 1 second. */
+    DimUpThenFade = 0
+}
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.4.2 */
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.4 */
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.4.2 */
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5.7.6. */
+/**
+ * Attributes and commands for switching devices between 'On' and 'Off' states.
+ *
+ * @see {@link MatterApplicationClusterSpecificationV1_0} § 1.5
+ */
+export declare const OnOffCluster: Cluster<{
+    /** Level Control for Lighting - Behavior that supports lighting applications */
+    lightingLevelControl: BitFlag;
+}, {
+    onOff: Attribute<boolean>;
+    clusterRevision: Attribute<number>;
+    featureMap: Attribute<import("../schema/BitmapSchema.js").TypeFromBitSchema<{
+        /** Level Control for Lighting - Behavior that supports lighting applications */
+        lightingLevelControl: BitFlag;
+    }>>;
+    attributeList: Attribute<import("../datatype/AttributeId.js").AttributeId[]>;
+    eventList: Attribute<import("../datatype/EventId.js").EventId[]>;
+    acceptedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+    generatedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+}, {
+    /**
+     * On receipt of this command, a device SHALL enter its ‘Off’ state. This state is device dependent, but it is
+     * recommended that it is used for power off or similar functions. On receipt of the Off command, the OnTime
+     * attribute SHALL be set to 0.
+     */
+    off: Command<void, void>;
+    /**
+     * On receipt of this command, a device SHALL enter its ‘On’ state. This state is device dependent, but it is
+     * recommended that it is used for power on or similar functions. On receipt of the On command, if the value
+     * of the OnTime attribute is equal to 0, the device SHALL set the OffWaitTime attribute to 0.
+     */
+    on: Command<void, void>;
+    /**
+     * On receipt of this command, if a device is in its ‘Off’ state it SHALL enter its ‘On’ state. Otherwise,
+     * if it is in its ‘On’ state it SHALL enter its ‘Off’ state. On receipt of the Toggle command, if the value
+     * of the OnOff attribute is equal to FALSE and if the value of the OnTime attribute is equal to 0, the device
+     * SHALL set the OffWaitTime attribute to 0. If the value of the OnOff attribute is equal to TRUE, the OnTime
+     * attribute SHALL be set to 0.
+     */
+    toggle: Command<void, void>;
+}, import("./Cluster.js").Events>;
+//# sourceMappingURL=OnOffCluster.d.ts.map

package/dist/es/cluster/OnOffCluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OnOffCluster.d.ts","sourceRoot":"","sources":["../../../src/cluster/OnOffCluster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAGpD,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAiB,MAAM,cAAc,CAAC;AAG1E;;;;;GAKG;AACH,0BAAkB,YAAY;IAC1B,kEAAkE;IAClE,GAAG,IAAI;IAEP,iEAAiE;IACjE,EAAE,IAAI;IAEN;;;;OAIG;IACH,MAAM,IAAI;CACb;AAED,yEAAyE;AACzE,0BAAkB,qBAAqB;IACnC,aAAa,IAAI;IACjB,UAAU,IAAI;CACjB;AAED,yEAAyE;AACzE,0BAAkB,0BAA0B;IACxC,kCAAkC;IAClC,IAAI,IAAI;IAER,wCAAwC;IACxC,MAAM,IAAI;IAEV,kEAAkE;IAClE,eAAe,IAAI;CACtB;AAED,yEAAyE;AACzE,0BAAkB,uBAAuB;IACrC,uDAAuD;IACvD,aAAa,IAAI;CACpB;AAED,yEAAyE;AAKzE,uEAAuE;AAWvE,yEAAyE;AAOzE,wEAAwE;AASxE;;;;GAIG;AACH,eAAO,MAAM,YAAY;IAOjB,gFAAgF;;;;;;QAAhF,gFAAgF;;;;;;;;IAwChF;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;iCA2BT,CAAC"}