Response parser now emits events for log, data, and event messages.

Author: jayalfredprufrock

README.md

@@ -1,4 +1,4 @@
 # node-aurora
 Node.js client library for interacting with Aurora Dreamband.
 
-This is not considered stable yet. Please consider this a WIP until 1.0 is released.
+Official documentation coming soon. Until then, consider this package a work in progress, subject to breaking changes.

src/Aurora.js

@@ -198,7 +198,7 @@ class Aurora extends EventEmitter {
 
                         this._processQueue();
 
-                    })
+                    });
 
                 });
 
@@ -298,15 +298,21 @@ class Aurora extends EventEmitter {
 
         }).catch (error => {
 
-            console.log(error)
-
+            console.log(error);
             console.timeEnd('command completed');
 
-            if (this.usbConnected){
-                this._processQueue();
-            }
+            this.cmdCurrent = null;
+
+            this._serial.flush(() => {
+
+                AuroraResponseSerialParser.reset();
+
+                if (this.usbConnected){
+                    this._processQueue();
+                }
+
+            });
 
-            //TODO: understand why I can't just return the error directly here....
             return Promise.reject(error);
         });
 
@@ -318,7 +324,7 @@ class Aurora extends EventEmitter {
 
         if (this.cmdCurrent) {
             this.cmdCurrent.triggerError(-1, "Lost connection to Aurora.");
-            this.cmdCurrent = false;
+            this.cmdCurrent = null ;
         }
 
         this._serial.removeAllListeners();

src/AuroraCmd.js

@@ -18,7 +18,7 @@ export default class AuroraCmd {
     static defaultOptions = {
 
         packetMode: false,                              //commands that return a lot of data can use this mode
-        respWatchdogTimeout: 1000,                      //how long the command has to finish before timing out
+        respWatchdogTimeout: 3000,                      //how long the command has to finish before timing out
         respTypeSuccess: AuroraCmd.RespTypes.ARRAY,     //by default, success response returns array of lines
         respTypeError: AuroraCmd.RespTypes.OBJECT,      //and error returns object { error: #, message: "" }
         respTypeSuccessOptions: {},
@@ -34,9 +34,6 @@ export default class AuroraCmd {
 
         this._reject = function () {};
         this._fulfill = function () {};
-
-        //used to indicate whether response piped to respOutputStream is an error response
-        this.error = false;
     }
 
     //called when a command is added to the processing queue
@@ -117,13 +114,12 @@ export default class AuroraCmd {
         this._setupRespSuccess();
         this._setupRespError();
 
-        this.error = false;
+        this.respSuccessStreamBack.on('data', this._onRespSuccessData);
+        this.respErrorStreamBack.on('data', this._onRespErrorData);
 
-        this.respSuccessStreamBack.on('data', this._onRespSuccessData.bind(this));
-        this.respErrorStreamBack.on('data', this._onRespErrorData.bind(this));
 
-        this.respSuccessStreamBack.on('finish', this._commandResponse.bind(this));
-        this.respErrorStreamBack.on('finish', this._commandResponse.bind(this));
+        this.respSuccessStreamBack.on('finish', this._onSuccess);
+        this.respErrorStreamBack.on('finish', this._onError);
 
         //write command string to input stream,
         Aurora._serial.write(this.toString() + '\n');
@@ -144,25 +140,13 @@ export default class AuroraCmd {
             }, this.options.respWatchdogTimeout);
         }
     }
-    
-    fail() {
-        
-    }
-    
-    succeed() {
-        
-    }
 
     triggerError(errorCode, errorMessage){
 
-        this.error = true;
         this.respTypeError = AuroraCmd.RespTypes.OBJECT;
         this.respError = { error: errorCode, message: errorMessage};
-        
 
-        if (this.respErrorStreamFront){
-            this.respErrorStreamFront.end();
-        }
+        this.respErrorStreamFront.end();
     }
 
     //process response
@@ -203,7 +187,7 @@ export default class AuroraCmd {
         }
     }
 
