ZigBeeCluster

This class is a representation of a ZigBee Endpoint in Homey.

Table of Contents

Methods

bind(callbackopt) → {Promise}

Bind to this cluster.

Parameters:
Name Type Attributes Description
callback genericCallbackFunction <optional>
Returns:
Type:
Promise

do(command, attr, callbackopt) → {Promise}

Send a command to this cluster.

Parameters:
Name Type Attributes Description
command string

Cluster command id

attr Object

Values to send

callback genericCallbackFunction <optional>
Returns:
Type:
Promise

read(key, callbackopt) → {Promise}

Request to read a value of this cluster.

Parameters:
Name Type Attributes Description
key Object

Value to read

callback genericCallbackFunction <optional>
Returns:
Type:
Promise

report(attr, minInt, maxInt, repChangeopt, callbackopt) → {Promise}

Configure attribute reporting for this cluster.

Parameters:
Name Type Attributes Description
attr string

Cluster attribute that needs to be reported

minInt number

Minimum reporting interval in seconds

maxInt number

Maximum reporting interval in seconds

repChange number <optional>

The attribute should report its value when the value is changed more than this setting, for attributes with analog data type this argument is mandatory.

callback genericCallbackFunction <optional>
Returns:
Type:
Promise

write(key, value, callbackopt) → {Promise}

Request to write a value of an attribute in this cluster.

Parameters:
Name Type Attributes Description
key Object

Attribute name to write to

value Mixed

Value to write

callback genericCallbackFunction <optional>
Returns:
Type:
Promise