/** * @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: "Groups", pics: "G", xref: "cluster§1.3", details: "> [!NOTE]" + "\n" + "> NOTE: Starting with the release of Matter when the Groupcast Cluster becomes certifiable, that " + "cluster supersedes this Groups Cluster. Groups created on devices prior to that Matter release " + "remain operational via the PerGroup feature in the Groupcast Cluster. All new group management " + "operations SHOULD be performed through the Groupcast Cluster. Device types with existing mandatory " + "conformance to the Groups Cluster shall retain Groups server cluster support for backward " + "compatibility." + "\n" + "The Groups cluster manages, per endpoint, the content of the node-wide Group Table that is part of " + "the underlying interaction layer." + "\n" + "In a network supporting fabrics, group IDs referenced by attributes or other elements of this " + "cluster are scoped to the accessing fabric." + "\n" + "The Groups cluster is scoped to the endpoint. Groups cluster commands support discovering the " + "endpoint membership in a group, adding the endpoint to a group, removing the endpoint from a group, " + "removing endpoint membership from all groups. All commands defined in this cluster shall only affect " + "groups scoped to the accessing fabric." + "\n" + "When group names are supported, the server stores a name string, which is set by the client for each " + "assigned group and indicated in response to a client request." + "\n" + "Note that configuration of group addresses for outgoing commands is achieved using the Message Layer " + "mechanisms where the Group Table is not involved. Hence this cluster does not play a part in that.", children: [ { tag: "attribute", name: "FeatureMap", xref: "cluster§1.3.4", children: [{ tag: "field", name: "GN", xref: "cluster§1.3.4.1", details: "The Group Names feature indicates the ability to store a name for a group when a group is added." }] }, { tag: "attribute", name: "NameSupport", xref: "cluster§1.3.6.1", details: "This attribute provides legacy, read-only access to whether the Group Names feature is supported. " + "The most significant bit, bit 7 (GroupNames), shall be equal to bit 0 of the FeatureMap attribute " + "(GN Feature). All other bits shall be 0." }, { tag: "command", name: "AddGroup", xref: "cluster§1.3.7.1", details: "The AddGroup command allows a client to add group membership in a particular group for the server " + "endpoint.", children: [ { tag: "field", name: "GroupId", xref: "cluster§1.3.7.1.1", details: "This field shall be used to identify the group and any associated key material to which the server " + "endpoint is to be added." }, { tag: "field", name: "GroupName", xref: "cluster§1.3.7.1.2", details: "This field may be set to a human-readable name for the group. If the client has no name for the " + "group, the GroupName field shall be set to the empty string." + "\n" + "Support of group names is optional and is indicated by the FeatureMap and NameSupport attribute." } ] }, { tag: "command", name: "ViewGroup", xref: "cluster§1.3.7.2", details: "The ViewGroup command allows a client to request that the server responds with a ViewGroupResponse " + "command containing the name string for a particular group." }, { tag: "command", name: "GetGroupMembership", xref: "cluster§1.3.7.3", details: "The GetGroupMembership command allows a client to inquire about the group membership of the server " + "endpoint, in a number of ways." }, { tag: "command", name: "RemoveGroup", xref: "cluster§1.3.7.4", details: "The RemoveGroup command allows a client to request that the server removes the membership for the " + "server endpoint, if any, in a particular group." }, { tag: "command", name: "RemoveAllGroups", xref: "cluster§1.3.7.5", details: "The RemoveAllGroups command allows a client to direct the server to remove all group associations " + "for the server endpoint." }, { tag: "command", name: "AddGroupIfIdentifying", xref: "cluster§1.3.7.6", details: "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. Identifying functionality " + "is controlled using the Identify cluster, (see Identify Cluster)." + "\n" + "For correct operation of the AddGroupIfIdentifying command, any endpoint that supports the Groups " + "server cluster shall also support the Identify server cluster." + "\n" + "This command might be used to assist configuring group membership in the absence of a commissioning " + "tool.", children: [ { tag: "field", name: "GroupId", xref: "cluster§1.3.7.6.1", details: "This field shall be used to identify the group and any associated key material to which the server " + "endpoint is to be added." }, { tag: "field", name: "GroupName", xref: "cluster§1.3.7.6.2", details: "This field may be set to a human-readable name for the group. If the client has no name for the " + "group, the GroupName field shall be set to the empty string." + "\n" + "Support of group names is optional and is indicated by the FeatureMap and NameSupport attribute." } ] }, { tag: "command", name: "AddGroupResponse", xref: "cluster§1.3.7.7", details: "The AddGroupResponse is sent by the Groups cluster server in response to an AddGroup command.", children: [ { tag: "field", name: "Status", xref: "cluster§1.3.7.7.1", details: "This field is set according to the Effect on Receipt section of the AddGroup command." }, { tag: "field", name: "GroupId", xref: "cluster§1.3.7.7.2", details: "This field is set to the GroupID field of the received AddGroup command." } ] }, { tag: "command", name: "ViewGroupResponse", xref: "cluster§1.3.7.8", details: "The ViewGroupResponse command is sent by the Groups cluster server in response to a ViewGroup " + "command.", children: [ { tag: "field", name: "Status", xref: "cluster§1.3.7.8.1", details: "This field is according to the Effect on Receipt section of the ViewGroup command." }, { tag: "field", name: "GroupId", xref: "cluster§1.3.7.8.2", details: "This field is set to the GroupID field of the received ViewGroup command." }, { tag: "field", name: "GroupName", xref: "cluster§1.3.7.8.3", details: "If the status is SUCCESS, and group names are supported, this field is set to the group name " + "associated with that group in the Group Table; otherwise it is set to the empty string." } ] }, { tag: "command", name: "GetGroupMembershipResponse", xref: "cluster§1.3.7.9", details: "The GetGroupMembershipResponse command is sent by the Groups cluster server in response to a " + "GetGroupMembership command.", children: [ { tag: "field", name: "Capacity", xref: "cluster§1.3.7.9.1", details: "This field shall contain the remaining capacity of the Group Table of the node. The following values " + "apply:" + "\n" + " - 0 - No further groups may be added." + "\n" + " - 0 < Capacity < 0xFE - Capacity holds the number of groups that may be added." + "\n" + " - 0xFE - At least 1 further group may be added (exact number is unknown)." + "\n" + " - null - It is unknown if any further groups may be added." }, { tag: "field", name: "GroupList", xref: "cluster§1.3.7.9.2", details: "The GroupList field shall contain either the group IDs of all the groups in the Group Table for " + "which the server endpoint is a member of the group (in the case where the GroupList field of the " + "received GetGroupMembership command was empty), or the group IDs of all the groups in the Group " + "Table for which the server endpoint is a member of the group and for which the group ID was included " + "in the the GroupList field of the received GetGroupMembership command (in the case where the " + "GroupList field of the received GetGroupMembership command was not empty). Zigbee: If the total " + "number of groups will cause the maximum payload length of a frame to be exceeded, then the GroupList " + "field shall contain only as many groups as will fit." } ] }, { tag: "command", name: "RemoveGroupResponse", xref: "cluster§1.3.7.10", details: "The RemoveGroupResponse command is generated by the server in response to the receipt of a " + "RemoveGroup command.", children: [ { tag: "field", name: "Status", xref: "cluster§1.3.7.10.1", details: "This field is according to the Effect on Receipt section of the RemoveGroup command." }, { tag: "field", name: "GroupId", xref: "cluster§1.3.7.10.2", details: "This field is set to the GroupID field of the received RemoveGroup command." } ] }, { tag: "datatype", name: "NameSupportBitmap", xref: "cluster§1.3.5.1", children: [{ tag: "field", name: "GroupNames", description: "The ability to store a name for a group." }] } ] });