Changes made to allow Zigbee protocol over XBee

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+*.swp
+.npmignore
+npm-debug.log
+/.project

README.md

@@ -0,0 +1,70 @@
+## NOTE!
+Check out [xbee-api](http://github.com/jouz/xbee-api). It separates out the API component and is aimed at being a more solid and tested module for working with XBees. New higher level modules based on [xbee-api](http://github.com/jouz/xbee-api) are in development here: [xbee-stream](http://github.com/jouz/xbee-stream) and here [xbee-nodes](http://github.com/jouz/xbee-nodes).
+
+# SVD-XBEE
+
+[Digi's xbee modules](http://www.digi.com/xbee) are good for quickly building low power wireless networks. They can be used to send/receive text data from serial ports of different devices. XBees can also be used alone for their on board digital and analog I/O capabilities.
+
+**svd-xbee** is a high level, actively maintained fork of Richard Morrison's [node-xbee](http://github.com/mozz100/node-xbee). It talks the ZigBee API with XBee radio modules over serial connections and provides high level abstractions of the XBee's functionality.
+
+### Nutshell
+```javascript
+var XBee = require('svd-xbee');
+
+var xbee = new XBee({
+  port: 'COM3',   // replace with yours
+  baudrate: 9600 // 9600 is default
+}).init();
+
+var robot = xbee.addNode([0x00,0x13,0xa2,0x00,0x40,0x61,0xaa,0xe2]);
+
+var robot.on("data", function(data) {
+    console.log("robot>", data);
+    if (data == "ping") robot.send("pong");
+});
+```
+### Features
+
+- Asynchronous architecture
+- Event-based Node Discovery
+- Local and remote AT commands
+- High-level abstraction of common tasks
+- Parse API frames into meaningful objects
+    - Regular text data
+    - Analog & Digital I/O Samples
+    - Modem Status
+    - Transmission Reports
+
+### Installation
+
+    npm install svd-xbee
+
+### Documentation
+
+For documentation, see the [Documentation](https://github.com/jouz/svd-xbee/wiki/Documentation).
+
+### EXAMPLES
+
+See the [examples folder](https://github.com/jouz/svd-xbee/tree/master/examples) in the repository for more examples.
+
+## SUPPORTED XBEE MODELS
+
+Both ZNet 2.5 and ZIGBEE modules should be supported. Since ZIGBEE offers more features and is more robust, you might be interested in upgrading your modules from ZNet 2.5 to ZIGBEE: [upgradingfromznettozb.pdf](ftp://ftp1.digi.com/support/documentation/upgradingfromznettozb.pdf).  
+Development is done using Series 2 XBee modules with XB24-ZB (ZIGBEE) firmware. In specific, this document is used as reference: [90000976_M.pdf](http://ftp1.digi.com/support/documentation/90000976_M.pdf "http://ftp1.digi.com/support/documentation/90000976_M.pdf").
+
+
+## MODULE CONFIGURATION
+
+The module communicating with svd-xbee must be set to use an API function set with escape characters enabled (ATAP = 2). Other nodes in the network can be configured however you find it convenient. See [Module Configuration](https://github.com/jouz/svd-xbee/wiki/Module-Configurationi) for more details.
+
+
+## ACKNOWLEDGMENTS
+
+* voodootikigod's [serialport module](https://github.com/voodootikigod/node-serialport) (in fact you're going to need this to use this package)
+* "[Building Wireless Sensor Networks](http://shop.oreilly.com/product/9780596807740.do)" by Rob Faludi
+
+
+## LICENSE
+
+
+> This work by <span xmlns:cc="http://creativecommons.org/ns#" property="cc:attributionName">Jan Kolkmeier</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-ShareAlike 2.0 UK: England &amp; Wales License</a>.<br /><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.0/uk/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-sa/2.0/uk/88x31.png" /></a><br />Based on a work at <a xmlns:dct="http://purl.org/dc/terms/" href="https://github.com/mozz100/node-xbee" rel="dct:source">github.com</a>.

examples/full/full.js

@@ -0,0 +1,131 @@
+var util = require('util');
+var XBee = require('../../index.js');
+
+// This parser buffers data, emits chucks
+// seperated by space chars (" ")
+var Parser = require('./parser.js');
+
+var xbee = new XBee.XBee({
+  port: 'COM3',   // replace with yours
+  baudrate: 9600 // 9600 is default
+})
+
+// Open COM port, read some parameters from the XBee at once.
+xbee.init();
+
+// Add Node by hand...
+var myNode = xbee.addNode([0x00,0x13,0xa2,0x00,0x40,0x61,0x2f,0xe4], Parser);
+
+// Triggered whenever this node
+//   - responds to discovery request
+//   - sends identification frame on network association
+//      (not necessarily on power up, as node might
+//       already be associated)
+myNode.on("discovered", function(node) {
+  console.log("Discovered myNode");
+
+  // We configure pin D4 to sample digital data.
+  myNode.AT("D4", [ 0x03 ], function(err, res, x) {
+      if (err) return console.log("AT Error D4:", err);
+
+    // This configures pin 2 to sample analog data.
+    myNode.AT("D2", [ 0x02 ], function(err, res, x) {
+      if (err) return console.log("AT Error D2:", err);
+
+      // We can put requests in the callback, but generally
+      // but generally parallel requests are fine!
+      myNode.AT("IS", function(err, res) { // Manually query IO Sample
+        if (err) return console.log("AT Error IS:", err);
+        console.log("Queried IO Sample: ", util.inspect(xbee.tools.parseIOSample(res)));
+      });
+    });
+
+  });
+});
+
+// Whenever myNode sends us an IO data sample...
+myNode.on("io", function(io) {
+  console.log("I/O: ", util.inspect(io));
+});
+
+// Whenever myNode sends us text data - since we are using
+// a parser, data will first be processed there before landing
+// here:
+myNode.on("data", function(data) {
+  console.log("Data: ", util.inspect(data));
+  if (data == "ping") myNode.send("pong");
+});
+
+
+// Emitted when .init() is done (COM port open, parameters read)
+xbee.on("initialized", function(params) {
+  console.log("XBee Parameters: %s", util.inspect(params));
+  // Start Node discovery to find currently connected nodes.
+  xbee.discover(); 
+  console.log("Node discovery starded...");
+
+  // Local Request:
+  xbee.AT("VR", function(err, res) {
+    console.log("Firmware Version:", xbee.tools.bArr2HexStr(res));
+  });
+
+
+  // Remote Requests ... 
+  // Enable auto reporting of IO Samples with a 2000ms interval set
+  // Note that this request will most typically fail. 
+  // Try uncommenting the line "xbee.discover()", and this should
+  // work fine (if your network is configured properly).
+  // The reason is that remote nodes seem to become unresponsive for
+  // a little while during node discovery.
+  myNode.AT("IR", xbee.tools.dec2bArr(2000), function(err, res) { 
+    if (err) return console.log("AT Error:", util.inspect(err));
+    console.log("Auto Reporting Enabled!");
+  });
+});
+
+xbee.on("discoveryEnd", function() {
+  // Discovery is over. If the XBee is an End Device/Router, 
+  // you may want to re-issue xbee.discover() later. 
+  // For Coordinators this should not be necessary, as
+  // nodes will notify coordinators once they join the PAN,
+  // triggering the "node" event.
+  console.log("...node discovery over");
+});
+
+// Triggered whenever a node is discovered that is not already
+// added. / myNode will not show up here!
+xbee.on("newNodeDiscovered", function(node) {
+  console.log("Node %s discovered", node.remote64.hex);
+  console.log(util.inspect(node));
+
+  node.on("data", function(data) {
+    console.log("%s> %s", node.remote64.hex, util.inspect(data)); 
+    node.send("pong", function(err, status) {
+      // Transmission successful if err is null
+    });
+  });
+
+  node.on("io", function(sample) {
+    console.log("%s> %s", node.remote64.hex, util.inspect(data)); 
+  });
+
+  // Here some functions you might find helpful:
+  node.setPinMode("DIO2", "DIGITAL_INPUT");
+  node.setPinMode("DIO3", "DIGITAL_INPUT");
+  node.setPinMode("DIO0", "DIGITAL_OUTPUT_HIGH");
+
+  node.getPinMode("DIO0", function(err, res) {
+    console.log("Pin DIO0 has mode: ", res);
+  });
+
+  // XBee will send a sample whenever one of these pins measure a change
+  node.setChangeDetection([ "DIO2", "DIO3" ]);
+
+  // Manually retrieve a sample
+  node.getSample(function(err, res) {
+    console.log("Res2:", util.inspect(res));
+  });
+
+  // ...or instruct xbee to sample data every 5 seconds:
+  node.setSampleInterval(2000);
+});

examples/full/parser.js

@@ -0,0 +1,18 @@
+exports = module.exports = function (device) {
+  var delimiter = " ";
+  function DataParser(device) {
+    this.device = device;
+    this.buffer = "";
+  }
+  DataParser.prototype.parse = function(data) {
+    this.buffer += data;
+    var split = this.buffer.indexOf(delimiter);
+    while (split > -1) {
+      this.device.emit('data', this.buffer.slice(0,split));
+      this.buffer = this.buffer.slice(split+delimiter.length);
+      split = this.buffer.indexOf(delimiter);
+    }
+  }
+
+  return new DataParser(device);
+}

examples/nutshell/nutshell.js

@@ -0,0 +1,27 @@
+var util = require('util');
+var XBee = require('../../index.js').XBee;
+
+var xbee = new XBee({
+  port: 'COM5',   // replace with yours
+  baudrate: 9600 // 9600 is default
+}).init();
+
+xbee.on("initialized", function(params) {
+  console.log("XBee Parameters: %s", util.inspect(params));
+
+  xbee.discover(); 
+  console.log("Node discovery starded...");
+});
+
+xbee.on("discoveryEnd", function() {
+  console.log("...node discovery over");
+});
+
+
+// Add Set to your remote node
+var robot = xbee.addNode([0x00,0x13,0xa2,0x00,0x40,0x61,0x2f,0xe4]);
+
+robot.on("data", function(data) {
+  console.log("robot>", data);
+  if (data == "ping") robot.send("pong");
+});