Documentation and code

back-end/boards.js

@@ -1,7 +1,7 @@
 "use strict";
 
 const log = require("./logger");
-const delay = require("./utilities").delay;
+const { delay } = require("./utilities");
 
 const FLASH_MODES = {
     qio: 0,
@@ -61,7 +61,8 @@ class EspBoard {
 }
 
 /**
- * Tested: Adafruit Huzzah
+ * Tested: Adafruit Feather Huzzah
+ * Needs testing: Adafruit Huzzah, SparkFun Thing, SparkFun Thing Dev Board
  */
 class Esp12 extends EspBoard {
     constructor(port) {

back-end/rom_comm.js

@@ -5,9 +5,7 @@ const SerialPort = require("serialport").SerialPort;
 const log = require("./logger");
 const slip = require("./streams/slip");
 const boards = require("./boards");
-const delay = require("./utilities").delay;
-const repeatPromise = require("./utilities").repeatPromise;
-const promiseChain = require("./utilities").promiseChain;
+const { delay, repeatPromise, promiseChain }  = require("./utilities");
 
 
 const commands = {

back-end/serial_scanner.js

@@ -15,7 +15,7 @@ module.exports = class SerialScanner extends EventEmitter {
                     this.emit("ports", this.ports);
                 });
             }
-        )
+        );
     }
 
     /**
@@ -33,7 +33,7 @@ module.exports = class SerialScanner extends EventEmitter {
                     this.ports = newPorts;
                 });
             }
-        )
+        );
     }
 
     /**

back-end/utilities.js

@@ -2,6 +2,12 @@
 
 const log = require("./logger");
 
+/**
+ * Creates delays in time. Ideal for gaurenteeing time between executions
+ * between {Promise} resolve handlers.
+ * @param time in milliseconds
+ * @returns {Promise}
+ */
 function delay(time) {
     return new Promise((resolve) => {
         log.info("Delaying for %d ms", time);
@@ -10,8 +16,10 @@ function delay(time) {
 }
 
 /**
- * Repeats a promise for `times` amount.
- * `callback` is a no parameter based function that **returns** a Promise.
+ * Repeats a promise a given number of times.
+ * @param times. The number of times to repeat a given promise.
+ * @param callback is a no parameter based function that returns a {Promise}.
+ * @returns {Promise}
  */
 function repeatPromise(times, callback) {
     let chain = Promise.resolve();

front-end/js/app.js

@@ -4,7 +4,7 @@
 const SerialScanner = require("../back-end/serial_scanner");
 const PortSelect = require("./js/port_select");
 
-function $(id) { return document.getElementById(id) }
+function $(id) { return document.getElementById(id); }
 
 const flashButton = $("flash-button");
 const appStatus = $("status");

front-end/js/port_select.js

@@ -58,4 +58,4 @@ module.exports = class PortSelect {
     set disabled (value) {
         this.selectElement.disabled = value;
     }
-}
+};