Interface Cluster

This cluster is used to trigger a Node to allow a new Administrator to commission it. It defines Attributes, Commands and Responses needed for this purpose.

There are two methods of commissioning, Basic Commissioning which may be supported and is described in Section 5.6.2, “Basic Commissioning Method (BCM)” and Enhanced Commissioning which shall be supported and is described in Section 5.6.3, “Enhanced Commissioning Method (ECM)”.

For the management of Operational Credentials and Trusted Root Certificates, the Node Operational Credentials cluster is used.

AdministratorCommissioningCluster supports optional features that you can enable with the AdministratorCommissioningCluster.with() factory method.

See

MatterSpecification.v13.Core § 11.19

interface Cluster {
    attributes: Merge<{
        adminFabricIndex: Attribute<null | FabricIndex, any>;
        adminVendorId: Attribute<null | VendorId, any>;
        windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
    }, GlobalAttributes<{
        basic: BitFlag;
    }>>;
    base: undefined;
    commands: {
        openCommissioningWindow: Command<TypeFromFields<{
            commissioningTimeout: FieldType<number>;
            discriminator: FieldType<number>;
            iterations: FieldType<number>;
            pakePasscodeVerifier: FieldType<Uint8Array>;
            salt: FieldType<Uint8Array>;
        }>, void, any>;
        revokeCommissioning: Command<void, void, any>;
    };
    events: {};
    extensions: readonly [{
        component: {
            commands: {
                openBasicCommissioningWindow: Command<TypeFromFields<{
                    commissioningTimeout: FieldType<number>;
                }>, void, any>;
            };
        };
        flags: {
            basic: true;
        };
    }];
    features: {
        basic: BitFlag;
    };
    id: Branded<60, "ClusterId">;
    name: "AdministratorCommissioning";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            adminFabricIndex: Attribute<null | FabricIndex, any>;
            adminVendorId: Attribute<null | VendorId, any>;
            windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
        };
        commands: {
            openCommissioningWindow: Command<TypeFromFields<{
                commissioningTimeout: FieldType<number>;
                discriminator: FieldType<number>;
                iterations: FieldType<number>;
                pakePasscodeVerifier: FieldType<Uint8Array>;
                salt: FieldType<Uint8Array>;
            }>, void, any>;
            revokeCommissioning: Command<void, void, any>;
        };
        extensions: readonly [{
            component: {
                commands: {
                    openBasicCommissioningWindow: Command<TypeFromFields<{
                        commissioningTimeout: FieldType<(...)>;
                    }>, void, any>;
                };
            };
            flags: {
                basic: true;
            };
        }];
        features: {
            basic: BitFlag;
        };
        id: 60;
        name: "AdministratorCommissioning";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            adminFabricIndex: Attribute<null | FabricIndex, any>;
            adminVendorId: Attribute<null | VendorId, any>;
            windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
        };
        commands: {
            openCommissioningWindow: Command<TypeFromFields<{
                commissioningTimeout: FieldType<number>;
                discriminator: FieldType<number>;
                iterations: FieldType<number>;
                pakePasscodeVerifier: FieldType<Uint8Array>;
                salt: FieldType<Uint8Array>;
            }>, void, any>;
            revokeCommissioning: Command<void, void, any>;
        };
        extensions: readonly [{
            component: {
                commands: {
                    openBasicCommissioningWindow: Command<TypeFromFields<{
                        commissioningTimeout: FieldType<(...)>;
                    }>, void, any>;
                };
            };
            flags: {
                basic: true;
            };
        }];
        features: {
            basic: BitFlag;
        };
        id: 60;
        name: "AdministratorCommissioning";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            adminFabricIndex: Attribute<null | FabricIndex, any>;
            adminVendorId: Attribute<null | VendorId, any>;
            windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
        };
        commands: {
            openCommissioningWindow: Command<TypeFromFields<{
                commissioningTimeout: FieldType<number>;
                discriminator: FieldType<number>;
                iterations: FieldType<number>;
                pakePasscodeVerifier: FieldType<Uint8Array>;
                salt: FieldType<Uint8Array>;
            }>, void, any>;
            revokeCommissioning: Command<void, void, any>;
        };
        extensions: readonly [{
            component: {
                commands: {
                    openBasicCommissioningWindow: Command<TypeFromFields<{
                        commissioningTimeout: FieldType<(...)>;
                    }>, void, any>;
                };
            };
            flags: {
                basic: true;
            };
        }];
        features: {
            basic: BitFlag;
        };
        id: 60;
        name: "AdministratorCommissioning";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            adminFabricIndex: Attribute<null | FabricIndex, any>;
            adminVendorId: Attribute<null | VendorId, any>;
            windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
        };
        commands: {
            openCommissioningWindow: Command<TypeFromFields<{
                commissioningTimeout: FieldType<number>;
                discriminator: FieldType<number>;
                iterations: FieldType<number>;
                pakePasscodeVerifier: FieldType<Uint8Array>;
                salt: FieldType<Uint8Array>;
            }>, void, any>;
            revokeCommissioning: Command<void, void, any>;
        };
        extensions: readonly [{
            component: {
                commands: {
                    openBasicCommissioningWindow: Command<TypeFromFields<{
                        commissioningTimeout: FieldType<(...)>;
                    }>, void, any>;
                };
            };
            flags: {
                basic: true;
            };
        }];
        features: {
            basic: BitFlag;
        };
        id: 60;
        name: "AdministratorCommissioning";
        revision: 1;
    }>, SelectionT>;
}

