Merge pull request #20 from aj-ptw/development

FIX: Daisy with cyton over wifi accel data counts

Author: AJ Keller

changelog.md

@@ -1,3 +1,9 @@
+# v0.2.6
+
+### Bug Fixes
+
+* Accel data with counts did not work for cyton with daisy over wifi.
+
 # v0.2.5
 
 ### Bug Fixes

openBCIUtilities.js

@@ -46,6 +46,7 @@ let utilitiesModule = {
    * @property {Number} lastSampleNumber (optional) - The last sample number
    * @property {Boolean} scale (optional) Default `true`. A gain of 24 for Cyton will be used and 51 for ganglion by default.
    */
+
   /**
    * @description Used to extract samples out of a buffer of unknown length
    * @param dataBuffer {Buffer} - A buffer to parse for samples
@@ -1815,7 +1816,9 @@ function makeDaisySampleObject (lowerSampleObject, upperSampleObject) {
     } else {
       daisySampleObject.accelData = upperSampleObject.accelData;
     }
-  } else if (lowerSampleObject.hasOwnProperty('accelDataCounts')) {
+  }
+
+  if (lowerSampleObject.hasOwnProperty('accelDataCounts')) {
     if (lowerSampleObject.accelDataCounts[0] > 0 || lowerSampleObject.accelDataCounts[1] > 0 || lowerSampleObject.accelDataCounts[2] > 0) {
       daisySampleObject.accelDataCounts = lowerSampleObject.accelDataCounts;
     } else {
@@ -1870,10 +1873,20 @@ function makeDaisySampleObjectWifi (lowerSampleObject, upperSampleObject) {
     'upper': upperSampleObject.timestamp
   };
 
-  if (lowerSampleObject.accelData) {
-    daisySampleObject['accelData'] = lowerSampleObject.accelData;
-  } else if (upperSampleObject.accelData) {
-    daisySampleObject['accelData'] = upperSampleObject.accelData;
+  if (lowerSampleObject.hasOwnProperty('accelData')) {
+    if (lowerSampleObject.accelData[0] > 0 || lowerSampleObject.accelData[1] > 0 || lowerSampleObject.accelData[2] > 0) {
+      daisySampleObject.accelData = lowerSampleObject.accelData;
+    } else {
+      daisySampleObject.accelData = upperSampleObject.accelData;
+    }
+  }
+
+  if (lowerSampleObject.hasOwnProperty('accelDataCounts')) {
+    if (lowerSampleObject.accelDataCounts[0] > 0 || lowerSampleObject.accelDataCounts[1] > 0 || lowerSampleObject.accelDataCounts[2] > 0) {
+      daisySampleObject.accelDataCounts = lowerSampleObject.accelDataCounts;
+    } else {
+      daisySampleObject.accelDataCounts = upperSampleObject.accelDataCounts;
+    }
   }
 
   daisySampleObject['valid'] = true;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openbci-utilities",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "The official utility package of Node.js SDK for the OpenBCI Biosensor Boards.",
   "main": "index.js",
   "scripts": {

test/openBCIConstants-test.js

@@ -1958,7 +1958,7 @@ describe('OpenBCIConstants', function () {
       assert.equal('Ganglion', k.OBCIGanglionPrefix);
     });
     it('Ganglion ble search time', function () {
-      assert.equal(0.032, k.OBCIGanglionAccelScaleFactor);
+      assert.equal(0.016, k.OBCIGanglionAccelScaleFactor);
     });
     it('Ganglion ble search time', function () {
       assert.equal(20000, k.OBCIGanglionBleSearchTime);

test/openBCIUtilities-test.js

@@ -1674,10 +1674,11 @@ describe('openBCIUtilities', function () {
       lowerSampleObject.channelData = [1, 2, 3, 4, 5, 6, 7, 8];
       lowerSampleObject.auxData = [0, 1, 2];
       lowerSampleObject.timestamp = 4;
-      lowerSampleObject.accelData = [0.5, -0.5, 1];
+      lowerSampleObject.accelData = [0, 0, 0];
       // Make the upper sample (channels 9-16)
       upperSampleObject = openBCIUtilities.newSample(2);
       upperSampleObject.channelData = [9, 10, 11, 12, 13, 14, 15, 16];
+      lowerSampleObject.accelData = [0, 1, 2];
       upperSampleObject.auxData = [3, 4, 5];
       upperSampleObject.timestamp = 8;
 
@@ -1686,11 +1687,12 @@ describe('openBCIUtilities', function () {
       lowerSampleObjectNoScale = openBCIUtilities.newSample(1);
       lowerSampleObjectNoScale.channelDataCounts = [1, 2, 3, 4, 5, 6, 7, 8];
       lowerSampleObjectNoScale.auxData = [0, 1, 2];
+      lowerSampleObjectNoScale.accelDataCounts = [0, 0, 0];
       lowerSampleObjectNoScale.timestamp = 4;
-      lowerSampleObjectNoScale.accelData = [0.5, -0.5, 1];
       // Make the upper sample (channels 9-16)
       upperSampleObjectNoScale = openBCIUtilities.newSample(2);
       upperSampleObjectNoScale.channelDataCounts = [9, 10, 11, 12, 13, 14, 15, 16];
+      lowerSampleObjectNoScale.accelDataCounts = [0, 1, 2];
       upperSampleObjectNoScale.auxData = [3, 4, 5];
       upperSampleObjectNoScale.timestamp = 8;
 
@@ -1741,6 +1743,28 @@ describe('openBCIUtilities', function () {
     });
     it('should store an accelerometer value if present', function () {
       expect(daisySampleObject).to.have.property('accelData');
+      expect(daisySampleObject.accelData).to.deep.equal([0, 1, 2]);
+      expect(daisySampleObjectNoScale).to.have.property('accelDataCounts');
+      expect(daisySampleObjectNoScale.accelDataCounts).to.deep.equal([0, 1, 2]);
+    });
+    it('should work for all accel cases to extract the non-zero values', function () {
+      let lowerSample = openBCIUtilities.newSample(1);
+      lowerSample.accelData = [0, 1, 2];
+      let upperSample = openBCIUtilities.newSample(2);
+      upperSample.accelData = [0, 0, 0];
+
+      let lowerSampleNoScale = openBCIUtilities.newSampleNoScale(1);
+      lowerSampleNoScale.accelDataCounts = [0, 1, 2];
+      let upperSampleNoScale = openBCIUtilities.newSampleNoScale(2);
+      upperSampleNoScale.accelDataCounts = [0, 0, 0];
+
+      // Call the function under test
+      let daisySample = openBCIUtilities.makeDaisySampleObjectWifi(lowerSample, upperSample);
+      let daisySampleNoScale = openBCIUtilities.makeDaisySampleObjectWifi(lowerSampleNoScale, upperSampleNoScale);
+      expect(daisySample).to.have.property('accelData');
+      expect(daisySample.accelData).to.deep.equal([0, 1, 2]);
+      expect(daisySampleNoScale).to.have.property('accelDataCounts');
+      expect(daisySampleNoScale.accelDataCounts).to.deep.equal([0, 1, 2]);
     });
   });
   describe('#isEven', function () {
@@ -2708,6 +2732,30 @@ describe('#extractRawDataPackets', function () {
       expect(bufferEqual(expectedRawDataPackets[i], output.rawDataPackets[i])).to.be.true(`Expected 0x${expectedRawDataPackets[i].toString('HEX')} to equal 0x${output.rawDataPackets[i].toString('HEX')}`);
     }
   });
+  it('should be able to extract multiple packets from a single buffer when daisy', () => {
+    // We are going to extract multiple buffers
+    let expectedNumberOfBuffers = 4;
+    // declare the big buffer
+    let buffer = new Buffer(k.OBCIPacketSize * expectedNumberOfBuffers);
+    // Fill that new big buffer with buffers
+    const expectedRawDataPackets = [
+      openBCIUtilities.samplePacketReal(0),
+      openBCIUtilities.samplePacketReal(0),
+      openBCIUtilities.samplePacketReal(1),
+      openBCIUtilities.samplePacketReal(1)
+    ];
+    expectedRawDataPackets[0].copy(buffer, 0);
+    expectedRawDataPackets[1].copy(buffer, k.OBCIPacketSize);
+    expectedRawDataPackets[2].copy(buffer, k.OBCIPacketSize * 2);
+    expectedRawDataPackets[2].copy(buffer, k.OBCIPacketSize * 3);
+    // Call the function under test
+    const output = openBCIUtilities.extractRawDataPackets(buffer);
+    // The buffer should not have anything in it any more
+    expect(output.buffer).to.be.null();
+    for (let i = 0; i < expectedNumberOfBuffers; i++) {
+      expect(bufferEqual(expectedRawDataPackets[i], output.rawDataPackets[i])).to.be.true(`Expected 0x${expectedRawDataPackets[i].toString('HEX')} to equal 0x${output.rawDataPackets[i].toString('HEX')}`);
+    }
+  });
 
   it('should be able to get multiple packets and keep extra data on the end', () => {
     let expectedString = 'AJ';