-    _commandResponse(){
+    _onError(){
 
         clearTimeout(this.respTimer);
 
@@ -212,12 +196,19 @@ export default class AuroraCmd {
         this.respSuccessStreamBack.removeAllListeners();
         this.respErrorStreamBack.removeAllListeners();
 
-        if (this.error) {
-            this._reject(this.respError);
-        }
-        else {
-            this._fulfill(this.respSuccess);
-        }
+        this._reject(this.respError);
+    }
+
+    _onSuccess(){
+
+        clearTimeout(this.respTimer);
+
+        this.respSuccessStreamFront.removeAllListeners();
+        this.respErrorStreamFront.removeAllListeners();
+        this.respSuccessStreamBack.removeAllListeners();
+        this.respErrorStreamBack.removeAllListeners();
+
+        this._fulfill(this.respSuccess);
     }
 
     toString() {

src/AuroraResponseSerialParser.js

@@ -1,8 +1,18 @@
 import EventEmitter from 'events';
 import AuroraConstants from './AuroraConstants';
+import moment from 'moment';
 
 class AuroraResponseSerialParser extends EventEmitter {
 
+    static logTypesToEvents = {
+
+        INFO: 'responseLogInfo',
+        WARN: 'responseLogWarning',
+        ERRO: 'responseLogError',
+        DATA: 'responseLogData',
+        EVNT: 'responseLogEvent'
+    };
+
     constructor() {
 
         super();
@@ -15,7 +25,7 @@ class AuroraResponseSerialParser extends EventEmitter {
         this.unparsedBuffer = null;
         this.responseState = AuroraConstants.ResponseStates.NO_COMMAND;
     }
-git 
+
     parseChunk(chunk) {
 
         //don't do anything if chunk is empty
@@ -62,15 +72,16 @@ git
 
                         if (cmdPromptIndex) {
 
-                            this.emit('response', bufferLine.slice(0, cmdPromptIndex));
+                            this._parseNonCommandResponseLine(bufferLine.slice(0, cmdPromptIndex));
+
                             bufferLine = bufferLine.slice(cmdPromptIndex);
                         }
 
                         this.emit('commandBegin', bufferLine.slice(AuroraConstants.COMMAND_PROMPT.length));
                     }
                     else {
 
-                        this.emit('response', bufferLine);
+                        this._parseNonCommandResponseLine(bufferLine);
                     }
                 }
                 else if (bufferLine.indexOf(AuroraConstants.COMMAND_DIVIDER_SUCCESS_STRING) === 0) {
@@ -190,6 +201,44 @@ git
             }
         }
     }
+
+    _parseNonCommandResponseLine = (line) => {
+
+        if (line.charAt(0) == '<'){
+
+            const logParts = line.match(/\< (WARN|ERRO|INFO|DATA|EVNT) \| (\d{2}:\d{2}:\d{2}\.\d{3}) > (.+)/i);
+
+            if (logParts && logParts.length == 4){
+
+                const logDate = moment(logParts[2], "HH:mm:ss.SSS", true).toDate();
+
+                this.emit(AuroraResponseSerialParser.logTypesToEvents[logParts[1].toUpperCase()], logParts[3], logDate);
+                return;
+            }
+        }
+        else if (line.slice(0, 6) == 'event-'){
+
+            const eventParts = line.match(/event-(\d{1,2}): (\d+)/i);
+
+            if (eventParts && eventParts.length == 3){
+
+                this.emit('responseEvent', +eventParts[1], +eventParts[2]);
+                return;
+            }
+        }
+        else {
+
+            const dataParts = line.split(': ');
+
+            if (dataParts.length == 2) {
+
+                this.emit('responseData', dataParts[0], dataParts[1].split(',').map(Number));
+                return;
+            }
+        }
+
+        this.emit('responseUnknown', line);
+    }
 }
 
 export default new AuroraResponseSerialParser();