Multi: make altitude calibration contingent on user specifying opts.e…

…levation
rwaldron · Oct 13, 2015 · 382765a · 382765a
1 parent 242c5b4
commit 382765a
Show file tree

Hide file tree

Showing 13 changed files with 484 additions and 425 deletions.
diff --git a/docs/altimeter-mpl3115a2.md b/docs/altimeter-mpl3115a2.md
@@ -33,15 +33,15 @@ var five = require("johnny-five");
 var board = new five.Board();
 
 board.on("ready", function() {
-  var barometer = new five.Altimeter({
+  var altitude = new five.Altimeter({
     controller: "MPL3115A2",
-    // change altitudeOffset with whatever is reported
+    // Change `elevation` with whatever is reported
     // on http://www.whatismyelevation.com/.
     // `12` is the elevation (meters) for where I live in Brooklyn
-    altitudeOffset: 12,
+    elevation: 12,
   });
 
-  barometer.on("data", function() {
+  altitude.on("data", function() {
     console.log("Altitude");
     console.log("  feet   : ", this.feet);
     console.log("  meters : ", this.meters);
@@ -61,6 +61,9 @@ board.on("ready", function() {
 
 ## Additional Notes
 - [MPL3115A2 - I2C Barometric Pressure/Altimiter/Temperature Sensor](https://www.adafruit.com/products/1893)
+- [SparkFun Altitude/Pressure Sensor Breakout - MPL3115A2](https://www.sparkfun.com/products/11084)
+- [SparkFun Weather Shield](https://www.sparkfun.com/products/12081)
+- [SparkFun Photon Weather Shield](https://www.sparkfun.com/products/13630)
 
 
 ## Learn More

diff --git a/docs/barometer-mpl3115a2.md b/docs/barometer-mpl3115a2.md
@@ -55,7 +55,10 @@ board.on("ready", function() {
 
 
 ## Additional Notes
-- [MPLe115A2 - I2C Barometric Pressure/Altimiter/Temperature Sensor](https://www.adafruit.com/products/1893)
+- [MPL3115A2 - I2C Barometric Pressure/Altimiter/Temperature Sensor](https://www.adafruit.com/products/1893)
+- [SparkFun Altitude/Pressure Sensor Breakout - MPL3115A2](https://www.sparkfun.com/products/11084)
+- [SparkFun Weather Shield](https://www.sparkfun.com/products/12081)
+- [SparkFun Photon Weather Shield](https://www.sparkfun.com/products/13630)
 
 
 ## Learn More

diff --git a/docs/multi-mpl3115a2.md b/docs/multi-mpl3115a2.md
@@ -35,10 +35,10 @@ var board = new five.Board();
 board.on("ready", function() {
   var multi = new five.Multi({
     controller: "MPL3115A2",
-    // change altitudeOffset with whatever is reported
+    // Change `elevation` with whatever is reported
     // on http://www.whatismyelevation.com/.
     // `12` is the elevation (meters) for where I live in Brooklyn
-    altitudeOffset: 12,
+    elevation: 12,
   });
 
   multi.on("change", function() {
@@ -59,6 +59,7 @@ board.on("ready", function() {
   });
 });
 
+
 ```
 
 
@@ -68,6 +69,12 @@ board.on("ready", function() {
 
 
 
+## Additional Notes
+- [MPL3115A2 - I2C Barometric Pressure/Altimiter/Temperature Sensor](https://www.adafruit.com/products/1893)
+- [SparkFun Altitude/Pressure Sensor Breakout - MPL3115A2](https://www.sparkfun.com/products/11084)
+- [SparkFun Weather Shield](https://www.sparkfun.com/products/12081)
+- [SparkFun Photon Weather Shield](https://www.sparkfun.com/products/13630)
+
 
 ## Learn More
 

diff --git a/docs/temperature-mpl3115a2.md b/docs/temperature-mpl3115a2.md
@@ -57,7 +57,10 @@ board.on("ready", function() {
 
 
 ## Additional Notes
-- [MPLe115A2 - I2C Barometric Pressure/Altimiter/Temperature Sensor](https://www.adafruit.com/products/1893)
+- [MPL3115A2 - I2C Barometric Pressure/Altimiter/Temperature Sensor](https://www.adafruit.com/products/1893)
+- [SparkFun Altitude/Pressure Sensor Breakout - MPL3115A2](https://www.sparkfun.com/products/11084)
+- [SparkFun Weather Shield](https://www.sparkfun.com/products/12081)
+- [SparkFun Photon Weather Shield](https://www.sparkfun.com/products/13630)
 
 
 ## Learn More

diff --git a/eg/altimeter-mpl3115a2.js b/eg/altimeter-mpl3115a2.js
@@ -2,15 +2,15 @@ var five = require("../lib/johnny-five.js");
 var board = new five.Board();
 
 board.on("ready", function() {
-  var barometer = new five.Altimeter({
+  var altitude = new five.Altimeter({
     controller: "MPL3115A2",
-    // change altitudeOffset with whatever is reported
+    // Change `elevation` with whatever is reported
     // on http://www.whatismyelevation.com/.
     // `12` is the elevation (meters) for where I live in Brooklyn
-    altitudeOffset: 12,
+    elevation: 12,
   });
 
-  barometer.on("data", function() {
+  altitude.on("data", function() {
     console.log("Altitude");
     console.log("  feet   : ", this.feet);
     console.log("  meters : ", this.meters);
@@ -20,4 +20,7 @@ board.on("ready", function() {
 
 // @markdown
 // - [MPL3115A2 - I2C Barometric Pressure/Altimiter/Temperature Sensor](https://www.adafruit.com/products/1893)
+// - [SparkFun Altitude/Pressure Sensor Breakout - MPL3115A2](https://www.sparkfun.com/products/11084)
+// - [SparkFun Weather Shield](https://www.sparkfun.com/products/12081)
+// - [SparkFun Photon Weather Shield](https://www.sparkfun.com/products/13630)
 // @markdown
diff --git a/eg/barometer-mpl3115a2.js b/eg/barometer-mpl3115a2.js
@@ -14,5 +14,8 @@ board.on("ready", function() {
 });
 
 // @markdown
-// - [MPLe115A2 - I2C Barometric Pressure/Altimiter/Temperature Sensor](https://www.adafruit.com/products/1893)
+// - [MPL3115A2 - I2C Barometric Pressure/Altimiter/Temperature Sensor](https://www.adafruit.com/products/1893)
+// - [SparkFun Altitude/Pressure Sensor Breakout - MPL3115A2](https://www.sparkfun.com/products/11084)
+// - [SparkFun Weather Shield](https://www.sparkfun.com/products/12081)
+// - [SparkFun Photon Weather Shield](https://www.sparkfun.com/products/13630)
 // @markdown
diff --git a/eg/multi-mpl3115a2.js b/eg/multi-mpl3115a2.js
@@ -4,10 +4,10 @@ var board = new five.Board();
 board.on("ready", function() {
   var multi = new five.Multi({
     controller: "MPL3115A2",
-    // change altitudeOffset with whatever is reported
+    // Change `elevation` with whatever is reported
     // on http://www.whatismyelevation.com/.
     // `12` is the elevation (meters) for where I live in Brooklyn
-    altitudeOffset: 12,
+    elevation: 12,
   });
 
   multi.on("change", function() {
@@ -27,3 +27,10 @@ board.on("ready", function() {
     console.log("--------------------------------------");
   });
 });
+
+// @markdown
+// - [MPL3115A2 - I2C Barometric Pressure/Altimiter/Temperature Sensor](https://www.adafruit.com/products/1893)
+// - [SparkFun Altitude/Pressure Sensor Breakout - MPL3115A2](https://www.sparkfun.com/products/11084)
+// - [SparkFun Weather Shield](https://www.sparkfun.com/products/12081)
+// - [SparkFun Photon Weather Shield](https://www.sparkfun.com/products/13630)
+// @markdown
diff --git a/eg/temperature-mpl3115a2.js b/eg/temperature-mpl3115a2.js
@@ -16,5 +16,8 @@ board.on("ready", function() {
 });
 
 // @markdown
-// - [MPLe115A2 - I2C Barometric Pressure/Altimiter/Temperature Sensor](https://www.adafruit.com/products/1893)
+// - [MPL3115A2 - I2C Barometric Pressure/Altimiter/Temperature Sensor](https://www.adafruit.com/products/1893)
+// - [SparkFun Altitude/Pressure Sensor Breakout - MPL3115A2](https://www.sparkfun.com/products/11084)
+// - [SparkFun Weather Shield](https://www.sparkfun.com/products/12081)
+// - [SparkFun Photon Weather Shield](https://www.sparkfun.com/products/13630)
 // @markdown
diff --git a/lib/altimeter.js b/lib/altimeter.js
@@ -26,7 +26,7 @@ var Controllers = {
 var priv = new Map();
 
 function Altimeter(opts) {
-  var controller, freq, last = 0, raw;
+  var controller, freq, last = 0, raw = 0;
 
   if (!(this instanceof Altimeter)) {
     return new Altimeter(opts);

diff --git a/lib/imu.js b/lib/imu.js
@@ -237,6 +237,8 @@ var Drivers = {
         var READLENGTH = 6;
         var io = board.io;
         var address = opts.address || this.ADDRESSES[0];
+        var elevation = null;
+        var isPressure = false;
 
         // See http://www.henrylahr.com/?p=99 for implementation approach
         //
@@ -247,7 +249,9 @@ var Drivers = {
           temperature: 0
         };
 
-        opts.altitudeOffset = opts.altitudeOffset || 0;
+        if (typeof opts.elevation !== "undefined") {
+          elevation = opts.elevation;
+        }
 
         var waitForReady = function(next) {
           io.i2cReadOnce(address, this.REGISTER.STATUS, 1, function(data) {
@@ -261,7 +265,7 @@ var Drivers = {
           }.bind(this));
         }.bind(this);
 
-        var readValues = function(isPressure) {
+        var readValues = function() {
           var modeMask = isPressure ? this.MASK.CONTROL.PRESSURE : this.MASK.CONTROL.ALTIMETER;
           var mode = this.MASK.CONTROL.SBYB | this.MASK.CONTROL.OS128 | modeMask;
 
@@ -290,17 +294,13 @@ var Drivers = {
                 computed.altitude = altNow;
               }
 
-              readValues(!isPressure);
+              isPressure = !isPressure;
+
+              readValues();
             }.bind(this));
           }.bind(this));
         }.bind(this);
 
-        io.i2cConfig(opts);
-
-        // configure the chip
-        // Set Altitude Offset.
-        io.i2cWriteReg(address, 0x2D, 0x00);
-
         var reads = [];
         var calibrate = function() {
           // Clear Oversampling and OST
@@ -317,9 +317,8 @@ var Drivers = {
               reads.push((m << 10 | c << 2) + fl);
 
               if (reads.length === 4) {
-
                 var curpress = (reads[0] + reads[1] + reads[2] + reads[3]) / 4;
-                var seapress = curpress / Math.pow(1 - opts.altitudeOffset * 0.0000225577, 5.255877);
+                var seapress = curpress / Math.pow(1 - elevation * 0.0000225577, 5.255877);
 
                 // Update Barometric input for Altitude
                 io.i2cWrite(address, this.REGISTER.BAR_IN_MSB, (seapress / 2) >> 8);
@@ -350,12 +349,22 @@ var Drivers = {
           }.bind(this), 500);
         }.bind(this);
 
+        io.i2cConfig(opts);
+
+        // configure the chip
+        // Set Altitude Offset.
+        io.i2cWriteReg(address, 0x2D, 0x00);
+
         io.i2cWrite(address, this.REGISTER.DATA_CONFIG,
           this.MASK.DATA_CONFIG.TDEFE |
           this.MASK.DATA_CONFIG.PDEFE |
           this.MASK.DATA_CONFIG.DREM);
 
-        calibrate();
+        if (elevation !== null) {
+          calibrate();
+        } else {
+          readValues();
+        }
       }
     },
     identifier: {