Adding altimeter support

rwaldron · Oct 7, 2015 · 5237658 · 5237658
1 parent c23c1a6
commit 5237658
Show file tree

Hide file tree

Showing 5 changed files with 200 additions and 9 deletions.
diff --git a/eg/altimeter-mpl3115a2.js b/eg/altimeter-mpl3115a2.js
@@ -0,0 +1,19 @@
+var five = require("../lib/johnny-five.js");
+var board = new five.Board();
+
+board.on("ready", function() {
+  var barometer = new five.Altimeter({
+    controller: "MPL3115A2"
+  });
+
+  barometer.on("data", function() {
+    console.log("Altitude");
+    console.log("  feet   : ", this.feet);
+    console.log("  meters : ", this.meters);
+    console.log("--------------------------------------");
+  });
+});
+
+// @markdown
+// - [MPLe115A2 - I2C Barometric Pressure/Altimiter/Temperature Sensor](https://www.adafruit.com/products/1893)
+// @markdown
diff --git a/eg/multi-mpl3115a2.js b/eg/multi-mpl3115a2.js
@@ -0,0 +1,25 @@
+var five = require("../");
+var board = new five.Board();
+
+board.on("ready", function() {
+  var multi = new five.Multi({
+    controller: "MPL3115A2"
+  });
+
+  multi.on("change", function() {
+    console.log("temperature");
+    console.log("  celsius      : ", this.temperature.celsius);
+    console.log("  fahrenheit   : ", this.temperature.fahrenheit);
+    console.log("  kelvin       : ", this.temperature.kelvin);
+    console.log("--------------------------------------");
+
+    console.log("barometer");
+    console.log("  pressure     : ", this.barometer.pressure);
+    console.log("--------------------------------------");
+
+    console.log("altimeter");
+    console.log("  feet         : ", this.altimeter.feet);
+    console.log("  meters       : ", this.altimeter.meters);
+    console.log("--------------------------------------");
+  });
+});
diff --git a/lib/altimeter.js b/lib/altimeter.js
@@ -0,0 +1,98 @@
+var Board = require("../lib/board.js"),
+  Emitter = require("events").EventEmitter,
+  util = require("util");
+
+var Controllers = {
+  MPL3115A2: {
+    initialize: {
+      value: function(opts, dataHandler) {
+        var Multi = require("../lib/imu");
+        var driver = Multi.Drivers.get(this.board, "MPL3115A2", opts);
+        driver.on("data", function(data) {
+          dataHandler(data.altitude);
+        });
+      }
+    },
+    toMeters: {
+      value: function(raw) {
+        return raw / 16;
+      }
+    }
+  }
+};
+
+var priv = new Map();
+
+function Altimeter(opts) {
+  var controller, freq, last = 0, raw;
+
+  if (!(this instanceof Altimeter)) {
+    return new Altimeter(opts);
+  }
+
+  Board.Component.call(
+    this, opts = Board.Options(opts)
+  );
+
+  freq = opts.freq || 25;
+
+
+  if (opts.controller && typeof opts.controller === "string") {
+    controller = Controllers[opts.controller.toUpperCase()];
+  } else {
+    controller = opts.controller;
+  }
+
+  priv.set(this, {});
+
+  Object.defineProperties(this, controller);
+
+  if (!this.toMeters) {
+    this.toMeters = opts.toMeters || function(x) { return x; };
+  }
+
+  var propDescriptors = {
+    meters: {
+      get: function() {
+        return this.toMeters(raw);
+      }
+    },
+    feet: {
+      get: function() {
+        return this.meters * 3.28084;
+      }
+    }
+  };
+  // Convenience aliases
+  propDescriptors.m = propDescriptors.meters;
+  propDescriptors.ft = propDescriptors.feet;
+
+  Object.defineProperties(this, propDescriptors);
+
+  if (typeof this.initialize === "function") {
+    this.initialize(opts, function(data) {
+      raw = data;
+    });
+  }
+
+  setInterval(function() {
+    if (raw === undefined) {
+      return;
+    }
+
+    var data = {};
+    data.m = data.meters = this.meters;
+    data.ft = data.feet = this.feet;
+
+    this.emit("data", null, data);
+
+    if (this.meters !== last) {
+      last = this.meters;
+      this.emit("change", null, data);
+    }
+  }.bind(this), freq);
+}
+
+util.inherits(Altimeter, Emitter);
+
+module.exports = Altimeter;
diff --git a/lib/imu.js b/lib/imu.js
@@ -3,6 +3,7 @@ var Emitter = require("events").EventEmitter;
 var util = require("util");
 var __ = require("../lib/fn.js");
 var Accelerometer = require("../lib/accelerometer.js");