Hierarchy (view full)

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: Merge<{
    adminFabricIndex: Attribute<null | FabricIndex, any>;
    adminVendorId: Attribute<null | VendorId, any>;
    windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
}, GlobalAttributes<{
    basic: BitFlag;
}>>

Type declaration

  • ReadonlyadminFabricIndex: Attribute<null | FabricIndex, any>

    When the WindowStatus attribute is not set to WindowNotOpen, this attribute shall indicate the FabricIndex associated with the Fabric scoping of the Administrator that opened the window. This may be used to cross-reference in the Fabrics attribute of the Node Operational Credentials cluster.

    If, during an open commissioning window, the fabric for the Administrator that opened the window is removed, then this attribute shall be set to null.

    When the WindowStatus attribute is set to WindowNotOpen, this attribute shall be set to null.

    See

    MatterSpecification.v13.Core § 11.19.7.2

  • ReadonlyadminVendorId: Attribute<null | VendorId, any>

    When the WindowStatus attribute is not set to WindowNotOpen, this attribute shall indicate the Vendor ID associated with the Fabric scoping of the Administrator that opened the window. This field shall match the VendorID field of the Fabrics attribute list entry associated with the Administrator having opened the window, at the time of window opening. If the fabric for the Administrator that opened the window is removed from the node while the commissioning window is still open, this attribute shall NOT be updated.

    When the WindowStatus attribute is set to WindowNotOpen, this attribute shall be set to null.

    See

    MatterSpecification.v13.Core § 11.19.7.3

  • ReadonlywindowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>

    Indicates whether a new Commissioning window has been opened by an Administrator, using either the OCW command or the OBCW command.

    This attribute shall revert to WindowNotOpen upon expiry of a commissioning window.

    Note that an initial commissioning window is not opened using either the OCW command or the OBCW command, and therefore this attribute shall be set to WindowNotOpen on initial commissioning.

    See

    MatterSpecification.v13.Core § 11.19.7.1

base

base: undefined

commands

commands: {
    openCommissioningWindow: Command<TypeFromFields<{
        commissioningTimeout: FieldType<number>;
        discriminator: FieldType<number>;
        iterations: FieldType<number>;
        pakePasscodeVerifier: FieldType<Uint8Array>;
        salt: FieldType<Uint8Array>;
    }>, void, any>;
    revokeCommissioning: Command<void, void, any>;
}

