README.md

zigbee-shepherd

An open source ZigBee gateway solution with node.js

Documentation

Please visit the Wiki.

Overview

zigbee-shepherd is an open source ZigBee gateway solution with node.js. It uses TI's CC253X wireless SoC as a zigbee network processor (ZNP), and takes the ZNP approach with cc-znp to run the CC253X as a coordinator and to run zigbee-shepherd as the host.

• A simple demo webapp

Installation

• Install zigbee-shepherd

$ npm install zigbee-shepherd --save

• Hardware

  • SmartRF05EB (with CC2530EM)
  • CC2531 USB Stick
  • CC2538 (Not tested yet. I don't have the kit.)
  • CC2630/CC2650 (Not tested yet. I don't have the kit.)

• Firmware

  • To use CC2530/31 as the coordinator, please download the pre-built ZNP image to your chip first. The pre-built image has been compiled as a ZNP with ZDO callback, ZCL supports, and functions we need.

Usage

var ZShepherd = require('zigbee-shepherd');
var shepherd = new ZShepherd('/dev/ttyUSB0');  // create a ZigBee server

shepherd.on('ready', function () {
    console.log('Server is ready.');

    // allow devices to join the network within 60 secs
    shepherd.permitJoin(60, function (err) {
        if (err)
            console.log(err);
    }); 
});

shepherd.start(function (err) {                // start the server
    if (err)
        console.log(err);
});

License

Licensed under MIT.