Add support for ganglion, cyton and daisy sample parsing

Author: AJ Keller

openBCIConstants.js

@@ -230,8 +230,9 @@ const obciRadioCmdBaudRateSetFast = 0x06;
 const obciRadioCmdSystemStatus = 0x07;
 
 /** Possible number of channels */
+const obciNumberOfChannelsCyton = 8;
 const obciNumberOfChannelsDaisy = 16;
-const obciNumberOfChannelsDefault = 8;
+const obciNumberOfChannelsDefault = obciNumberOfChannelsCyton;
 const obciNumberOfChannelsGanglion = 4;
 
 /** Possible OpenBCI board types */
@@ -456,14 +457,14 @@ const obciGanglionPacket19Bit = {
   dataStart: 1,
   dataStop: 20
 };
-const obciGanglionMCP3912Gain = 1.0;  // assumed gain setting for MCP3912.  NEEDS TO BE ADJUSTABLE JM
+const obciGanglionMCP3912Gain = 51.0;  // assumed gain setting for MCP3912.  NEEDS TO BE ADJUSTABLE JM
 const obciGanglionMCP3912Vref = 1.2;  // reference voltage for ADC in MCP3912 set in hardware
 const obciGanglionPrefix = 'Ganglion';
 const obciGanglionSyntheticDataEnable = 't';
 const obciGanglionSyntheticDataDisable = 'T';
 const obciGanglionImpedanceStart = 'z';
 const obciGanglionImpedanceStop = 'Z';
-const obciGanglionScaleFactorPerCountVolts = obciGanglionMCP3912Vref / (8388607.0 * obciGanglionMCP3912Gain * 1.5 * 51.0);
+const obciGanglionScaleFactorPerCountVolts = obciGanglionMCP3912Vref / (8388607.0 * obciGanglionMCP3912Gain * 1.5);
 
 /** Simblee */
 const simbleeUuidService = 'fe84';
@@ -484,6 +485,11 @@ const obciNobleEmitterScanStop = 'scanStop';
 const obciNobleEmitterStateChange = 'stateChange';
 const obciNobleStatePoweredOn = 'poweredOn';
 