Type declaration

  • ReadonlyopenCommissioningWindow: Command<TypeFromFields<{
        commissioningTimeout: FieldType<number>;
        discriminator: FieldType<number>;
        iterations: FieldType<number>;
        pakePasscodeVerifier: FieldType<Uint8Array>;
        salt: FieldType<Uint8Array>;
    }>, void, any>

    This command is used by a current Administrator to instruct a Node to go into commissioning mode. The Enhanced Commissioning Method specifies a window of time during which an already commissioned Node accepts PASE sessions. The current Administrator MUST specify a timeout value for the duration of OCW.

    When OCW expires or commissioning completes, the Node shall remove the Passcode by deleting the PAKE passcode verifier as well as stop publishing the DNS-SD record corresponding to this command as described in Section 4.3.1, “Commissionable Node Discovery”. The commissioning into a new Fabric completes when the Node successfully receives a CommissioningComplete command, see Section 5.5, “Commissioning Flows”.

    The parameters for OpenCommissioningWindow command are as follows:

    A current Administrator may invoke this command to put a node in commissioning mode for the next Administrator. On completion, the command shall return a cluster specific status code from the Section 11.19.6, “Status Codes” below reflecting success or reasons for failure of the operation. The new Administrator shall discover the Node on the IP network using DNS-based Service Discovery (DNS-SD) for commissioning.

    If any format or validity errors related to the PAKEPasscodeVerifier, Iterations or Salt arguments arise, this command shall fail with a cluster specific status code of PAKEParameterError.

    If a commissioning window is already currently open, this command shall fail with a cluster specific status code of Busy.

    If the fail-safe timer is currently armed, this command shall fail with a cluster specific status code of Busy, since it is likely that concurrent commissioning operations from multiple separate Commissioners are about to take place.

    In case of any other parameter error, this command shall fail with a status code of COMMAND_INVALID.

    See

    MatterSpecification.v13.Core § 11.19.8.1

  • ReadonlyrevokeCommissioning: Command<void, void, any>

    This command is used by a current Administrator to instruct a Node to revoke any active Open Commissioning Window or Open Basic Commissioning Window command. This is an idempotent command and the Node shall (for ECM) delete the temporary PAKEPasscodeVerifier and associated data, and stop publishing the DNS-SD record associated with the Open Commissioning Window or Open Basic Commissioning Window command, see Section 4.3.1, “Commissionable Node Discovery”.

    If no commissioning window was open at time of receipt, this command shall fail with a cluster specific status code of WindowNotOpen.

    If the commissioning window was open and the fail-safe was armed when this command is received, the device shall immediately expire the fail-safe and perform the cleanup steps outlined in Section 11.10.6.2.2, “Behavior on expiry of Fail-Safe timer”.

    See

    MatterSpecification.v13.Core § 11.19.8.3

events

events: {}

extensions

extensions: readonly [{
    component: {
        commands: {
            openBasicCommissioningWindow: Command<TypeFromFields<{
                commissioningTimeout: FieldType<number>;
            }>, void, any>;
        };
    };
    flags: {
        basic: true;
    };
}]

features

features: {
    basic: BitFlag;
}

Type declaration

  • Readonlybasic: BitFlag

    Basic

    Node supports Basic Commissioning Method.

id

id: Branded<60, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

  • alter<const AlterationsT>(alterations): WithAlterations<Of<{
        attributes: {
            adminFabricIndex: Attribute<null | FabricIndex, any>;
            adminVendorId: Attribute<null | VendorId, any>;
            windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
        };
        commands: {
            openCommissioningWindow: Command<TypeFromFields<{
                commissioningTimeout: FieldType<number>;
                discriminator: FieldType<number>;
                iterations: FieldType<number>;
                pakePasscodeVerifier: FieldType<Uint8Array>;
                salt: FieldType<Uint8Array>;
            }>, void, any>;
            revokeCommissioning: Command<void, void, any>;
        };
        extensions: readonly [{
            component: {
                commands: {
                    openBasicCommissioningWindow: Command<TypeFromFields<{
                        commissioningTimeout: FieldType<(...)>;
                    }>, void, any>;
                };
            };
            flags: {
                basic: true;
            };
        }];
        features: {
            basic: BitFlag;
        };
        id: 60;
        name: "AdministratorCommissioning";
        revision: 1;
    }>, AlterationsT>

  • Modify elements using ElementModifier.alter.

    Type Parameters

    • const AlterationsT extends Alterations<Of<{
          attributes: {
              adminFabricIndex: Attribute<null | FabricIndex, any>;
              adminVendorId: Attribute<null | VendorId, any>;
              windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
          };
          commands: {
              openCommissioningWindow: Command<TypeFromFields<{
                  commissioningTimeout: FieldType<number>;
                  discriminator: FieldType<number>;
                  iterations: FieldType<number>;
                  pakePasscodeVerifier: FieldType<Uint8Array>;
                  salt: FieldType<Uint8Array>;
              }>, void, any>;
              revokeCommissioning: Command<void, void, any>;
          };
          extensions: readonly [{
              component: {
                  commands: {
                      openBasicCommissioningWindow: Command<TypeFromFields<{
                          commissioningTimeout: FieldType<(...)>;
                      }>, void, any>;
                  };
              };
              flags: {
                  basic: true;
              };
          }];
          features: {
              basic: BitFlag;
          };
          id: 60;
          name: "AdministratorCommissioning";
          revision: 1;
      }>>

    Parameters

    Returns WithAlterations<Of<{
        attributes: {
            adminFabricIndex: Attribute<null | FabricIndex, any>;
            adminVendorId: Attribute<null | VendorId, any>;
            windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
        };
        commands: {
            openCommissioningWindow: Command<TypeFromFields<{
                commissioningTimeout: FieldType<number>;
                discriminator: FieldType<number>;
                iterations: FieldType<number>;
                pakePasscodeVerifier: FieldType<Uint8Array>;
                salt: FieldType<Uint8Array>;
            }>, void, any>;
            revokeCommissioning: Command<void, void, any>;
        };
        extensions: readonly [{
            component: {
                commands: {
                    openBasicCommissioningWindow: Command<TypeFromFields<{
                        commissioningTimeout: FieldType<(...)>;
                    }>, void, any>;
                };
            };
            flags: {
                basic: true;
            };
        }];
        features: {
            basic: BitFlag;
        };
        id: 60;
        name: "AdministratorCommissioning";
        revision: 1;
    }>, AlterationsT>

