ZigBeeNode

This class is a representation of a Zigbee Device in Homey. This class must not be initiated directly, but retrieved by calling ManagerZigBee#getNode.

Example

// device.js
const zigBeeNode = await this.homey.zigbee.getNode(this);

Instance Properties

ieeeAddress

(readonly) ieeeAddress: string

The node's IEEE address. Note: available since Homey v12.3.0.

Type

  • string

manufacturerName

(readonly) manufacturerName: string

The node's manufacturer name.

Type

  • string

productId

(readonly) productId: string

The node's product id.

Type

  • string

Instance Methods

handleFrame

(async) handleFrame(endpointId, clusterId, frame, meta): Promise.<void>

This method is called when a frame has been received from this ZigBeeNode. This method must be overridden.

Parameters

Name Type Description
endpointId
number
clusterId
number
frame
Buffer
meta
object

Returns

Promise.<void>

sendFrame

(async) sendFrame(endpointId, clusterId, frame): Promise.<void>

Call this method to send a frame this ZigBeeNode.

Parameters

Name Type Description
endpointId
number
clusterId
number
frame
Buffer

Returns

Promise.<void>