Interface State

interface State {
    groupKeyMap: TypeFromFields<{
        fabricIndex: FieldType<FabricIndex>;
        groupId: FieldType<GroupId>;
        groupKeySetId: FieldType<number>;
    }>[];
    groupTable: TypeFromFields<{
        endpoints: FieldType<EndpointNumber[]>;
        fabricIndex: FieldType<FabricIndex>;
        groupId: FieldType<GroupId>;
        groupName: OptionalFieldType<string>;
    }>[];
    maxGroupKeysPerFabric: number;
    maxGroupsPerFabric: number;
}

Hierarchy

  • StateType
    • State

Properties

groupKeyMap groupTable maxGroupKeysPerFabric maxGroupsPerFabric

Properties

ReadonlygroupKeyMap

groupKeyMap: TypeFromFields<{
    fabricIndex: FieldType<FabricIndex>;
    groupId: FieldType<GroupId>;
    groupKeySetId: FieldType<number>;
}>[]

This attribute is a list of GroupKeyMapStruct entries. Each entry associates a logical Group Id with a particular group key set.

See

MatterSpecification.v13.Core § 11.2.6.1

ReadonlygroupTable

groupTable: TypeFromFields<{
    endpoints: FieldType<EndpointNumber[]>;
    fabricIndex: FieldType<FabricIndex>;
    groupId: FieldType<GroupId>;
    groupName: OptionalFieldType<string>;
}>[]

This attribute is a list of GroupInfoMapStruct entries. Each entry provides read-only information about how a given logical Group ID maps to a particular set of endpoints, and a name for the group. The content of this attribute reflects data managed via the Groups cluster (see AppClusters), and is in general terms referred to as the 'node-wide Group Table'.

The GroupTable shall NOT contain any entry whose GroupInfoMapStruct has an empty Endpoints list. If a RemoveGroup or RemoveAllGroups command causes the removal of a group mapping from its last mapped endpoint, the entire GroupTable entry for that given GroupId shall be removed.

See

MatterSpecification.v13.Core § 11.2.6.2

ReadonlymaxGroupKeysPerFabric

maxGroupKeysPerFabric: number

Indicates the maximum number of group key sets this node supports per fabric. The value of this attribute shall be set according to the minimum number of group key sets to support as specified in Group Limits.

See

MatterSpecification.v13.Core § 11.2.6.4

ReadonlymaxGroupsPerFabric

maxGroupsPerFabric: number

Indicates the maximum number of groups that this node supports per fabric. The value of this attribute shall be set to be no less than the required minimum supported groups as specified in Group Limits. The length of the GroupKeyMap and GroupTable list attributes shall NOT exceed the value of the MaxGroupsPerFabric attribute multiplied by the number of supported fabrics.

See

MatterSpecification.v13.Core § 11.2.6.3

Settings

Member Visibility

On This Page

Properties