zigbee-herdsman
    Preparing search index...

    Hierarchy (View Summary)

    Index

    Properties

    clusters: Clusters
    deviceID?: number
    deviceIeeeAddress: string
    deviceNetworkAddress: number
    ID: number
    inputClusters: number[]
    meta: KeyValue
    outputClusters: number[]
    profileID?: number

    Accessors

    Methods

    • Parameters

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

      Returns Promise<void | KeyValue>

    • Parameters

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

      Returns Promise<void | KeyValue>

    • Parameters

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

      Returns Promise<void>

    • Parameters

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

      Returns undefined | string | number

    • Parameters

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

      Returns Promise<KeyValue>

    • Parameters

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

      Returns 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

      Returns Promise<void>

    • Parameters

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

      Returns Promise<void>

    • Parameters

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

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

    • Parameters

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

      Returns Promise<void>

    • Parameters

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

      Returns Promise<void>

    • Parameters

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

      Returns Promise<void>

    • 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>

    • Parameters

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

      Returns Promise<void>

    • Parameters

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

      Returns Endpoint