ZigBeeNode

Table of Contents

new Homey.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.

Properties:
Name Type Description
manufacturerName string
productId string
receiveWhenIdle boolean

Reflects whether ZigBeeNode can receive commands while idle. If this property is false the ZigBeeNode is a Sleepy End Device (SED, check the Zigbee Cluster Specification (PDF) for more information). In that case it can not be assumed that the device will timely respond to commands and or requests, it will only be 'awake' for a short amount of time on an unknown interval.

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

Methods

(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:
Type:
Promise.<void>

(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:
Type:
Promise.<void>

Table of Contents

Methods

(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:
Type:
Promise.<void>

(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:
Type:
Promise.<void>