enable

  • enable<const FlagsT>(flags): WithFlags<Of<{
        attributes: {
            adminFabricIndex: Attribute<null | FabricIndex, any>;
            adminVendorId: Attribute<null | VendorId, any>;
            windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
        };
        commands: {
            openCommissioningWindow: Command<TypeFromFields<{
                commissioningTimeout: FieldType<number>;
                discriminator: FieldType<number>;
                iterations: FieldType<number>;
                pakePasscodeVerifier: FieldType<Uint8Array>;
                salt: FieldType<Uint8Array>;
            }>, void, any>;
            revokeCommissioning: Command<void, void, any>;
        };
        extensions: readonly [{
            component: {
                commands: {
                    openBasicCommissioningWindow: Command<TypeFromFields<{
                        commissioningTimeout: FieldType<(...)>;
                    }>, void, any>;
                };
            };
            flags: {
                basic: true;
            };
        }];
        features: {
            basic: BitFlag;
        };
        id: 60;
        name: "AdministratorCommissioning";
        revision: 1;
    }>, FlagsT>

  • Modify elements using ElementModifier.enable.

    Type Parameters

    • const FlagsT extends ElementFlags<Of<{
          attributes: {
              adminFabricIndex: Attribute<null | FabricIndex, any>;
              adminVendorId: Attribute<null | VendorId, any>;
              windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
          };
          commands: {
              openCommissioningWindow: Command<TypeFromFields<{
                  commissioningTimeout: FieldType<number>;
                  discriminator: FieldType<number>;
                  iterations: FieldType<number>;
                  pakePasscodeVerifier: FieldType<Uint8Array>;
                  salt: FieldType<Uint8Array>;
              }>, void, any>;
              revokeCommissioning: Command<void, void, any>;
          };
          extensions: readonly [{
              component: {
                  commands: {
                      openBasicCommissioningWindow: Command<TypeFromFields<{
                          commissioningTimeout: FieldType<(...)>;
                      }>, void, any>;
                  };
              };
              flags: {
                  basic: true;
              };
          }];
          features: {
              basic: BitFlag;
          };
          id: 60;
          name: "AdministratorCommissioning";
          revision: 1;
      }>>

    Parameters

    Returns WithFlags<Of<{
        attributes: {
            adminFabricIndex: Attribute<null | FabricIndex, any>;
            adminVendorId: Attribute<null | VendorId, any>;
            windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
        };
        commands: {
            openCommissioningWindow: Command<TypeFromFields<{
                commissioningTimeout: FieldType<number>;
                discriminator: FieldType<number>;
                iterations: FieldType<number>;
                pakePasscodeVerifier: FieldType<Uint8Array>;
                salt: FieldType<Uint8Array>;
            }>, void, any>;
            revokeCommissioning: Command<void, void, any>;
        };
        extensions: readonly [{
            component: {
                commands: {
                    openBasicCommissioningWindow: Command<TypeFromFields<{
                        commissioningTimeout: FieldType<(...)>;
                    }>, void, any>;
                };
            };
            flags: {
                basic: true;
            };
        }];
        features: {
            basic: BitFlag;
        };
        id: 60;
        name: "AdministratorCommissioning";
        revision: 1;
    }>, FlagsT>

