@matter/types 0.16.0-alpha.0-20251022-5a69ce65a → 0.16.0-alpha.0-20251027-17770fb28

package/src/clusters/network-commissioning.ts

@@ -116,7 +116,7 @@ export namespace NetworkCommissioning {
         NetworkNotFound = 5,
 
         /**
-         * Cannot find AP: Mismatch on band/channels/regulato ry domain / 2.4GHz vs 5GHz
+         * Cannot find AP: Mismatch on band/channels/regulatory domain/ 2.4GHz vs 5GHz
          */
         RegulatoryError = 6,
 
@@ -287,6 +287,8 @@ export namespace NetworkCommissioning {
     export interface ThreadInterfaceScanResult extends TypeFromSchema<typeof TlvThreadInterfaceScanResult> {}
 
     /**
+     * This command is used to report the results of a ScanNetworks command.
+     *
      * This command shall contain the status of the last ScanNetworks command, and the associated scan results if the
      * operation was successful.
      *
@@ -361,6 +363,8 @@ export namespace NetworkCommissioning {
     });
 
     /**
+     * This command is used to report the results of a ScanNetworks command.
+     *
      * This command shall contain the status of the last ScanNetworks command, and the associated scan results if the
      * operation was successful.
      *
@@ -387,7 +391,7 @@ export namespace NetworkCommissioning {
         networkId: TlvField(0, TlvByteString.bound({ minLength: 1, maxLength: 32 })),
 
         /**
-         * See Breadcrumb for usage.
+         * See Section 11.9.7.1.2, “Breadcrumb Field” for usage.
          *
          * @see {@link MatterSpecification.v141.Core} § 11.9.7.6.2
          */
@@ -402,6 +406,9 @@ export namespace NetworkCommissioning {
     export interface RemoveNetworkRequest extends TypeFromSchema<typeof TlvRemoveNetworkRequest> {}
 
     /**
+     * This command is used to report the results of a network configuration command (AddOrUpdateWiFiNetwork,
+     * AddOrUpdateThreadNetwork, or RemoveNetwork).
+     *
      * This response command relates status information for some commands which require it as their response command.
      * See each individual cluster server command for the situations that may cause a NetworkingStatus different than
      * Success.
@@ -435,16 +442,15 @@ export namespace NetworkCommissioning {
         networkingStatus: TlvField(0, TlvEnum<NetworkCommissioningStatus>()),
 
         /**
-         * See DebugText for usage.
+         * See Section 11.9.7.2.2, “DebugText Field” for usage.
          *
          * @see {@link MatterSpecification.v141.Core} § 11.9.7.7.2
          */
         debugText: TlvOptionalField(1, TlvString.bound({ maxLength: 512 })),
 
         /**
-         * When the NetworkingStatus is Success, this field shall be present. It shall contain the 0-based index of the
-         * entry in the Networks attribute that was last added, updated or removed successfully by the associated
-         * request command.
+         * This field shall contain the 0-based index of the entry in the Networks attribute that was last added,
+         * updated or removed successfully by the associated request command.
          *
          * @see {@link MatterSpecification.v141.Core} § 11.9.7.7.3
          */
@@ -452,6 +458,9 @@ export namespace NetworkCommissioning {
     });
 
     /**
+     * This command is used to report the results of a network configuration command (AddOrUpdateWiFiNetwork,
+     * AddOrUpdateThreadNetwork, or RemoveNetwork).
+     *
      * This response command relates status information for some commands which require it as their response command.
      * See each individual cluster server command for the situations that may cause a NetworkingStatus different than
      * Success.
@@ -481,7 +490,7 @@ export namespace NetworkCommissioning {
         networkId: TlvField(0, TlvByteString.bound({ minLength: 1, maxLength: 32 })),
 
         /**
-         * See Breadcrumb for usage.
+         * See Section 11.9.7.1.2, “Breadcrumb Field” for usage.
          *
          * @see {@link MatterSpecification.v141.Core} § 11.9.7.8.2
          */
@@ -496,6 +505,8 @@ export namespace NetworkCommissioning {
     export interface ConnectNetworkRequest extends TypeFromSchema<typeof TlvConnectNetworkRequest> {}
 
     /**
+     * This command is used to report the results of a ConnectNetwork command.
+     *
      * Before generating a ConnectNetworkResponse, the server shall:
      *
      *   • Set the LastNetworkingStatus attribute value to the NetworkingStatus matching the response.
@@ -535,7 +546,7 @@ export namespace NetworkCommissioning {
         networkingStatus: TlvField(0, TlvEnum<NetworkCommissioningStatus>()),
 
         /**
-         * See DebugText for usage.
+         * See Section 11.9.7.2.2, “DebugText Field” for usage.
          *
          * @see {@link MatterSpecification.v141.Core} § 11.9.7.9.2
          */
@@ -567,6 +578,8 @@ export namespace NetworkCommissioning {
     });
 
     /**
+     * This command is used to report the results of a ConnectNetwork command.
+     *
      * Before generating a ConnectNetworkResponse, the server shall:
      *
      *   • Set the LastNetworkingStatus attribute value to the NetworkingStatus matching the response.
@@ -603,7 +616,7 @@ export namespace NetworkCommissioning {
         networkIndex: TlvField(1, TlvUInt8),
 
         /**
-         * See Breadcrumb for usage.
+         * See Section 11.9.7.1.2, “Breadcrumb Field” for usage.
          *
          * ### Effect when received
          *
@@ -681,7 +694,7 @@ export namespace NetworkCommissioning {
          * Credentials is the passphrase or PSK for the network (if any is needed).
          *
          * Security type, cipher and credential format (passphrase or PSK) shall be contextually auto-selected during
-         * execution of the ConnectNetwork Command and during subsequent operational state network connections, based on
+         * execution of the ConnectNetwork command and during subsequent operational state network connections, based on
          * the most secure Wi-Fi security type available within beacons and probe responses for the set of all
          * discovered BSSIDs for the configured SSID. The type of PSK or passphrase used shall be inferred based on the
          * length and contents of the Credentials field provided, matching the security type chosen.
@@ -715,7 +728,7 @@ export namespace NetworkCommissioning {
         credentials: TlvField(1, TlvByteString.bound({ maxLength: 64 })),
 
         /**
-         * See Breadcrumb for usage.
+         * See Section 11.9.7.1.2, “Breadcrumb Field” for usage.
          *
          * @see {@link MatterSpecification.v141.Core} § 11.9.7.3.3
          */
@@ -733,9 +746,7 @@ export namespace NetworkCommissioning {
      * The ThreadCapabilitiesBitmap encodes the supported Thread features and capabilities of a Thread-enabled network
      * interface.
      *
-     * > [!NOTE]
-     *
-     * > The valid combinations of capabilities are restricted and dependent on Thread version.
+     * NOTE The valid combinations of capabilities are restricted and dependent on Thread version.
      *
      * @see {@link MatterSpecification.v141.Core} § 11.9.5.2
      */
@@ -784,7 +795,7 @@ export namespace NetworkCommissioning {
         operationalDataset: TlvField(0, TlvByteString.bound({ maxLength: 254 })),
 
         /**
-         * See Breadcrumb for usage.
+         * See Section 11.9.7.1.2, “Breadcrumb Field” for usage.
          *
          * @see {@link MatterSpecification.v141.Core} § 11.9.7.4.2
          */
@@ -859,7 +870,7 @@ export namespace NetworkCommissioning {
              * Indicates the maximum duration taken, in seconds, by the network interface on this cluster server
              * instance to provide scan results.
              *
-             * See ScanNetworks for usage.
+             * See Section 11.9.7.1, “ScanNetworks Command” for usage.
              *
              * @see {@link MatterSpecification.v141.Core} § 11.9.6.3
              */
@@ -878,6 +889,9 @@ export namespace NetworkCommissioning {
 
         commands: {
             /**
+             * This command is used to scan for available networks on the network interface associated with the cluster
+             * instance.
+             *
              * This command shall scan on the Cluster instance’s associated network interface for either of:
              *
              *   • All available networks (non-directed scanning)
@@ -893,8 +907,8 @@ export namespace NetworkCommissioning {
              * SSID) is provided in the command arguments. Directed scanning shall restrict the result set to the
              * specified network only.
              *
-             * If this command is received without an armed fail-safe context (see ArmFailSafe), then this command shall
-             * fail with a FAILSAFE_REQUIRED status code sent back to the initiator.
+             * If this command is received without an armed fail-safe context (see Section 11.10.7.2, “ArmFailSafe
+             * Command”), then this command shall fail with a FAILSAFE_REQUIRED status code sent back to the initiator.
              *
              * The client shall NOT expect the server to be done scanning and have responded with ScanNetworksResponse
              * before ScanMaxTimeSeconds seconds have elapsed. Enough transport time affordances for retries SHOULD be
@@ -928,12 +942,15 @@ export namespace NetworkCommissioning {
             ),
 
             /**
+             * This command is used to remove a network configuration on the network interface associated with the
+             * cluster instance.
+             *
              * This command shall remove the network configuration from the Cluster if there was already a network
              * configuration with the same NetworkID. The relative order of the entries in the Networks attribute shall
              * remain unchanged, except for the removal of the requested network configuration.
              *
-             * If this command is received without an armed fail-safe context (see ArmFailSafe), then this command shall
-             * fail with a FAILSAFE_REQUIRED status code sent back to the initiator.
+             * If this command is received without an armed fail-safe context (see Section 11.10.7.2, “ArmFailSafe
+             * Command”), then this command shall fail with a FAILSAFE_REQUIRED status code sent back to the initiator.
              *
              * If the Networks attribute does not contain a matching entry, the command shall immediately respond with
              * NetworkConfigResponse having NetworkingStatus status field set to NetworkIdNotFound.
@@ -953,6 +970,9 @@ export namespace NetworkCommissioning {
             ),
 
             /**
+             * This command is used to connect to a network on the network interface associated with the cluster
+             * instance.
+             *
              * This command shall attempt to connect to a network whose configuration was previously added by either the
              * AddOrUpdateWiFiNetwork or AddOrUpdateThreadNetwork commands. Network is identified by its NetworkID.
              *
@@ -960,8 +980,8 @@ export namespace NetworkCommissioning {
              * unable to proceed with such an operation, such as if it is currently attempting to connect in the
              * background, or is already proceeding with a prior ConnectNetwork.
              *
-             * If this command is received without an armed fail-safe context (see ArmFailSafe), then this command shall
-             * fail with a FAILSAFE_REQUIRED status code sent back to the initiator.
+             * If this command is received without an armed fail-safe context (see Section 11.10.7.2, “ArmFailSafe
+             * Command”), then this command shall fail with a FAILSAFE_REQUIRED status code sent back to the initiator.
              *
              * Before connecting to the new network, the Node shall disconnect the operational network connections
              * managed by any other Network Commissioning cluster instances (whether under the Root Node or a Secondary
@@ -994,8 +1014,8 @@ export namespace NetworkCommissioning {
              * attribute.
              *
              * Even after successfully connecting to a network, the configuration shall revert to the prior state of
-             * configuration if the CommissioningComplete command (see CommissioningComplete) is not successfully
-             * invoked before expiry of the Fail-Safe timer.
+             * configuration if the CommissioningComplete command (see Section 11.10.7.6, “CommissioningComplete
+             * Command”) is not successfully invoked before expiry of the Fail-Safe timer.
              *
              * When non-concurrent commissioning is being used by a Commissioner or Administrator, the
              * ConnectNetworkResponse shall be sent with the NetworkingStatus field set to Success prior to closing the
@@ -1006,8 +1026,8 @@ export namespace NetworkCommissioning {
              * Node on the new operational network. Therefore, before invoking the ConnectNetwork command, the client
              * SHOULD re-invoke the Arm Fail-Safe command with a duration that meets the following:
              *
-             *   1. Sufficient time to meet the minimum required time (see ConnectMaxTimeSeconds) that may be taken by
-             *      the server to connect to the desired network.
+             *   1. Sufficient time to meet the minimum required time (see Section 11.9.6.4, “ConnectMaxTimeSeconds
+             *      Attribute”) that may be taken by the server to connect to the desired network.
              *
              *   2. Sufficient time to account for possible message-layer retries when a response is requested.
              *
@@ -1038,6 +1058,8 @@ export namespace NetworkCommissioning {
             ),
 
             /**
+             * This command is used to re-order the network configuration list.
+             *
              * This command shall set the specific order of the network configuration selected by its NetworkID in the
              * Networks attribute to match the position given by NetworkIndex.
              *
@@ -1068,10 +1090,12 @@ export namespace NetworkCommissioning {
 
         commands: {
             /**
+             * This command is used to add or update a Wi-Fi network configuration.
+             *
              * This command shall be used to add or modify Wi-Fi network configurations.
              *
-             * If this command is received without an armed fail-safe context (see ArmFailSafe), then this command shall
-             * fail with a FAILSAFE_REQUIRED status code sent back to the initiator.
+             * If this command is received without an armed fail-safe context (see Section 11.10.7.2, “ArmFailSafe
+             * Command”), then this command shall fail with a FAILSAFE_REQUIRED status code sent back to the initiator.
              *
              * The Credentials associated with the network are not readable after execution of this command, as they do
              * not appear in the Networks attribute, for security reasons.
@@ -1125,10 +1149,12 @@ export namespace NetworkCommissioning {
 
         commands: {
             /**
+             * This command is used to add or update a Thread network configuration.
+             *
              * This command shall be used to add or modify Thread network configurations.
              *
-             * If this command is received without an armed fail-safe context (see ArmFailSafe), then this command shall
-             * fail with a FAILSAFE_REQUIRED status code sent back to the initiator.
+             * If this command is received without an armed fail-safe context (see Section 11.10.7.2, “ArmFailSafe
+             * Command”), then this command shall fail with a FAILSAFE_REQUIRED status code sent back to the initiator.
              *
              * See Section 11.9.7.5, “Common processing of AddOrUpdateWiFiNetwork and AddOrUpdateThreadNetwork” for
              * behavior of addition/update.
@@ -1223,7 +1249,7 @@ export namespace NetworkCommissioning {
              * It is undefined what happens if InterfaceEnabled is written to false on the same interface as that which
              * is used to write the value. In that case, it is possible that the Administrator would have to await
              * expiry of the fail-safe, and associated recovery of network configuration to prior safe values, before
-             * being able to communicate with the node again (see ArmFailSafe).
+             * being able to communicate with the node again (see Section 11.10.7.2, “ArmFailSafe Command”).
              *
              * It may be possible to disable Ethernet interfaces but it is implementation-defined. If not supported, a
              * write to this attribute with a value of false shall fail with a status of INVALID_ACTION. When disabled,

package/src/clusters/occupancy-sensing.ts

@@ -61,7 +61,7 @@ export namespace OccupancySensing {
         /**
          * ActiveInfrared (AIR)
          *
-         * Supports sensing using Active InfraRed measurement (e.g. time-of-flight or transflective/reflec tive IR
+         * Supports sensing using Active InfraRed measurement (e.g. time-of-flight or transflective/reflective IR
          * sensing)
          */
         ActiveInfrared = "ActiveInfrared",
@@ -76,7 +76,7 @@ export namespace OccupancySensing {
         /**
          * RfSensing (RFS)
          *
-         * Supports sensing based on RF signal analysis
+         * Supports sensing using analysis of radio signals, e.g.: RSSI, CSI and/or any other metric from the signal
          */
         RfSensing = "RfSensing",
 
@@ -377,7 +377,7 @@ export namespace OccupancySensing {
             physicalContact: BitFlag(3),
 
             /**
-             * Supports sensing using Active InfraRed measurement (e.g. time-of-flight or transflective/reflec tive IR
+             * Supports sensing using Active InfraRed measurement (e.g. time-of-flight or transflective/reflective IR
              * sensing)
              */
             activeInfrared: BitFlag(4),
@@ -388,7 +388,7 @@ export namespace OccupancySensing {
             radar: BitFlag(5),
 
             /**
-             * Supports sensing based on RF signal analysis
+             * Supports sensing using analysis of radio signals, e.g.: RSSI, CSI and/or any other metric from the signal
              */
             rfSensing: BitFlag(6),
 
@@ -421,12 +421,10 @@ export namespace OccupancySensing {
             /**
              * This attribute shall specify the time delay, in seconds, before the sensor changes to its unoccupied
              * state after the last detection of occupancy in the sensed area. This is equivalent to the legacy
-             *
              * *OccupiedToUnoccupiedDelay attributes.
              *
-             * The value of HoldTime shall be within the limits provided in the HoldTimeLimits attribute, i.e.
-             * HoldTimeMin <= HoldTime <= HoldTimeMax Low values of HoldTime SHOULD be avoided since they could lead to
-             * many reporting messages. A value 0 for HoldTime shall NOT be used.
+             * Low values of HoldTime SHOULD be avoided since they could lead to many reporting messages. A value 0 for
+             * HoldTime shall NOT be used.
              *
              * The figure below illustrates this with an example of how this attribute is used for a PIR sensor. It uses
              * threshold detection to generate an "internal detection" signal, which needs post-processing to become

package/src/clusters/on-off.ts

@@ -259,7 +259,7 @@ export namespace OnOff {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.5.6.3
              */
-            globalSceneControl: Attribute(0x4000, TlvBoolean, { default: true }),
+            globalSceneControl: Attribute(0x4000, TlvBoolean),
 
             /**
              * This attribute specifies the length of time (in 1/10ths second) that the On state shall be maintained
@@ -269,7 +269,7 @@ export namespace OnOff {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.5.6.4
              */
-            onTime: WritableAttribute(0x4001, TlvUInt16, { default: 0 }),
+            onTime: WritableAttribute(0x4001, TlvUInt16),
 
             /**
              * This attribute specifies the length of time (in 1/10ths second) that the Off state shall be guarded to
@@ -281,7 +281,7 @@ export namespace OnOff {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.5.6.5
              */
-            offWaitTime: WritableAttribute(0x4002, TlvUInt16, { default: 0 }),
+            offWaitTime: WritableAttribute(0x4002, TlvUInt16),
 
             /**
              * This attribute shall define the desired startup behavior of a device when it is supplied with power and
@@ -422,7 +422,7 @@ export namespace OnOff {
              *
              * @see {@link MatterSpecification.v141.Cluster} § 1.5.6.2
              */
-            onOff: Attribute(0x0, TlvBoolean, { scene: true, persistent: true, default: false })
+            onOff: Attribute(0x0, TlvBoolean, { scene: true, persistent: true })
         },
 
         commands: {