initial commit

Author: asanchezdelc

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.DS_Store
+.idea

README.md

@@ -1,2 +1,31 @@
-# cayennejs
-Cayenne IoT Node.JS library
+# Cayenne IoT Node.JS API
+
+```
+npm install cayennejs
+```
+
+```
+var Cayenne = require('cayennejs');
+
+// Initiate MQTT API
+const cayenneClient = new Cayenne.MQTT({
+  username: "foobar",
+  password: "secret",
+  clientId: "thing-id"
+});
+
+cayenneClient.connect((err, mqttClient) => {
+  // dashboard widget automatically detects datatype & unit
+  cayenneClient.kelvinWrite(3, 65);
+
+  // sending raw values without datatypes
+  cayenneClient.rawWrite(4, 123);
+
+  // subscribe to data channel for actions (actuators)
+  cayenneClient.on("cmd9", function(data) {
+    console.log(data);
+  });
+
+});
+
+```

index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/cayenne');

lib/cayenne.js

@@ -0,0 +1,4 @@
+// export the class
+module.exports = {
+  MQTT: require('./mqtt')
+};

lib/datatypes.js

@@ -0,0 +1,32 @@
+var TYPE = {};
+
+TYPE.ANALOG = "analog"
+TYPE.DIGITAL = "digital"
+TYPE.BAROMETRIC_PRESSURE = "bp"     // Barometric pressure
+TYPE.BATTERY = "batt"               // Battery
+TYPE.LUMINOSITY = "lum"             // Luminosity
+TYPE.PROXIMITY = "prox"             // Proximity
+TYPE.RELATIVE_HUMIDITY = "rel_hum"  // Relative Humidity
+TYPE.TEMPERATURE = "temp"           // Temperature
+TYPE.VOLTAGE = "voltage"            // Voltage
+
+var UNIT = {};
+UNIT.UNDEFINED = "null"
+UNIT.PASCAL = "pa"          // Pascal
+UNIT.HECTOPASCAL = "hpa"    // Hectopascal
+UNIT.PERCENT = "p"          // % (0 to 100)
+UNIT.RATIO = "r"            // Ratio
+UNIT.VOLTS = "v"            // Volts
+UNIT.LUX = "lux"            // Lux
+UNIT.CENTIMETER = "cm"      // Centimeter
+UNIT.METER = "m"            // Meter
+UNIT.DIGITAL = "d"          // Digital (0/1)
+UNIT.FAHRENHEIT = "f"       // Fahrenheit
+UNIT.CELSIUS = "c"          // Celsius
+UNIT.KELVIN = "k"           // Kelvin
+UNIT.MILLIVOLTS = "mv"      // Millivolts
+
+module.exports = {
+    TYPE:TYPE,
+    UNIT:UNIT
+}

lib/mqtt.js

