Class Group

ReadonlygroupID

Readonlymeta

customClusters

• get customClusters(): [input: CustomClusters, output: CustomClusters]

  List of server / client custom clusters common to all devices in the group

  Returns [input: CustomClusters, output: CustomClusters]

members

• get members(): Endpoint[]

  Member endpoints with valid devices (not unknown/deleted)

  Returns Endpoint[]

addMember

• addMember(endpoint: Endpoint): void

  Parameters

  • endpoint: Endpoint

  Returns void

command

• command<
      Cl extends string
      | number,
      Co extends string | number,
      Custom extends TCustomCluster | undefined = undefined,
  >(
      clusterKey:
          | Readonly<
              {
                  attributes: Readonly<Record<string, Attribute>>;
                  commands: Readonly<Record<string, Command>>;
                  commandsResponse: Readonly<Record<string, Command>>;
                  ID: number;
                  manufacturerCode?: number;
                  name: string;
              },
          >
          | Cl,
      commandKey: Co,
      payload: ClusterOrRawPayload<Cl, Co, Custom>,
      options?: Options,
  ): Promise<undefined>

  Send a cluster-specific command to the group. Pass a Cluster object to use a custom cluster that not every member has registered; supply explicit type arguments for payload checking.

  Type Parameters

  • Cl extends string | number
  • Co extends string | number
  • Custom extends TCustomCluster | undefined = undefined

  Parameters

  • clusterKey:
        | Readonly<
            {
                attributes: Readonly<Record<string, Attribute>>;
                commands: Readonly<Record<string, Command>>;
                commandsResponse: Readonly<Record<string, Command>>;
                ID: number;
                manufacturerCode?: number;
                name: string;
            },
        >
        | Cl
  • commandKey: Co
  • payload: ClusterOrRawPayload<Cl, Co, Custom>
  • Optionaloptions: Options

  Returns Promise<undefined>

hasMember

• hasMember(endpoint: Endpoint): boolean

  Parameters

  • endpoint: Endpoint

  Returns boolean

read

• read<
      Cl extends string
      | number,
      Custom extends TCustomCluster | undefined = undefined,
  >(
      clusterKey: Cl,
      attributes: ClusterOrRawAttributeKeys<Cl, Custom>,
      options?: Options,
  ): Promise<undefined>

  Type Parameters

  • Cl extends string | number
  • Custom extends TCustomCluster | undefined = undefined

  Parameters

  • clusterKey: Cl
  • attributes: ClusterOrRawAttributeKeys<Cl, Custom>
  • Optionaloptions: Options

  Returns Promise<undefined>

removeFromDatabase

• removeFromDatabase(): void

  Returns void

removeFromNetwork

• removeFromNetwork(): Promise<void>

  Returns Promise<void>

removeMember

• removeMember(endpoint: Endpoint): void

  Parameters

  • endpoint: Endpoint

  Returns void

save

• save(writeDatabase?: boolean): void

  Parameters

  • writeDatabase: boolean = true

  Returns void

write

• write<
      Cl extends string
      | number,
      Custom extends TCustomCluster | undefined = undefined,
  >(
      clusterKey: Cl,
      attributes: PartialClusterOrRawWriteAttributes<Cl, Custom>,
      options?: Options,
  ): Promise<void>

  Type Parameters

  • Cl extends string | number
  • Custom extends TCustomCluster | undefined = undefined

  Parameters

  • clusterKey: Cl
  • attributes: PartialClusterOrRawWriteAttributes<Cl, Custom>
  • Optionaloptions: Options

  Returns Promise<void>

Staticall

• all(): Group[]

  Returns Group[]

  Deprecated

  use allIterator()

StaticallIterator

• allIterator(predicate?: (value: Group) => boolean): Generator<Group>

  Parameters

  • Optionalpredicate: (value: Group) => boolean

  Returns Generator<Group>

StaticbyGroupID

• byGroupID(groupID: number): Group | undefined

  Parameters

  • groupID: number

  Returns Group | undefined

Staticcreate

• create(groupID: number): Group

  Parameters

  • groupID: number

  Returns Group

StaticresetCache

• resetCache(): void

  Reset runtime lookups.

  Returns void