Merge pull request #158 from aj-ptw/sync-chan-set

Sync chan set

Author: AJ Keller

README.md

@@ -1069,6 +1069,12 @@ ourBoard.connect(portName)
 
 ```
 
+#### <a name="method-sync-register-settings"></a> .syncRegisterSettings()
+
+Syncs the internal channel settings object with a cyton, this will take about over a second because there are delays between the register reads in the firmware.
+
+**_Returns_** a promise, fulfilled once the channel settings have been synced and reject on error.
+
 #### <a name="method-test-signal"></a> .testSignal(signal)
 
 Apply the internal test signal to all channels.

changelog.md

@@ -1,3 +1,10 @@
+# 2.1.3
+
+### Enhancements
+
+* Can now sync the channel settings from the actual registers on the ADS! Call `.syncRegisterSettings()`
+* Bumped openbci-utilities to v0.1.4
+
 # 2.1.2
 
 ### Enhancements

openBCICyton.js

@@ -1184,13 +1184,40 @@ Cyton.prototype.getSettingsForChannel = function (channelNumber) {
 };
 
 /**
- * @description To print out the register settings to the console
- * @returns {Promise.<T>|*}
+ * @description Syncs the internal channel settings object with a cyton, this will take about
+ *  over a second because there are delays between the register reads in the firmware.
+ * @returns {Promise.<T>|*} Resolved once synced, rejects on error or 2 second timeout
  * @author AJ Keller (@pushtheworldllc)
  */
-Cyton.prototype.printRegisterSettings = function () {
-  return this.write(k.OBCIMiscQueryRegisterSettings).then(() => {
-    this.curParsingMode = k.OBCIParsingChannelSettings;
+Cyton.prototype.syncRegisterSettings = function () {
+  // Set a timeout. Since poll times can be max of 255 seconds, we should set that as our timeout. This is
+  //  important if the module was connected, not streaming and using the old firmware
+  let badCommsTimeout;
+  return new Promise((resolve, reject) => {
+    badCommsTimeout = setTimeout(() => {
+      reject(Error('Please make sure your radio system is up'));
+    }, 2500);
+    // Subscribe to the EOT event
+    this.once(k.OBCIEmitterEot, data => {
+      if (this.options.verbose) console.log(data.toString());
+      this._rawDataPacketToSample.data = data;
+      try {
+        obciUtils.syncChannelSettingsWithRawData(this._rawDataPacketToSample);
+        resolve();
+      } catch (e) {
+        reject(e);
+      }
+      // Remove the timeout!
+      clearTimeout(badCommsTimeout);
+      badCommsTimeout = null;
+    });
+    this.curParsingMode = k.OBCIParsingEOT;
+
+    this.write(k.OBCIMiscQueryRegisterSettings)
+      .catch((err) => {
+        clearTimeout(badCommsTimeout);
+        reject(err);
+      });
   });
 };
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openbci",
-  "version": "2.1.2",
+  "version": "2.1.3",
   "description": "The official Node.js SDK for the OpenBCI Biosensor Board.",
   "main": "index.js",
   "scripts": {
@@ -21,7 +21,7 @@
     "gaussian": "^1.0.0",
     "lodash": "^4.17.4",
     "mathjs": "^3.14.2",
-    "openbci-utilities": "0.1.2",
+    "openbci-utilities": "^0.1.4",
     "performance-now": "^2.1.0",
     "safe-buffer": "^5.1.1",
     "serialport": "4.0.7",