@@ -0,0 +1,132 @@
+const routes = require('routes');
+const mqtt = require('mqtt');
+const DataTypes = require('./datatypes.js');
+const TYPE = DataTypes.TYPE;
+const UNIT = DataTypes.UNIT;
+const events = require('events');
+const Router = routes();
+const THINGS = 'things';
+
+
+var Cayenne = function(options) {
+  apiVersion = "v1";
+  this.options = options;
+
+  this.debug = this.options.debug || false;
+  this.ssl = this.options.ssl || false;
+
+  this.broker = this.options.broker || "mqtt.mydevices.com";
+
+  this.client = null;
+  this.connected = false;
+
+  this.rootTopic = [
+    apiVersion,
+    this.options.username,
+    THINGS,
+    this.options.clientId
+  ].join('/');
+
+};
+
+Cayenne.prototype.__proto__ = events.EventEmitter.prototype;
+
+Cayenne.prototype.connect = function(callback) {
+  const self = this;
+  thingTopic = this.rootTopic;
+  
+  this.client = mqtt.connect("mqtt://" + broker, {
+      username: this.options.username,
+      password: this.options.password,
+      clientId: this.options.clientId,
+  });
+
+  this.client.on('connect', function () {
+      self.connected = true;
+      self.client.subscribe(self.rootTopic + '/cmd/+');
+
+      return callback(null, self.client);
+  });
+
+  this.client.on('message', self.onMessage.bind(self));
+
+  const cmdTopic = apiVersion + '/:username/'+THINGS+'/:thingId/cmd/:channel';
+  Router.addRoute(cmdTopic, this.handleCommand.bind(this));
+
+}
+
+Cayenne.prototype.rawWrite = function(channel, value, type, unit) {
+    var topic = this.getDataTopic(channel);
+    var payload;
+
+    if (unit === undefined) {
+        unit = "null";
+    }
+
+    if (type === undefined) {
+        payload = value;
+    } else {
+        payload = type + "," + unit + "=" + value;
+    }
+
+    this.client.publish(topic, payload);
+};
+
+
+Cayenne.prototype.getDataTopic = function (channel) {
+    return this.rootTopic + '/data/' + channel;
+};
+
+Cayenne.prototype.handleCommand = function (req) {
+  const payload = req.payload.split(',');
+  const seq = payload[0];
+  const cmd = payload[1];
+
+  this.client.publish(this.rootTopic + '/response', 'ok,'+seq);
+  this.client.publish(this.rootTopic + '/data/' + req.meta.channel, cmd);
+
+  this.emit("cmd" + req.meta.channel, req);
+}
+
+Cayenne.prototype.onMessage = function(topic, payload)  {
+    var route = Router.match(topic);
+
+    if (!route) {
+      return;
+    }
+
+    var req = {
+       path: topic,
+       payload: payload.toString(),
+       meta: route ? route.params: null,
+       splats: route ? route.splats : null
+    };
+
+   return route.fn(req);
+}
+
+Cayenne.prototype.celsiusWrite = function (channel, value)  {
+    this.rawWrite(channel, value, TYPE.TEMPERATURE, UNIT.CELSIUS);
+}
+
+Cayenne.prototype.fahrenheitWrite = function (channel, value)  {
+    this.rawWrite(channel, value, TYPE.TEMPERATURE, UNIT.FAHRENHEIT)
+}
+
+Cayenne.prototype.kelvinWrite = function (channel, value)  {
+    this.rawWrite(channel, value, TYPE.TEMPERATURE, UNIT.KELVIN)
+}
+
+Cayenne.prototype.luxWrite = function (channel, value)  {
+    this.rawWrite(channel, value, TYPE.LUMINOSITY, UNIT.LUX)
+}
+
+Cayenne.prototype.pascalWrite = function (channel, value)  {
+    this.rawWrite(channel, value, TYPE.BAROMETRIC_PRESSURE, UNIT.PASCAL)
+}
+
+Cayenne.prototype.hectoPascalWrite = function (channel, value)  {
+    this.rawWrite(channel, value, TYPE.BAROMETRIC_PRESSURE, UNIT.HECTOPASCAL)
+}
+
+module.exports = Cayenne;

package.json

@@ -0,0 +1,24 @@
+{
+  "name": "cayennejs",
+  "description": "Cayenne API Node.JS Library",
+  "version": "0.0.1",
+  "homepage": "mydevices.com/cayenne",
+  "repository": "https://github.com/myDevicesIoT/cayennejs",
+  "main": "",
+  "keywords": ["cayenne", "mqtt", "iot", "api", "mydevices"],
+  "engines": {
+    "node": ">=4.0.0"
+  },
+  "dependencies": {
+    "mqtt": "2.x.x",
+    "routes": "^2.1.0"
+  },
+  "devDependencies": {
+    "assert": "^1.4.1",
+    "mocha": "^3.1.2"
+  },
+  "scripts": {
+    "test": "mocha --timeout 2000"
+  },
+  "license": "MIT"
+}

test/mqtt.js

@@ -0,0 +1,26 @@
+const Cayenne = require('../');
+
+const cayenneClient = new Cayenne.MQTT({
+  username: "",
+  password: "",
+  clientId: ""
+});
+
+describe('MQTT connection', function() {
+
+  it('should connect with valid credentials', function(done) {
+    cayenneClient.connect(done);
+  });
+
+  it('should send sensor data', function(done) {
+    cayenneClient.kelvinWrite(3, 65);
+
+    done();
+  });
+
+  it('should subscribe to channel and receive data', function (done) {
+    cayenneClient.on("cmd9", function(){
+      setTimeout(done, 1000);
+    });
+  });
+});