Class default

Readonlyclusters

OptionaldeviceID

deviceIeeeAddress

deviceNetworkAddress

ReadonlyID

inputClusters

meta

outputClusters

OptionalprofileID

binds

• get binds(): Bind[]

• Returns Bind[]

configuredReportings

• get configuredReportings(): ConfiguredReporting[]

• Returns ConfiguredReporting[]

addBinding

• addBinding(clusterKey, target): void

• Parameters

  • clusterKey: string | number
  • target: number | default | default

  Returns void

addToGroup

• addToGroup(group): Promise<void>

• Parameters

  • group: default

  Returns Promise<void>

bind

• bind(clusterKey, target): Promise<void>

• Parameters

  • clusterKey: string | number
  • target: number | default | default

  Returns Promise<void>

command

• command(clusterKey, commandKey, payload, options?): Promise<void | KeyValue>

• Parameters

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

  Returns Promise<void | KeyValue>

commandResponse

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

• Parameters

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

  Returns Promise<void | KeyValue>

configureReporting

• configureReporting(clusterKey, items, options?): Promise<void>

• Parameters

  • clusterKey: string | number
  • items: ConfigureReportingItem[]
  • Optionaloptions: Options

  Returns Promise<void>

defaultResponse

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

• Parameters

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

  Returns Promise<void>

getBindIndex

• getBindIndex(clusterId, target): number

• Parameters

  • clusterId: number
  • target: default | default

  Returns number

getClusterAttributeValue

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

• Parameters

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

  Returns undefined | string | number

getDevice

• getDevice(): default

• Get device of this endpoint

  Returns default

getInputClusters

• getInputClusters(): Cluster[]

• Returns Cluster[]

getOutputClusters

• getOutputClusters(): Cluster[]

• Returns Cluster[]

hasBind

• hasBind(clusterId, target): boolean

• Parameters

  • clusterId: number
  • target: default | default

  Returns boolean

hasPendingRequests

• hasPendingRequests(): boolean

• Returns boolean

read

• read(clusterKey, attributes, options?): Promise<KeyValue>

• Parameters

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

  Returns Promise<KeyValue>

readResponse

• readResponse(clusterKey, transactionSequenceNumber, attributes, 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): 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 | default

  Returns Promise<void>

report

• report(clusterKey, attributes, options?): Promise<void>

• Parameters

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

  Returns Promise<void>

save

• save(): void

• Returns void

saveClusterAttributeKeyValue

• saveClusterAttributeKeyValue(clusterKey, list): void

• Parameters

  • clusterKey: string | number
  • list: KeyValue

  Returns void

sendPendingRequests

• sendPendingRequests(fastPolling): Promise<void>

• Parameters

  • fastPolling: boolean

  Returns Promise<void>

supportsInputCluster

• supportsInputCluster(clusterKey): boolean

• Parameters

  • clusterKey: string | number

  Returns boolean

supportsOutputCluster

• supportsOutputCluster(clusterKey): boolean

• Parameters

  • clusterKey: string | number

  Returns boolean

toDatabaseRecord

• toDatabaseRecord(): KeyValue

• Returns KeyValue

unbind

• unbind(clusterKey, target): Promise<void>

• Parameters

  • clusterKey: string | number
  • target: number | default | default

  Returns Promise<void>

updateSimpleDescriptor

• updateSimpleDescriptor(): Promise<void>

• Returns Promise<void>

waitForCommand

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

• Parameters

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

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

  • cancel: (() => void)

    • • (): void

      • Returns void

  • promise: Promise<{
        header: ZclHeader;
        payload: KeyValue;
    }>

write

• write(clusterKey, attributes, options?): Promise<void>

• Parameters

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

  Returns Promise<void>

writeResponse

• writeResponse(clusterKey, transactionSequenceNumber, attributes, options?): Promise<void>

• Parameters

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

  Returns Promise<void>

writeStructured

• writeStructured(clusterKey, payload, options?): Promise<void>

• Parameters

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

  Returns Promise<void>

zclCommand

• zclCommand(clusterKey, commandKey, payload, options?, logPayload?, checkStatus?, frameType?): Promise<void | ZclFrame>

• Parameters

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

  Returns Promise<void | ZclFrame>

zclCommandBroadcast

• zclCommandBroadcast(endpoint, destination, clusterKey, commandKey, payload, options?): Promise<void>

• Parameters

  • endpoint: number
  • destination: BroadcastAddress
  • clusterKey: string | number
  • commandKey: string | number
  • payload: unknown
  • Optionaloptions: Options

  Returns Promise<void>

Staticcreate

• create(ID, profileID, deviceID, inputClusters, outputClusters, deviceNetworkAddress, deviceIeeeAddress): default

• Parameters

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

  Returns default

StaticfromDatabaseRecord

• fromDatabaseRecord(record, deviceNetworkAddress, deviceIeeeAddress): default

• Parameters

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

  Returns default