@project-chip/matter.js 0.0.2 → 0.1.0

package/dist/dts/cluster/GeneralCommissioningCluster.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, Command, WritableAttribute } from "./Cluster.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
+/**
+ * This enumeration is used by the RegulatoryConfig and LocationCapability attributes to indicate possible radio usage.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.9.5.3
+ */
+export declare const enum RegulatoryLocationType {
+    /** Indoor only */
+    Indoor = 0,
+    /** Outdoor only */
+    Outdoor = 1,
+    /** Indoor/Outdoor */
+    IndoorOutdoor = 2
+}
+/**
+ * This enumeration is used by several response commands in this cluster to indicate particular errors.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.9.5.1
+ */
+export declare const enum CommissioningError {
+    /** No error. */
+    Ok = 0,
+    /** Attempting to set regulatory configuration to a region or indoor/outdoor mode for which the server does not have proper configuration. */
+    ValueOutsideRange = 1,
+    /** Executed CommissioningComplete outside CASE session. */
+    InvalidAuthentication = 2,
+    /** Executed CommissioningComplete when there was no active Fail-Safe context. */
+    NoFailSafe = 3,
+    /** Attempting to arm fail-safe or execute CommissioningComplete from a fabric different than the one associated with the current fail-safe context. */
+    BusyWithOtherAdmin = 4
+}
+/**
+ * Used by the following commands as response payload:
+ * ArmFailSafeResponse, @see {@link MatterCoreSpecificationV1_0} § 11.9.7.3
+ * CommissioningCompleteResponse, @see {@link MatterCoreSpecificationV1_0} § 11.9.7.7
+ * CommissioningCompleteResponse, @see {@link MatterCoreSpecificationV1_0} § 11.9.7.7
+ */
+declare const TlvCommissioningSuccessFailureResponse: import("../tlv/TlvObject.js").ObjectSchema<{
+    /** Contain the result of the operation. */
+    errorCode: import("../tlv/TlvObject.js").FieldType<CommissioningError>;
+    /** Should help developers in troubleshooting errors. The value MAY go into logs or crash reports, not User UIs. */
+    debugText: import("../tlv/TlvObject.js").FieldType<string>;
+}>;
+export type CommissioningSuccessFailureResponse = TypeFromSchema<typeof TlvCommissioningSuccessFailureResponse>;
+/**
+ * This cluster is used to manage global aspects of the Commissioning flow.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.9
+ */
+export declare const GeneralCommissioningCluster: Cluster<import("../matter.js").BitSchema, {
+    breadcrumb: WritableAttribute<number | bigint>;
+    commissioningInfo: Attribute<{
+        failSafeExpiryLengthSeconds: number;
+        maxCumulativeFailsafeSeconds: number;
+    }>;
+    regulatoryConfig: Attribute<RegulatoryLocationType>;
+    locationCapability: Attribute<RegulatoryLocationType>;
+    supportsConcurrentConnections: Attribute<boolean>;
+    clusterRevision: Attribute<number>;
+    featureMap: Attribute<import("../matter.js").TypeFromBitSchema<import("../matter.js").BitSchema>>;
+}, {
+    /** Arms the persistent fail-safe timer with an expiry time of now + ExpiryLengthSeconds using device clock. */
+    armFailSafe: Command<{
+        expiryLengthSeconds: number;
+        breadcrumbStep: number | bigint;
+    }, {
+        errorCode: CommissioningError;
+        debugText: string;
+    }>;
+    /** Sets or Updates the regulatory configuration to be used during commissioning. */
+    setRegulatoryConfig: Command<{
+        breadcrumbStep: number | bigint;
+        newRegulatoryConfig: RegulatoryLocationType;
+        countryCode: string;
+    }, {
+        errorCode: CommissioningError;
+        debugText: string;
+    }>;
+    /**
+     * Informs that all steps of Commissioning/Reconfiguration needed during the fail-safe period have been
+     * completed.
+     */
+    commissioningComplete: Command<{}, {
+        errorCode: CommissioningError;
+        debugText: string;
+    }>;
+}, import("./Cluster.js").Events>;
+export {};

package/dist/dts/cluster/GroupsCluster.d.ts

