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(
      clusterKey: string | number,
      commandKey: string | number,
      payload: KeyValue,
      options?: Options,
  ): Promise<undefined | KeyValue>

  Parameters

  • clusterKey: string | number
  • commandKey: string | number
  • payload: KeyValue
  • Optionaloptions: Options

  Returns Promise<undefined | KeyValue>

commandResponse

• commandResponse(
      clusterKey: string | number,
      commandKey: string | number,
      payload: KeyValue,
      options?: Options,
      transactionSequenceNumber?: number,
  ): Promise<void>

  Parameters

  • clusterKey: string | number
  • commandKey: string | number
  • payload: KeyValue
  • Optionaloptions: Options
  • OptionaltransactionSequenceNumber: number

  Returns Promise<void>

configureReporting

• configureReporting(
      clusterKey: string | number,
      items: ConfigureReportingItem[],
      options?: Options,
  ): Promise<void>

  Parameters

  • clusterKey: string | number
  • items: ConfigureReportingItem[]
  • 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(
      clusterKey: string | number,
      attributes: (string | number)[],
      options?: Options,
  ): Promise<KeyValue>

  Parameters

  • clusterKey: string | number
  • attributes: (string | number)[]
  • Optionaloptions: Options

  Returns Promise<KeyValue>

readResponse

• readResponse(
      clusterKey: string | number,
      transactionSequenceNumber: number,
      attributes: KeyValue,
      options?: Options,
  ): Promise<void>

  Parameters

  • clusterKey: string | number
  • transactionSequenceNumber: number
  • attributes: KeyValue
  • 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(
      clusterKey: string | number,
      attributes: KeyValue,
      options?: Options,
  ): Promise<void>

  Parameters

  • clusterKey: string | number
  • attributes: KeyValue
  • 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(
      clusterKey: string | number,
      attributes: KeyValue,
      options?: Options,
  ): Promise<void>

  Parameters

  • clusterKey: string | number
  • attributes: KeyValue
  • Optionaloptions: Options

  Returns Promise<void>

writeResponse

• writeResponse(
      clusterKey: string | number,
      transactionSequenceNumber: number,
      attributes: KeyValue,
      options?: Options,
  ): Promise<void>

  Parameters

  • clusterKey: string | number
  • transactionSequenceNumber: number
  • attributes: KeyValue
  • Optionaloptions: Options

  Returns Promise<void>

writeStructured

• writeStructured(
      clusterKey: string | number,
      payload: KeyValue,
      options?: Options,
  ): Promise<void>

  Parameters

  • clusterKey: string | number
  • payload: KeyValue
  • Optionaloptions: Options

  Returns Promise<void>

zclCommand

• zclCommand(
      clusterKey: string | number | Cluster,
      commandKey: string | number | Command,
      payload: KeyValue,
      options?: Options,
      logPayload?: KeyValue,
      checkStatus?: boolean,
      frameType?: FrameType,
  ): Promise<undefined | ZclFrame>

  Parameters

  • clusterKey: string | number | Cluster
  • commandKey: string | number | Command
  • payload: KeyValue
  • Optionaloptions: Options
  • OptionallogPayload: KeyValue
  • checkStatus: boolean = false
  • frameType: FrameType = Zcl.FrameType.GLOBAL

  Returns Promise<undefined | ZclFrame>

zclCommandBroadcast

• zclCommandBroadcast(
      endpoint: number,
      destination: BroadcastAddress,
      clusterKey: string | number,
      commandKey: string | number,
      payload: unknown,
      options?: Options,
  ): Promise<void>

  Parameters

  • endpoint: number
  • destination: BroadcastAddress
  • clusterKey: string | number
  • commandKey: string | number
  • payload: unknown
  • 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