/** * @license * Copyright 2022-2026 Matter.js Authors * SPDX-License-Identifier: Apache-2.0 */ /*** THIS FILE IS GENERATED, DO NOT EDIT ***/ import { Resource } from "#models/Resource.js"; Resource.add({ tag: "cluster", name: "JointFabricAdministrator", pics: "JFADMIN", xref: "core§11.25", details: "An instance of the Joint Fabric Administrator Cluster only applies to Joint Fabric Administrator " + "nodes fulfilling the role of Anchor CA.", children: [ { tag: "attribute", name: "AdministratorFabricIndex", xref: "core§11.25.5.1", details: "The AdministratorFabricIndex attribute shall indicate the FabricIndex from the Endpoint 0's " + "Operational Cluster Fabrics attribute (i.e. the Fabric Table) which is associated with the " + "JointFabric. This field shall have the value of null if there is no fabric associated with the " + "JointFabric." }, { tag: "command", name: "IcaccsrRequest", xref: "core§11.25.6.1", details: "This command shall be generated during Joint Commissioning Method and subsequently be responded in " + "the form of an ICACCSRResponse command." }, { tag: "command", name: "IcaccsrResponse", xref: "core§11.25.6.2", details: "This command shall be generated in response to a ICACCSRRequest command." + "\n" + "Check ICAC Cross Signing for details about the generation of the ICACCSR.", children: [{ tag: "field", name: "Icaccsr", xref: "core§11.25.6.2.1", details: "This field shall be a DER-encoded octet string of a properly encoded PKCS #10 RFC2986 Certificate " + "Signing Request (CSR)." }] }, { tag: "command", name: "AddIcac", xref: "core§11.25.6.3", details: "This command shall be generated and executed during Joint Commissioning Method and subsequently be " + "responded in the form of an ICACResponse command." + "\n" + "A Commissioner or Administrator shall issue this command after issuing the ICACCSRRequest command " + "and receiving its response." + "\n" + "A Commissioner or Administrator shall issue this command after performing the Attestation Procedure, " + "Fabric Table VID Verification and after validating that the peer is authorized to act as an " + "Administrator in its own Fabric." + "\n" + "Check ICA Cross Signing for details about the generation of ICACValue.", children: [{ tag: "field", name: "IcacValue", xref: "core§11.25.6.3.1", details: "This field shall contain an ICAC encoded using Matter Certificate Encoding." }] }, { tag: "command", name: "IcacResponse", xref: "core§11.25.6.4", details: "This command shall be generated in response to the AddICAC command.", children: [{ tag: "field", name: "StatusCode", xref: "core§11.25.6.4.1", details: "This field shall contain an ICACResponseStatusEnum value representing the status of the AddICAC " + "operation." }] }, { tag: "command", name: "OpenJointCommissioningWindow", xref: "core§11.25.6.5", details: "> [!NOTE]" + "\n" + "> NOTE: This is an alias onto the OpenCommissioningWindow command within the Joint Fabric " + "Administrator Cluster. Refer to the OpenCommissioningWindow command for a description of the " + "command behavior and parameters." + "\n" + "This command shall fail with a InvalidAdministratorFabricIndex status code sent back to the " + "initiator if the AdministratorFabricIndex attribute has the value of null." + "\n" + "The parameters for OpenJointCommissioningWindow command are as follows:" }, { tag: "command", name: "TransferAnchorRequest", xref: "core§11.25.6.6", details: "This command shall be sent by a candidate Joint Fabric Anchor Administrator to the current Joint " + "Fabric Anchor Administrator to request transfer of the Anchor Fabric." }, { tag: "command", name: "TransferAnchorResponse", xref: "core§11.25.6.7", details: "This command shall be generated in response to the Transfer Anchor Request command." }, { tag: "command", name: "TransferAnchorComplete", xref: "core§11.25.6.8", details: "This command shall indicate the completion of the transfer of the Anchor Fabric to another Joint " + "Fabric Ecosystem Administrator." }, { tag: "command", name: "AnnounceJointFabricAdministrator", xref: "core§11.25.6.9", details: "This command shall be used for communicating to client the endpoint that holds the Joint Fabric " + "Administrator Cluster." + "\n" + "This field shall contain the unique identifier for the endpoint that holds the Joint Fabric " + "Administrator Cluster." }, { tag: "datatype", name: "ICACResponseStatusEnum", xref: "core§11.25.4.1", details: "This enumeration is used by the AddICAC command to convey the outcome of this cluster's operations.", children: [ { tag: "field", name: "Ok", description: "No error" }, { tag: "field", name: "InvalidPublicKey", description: "Public Key in the ICAC is invalid" }, { tag: "field", name: "InvalidIcac", description: "ICAC chain validation failed / ICAC DN Encoding rules verification failed" } ] }, { tag: "datatype", name: "TransferAnchorResponseStatusEnum", xref: "core§11.25.4.2", details: "This enumeration is used by the TransferAnchorResponse command to convey the detailed outcome of " + "this cluster's TransferAnchorRequest command.", children: [ { tag: "field", name: "Ok", description: "No error" }, { tag: "field", name: "TransferAnchorStatusDatastoreBusy", description: "Anchor Transfer was not started due to on-going Datastore operations" }, { tag: "field", name: "TransferAnchorStatusNoUserConsent", description: "User has not consented for Anchor Transfer" } ] }, { tag: "datatype", name: "ICACCSRResponseStatusCodeEnum", xref: "core§11.25.4.3", children: [ { tag: "field", name: "Ok", description: "No error" }, { tag: "field", name: "Busy", description: "Could not be completed because another commissioning is in progress" }, { tag: "field", name: "PakeParameterError", description: "Provided PAKE parameters were incorrectly formatted or otherwise invalid" }, { tag: "field", name: "WindowNotOpen", description: "The Joint Commissioning Method commissioning window is not currently open" }, { tag: "field", name: "VidNotVerified", description: "ICACCSRRequest command has been invoked by a peer against which Fabric Table VID Verification hasn't been executed" }, { tag: "field", name: "InvalidAdministratorFabricIndex", description: "OpenJointCommissioningWindow command has been invoked but the AdministratorFabricIndex field has the value of null" } ] } ] });