@@ -0,0 +1,92 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, Command } from "./Cluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { StatusCode } from "../protocol/InteractionProtocol.js";
+/**
+ * The Groups cluster manages, per endpoint, the content of the node-wide Group
+ * Table that is part of the underlying interaction layer.
+ *
+ * @see {@link MatterApplicationClusterSpecificationV1_0} § 1.3
+ */
+export declare const GroupsCluster: Cluster<{
+    /** The ability to store a name for a group. */
+    groupNames: BitFlag;
+}, {
+    nameSupport: Attribute<import("../schema/BitmapSchema.js").TypeFromBitSchema<{
+        groupNames: BitFlag;
+    }>>;
+    clusterRevision: Attribute<number>;
+    featureMap: Attribute<import("../schema/BitmapSchema.js").TypeFromBitSchema<{
+        /** The ability to store a name for a group. */
+        groupNames: BitFlag;
+    }>>;
+}, {
+    /**
+     * The AddGroup command allows a client to add group membership in a particular group for the server endpoint.
+     */
+    addGroup: Command<{
+        groupId: import("../common/GroupId.js").GroupId;
+        groupName: string;
+    }, {
+        status: StatusCode;
+        groupId: import("../common/GroupId.js").GroupId;
+    }>;
+    /**
+     * The ViewGroup command allows a client to request that the server responds with a ViewGroupResponse command
+     * containing the name string for a particular group.
+     *
+     */
+    viewGroup: Command<{
+        groupId: import("../common/GroupId.js").GroupId;
+    }, {
+        status: StatusCode;
+        groupId: import("../common/GroupId.js").GroupId;
+        groupName: string;
+    }>;
+    /**
+     * The GetGroupMembership command allows a client to inquire about the group membership of the server endpoint,
+     * in a number of ways.
+     */
+    getGroupMembership: Command<{
+        groupList: import("../common/GroupId.js").GroupId[];
+    }, {
+        groupList: import("../common/GroupId.js").GroupId[];
+        capacity: number | null;
+    }>;
+    /**
+     * The RemoveGroup command allows a client to request that the server removes the membership for the server
+     * endpoint, if any, in a particular group.
+     */
+    removeGroup: Command<{
+        groupId: import("../common/GroupId.js").GroupId;
+    }, {
+        status: StatusCode;
+        groupId: import("../common/GroupId.js").GroupId;
+    }>;
+    /**
+     * The RemoveAllGroups command allows a client to direct the server to remove all group associations for the
+     * server endpoint.
+     *
+     * TODO: According to specs the response might be suppressed:
+     * If the RemoveAllGroups command was received as unicast and a response is not suppressed, the server
+     * SHALL generate a response with the Status field set to SUCCESS.
+     * Else potentially no response?
+     *
+     */
+    removeAllGroups: Command<{}, {
+        status: StatusCode;
+    }>;
+    /**
+     * The AddGroupIfIdentifying command allows a client to add group membership in a particular group for the
+     * server endpoint, on condition that the endpoint is identifying itself.
+     *
+     */
+    addGroupIfIdentifying: Command<{
+        groupId: import("../common/GroupId.js").GroupId;
+        groupName: string;
+    }, void>;
+}, import("./Cluster.js").Events>;

package/dist/dts/cluster/IdentifyCluster.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, WritableAttribute, Cluster, Command, OptionalCommand } from "./Cluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.2.5.2 */
+export declare const enum IdentifyType {
+    None = 0,
+    VisibleLight = 1,
+    VisibleLED = 2,
+    AudibleBeep = 3,
+    Display = 4,
+    Actuator = 5
+}
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.2.6.3.1 */
+export declare const enum IdentifyEffectIdentifier {
+    Blink = 0,
+    Breathe = 1,
+    Okay = 2,
+    ChannelChange = 11,
+    FinishEffect = 254,
+    StopEffect = 255
+}
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.2.6.3.2 */
+export declare const enum EffectVariant {
+    Default = 0
+}
+/**
+ * Attributes and commands for putting a device into Identification mode (e.g. flashing a light).
+ *
+ * @see {@link MatterApplicationClusterSpecificationV1_0} § 1.2
+ */
+export declare const IdentifyCluster: Cluster<{
+    /** Replies to multicast / groupcast queries if the identification state is active. */
+    query: BitFlag;
+}, {
+    identifyTime: WritableAttribute<number>;
+    identifyType: Attribute<IdentifyType>;
+    clusterRevision: Attribute<number>;
+    featureMap: Attribute<import("../schema/BitmapSchema.js").TypeFromBitSchema<{
+        /** Replies to multicast / groupcast queries if the identification state is active. */
+        query: BitFlag;
+    }>>;
+}, {
+    /** Starts or stops the receiving device identifying itself. */
+    identify: Command<{
+        identifyTime: number;
+    }, void>;
+    /** Request the target or targets to respond if they are currently identifying themselves. */
+    identifyQuery: Command<{}, {
+        timeout: number;
+    }>;
+    /** Allows the support of feedback to the user, such as a certain light effect when identifying. */
+    triggerEffect: OptionalCommand<{
+        effectIdentifier: IdentifyEffectIdentifier;
+        effectVariant: EffectVariant;
+    }, void>;
+}, import("./Cluster.js").Events>;

