Merge pull request #94 from aj-ptw/minor-patches

Fix leaked event emitter with time sync, remove extra log statement

Author: AJ Keller

.travis.yml

@@ -3,11 +3,20 @@ node_js:
   - "4.0"
   - "4.1"
   - "4.2"
+  - "4.3"
+  - "4.4"
+  - "4.5"
+  - "4.6"
   - "5.11.0"
   - "6.0"
   - "6.1"
   - "6.2"
   - "6.3"
+  - "6.4"
+  - "6.5"
+  - "6.6"
+  - "6.7"
+  - "6.8"
 install:
   - npm install --all
 script:

changelog.md

@@ -1,3 +1,14 @@
+# 1.3.3
+
+### New Features
+
+* Add `timeOffsetMaster` to object emitted when bad time sync.
+
+### Bug Fixes
+
+* Fixed log statement on impedance setting function
+* Remove event emitter with time sync on reject of sync clock full
+
 # 1.3.2
 
 ### Enhancements

examples/timeSync/timeSync.js

@@ -63,16 +63,16 @@ var sampleFunc = sample => {
     // Resynchronize every every second
     if (sample._count % (sampleRate * 1) === 0) {
         ourBoard.syncClocksFull()
-        .then(syncObj => {
-            // Sync was successful
-            if (syncObj.valid) {
-                // Log the object to check it out!
-                console.log(`timeOffset`,syncObj.timeOffsetMaster);
-            } else {
-                // Retry it
-                console.log(`Was not able to sync... retry!`);
-            }
-        });
+            .then(syncObj => {
+                // Sync was successful
+                if (syncObj.valid) {
+                    // Log the object to check it out!
+                    console.log(`timeOffset`,syncObj.timeOffsetMaster);
+                } else {
+                    // Retry it
+                    console.log(`Was not able to sync... retry!`);
+                }
+            });
     }
 
     if (sample.timeStamp) { // true after the first successful sync

openBCIBoard.js

@@ -176,6 +176,7 @@ function OpenBCIFactory() {
         this._lowerChannelsSampleObject = null;
         this.sync = {
             curSyncObj: null,
+            eventEmitter: null,
             objArray: [],
             sntpActive: false,
             timeOffsetMaster: 0,
@@ -1327,7 +1328,6 @@ function OpenBCIFactory() {
             if (this.options.verbose) console.log('pInput: ' + pInput + ' nInput: ' + nInput);
             // Get impedance settings to send the board
             k.getImpedanceSetter(channelNumber,pInput,nInput).then((commandsArray) => {
-                console.log(commandsArray);
                 this.write(commandsArray);
                 //delayInMS += commandsArray.length * k.OBCIWriteIntervalDelayMSLong;
                 delayInMS += this.commandsToWrite * k.OBCIWriteIntervalDelayMSShort; // Account for commands waiting to be sent in the write buffer
@@ -1564,10 +1564,11 @@ function OpenBCIFactory() {
             if (!this.usingVersionTwoFirmware()) reject('Time sync not implemented on v1 firmware, please update to v2');
             setTimeout(() => {
                 return reject('syncClocksFull timeout after 500ms with no sync');
-            }, 1000); // Should not take more than 1s to sync up
-            this.once('synced',syncObj => {
+            }, 500); // Should not take more than 1s to sync up
+            this.sync.eventEmitter = syncObj => {
                 return resolve(syncObj);
-            });
+            };
+            this.once('synced', this.sync.eventEmitter);
             this.sync.curSyncObj = openBCISample.newSyncObject();
             this.sync.curSyncObj.timeSyncSent = this.time();
             this.curParsingMode = k.OBCIParsingTimeSyncSent;
@@ -1853,7 +1854,9 @@ function OpenBCIFactory() {
                 // Fix the curParsingMode back to normal
                 this.curParsingMode = k.OBCIParsingNormal;
                 // Emit the bad sync object for fun
-                this.emit('synced',openBCISample.newSyncObject());
+                var badObject = openBCISample.newSyncObject();
+                badObject.timeOffsetMaster = this.sync.timeOffsetMaster;
+                this.emit('synced', badObject);
                 // Set back to null
                 this.sync.curSyncObj = null;
                 // Return will exit this method with the err
@@ -1951,6 +1954,12 @@ function OpenBCIFactory() {
                     return resolve(rawPacket);
                 })
                 .catch(err => {
+                    // Emit the bad sync object for fun
+                    var badObject = openBCISample.newSyncObject();
+                    badObject.timeOffsetMaster = this.sync.timeOffsetMaster;
+                    this.emit('synced', badObject);
+                    // Set back to null
+                    this.sync.curSyncObj = null;
                     console.log('Error in _processPacketTimeSyncSet', err)
                     return reject(err);
                 });

openBCISample.js

@@ -707,7 +707,6 @@ function parsePacketTimeSyncedAccel(dataBuf,channelSettingsArray,boardOffsetTime
     return new Promise((resolve, reject) => {
         // The sample object we are going to build
         var sampleObject = {};
-
         if (dataBuf.byteLength != k.OBCIPacketSize) reject("Error [parsePacketTimeSyncedAccel]: input buffer must be " + k.OBCIPacketSize + " bytes!");
 
         // Get the sample number
@@ -803,10 +802,12 @@ function getFromTimePacketTime(dataBuf) {
     // Ths packet has 'A0','00'....,'00','00','FF','FF','FF','FF','C3' where the 'FF's are times
     const lastBytePosition = k.OBCIPacketSize - 1; // This is 33, but 0 indexed would be 32 minus 1 for the stop byte and another two for the aux channel or the
     return new Promise((resolve, reject) => {
-        if (dataBuf.byteLength != k.OBCIPacketSize) reject("Error [getFromTimePacketTime]: input buffer must be " + k.OBCIPacketSize + " bytes!");
-
-        // Grab the time from the packet
-        resolve(dataBuf.readUInt32BE(lastBytePosition - k.OBCIStreamPacketTimeByteSize));
+        if (dataBuf.byteLength != k.OBCIPacketSize) {
+            reject("Error [getFromTimePacketTime]: input buffer must be " + k.OBCIPacketSize + " bytes!");
+        } else {
+            // Grab the time from the packet
+            resolve(dataBuf.readUInt32BE(lastBytePosition - k.OBCIStreamPacketTimeByteSize));
+        }
     });
 }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openbci",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "The official Node.js SDK for the OpenBCI Biosensor Board.",
   "main": "openBCIBoard",
   "scripts": {