+/** Protocols */
+const obciProtocolBLE = "ble";
+const obciProtocolSerial = "serial";
+const obciProtocolWifi = "wifi";
+
 module.exports = {
   /** Turning channels off */
   OBCIChannelOff1: obciChannelOff1,
@@ -878,6 +884,7 @@ module.exports = {
   /** Triggers */
   OBCITrigger: obciTrigger,
   /** Possible number of channels */
+  OBCINumberOfChannelsCyton: obciNumberOfChannelsCyton,
   OBCINumberOfChannelsDaisy: obciNumberOfChannelsDaisy,
   OBCINumberOfChannelsDefault: obciNumberOfChannelsDefault,
   OBCINumberOfChannelsGanglion: obciNumberOfChannelsGanglion,
@@ -1170,7 +1177,11 @@ module.exports = {
   isPeripheralGanglion,
   commandSampleRateForCmdCyton,
   commandSampleRateForCmdGanglion,
-  commandBoardModeForMode
+  commandBoardModeForMode,
+  /** Protocols */
+  OBCIProtocolBLE: obciProtocolBLE,
+  OBCIProtocolSerial: obciProtocolSerial,
+  OBCIProtocolWifi: obciProtocolWifi
 };
 
 /**

openBCIUtilities.js

@@ -881,7 +881,7 @@ function newSyncObject () {
  * @description Used transform raw data packets into fully qualified packets
  * @param o {Object}
  * @param o.rawDataPackets {Array} - An array of rawDataPackets
- * @param o.gains {Array}
+ * @param o.channelSettings {Array}
  * @param o.timeOffset {Number} (optional) for non time stamp use cases i.e. 0xC0 or 0xC1 (default and raw aux)
  * @param o.accelArray {Array} (optional) for non time stamp use cases
  * @param o.verbose {Boolean} (optional) for verbose output
@@ -900,22 +900,22 @@ function transformRawDataPacketsToSample (o) {
         case k.OBCIStreamPacketStandardAccel:
           sample = utilitiesModule.parsePacketStandardAccel({
             rawDataPacket,
-            gains: o.gains,
+            channelSettings: o.channelSettings,
             scale: o.scale
           });
           break;
         case k.OBCIStreamPacketStandardRawAux:
           sample = utilitiesModule.parsePacketStandardRawAux({
             rawDataPacket,
-            gains: o.gains,
+            channelSettings: o.channelSettings,
             scale: o.scale
           });
           break;
         case k.OBCIStreamPacketAccelTimeSyncSet:
         case k.OBCIStreamPacketAccelTimeSynced:
           sample = utilitiesModule.parsePacketTimeSyncedAccel({
             rawDataPacket,
-            gains: o.gains,
+            channelSettings: o.channelSettings,
             timeOffset: o.timeOffset,
             accelArray: o.accelArray
           });
@@ -924,7 +924,7 @@ function transformRawDataPacketsToSample (o) {
         case k.OBCIStreamPacketRawAuxTimeSynced:
           sample = utilitiesModule.parsePacketTimeSyncedRawAux({
             rawDataPacket,
-            gains: o.gains,
+            channelSettings: o.channelSettings,
             timeOffset: o.timeOffset
           });
           break;
@@ -948,7 +948,7 @@ function transformRawDataPacketsToSample (o) {
  * @description This method parses a 33 byte OpenBCI V3 packet and converts to a sample object
  * @param o {Object} - The input object
  * @param o.rawDataPacket {Buffer} - The 33byte raw packet
- * @param o.gains {Array} - An array of channel settings that is an Array that has shape similar to the one
+ * @param o.channelSettings {Array} - An array of channel settings that is an Array that has shape similar to the one
  *                  calling k.channelSettingsArrayInit(). The most important rule here is that it is
  *                  Array of objects that have key-value pair {gain:NUMBER}
  * @param o.scale {Boolean} - Do you want to scale the results? Default true
@@ -966,7 +966,7 @@ function parsePacketStandardAccel (o) {
   sampleObject.accelData = getDataArrayAccel(o.rawDataPacket.slice(k.OBCIPacketPositionStartAux, k.OBCIPacketPositionStopAux + 1));
 
   if (k.isUndefined(o.scale) || k.isNull(o.scale)) o.scale = true;
-  if (o.scale) sampleObject.channelData = getChannelDataArray(o.rawDataPacket, o.gains);
+  if (o.scale) sampleObject.channelData = getChannelDataArray(o.rawDataPacket, o.channelSettings);
   else sampleObject.channelDataCounts = getChannelDataArrayNoScale(o.rawDataPacket);
 
   if (k.getVersionNumber(process.version) >= 6) {
@@ -989,7 +989,7 @@ function parsePacketStandardAccel (o) {
  * @description This method parses a 33 byte OpenBCI V3 packet and converts to a sample object
  * @param o {Object} - The input object
  * @param o.rawDataPacket {Buffer} - The 33byte raw packet
- * @param o.gains {Array} - An array of channel settings that is an Array that has shape similar to the one
+ * @param o.channelSettings {Array} - An array of channel settings that is an Array that has shape similar to the one
  *                  calling k.channelSettingsArrayInit(). The most important rule here is that it is
  *                  Array of objects that have key-value pair {gain:NUMBER}
  * @param o.scale {Boolean} - Do you want to scale the results? Default is true
@@ -1007,7 +1007,7 @@ function parsePacketStandardRawAux (o) {
 
   // Store the channel data
   if (k.isUndefined(o.scale) || k.isNull(o.scale)) o.scale = true;
-  if (o.scale) sampleObject.channelData = getChannelDataArray(o.rawDataPacket, o.gains);
+  if (o.scale) sampleObject.channelData = getChannelDataArray(o);
   else sampleObject.channelDataCounts = getChannelDataArrayNoScale(o.rawDataPacket);
 
   // Slice the buffer for the aux data
@@ -1034,7 +1034,7 @@ function parsePacketStandardRawAux (o) {
  *      Z axis data is sent with every sampleNumber % 10 === 2
  * @param o {Object} - The input object
  * @param o.rawDataPacket {Buffer} - The 33byte raw time synced accel packet
- * @param o.gains {Array} - An array of channel settings that is an Array that has shape similar to the one
+ * @param o.channelSettings {Array} - An array of channel settings that is an Array that has shape similar to the one
  *                  calling OpenBCIConstans.channelSettingsArrayInit(). The most important rule here is that it is
  *                  Array of objects that have key-value pair {gain:NUMBER}
  * @param o.timeOffset {Number} - The difference between board time and current time calculated with sync methods.
@@ -1075,24 +1075,22 @@ function parsePacketTimeSyncedAccel (o) {
   }
 
   if (k.isUndefined(o.scale) || k.isNull(o.scale)) o.scale = true;
-  if (o.scale) sampleObject.channelData = getChannelDataArray(o.rawDataPacket, o.gains);
+  if (o.scale) sampleObject.channelData = getChannelDataArray(o.rawDataPacket, o.channelSettings);
   else sampleObject.channelDataCounts = getChannelDataArrayNoScale(o.rawDataPacket);
 
   return sampleObject;
 }
 
 /**
- * @description Grabs an accel value from a raw but time synced packet. Important that this utilizes the fact that:
- *      X axis data is sent with every sampleNumber % 10 === 0
- *      Y axis data is sent with every sampleNumber % 10 === 1
- *      Z axis data is sent with every sampleNumber % 10 === 2
+ * @description Raw aux
  * @param o {Object} - The input object
  * @param o.rawDataPacket {Buffer} - The 33byte raw time synced accel packet
- * @param o.gains {Array} - An array of channel settings that is an Array that has shape similar to the one
+ * @param o.channelSettings {Array} - An array of channel settings that is an Array that has shape similar to the one
  *                  calling k.channelSettingsArrayInit(). The most important rule here is that it is
  *                  Array of objects that have key-value pair {gain:NUMBER}
  * @param o.timeOffset {Number} - The difference between board time and current time calculated with sync methods.
  * @param o.scale {Boolean} - Do you want to scale the results? Default is true
+ * @param o.lastSampleNumber {Number} - The last sample number
  * @returns {Sample} - A sample object. NOTE: The aux data is placed in a 2 byte buffer
  */
 function parsePacketTimeSyncedRawAux (o) {
@@ -1124,7 +1122,7 @@ function parsePacketTimeSyncedRawAux (o) {
 
   // Grab the channel data.
   if (k.isUndefined(o.scale) || k.isNull(o.scale)) o.scale = true;
-  if (o.scale) sampleObject.channelData = getChannelDataArray(o.rawDataPacket, o.gains);
+  if (o.scale) sampleObject.channelData = getChannelDataArray(o);
   else sampleObject.channelDataCounts = getChannelDataArrayNoScale(o.rawDataPacket);
 
   return sampleObject;
@@ -1212,40 +1210,62 @@ function getDataArrayAccel (dataBuf) {
   return accelData;
 }
 /**
-* @description Takes a buffer filled with 24 bit signed integers from an OpenBCI device with gain settings in
-*                  channelSettingsArray[index].gain and converts based on settings of ADS1299... spits out an
-*                  array of floats in VOLTS
-* @param dataBuf {Buffer} - Buffer with 33 bit signed integers, number of elements is same as channelSettingsArray.length * 3
-* @param channelSettingsArray {Array} - The channel settings array, see OpenBCIConstants.channelSettingsArrayInit() for specs
-* @returns {Array} - Array filled with floats for each channel's voltage in VOLTS
-* @author AJ Keller (@pushtheworldllc)
-*/
-function getChannelDataArray (dataBuf, channelSettingsArray) {
-  if (!Array.isArray(channelSettingsArray)) {
+ * @description Takes a buffer filled with 24 bit signed integers from an OpenBCI device with gain settings in
+ *                  channelSettingsArray[index].gain and converts based on settings of ADS1299... spits out an
+ *                  array of floats in VOLTS
+ * @param o {Object} - The input object
+ * @param o.rawDataPacket {Buffer} - The 33byte raw time synced accel packet
+ * @param o.channelSettings {Array} - An array of channel settings that is an Array that has shape similar to the one
+ *                  calling k.channelSettingsArrayInit(). The most important rule here is that it is
+ *                  Array of objects that have key-value pair {gain:NUMBER}
+ * @param o.scale {Boolean} - Do you want to scale the results? Default is true
+ * @param o.lastSampleNumber {Number} - The last sample number
+ * @param o.protocol {String} - Either `Serial` or `Wifi` (Default is `Wifi`)
+ * @returns {Array} - Array filled with floats for each channel's voltage in VOLTS
+ * @author AJ Keller (@pushtheworldllc)
+ */
+function getChannelDataArray (o) {
+  if (!Array.isArray(o.channelSettings)) {
     throw new Error('Error [getChannelDataArray]: Channel Settings must be an array!');
   }
   var channelData = [];
   // Grab the sample number from the buffer
-  var sampleNumber = dataBuf[k.OBCIPacketPositionSampleNumber];
-  var daisy = channelSettingsArray.length > k.OBCINumberOfChannelsDefault;
+  var sampleNumber = o.rawDataPacket[k.OBCIPacketPositionSampleNumber];
+  var daisy = o.channelSettings.length === k.OBCINumberOfChannelsDaisy;
 
   // Channel data arrays are always 8 long
   for (var i = 0; i < k.OBCINumberOfChannelsDefault; i++) {
-    if (!channelSettingsArray[i].hasOwnProperty('gain')) {
+    if (!o.channelSettings[i].hasOwnProperty('gain')) {
       throw new Error(`Error [getChannelDataArray]: Invalid channel settings object at index ${i}`);
     }
-    if (!k.isNumber(channelSettingsArray[i].gain)) {
+    if (!k.isNumber(o.channelSettings[i].gain)) {
       throw new Error('Error [getChannelDataArray]: Property gain of channelSettingsObject not or type Number');
     }
 
-    var scaleFactor = 0;
-    if (isEven(sampleNumber) && daisy) {
-      scaleFactor = ADS1299_VREF / channelSettingsArray[i + k.OBCINumberOfChannelsDefault].gain / (Math.pow(2, 23) - 1);
-    } else {
-      scaleFactor = ADS1299_VREF / channelSettingsArray[i].gain / (Math.pow(2, 23) - 1);
+    let scaleFactor = 0;
+
+    if (o.protocol === k.OBCIProtocolSerial) {
+      if (isEven(sampleNumber) && daisy) {
+        scaleFactor = ADS1299_VREF / o.channelSettings[i + k.OBCINumberOfChannelsDefault].gain / (Math.pow(2, 23) - 1);
+      } else {
+        scaleFactor = ADS1299_VREF / o.channelSettings[i].gain / (Math.pow(2, 23) - 1);
+      }
+    } else if (o.protocol === k.OBCIProtocolWifi) {
+      if (daisy) {
+        if (o.lastSampleNumber === sampleNumber) {
+          scaleFactor = ADS1299_VREF / o.channelSettings[i + k.OBCINumberOfChannelsDefault].gain / (Math.pow(2, 23) - 1);
+        } else {
+          scaleFactor = ADS1299_VREF / o.channelSettings[i].gain / (Math.pow(2, 23) - 1);
+        }
+      } else if (o.channelSettings.length === k.OBCINumberOfChannelsCyton) {
+        scaleFactor = ADS1299_VREF / o.channelSettings[i].gain / (Math.pow(2, 23) - 1);
+      } else {
+        scaleFactor = k.OBCIGanglionScaleFactorPerCountVolts;
+      }
     }
+
     // Convert the three byte signed integer and convert it
-    channelData.push(scaleFactor * utilitiesModule.interpret24bitAsInt32(dataBuf.slice((i * 3) + k.OBCIPacketPositionChannelDataStart, (i * 3) + k.OBCIPacketPositionChannelDataStart + 3)));
+    channelData.push(scaleFactor * utilitiesModule.interpret24bitAsInt32(o.rawDataPacket.slice((i * 3) + k.OBCIPacketPositionChannelDataStart, (i * 3) + k.OBCIPacketPositionChannelDataStart + 3)));
   }
   return channelData;
 }