Merge pull request #30 from aj-ptw/master

FIX: ganglion messages not processed properly

Author: AJ Keller

CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.3.6
+
+### Bug Fixes 
+
+* Fix bug where parseGanglion could result in a concat of non-buffer types
+
 # v0.3.5
 
 ### Bug Fixes 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openbci-utilities",
-  "version": "0.3.5",
+  "version": "0.3.6",
   "description": "The official utility package of Node.js SDK for the OpenBCI Biosensor Boards.",
   "main": "dist/openbci-utilities.js",
   "module": "src/index.js",

src/utilities.js

@@ -728,7 +728,9 @@ let utilitiesModule = {
         0b00000111  // 19
       ]);
   },
-  parseGanglion
+  parseGanglion,
+  processMultiBytePacket,
+  processMultiBytePacketStop
 };
 
 /**
@@ -860,7 +862,7 @@ function processImpedanceData (o) {
  */
 function processMultiBytePacket (o) {
   if (o.multiPacketBuffer) {
-    o.multiPacketBuffer = Buffer.concat([o.multiPacketBuffer, o.rawDataPacket.slice(k.OBCIGanglionPacket19Bit.dataStart, k.OBCIGanglionPacket19Bit.dataStop)]);
+    o.multiPacketBuffer = Buffer.concat([Buffer.from(o.multiPacketBuffer), Buffer.from(o.rawDataPacket.slice(k.OBCIGanglionPacket19Bit.dataStart, k.OBCIGanglionPacket19Bit.dataStop))]);
   } else {
     o.multiPacketBuffer = o.rawDataPacket.slice(k.OBCIGanglionPacket19Bit.dataStart, k.OBCIGanglionPacket19Bit.dataStop);
   }
@@ -873,9 +875,11 @@ function processMultiBytePacket (o) {
  */
 function processMultiBytePacketStop (o) {
   processMultiBytePacket(o);
-  const str = o.multiPacketBuffer;
+  const str = o.multiPacketBuffer.toString();
   o.multiPacketBuffer = null;
-  return str;
+  return {
+    'message': str
+  };
 }
 
 /**

test/openBCIUtilities-test.js

@@ -37,6 +37,43 @@ describe('openBCIUtilities', function () {
     accelArray = [0, 0, 0];
   });
   afterEach(() => bluebirdChecks.noPendingPromises());
+  describe('#processMultiBytePacketStop', function () {
+    it('should output the message', function () {
+      const rawBuf = Buffer.from([0xCF, 0x65, 0x64, 0x0A]);
+
+      const expectedOutput = 'ed\n';
+
+      const actualOutput = openBCIUtilities.processMultiBytePacketStop({
+        multiPacketBuffer: null,
+        rawDataPacket: rawBuf
+      });
+      expect(actualOutput.message).to.equal(expectedOutput);
+    });
+  });
+  describe('#processMultiBytePacket', function () {
+    it('should be convert raw data packtet to string', function () {
+      const rawBufMulti = Buffer.from([0xCE, 0x61, 0x63, 0x63, 0x65, 0x6C, 0x65, 0x72, 0x6F, 0x6D, 0x65, 0x74, 0x65, 0x72, 0x20, 0x65, 0x6E, 0x61, 0x62, 0x6C]);
+
+      const expectedRawBufMulti = Buffer.from([0x61, 0x63, 0x63, 0x65, 0x6C, 0x65, 0x72, 0x6F, 0x6D, 0x65, 0x74, 0x65, 0x72, 0x20, 0x65, 0x6E, 0x61, 0x62, 0x6C]);
+
+      const o = {};
+      o.rawDataPacket = rawBufMulti;
+      openBCIUtilities.processMultiBytePacket(o);
+      expect(o.multiPacketBuffer.toString()).to.equal(expectedRawBufMulti.toString());
+    });
+    it('should be able to concat multi byte messages', function () {
+      const rawBufMulti = Buffer.from([0xCE, 0x61, 0x63, 0x63, 0x65, 0x6C, 0x65, 0x72, 0x6F, 0x6D, 0x65, 0x74, 0x65, 0x72, 0x20, 0x65, 0x6E, 0x61, 0x62, 0x6C]);
+      const o = {
+        multiPacketBuffer: rawBufMulti.slice(1).toString()
+      };
+      const rawBufStop = Buffer.from([0xCF, 0x65, 0x64, 0x0A]);
+      const expectedRawBufMulti = Buffer.from([0x61, 0x63, 0x63, 0x65, 0x6C, 0x65, 0x72, 0x6F, 0x6D, 0x65, 0x74, 0x65, 0x72, 0x20, 0x65, 0x6E, 0x61, 0x62, 0x6C, 0x65, 0x64, 0x0A]);
+
+      o.rawDataPacket = rawBufStop;
+      openBCIUtilities.processMultiBytePacket(o);
+      expect(o.multiPacketBuffer.toString()).to.equal(expectedRawBufMulti.toString());
+    });
+  });
   describe('#convertGanglionArrayToBuffer', function () {
     it('should fill the packet with values from data', function () {
       const numChannels = k.numberOfChannelsForBoardType(k.OBCIBoardGanglion);