Variable ClusterInstanceConst

Type declaration

• Readonlyattributes: {
      nameSupport: FixedAttribute<TypeFromPartialBitSchema<{
          nameSupport: BitFlag;
      }>, any>;
  }

  • ReadonlynameSupport: FixedAttribute<TypeFromPartialBitSchema<{
        nameSupport: BitFlag;
    }>, any>

    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.

    See

    MatterSpecification.v13.Cluster § 1.3.6.1

• Readonlycommands: {
      addGroup: Command<TypeFromFields<{
          groupId: FieldType<GroupId>;
          groupName: FieldType<string>;
      }>, TypeFromFields<{
          groupId: FieldType<GroupId>;
          status: FieldType<Status>;
      }>, any>;
      addGroupIfIdentifying: Command<TypeFromFields<{
          groupId: FieldType<GroupId>;
          groupName: FieldType<string>;
      }>, void, any>;
      getGroupMembership: Command<TypeFromFields<{
          groupList: FieldType<GroupId[]>;
      }>, TypeFromFields<{
          capacity: FieldType<null | number>;
          groupList: FieldType<GroupId[]>;
      }>, any>;
      removeAllGroups: Command<void, void, any>;
      removeGroup: Command<TypeFromFields<{
          groupId: FieldType<GroupId>;
      }>, TypeFromFields<{
          groupId: FieldType<GroupId>;
          status: FieldType<Status>;
      }>, any>;
      viewGroup: Command<TypeFromFields<{
          groupId: FieldType<GroupId>;
      }>, TypeFromFields<{
          groupId: FieldType<GroupId>;
          groupName: FieldType<string>;
          status: FieldType<Status>;
      }>, any>;
  }

  • ReadonlyaddGroup: Command<TypeFromFields<{
        groupId: FieldType<GroupId>;
        groupName: FieldType<string>;
    }>, TypeFromFields<{
        groupId: FieldType<GroupId>;
        status: FieldType<Status>;
    }>, any>

    The AddGroup command allows a client to add group membership in a particular group for the server endpoint.

    See

    MatterSpecification.v13.Cluster § 1.3.7.1

  • ReadonlyaddGroupIfIdentifying: Command<TypeFromFields<{
        groupId: FieldType<GroupId>;
        groupName: FieldType<string>;
    }>, void, any>

    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).

    For correct operation of the AddGroupIfIdentifying command, any endpoint that supports the Groups server cluster shall also support the Identify server cluster.

    This command might be used to assist configuring group membership in the absence of a commissioning tool.

    See

    MatterSpecification.v13.Cluster § 1.3.7.6

  • ReadonlygetGroupMembership: Command<TypeFromFields<{
        groupList: FieldType<GroupId[]>;
    }>, TypeFromFields<{
        capacity: FieldType<null | number>;
        groupList: FieldType<GroupId[]>;
    }>, any>

    The GetGroupMembership command allows a client to inquire about the group membership of the server endpoint, in a number of ways.

    See

    MatterSpecification.v13.Cluster § 1.3.7.3

  • ReadonlyremoveAllGroups: Command<void, void, any>

    The RemoveAllGroups command allows a client to direct the server to remove all group associations for the server endpoint.

    See

    MatterSpecification.v13.Cluster § 1.3.7.5

  • ReadonlyremoveGroup: Command<TypeFromFields<{
        groupId: FieldType<GroupId>;
    }>, TypeFromFields<{
        groupId: FieldType<GroupId>;
        status: FieldType<Status>;
    }>, any>

    The RemoveGroup command allows a client to request that the server removes the membership for the server endpoint, if any, in a particular group.

    See

    MatterSpecification.v13.Cluster § 1.3.7.4

  • ReadonlyviewGroup: Command<TypeFromFields<{
        groupId: FieldType<GroupId>;
    }>, TypeFromFields<{
        groupId: FieldType<GroupId>;
        groupName: FieldType<string>;
        status: FieldType<Status>;
    }>, any>

    The ViewGroup command allows a client to request that the server responds with a ViewGroupResponse command containing the name string for a particular group.

    See

    MatterSpecification.v13.Cluster § 1.3.7.2

• Readonlyextensions: readonly []

  This metadata controls which GroupsCluster elements matter.js activates for specific feature combinations.

• Readonlyfeatures: {
      groupNames: BitFlag;
  }

  • ReadonlygroupNames: BitFlag

    GroupNames

    The Group Names feature indicates the ability to store a name for a group when a group is added.

    See

    MatterSpecification.v13.Cluster § 1.3.4.1

• Readonlyid: 4

• Readonlyname: "Groups"

• Readonlyrevision: 4

• ReadonlysupportedFeatures: {
      groupNames: true;
  }

  • ReadonlygroupNames: true