package/dist/dts/cluster/LabelCluster.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, WritableAttribute } from "./Cluster.js";
+/**
+ * This cluster provides a feature to tag an endpoint with zero or more labels.
+ * Derived from LabelCluster ({@link MatterCoreSpecificationV1_0} § 9.7)
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.9
+ */
+export declare const UserLabelCluster: Cluster<import("../matter.js").BitSchema, {
+    labelList: WritableAttribute<{
+        value: string;
+        label: string;
+    }[]>;
+    clusterRevision: Attribute<number>;
+    featureMap: Attribute<import("../matter.js").TypeFromBitSchema<import("../matter.js").BitSchema>>;
+}, import("./Cluster.js").Commands, import("./Cluster.js").Events>;
+/**
+ * This cluster provides a feature for the device to tag an endpoint with zero or more read only labels.
+ * Derived from LabelCluster ({@link MatterCoreSpecificationV1_0} § 9.7)
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.8
+ */
+export declare const FixedLabelCluster: Cluster<import("../matter.js").BitSchema, {
+    labelList: Attribute<{
+        value: string;
+        label: string;
+    }[]>;
+    clusterRevision: Attribute<number>;
+    featureMap: Attribute<import("../matter.js").TypeFromBitSchema<import("../matter.js").BitSchema>>;
+}, import("./Cluster.js").Commands, import("./Cluster.js").Events>;

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

@@ -0,0 +1,85 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, Command } from "./Cluster.js";
+import { BitFlag } from "../schema/BitmapSchema.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;
+    }>>;
+}, {
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+}, import("./Cluster.js").Events>;

package/dist/dts/cluster/OperationalCredentialsCluster.d.ts