set

  • set<const ValuesT>(values): WithValues<Of<{
        attributes: {
            adminFabricIndex: Attribute<null | FabricIndex, any>;
            adminVendorId: Attribute<null | VendorId, any>;
            windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
        };
        commands: {
            openCommissioningWindow: Command<TypeFromFields<{
                commissioningTimeout: FieldType<number>;
                discriminator: FieldType<number>;
                iterations: FieldType<number>;
                pakePasscodeVerifier: FieldType<Uint8Array>;
                salt: FieldType<Uint8Array>;
            }>, void, any>;
            revokeCommissioning: Command<void, void, any>;
        };
        extensions: readonly [{
            component: {
                commands: {
                    openBasicCommissioningWindow: Command<TypeFromFields<{
                        commissioningTimeout: FieldType<(...)>;
                    }>, void, any>;
                };
            };
            flags: {
                basic: true;
            };
        }];
        features: {
            basic: BitFlag;
        };
        id: 60;
        name: "AdministratorCommissioning";
        revision: 1;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {
          adminFabricIndex: null | number;
          adminVendorId: null | number;
          windowStatus: number;
      }

    Parameters

    Returns WithValues<Of<{
        attributes: {
            adminFabricIndex: Attribute<null | FabricIndex, any>;
            adminVendorId: Attribute<null | VendorId, any>;
            windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
        };
        commands: {
            openCommissioningWindow: Command<TypeFromFields<{
                commissioningTimeout: FieldType<number>;
                discriminator: FieldType<number>;
                iterations: FieldType<number>;
                pakePasscodeVerifier: FieldType<Uint8Array>;
                salt: FieldType<Uint8Array>;
            }>, void, any>;
            revokeCommissioning: Command<void, void, any>;
        };
        extensions: readonly [{
            component: {
                commands: {
                    openBasicCommissioningWindow: Command<TypeFromFields<{
                        commissioningTimeout: FieldType<(...)>;
                    }>, void, any>;
                };
            };
            flags: {
                basic: true;
            };
        }];
        features: {
            basic: BitFlag;
        };
        id: 60;
        name: "AdministratorCommissioning";
        revision: 1;
    }>, ValuesT>

with

  • with<const SelectionT>(...selection): Of<Of<{
        attributes: {
            adminFabricIndex: Attribute<null | FabricIndex, any>;
            adminVendorId: Attribute<null | VendorId, any>;
            windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
        };
        commands: {
            openCommissioningWindow: Command<TypeFromFields<{
                commissioningTimeout: FieldType<number>;
                discriminator: FieldType<number>;
                iterations: FieldType<number>;
                pakePasscodeVerifier: FieldType<Uint8Array>;
                salt: FieldType<Uint8Array>;
            }>, void, any>;
            revokeCommissioning: Command<void, void, any>;
        };
        extensions: readonly [{
            component: {
                commands: {
                    openBasicCommissioningWindow: Command<TypeFromFields<{
                        commissioningTimeout: FieldType<(...)>;
                    }>, void, any>;
                };
            };
            flags: {
                basic: true;
            };
        }];
        features: {
            basic: BitFlag;
        };
        id: 60;
        name: "AdministratorCommissioning";
        revision: 1;
    }>, SelectionT>

  • Select features using ClusterComposer.compose.

    Type Parameters

    • const SelectionT extends FeatureSelection<Of<{
          attributes: {
              adminFabricIndex: Attribute<null | FabricIndex, any>;
              adminVendorId: Attribute<null | VendorId, any>;
              windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
          };
          commands: {
              openCommissioningWindow: Command<TypeFromFields<{
                  commissioningTimeout: FieldType<number>;
                  discriminator: FieldType<number>;
                  iterations: FieldType<number>;
                  pakePasscodeVerifier: FieldType<Uint8Array>;
                  salt: FieldType<Uint8Array>;
              }>, void, any>;
              revokeCommissioning: Command<void, void, any>;
          };
          extensions: readonly [{
              component: {
                  commands: {
                      openBasicCommissioningWindow: Command<TypeFromFields<{
                          commissioningTimeout: FieldType<(...)>;
                      }>, void, any>;
                  };
              };
              flags: {
                  basic: true;
              };
          }];
          features: {
              basic: BitFlag;
          };
          id: 60;
          name: "AdministratorCommissioning";
          revision: 1;
      }>>

    Parameters

    Returns Of<Of<{
        attributes: {
            adminFabricIndex: Attribute<null | FabricIndex, any>;
            adminVendorId: Attribute<null | VendorId, any>;
            windowStatus: Attribute<AdministratorCommissioning.CommissioningWindowStatus, any>;
        };
        commands: {
            openCommissioningWindow: Command<TypeFromFields<{
                commissioningTimeout: FieldType<number>;
                discriminator: FieldType<number>;
                iterations: FieldType<number>;
                pakePasscodeVerifier: FieldType<Uint8Array>;
                salt: FieldType<Uint8Array>;
            }>, void, any>;
            revokeCommissioning: Command<void, void, any>;
        };
        extensions: readonly [{
            component: {
                commands: {
                    openBasicCommissioningWindow: Command<TypeFromFields<{
                        commissioningTimeout: FieldType<(...)>;
                    }>, void, any>;
                };
            };
            flags: {
                basic: true;
            };
        }];
        features: {
            basic: BitFlag;
        };
        id: 60;
        name: "AdministratorCommissioning";
        revision: 1;
    }>, SelectionT>

Settings

Member Visibility

On This Page

Properties
Methods