Class Endpoint

Readonlyclusters

OptionaldeviceID

deviceIeeeAddress

deviceNetworkAddress

ReadonlyID

inputClusters

meta

outputClusters

OptionalprofileID

binds

• get binds(): Bind[]

  Returns Bind[]

configuredReportings

• get configuredReportings(): ConfiguredReporting[]

  Returns ConfiguredReporting[]

addBinding

• addBinding(clusterKey: string | number, target: number | Endpoint | Group): void

  Parameters

  • clusterKey: string | number
  • target: number | Endpoint | Group

  Returns void

addToGroup

• addToGroup(group: Group): Promise<void>

  Parameters

  • group: Group

  Returns Promise<void>

bind

• bind(
      clusterKey: string | number,
      target: number | Endpoint | Group,
  ): Promise<void>

  Parameters

  • clusterKey: string | number
  • target: number | Endpoint | Group

  Returns Promise<void>

command

• command<
      Cl extends string
      | number,
      Co extends string | number,
      Custom extends undefined | TCustomCluster = undefined,
  >(
      clusterKey: Cl,
      commandKey: Co,
      payload: ClusterOrRawPayload<Cl, Co, Custom>,
      options?: Options,
  ): Promise<undefined | KeyValue>

  Type Parameters

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

  Parameters

  • clusterKey: Cl
  • commandKey: Co
  • payload: ClusterOrRawPayload<Cl, Co, Custom>
  • Optionaloptions: Options

  Returns Promise<undefined | KeyValue>

commandResponse

• commandResponse<
      Cl extends string
      | number,
      Co extends string | number,
      Custom extends undefined | TCustomCluster = undefined,
  >(
      clusterKey: Cl,
      commandKey: Co,
      payload: ClusterOrRawPayload<Cl, Co, Custom>,
      options?: Options,
      transactionSequenceNumber?: number,
  ): Promise<void>

  Type Parameters

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

  Parameters

  • clusterKey: Cl
  • commandKey: Co
  • payload: ClusterOrRawPayload<Cl, Co, Custom>
  • Optionaloptions: Options
  • OptionaltransactionSequenceNumber: number

  Returns Promise<void>

configureReporting

• configureReporting<
      Cl extends string
      | number,
      Custom extends undefined | TCustomCluster = undefined,
  >(
      clusterKey: Cl,
      items: ConfigureReportingItem<Cl, Custom>[],
      options?: Options,
  ): Promise<void>

  Type Parameters

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

  Parameters

  • clusterKey: Cl
  • items: ConfigureReportingItem<Cl, Custom>[]
  • Optionaloptions: Options

  Returns Promise<void>

defaultResponse

• defaultResponse(
      commandID: number,
      status: number,
      clusterID: number,
      transactionSequenceNumber: number,
      options?: Options,
  ): Promise<void>

  Parameters

  • commandID: number
  • status: number
  • clusterID: number
  • transactionSequenceNumber: number
  • Optionaloptions: Options

  Returns Promise<void>

getBindIndex

• getBindIndex(clusterId: number, target: Endpoint | Group): number

  Parameters

  • clusterId: number
  • target: Endpoint | Group

  Returns number

getClusterAttributeValue

• getClusterAttributeValue(
      clusterKey: string | number,
      attributeKey: string | number,
  ): undefined | string | number

  Parameters

  • clusterKey: string | number
  • attributeKey: string | number

  Returns undefined | string | number

getDevice

• getDevice(): Device

  Get device of this endpoint

  Returns Device

getInputClusters

• getInputClusters(): Cluster[]

  Returns Cluster[]

getOutputClusters

• getOutputClusters(): Cluster[]

  Returns Cluster[]

hasBind

• hasBind(clusterId: number, target: Endpoint | Group): boolean

  Parameters

  • clusterId: number
  • target: Endpoint | Group

  Returns boolean

hasPendingRequests

• hasPendingRequests(): boolean

  Returns boolean

read

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

  Type Parameters

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

  Parameters

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

  Returns Promise<ClusterOrRawAttributes<Cl, Custom>>

readResponse

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

  Type Parameters

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

  Parameters

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

  Returns Promise<void>

removeFromAllGroups

• removeFromAllGroups(): Promise<void>

  Returns Promise<void>

removeFromAllGroupsDatabase

• removeFromAllGroupsDatabase(): void

  Returns void

removeFromGroup

• removeFromGroup(group: number | Group): Promise<void>

  Remove endpoint from a group, accepts both a Group and number as parameter. The number parameter type should only be used when removing from a group which is not known to zigbee-herdsman.

  Parameters

  • group: number | Group

  Returns Promise<void>

report

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

  Type Parameters

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

  Parameters

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

  Returns Promise<void>

save

• save(): void

  Returns void

saveClusterAttributeKeyValue

• saveClusterAttributeKeyValue(clusterKey: string | number, list: KeyValue): void

  Parameters

  • clusterKey: string | number
  • list: KeyValue

  Returns void

sendPendingRequests

• sendPendingRequests(fastPolling: boolean): Promise<void>

  Parameters

  • fastPolling: boolean

  Returns Promise<void>

supportsInputCluster

• supportsInputCluster(clusterKey: string | number): boolean

  Parameters

  • clusterKey: string | number

  Returns boolean

supportsOutputCluster