+var Altimeter = require("../lib/altimeter.js");
 var Barometer = require("../lib/barometer.js");
 var Hygrometer = require("../lib/hygrometer.js");
 var Temperature = require("../lib/temperature.js");
@@ -219,7 +220,7 @@ var Drivers = {
         CONTROL: {
           SBYB: 0x01,
           OS128: 0x38,
-          ALTIMITER: 0x80,
+          ALTIMETER: 0x80,
           PRESSURE: 0x00
         },
         DATA_CONFIG: {
@@ -239,11 +240,11 @@ var Drivers = {
           pressure: 0,
           altitude: 0,
           temperature: 0
-        }
+        };
 
         var waitForReady = function(next) {
           io.i2cReadOnce(address, this.REGISTER.STATUS, 1, function(data) {
-            if(data[0] & this.MASK.STATUS.PRESSURE_DATA_READ) {
+            if (data[0] & this.MASK.STATUS.PRESSURE_DATA_READ) {
               next();
             } else {
               setTimeout(function() {
@@ -254,29 +255,27 @@ var Drivers = {
         }.bind(this);
 
         var readValues = function(isPressure) {
-          var modeMask = isPressure ? this.MASK.CONTROL.PRESSURE : this.MASK.CONTROL.ALTIMITER;
+          var modeMask = isPressure ? this.MASK.CONTROL.PRESSURE : this.MASK.CONTROL.ALTIMETER;
 
           io.i2cWrite(address, this.REGISTER.CONTROL,
             this.MASK.CONTROL.SBYB |
             this.MASK.CONTROL.OS128 |
             modeMask);
 
           waitForReady(function() {
-            io.i2cReadOnce(address, this.REGISTER.PRESSURE_MSB, 6, function(data) {
+            io.i2cReadOnce(address, this.REGISTER.PRESSURE_MSB, READLENGTH, function(data) {
               var value = uint24(data[1], data[2], data[3]) >> 4;
               var temperature = uint16(data[4], data[5]) >> 4;
 
               computed.temperature = temperature;
 
-              if(isPressure) {
+              if (isPressure) {
                 computed.pressure = value;
-                this.emit('data', computed);
+                this.emit("data", computed);
               } else {
                 if (value & 0x800000) {
                   value |= 0xFF000000;
                 }
-                //value /= 16;
-
                 computed.altitude = value;
               }
 
@@ -683,6 +682,55 @@ var Controllers = {
     hygrometer: {
       get: function() {
         return priv.get(this).hygrometer;
+        }
+    },
+    temperature: {
+      get: function() {
+        return priv.get(this).temperature;
+      }
+    }
+  },
+  MPL3115A2: {
+    initialize: {
+      value: function(opts) {
+        var state = priv.get(this);
+
+        state.barometer = new Barometer(
+          Object.assign({
+            controller: "MPL3115A2",
+            freq: opts.freq,
+            board: this.board,
+          }, opts)
+        );
+
+        state.altimeter = new Altimeter(
+          Object.assign({
+            controller: "MPL3115A2",
+            freq: opts.freq,
+            board: this.board,
+          }, opts)
+        );
+
+        state.temperature = new Temperature(
+          Object.assign({
+            controller: "MP3L115A2",
+            freq: opts.freq,
+            board: this.board,
+          }, opts)
+        );
+      }
+    },
+    components: {
+      value: ["barometer", "altimeter", "temperature"]
+    },
+    barometer: {
+      get: function() {
+        return priv.get(this).barometer;
+      }
+    },
+    altimeter: {
+      get: function() {
+        return priv.get(this).altimeter;
       }
     },
     temperature: {

diff --git a/lib/johnny-five.js b/lib/johnny-five.js
@@ -6,6 +6,7 @@ module.exports = {
   // extract-start:apinames
   Accelerometer: require("./accelerometer"),
   Animation: require("./animation"),
+  Altimeter: require("./altimeter"),
   Barometer: require("./barometer"),
   Board: require("./board"),
   Button: require("./button"),