homey-zigbeedriver

    1.6.12 • Public • Published

    Homey ZigbeeDriver

    npm Lint NPM Deploy Documentation To GitHub Pages

    This module can be used to make the development of Zigbee apps for Homey easier.

    It is essentially a map-tool from Homey-capabilities to Zigbee endpoints and clusters.

    This module requires Homey Apps SDK v3.

    Related Modules

    Installation

    $ npm install homey-zigbeedriver

    Also checkout zigbee-clusters if you want to do more advanced things or implement a driver for a Zigbee device without homey-zigbeedriver.

    $ npm install zigbee-clusters

    Requirements

    This module requires Homey Apps SDK v3.

    Usage

    Your device should extend ZigBeeDevice. Start by looking at the docs for ZigBeeDevice. This is the class you most likely want to extend from. If you are implementing a light device take a look at ZigBeeLightDevice.

    See examples/exampleBulb.js and examples/tradfriBulb.json

    Documentation

    See https://athombv.github.io/node-homey-zigbeedriver

    Deprecations and breaking changes for homey-zigbeedriver

    This is a non exhaustive list of deprecations and breaking changes in homey-zigbeedriver with respect to homey-meshdriver which might be good to be aware of:

    • MeshDevice is removed in favour of ZigBeeDevice.
    • onMeshInit() is deprecated in favour of onNodeInit().
    • this.node.on(‘online’) is removed in favour of this.onEndDeviceAnnounce().
    • getClusterEndpoint returns null if not found.
    • cluster property is changed from string value (e.g. genOnOff) to an object which is exported by const { CLUSTER } = require(‘zigbee-clusters’);
    • registerReportListener is deprecated in favour of BoundCluster implementation.
    • registerAttrReportListener is deprecated in favour of configureAttributeReporting.
    • calculateZigbeeDimDuration renamed to calculateLevelControlTransitionTime.
    • calculateColorControlTransitionTime is added for the colorControl cluster.
    • ZigBeeXYLightDevice is removed in favour of ZigBeeLightDevice, it detects if the light supports hue and saturation or XY only.

    Keywords

    Install

    npm i homey-zigbeedriver

    DownloadsWeekly Downloads

    8

    Version

    1.6.12

    License

    ISC

    Unpacked Size

    157 kB

    Total Files

    40

    Last publish

    Collaborators

    • robinbolscher
    • weejewel
    • athombv-github-actions