• supportsOutputCluster(clusterKey: string | number): boolean

  Parameters

  • clusterKey: string | number

  Returns boolean

toDatabaseRecord

• toDatabaseRecord(): KeyValue

  Returns KeyValue

unbind

• unbind(
      clusterKey: string | number,
      target: number | Endpoint | Group,
  ): Promise<void>

  Parameters

  • clusterKey: string | number
  • target: number | Endpoint | Group

  Returns Promise<void>

updateSimpleDescriptor

• updateSimpleDescriptor(): Promise<void>

  Returns Promise<void>

waitForCommand

• waitForCommand(
      clusterKey: string | number,
      commandKey: string | number,
      transactionSequenceNumber: undefined | number,
      timeout: number,
  ): {
      cancel: () => void;
      promise: Promise<{ header: ZclHeader; payload: KeyValue }>;
  }

  Parameters

  • clusterKey: string | number
  • commandKey: string | number
  • transactionSequenceNumber: undefined | number
  • timeout: number

  Returns {
      cancel: () => void;
      promise: Promise<{ header: ZclHeader; payload: KeyValue }>;
  }

write

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

  Type Parameters

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

  Parameters

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

  Returns Promise<void>

writeResponse

• writeResponse<
      Cl extends string
      | number,
      Custom extends undefined | TCustomCluster = undefined,
  >(
      clusterKey: Cl,
      transactionSequenceNumber: number,
      attributes: Partial<
          Record<
              ClusterOrRawAttributeKeys<Cl, Custom>[number],
              { attrId?: number; status: number },
          >,
      > & Record<number, { attrId?: number; status: number }>,
      options?: Options,
  ): Promise<void>

  Type Parameters

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

  Parameters

  • clusterKey: Cl
  • transactionSequenceNumber: number
  • attributes: Partial<
        Record<
            ClusterOrRawAttributeKeys<Cl, Custom>[number],
            { attrId?: number; status: number },
        >,
    > & Record<number, { attrId?: number; status: number }>
  • Optionaloptions: Options

  Returns Promise<void>

writeStructured

• writeStructured<Cl extends string | number>(
      clusterKey: Cl,
      payload: {
          attrId: number;
          dataType: number;
          elementData: unknown;
          selector: StructuredSelector;
      }[],
      options?: Options,
  ): Promise<void>

  Type Parameters

  • Cl extends string | number

  Parameters

  • clusterKey: Cl
  • payload: {
        attrId: number;
        dataType: number;
        elementData: unknown;
        selector: StructuredSelector;
    }[]

    • attrId: number

      Type: UINT16

    • dataType: number

      Type: UINT8

    • elementData: unknown

      Type: USE_DATA_TYPE

    • selector: StructuredSelector

      Type: STRUCTURED_SELECTOR

  • Optionaloptions: Options

  Returns Promise<void>

zclCommand

• zclCommand<
      Cl extends string
      | number,
      Co extends string | number,
      Custom extends undefined | TCustomCluster = undefined,
  >(
      clusterKey: Cluster | Cl,
      commandKey: Command | Co,
      payload: ClusterOrRawPayload<Cl, Co, Custom> | FoundationOrRawPayload<Co>,
      options?: Options,
      logPayload?: KeyValue,
      checkStatus?: boolean,
      frameType?: FrameType,
  ): Promise<undefined | ZclFrame>

  Type Parameters

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

  Parameters

  • clusterKey: Cluster | Cl
  • commandKey: Command | Co
  • payload: ClusterOrRawPayload<Cl, Co, Custom> | FoundationOrRawPayload<Co>
  • Optionaloptions: Options
  • OptionallogPayload: KeyValue
  • checkStatus: boolean = false
  • frameType: FrameType = Zcl.FrameType.GLOBAL

  Returns Promise<undefined | ZclFrame>

zclCommandBroadcast

• zclCommandBroadcast<
      Cl extends string
      | number,
      Co extends string | number,
      Custom extends undefined | TCustomCluster = undefined,
  >(
      endpoint: number,
      destination: BroadcastAddress,
      clusterKey: Cl,
      commandKey: Co,
      payload: ClusterOrRawPayload<Cl, Co, Custom> | FoundationOrRawPayload<Co>,
      options?: Options,
  ): Promise<void>

  Type Parameters

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

  Parameters

  • endpoint: number
  • destination: BroadcastAddress
  • clusterKey: Cl
  • commandKey: Co
  • payload: ClusterOrRawPayload<Cl, Co, Custom> | FoundationOrRawPayload<Co>
  • Optionaloptions: Options

  Returns Promise<void>

Staticcreate

• create(
      id: number,
      profileID: undefined | number,
      deviceID: undefined | number,
      inputClusters: number[],
      outputClusters: number[],
      deviceNetworkAddress: number,
      deviceIeeeAddress: string,
  ): Endpoint

  Parameters

  • id: number
  • profileID: undefined | number
  • deviceID: undefined | number
  • inputClusters: number[]
  • outputClusters: number[]
  • deviceNetworkAddress: number
  • deviceIeeeAddress: string

  Returns Endpoint

StaticfromDatabaseRecord

• fromDatabaseRecord(
      record: KeyValue,
      deviceNetworkAddress: number,
      deviceIeeeAddress: string,
  ): Endpoint

  Parameters

  • record: KeyValue
  • deviceNetworkAddress: number
  • deviceIeeeAddress: string

  Returns Endpoint