@@ -0,0 +1,156 @@
+/**
+ * @license
+ * Copyright 2022 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, Command } from "./Cluster.js";
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.5.1 */
+export declare const RESP_MAX = 900;
+/**
+ * Used by the CertificateChainRequest command to convey which certificate from the device attestation certificate
+ * chain to transmit back to the client.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.17.5.8 */
+export declare const enum CertificateChainType {
+    /** Request the DER- encoded DAC certificate */
+    DeviceAttestation = 1,
+    /** Request the DER- encoded PAI certificate */
+    ProductAttestationIntermediate = 2
+}
+/**
+ * Used by the NOCResponse common response command to convey detailed outcome of several of this cluster’s operations.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.17.5.9 */
+export declare const enum OperationalCertStatus {
+    /** OK, no error. */
+    Success = 0,
+    /** Public Key in the NOC does not match the public key in the NOCSR. */
+    InvalidPublicKey = 1,
+    /** The Node Operational ID in the NOC is not formatted correctly. */
+    InvalidNodeOpId = 2,
+    /** Any other validation error in NOC chain. */
+    InvalidOperationalCert = 3,
+    /** No record of prior CSR for which this NOC could match. */
+    MissingCsr = 4,
+    /** NOCs table full, cannot add another one. */
+    TableFull = 5,
+    /** Invalid CaseAdminSubject field for an AddNOC command. */
+    InvalidAdminSubject = 6,
+    /** Trying to AddNOC instead of UpdateNOC against an existing Fabric. */
+    FabricConflict = 9,
+    /** Label already exists on another Fabric. */
+    LabelConflict = 10,
+    /** FabricIndex argument is invalid. */
+    InvalidFabricIndex = 11
+}
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.5.4 */
+export declare const TlvAttestation: import("../tlv/TlvObject.js").ObjectSchema<{
+    declaration: import("../tlv/TlvObject.js").FieldType<Uint8Array>;
+    attestationNonce: import("../tlv/TlvObject.js").FieldType<Uint8Array>;
+    timestamp: import("../tlv/TlvObject.js").FieldType<number>;
+    firmwareInfo: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array>;
+}>;
+/** @see {@link MatterCoreSpecificationV1_0} § 11.17.5.6 */
+export declare const TlvCertSigningRequest: import("../tlv/TlvObject.js").ObjectSchema<{
+    certSigningRequest: import("../tlv/TlvObject.js").FieldType<Uint8Array>;
+    certSigningRequestNonce: import("../tlv/TlvObject.js").FieldType<Uint8Array>;
+    vendorReserved1: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array>;
+    vendorReserved2: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array>;
+    vendorReserved3: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array>;
+}>;
+/**
+ * This cluster is used to add or remove Operational Credentials on a Commissionee or Node, as well as manage the
+ * associated Fabrics.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.17
+ */
+export declare const OperationalCredentialsCluster: Cluster<import("../matter.js").BitSchema, {
+    nocs: Attribute<{
+        noc: Uint8Array;
+        icac: Uint8Array | null;
+    }[]>;
+    fabrics: Attribute<{
+        label: string;
+        vendorId: import("../common/VendorId.js").VendorId;
+        rootPublicKey: Uint8Array;
+        fabricID: import("../common/FabricId.js").FabricId;
+        nodeID: import("../common/NodeId.js").NodeId;
+    }[]>;
+    supportedFabrics: Attribute<number>;
+    commissionedFabrics: Attribute<number>;
+    trustedRootCertificates: Attribute<Uint8Array[]>;
+    currentFabricIndex: Attribute<number>;
+    clusterRevision: Attribute<number>;
+    featureMap: Attribute<import("../matter.js").TypeFromBitSchema<import("../matter.js").BitSchema>>;
+}, {
+    /** Sender is requesting attestation information from the receiver. */
+    requestAttestation: Command<{
+        attestationNonce: Uint8Array;
+    }, {
+        elements: Uint8Array;
+        signature: Uint8Array;
+    }>;
+    /** Sender is requesting a device attestation certificate from the receiver. */
+    requestCertChain: Command<{
+        type: CertificateChainType;
+    }, {
+        certificate: Uint8Array;
+    }>;
+    /** Sender is requesting a certificate signing request (CSR) from the receiver. */
+    requestCertSigning: Command<{
+        certSigningRequestNonce: Uint8Array;
+        isForUpdateNOC?: boolean | undefined;
+    }, {
+        elements: Uint8Array;
+        signature: Uint8Array;
+    }>;
+    /** Sender is requesting to add the new node operational certificates. */
+    addOperationalCert: Command<{
+        operationalCert: Uint8Array;
+        identityProtectionKey: Uint8Array;
+        caseAdminNode: import("../common/NodeId.js").NodeId;
+        adminVendorId: import("../common/VendorId.js").VendorId;
+        intermediateCaCert?: Uint8Array | undefined;
+    }, {
+        status: OperationalCertStatus;
+        fabricIndex?: import("../common/FabricIndex.js").FabricIndex | undefined;
+        debugText?: string | undefined;
+    }>;
+    /** Sender is requesting to update the node operational certificates. */
+    updateOperationalCert: Command<{
+        operationalCert: Uint8Array;
+        intermediateCaCert?: Uint8Array | undefined;
+    }, {
+        status: OperationalCertStatus;
+        fabricIndex?: import("../common/FabricIndex.js").FabricIndex | undefined;
+        debugText?: string | undefined;
+    }>;
+    /**
+     * This command SHALL be used by an Administrative Node to set the user-visible Label field for a given
+     * Fabric, as reflected by entries in the Fabrics attribute.
+     */
+    updateFabricLabel: Command<{
+        label: string;
+    }, {
+        status: OperationalCertStatus;
+        fabricIndex?: import("../common/FabricIndex.js").FabricIndex | undefined;
+        debugText?: string | undefined;
+    }>;
+    /**
+     * This command is used by Administrative Nodes to remove a given fabric index and delete all associated
+     * fabric-scoped data.
+     */
+    removeFabric: Command<{
+        fabricIndex: import("../common/FabricIndex.js").FabricIndex;
+    }, {
+        status: OperationalCertStatus;
+        fabricIndex?: import("../common/FabricIndex.js").FabricIndex | undefined;
+        debugText?: string | undefined;
+    }>;
+    /**
+     * This command SHALL add a Trusted Root CA Certificate, provided as its CHIP Certificate representation.
+     */
+    addRootCert: Command<{
+        certificate: Uint8Array;
+    }, void>;
+}, import("./Cluster.js").Events>;