openbci - npm Package Compare versions

Comparing version 1.2.3 to 1.3.0

changelog.md

@@ -0,1 +1,7 @@
+# 1.3.0
+
+### New Features
+
+* Add dropped packet detection, new event `droppedPacket` can be added to get an array of dropped packet numbers in the case of the dropped packet event.
+
 # 1.2.3
@@ -2,0 +8,0 @@

openBCIConstants.js

@@ -202,2 +202,5 @@ /**
 
+/** Max sample number */
+const OBCISampleNumberMax = 255;
+
 /** Packet Size */
@@ -733,2 +736,4 @@ const OBCIPacketSize = 33;
     OBCISampleRate250,
+    /** Max sample number */
+    OBCISampleNumberMax,
     /** Packet Size */
@@ -735,0 +740,0 @@ OBCIPacketSize,

openBCISample.js

@@ -525,3 +525,38 @@ 'use strict';
     isStopByte,
-    newSyncObject
+    newSyncObject,
+    /**
+     * @description Checks to make sure the previous sample number is one less
+     *  then the new sample number. Takes into account sample numbers wrapping
+     *  around at 255.
+     * @param `previousSampleNumber` {Number} - An integer number of the previous
+     *  sample number.
+     * @param `newSampleNumber` {Number} - An integer number of the new sample
+     *  number.
+     * @returns {Array} - Returns null if there is no dropped packets, otherwise,
+     *  or on a missed packet, an array of their packet numbers is returned.
+     */
+    droppedPacketCheck: (previousSampleNumber, newSampleNumber) => {
+        if (previousSampleNumber === k.OBCISampleNumberMax && newSampleNumber === 0) {
+            return null;
+        }
+
+        if (newSampleNumber - previousSampleNumber === 1) {
+            return null;
+        }
+
+        var missedPacketArray = [];
+
+        if (previousSampleNumber > newSampleNumber) {
+          var numMised = k.OBCISampleNumberMax - previousSampleNumber;
+          for (var i = 0; i < numMised; i++) {
+              missedPacketArray.push(previousSampleNumber + i + 1);
+          }
+          previousSampleNumber = -1;
+        }
+
+        for (var i = 1; i < (newSampleNumber - previousSampleNumber); i++) {
+            missedPacketArray.push(previousSampleNumber + i);
+        }
+        return missedPacketArray;
+    }
 };
@@ -528,0 +563,0 @@

package.json

 {
   "name": "openbci",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "description": "The official Node.js SDK for the OpenBCI Biosensor Board.",
@@ -5,0 +5,0 @@ "main": "openBCIBoard",

README.md

@@ -1043,2 +1043,6 @@ [![Stories in Ready](https://badge.waffle.io/OpenBCI/OpenBCI_NodeJS.png?label=ready&title=Ready)](https://waffle.io/OpenBCI/OpenBCI_NodeJS)
 
+### <a name="event-close"></a> .on('droppedPacket', callback)
+
+Emitted when a packet (or packets) are dropped. Returns an array.
+
 ### <a name="event-error"></a> .on('error', callback)
@@ -1050,3 +1054,3 @@
 
-Emitted when there is a new impedanceArray available.
+Emitted when there is a new impedanceArray available. Returns an array.
 
@@ -1053,0 +1057,0 @@ ### <a name="event-query"></a> .on('query', callback)

No alert changes

Improved metrics

Total package byte prevSize

275030

increased by0.8%

Lines of code

4662

increased by0.89%

Number of lines in readme file

1173

increased by0.34%

No dependency changes