Add interactive prompt for installation

.npmignore

@@ -0,0 +1 @@
+assets/

README.md

@@ -91,6 +91,13 @@ As a convenience, if you would like to install StandardFirmata you can do so by:
 interchange install StandardFirmata -a <board> -p <port>
 ```
 
+For an interactive interface that will prompt you with choices for each option, use
+```
+interchange install --interactive
+```
+
+![Interactive CLI demo](https://github.com/ajfisher/nodebots-interchange/raw/master/assets/interchange.gif)
+
 ### Usage examples
 
 Get help:

bin/cli.js

@@ -3,6 +3,7 @@
 var program = require('commander');
 var version = require('../package.json').version;
 var Interchange = require('../lib/interchange');
+var Inquire = require('../lib/inquire');
 var interchange = new Interchange();
 
 program
@@ -32,6 +33,13 @@ program.command("install [firmware]")
     .option("-p, --port <port>", "Serial port board is attached to")
     .option("-f, --firmata [firmata]", "Install firmata version of firmware")
     .option("-i, --address <address>", "Specify I2C address, eg 0x67")
-    .action(interchange.install_firmware.bind(interchange));
+    .option("--interactive", "Interactive mode will prompt for input")
+    .action(function (firmware, opts) {
+        if (opts.interactive) {
+            var inquire = new Inquire(interchange.install_firmware.bind(interchange));
+        } else {
+            interchange.install_firmware(firmware, opts);
+        }
+    });
 
 program.parse(process.argv);

lib/inquire.js

@@ -0,0 +1,107 @@
+var inquirer = require('inquirer');
+var Interchange = require('../lib/interchange');
+var Inquire = require('../lib/inquire');
+var firmwares = require('../lib/firmwares.json').firmwares;
+
+var Inquire = function (cb) {
+
+    this.interchange = new Interchange();
+
+    this.callback = cb;
+
+    this.interchange.get_ports(function (err, ports) {
+
+        if (err) {
+            console.error(err);
+            return;
+        }
+
+        this.promptQuestions(ports);
+
+    }.bind(this));
+
+};
+
+Inquire.prototype.promptQuestions = function (ports) {
+
+    var questions = [
+        {
+            type: "list",
+            name: "firmware",
+            message: "Choose a firmware",
+            choices: this.interchange.firmwares.map(function (el) {
+                return el.name
+            })
+        },
+        {
+            type: "confirm",
+            name: "firmata",
+            message: "Install firmata version?",
+            default: function (answers) {
+                return answers.firmware.indexOf('Firmata') > -1;
+            },
+            when: function (answers) {
+                var firmware = firmwares.filter(function(obj) {
+                    return obj.name === answers.firmware
+                });
+
+                return firmware.length && firmware[0].firmata && answers.firmware.indexOf('Firmata') === -1;
+            }
+        },
+        {
+            type: "input",
+            name: "firmataType",
+            message: "Firmata name [optional]",
+            default: null,
+            when: function (answers) {
+                return answers.firmata;
+            }
+        },
+        {
+            type: "list",
+            name: "avr",
+            message: "Choose a board",
+            choices: [
+                "uno",
+                "nano",
+                "promini",
+            ],
+            default: "nano"
+        },
+        {
+            type: "list",
+            name: "port",
+            message: "Choose a port",
+            choices: ports.map(function (el) {
+                return el.comName;
+            }),
+            default: null
+        },
+        {
+            type: "input",
+            name: "address",
+            message: "Choose an I2C address [optional]",
+            default: null,
+            when: function (answers) {
+                return !answers.firmata && answers.firmware.indexOf('Firmata') === -1;
+            }
+        }
+    ];
+
+    inquirer.prompt(questions, function(answers) {
+        var firmware = answers.firmware;
+        var opts = {
+            board : answers.avr,
+            port : answers.port,
+            address : answers.address,
+            firmata : answers.firmataType || answers.firmata
+        };
+
+        if (this.callback && typeof this.callback === 'function') {
+            this.callback(firmware, opts);
+        }
+    }.bind(this));
+
+};
+
+module.exports = Inquire;

lib/interchange.js

@@ -21,6 +21,8 @@ var fw = null; // used to hold details of the firmware we want in it.
 
 var Interchange = function () {
 
+    this.firmwares = firmwares;
+
 };
 
 Interchange.prototype.clean_temp_dir = function (tmpdir) {
@@ -44,12 +46,18 @@ Interchange.prototype.list_devices = function () {
     });
 };
 
+Interchange.prototype.get_ports = function (cb) {
+    Serialport.list(function (err, ports) {
+        cb(err, ports);
+    });
+};
+
 Interchange.prototype.list_ports = function (opts) {
     // this function lists out all the ports available to flash firmware
 
     var verbose = opts.verbose;
 
-    Serialport.list(function (err, ports) {
+    this.get_ports(function (err, ports) {
         if (err) {
             console.error(err);
             return;
@@ -345,7 +353,7 @@ Interchange.prototype.check_firmware = function (firmware, options, cb) {
     // to a temporary location
 
     var board = options.board || "nano"; // assumes nano if none provided
-    var useFirmata = (firmware.indexOf('Firmata') > 0) || (options.firmata != null) || false;
+    var useFirmata = (firmware.indexOf('Firmata') > 0) || options.firmata || false;
     var firmataName = options.firmata || "";
     // check for default where no firmata name is supplied or default is implied.
     if (firmataName === true) {

package.json

@@ -39,6 +39,7 @@
     "commander": "^2.9.0",
     "download": "^4.4.1",
     "fs-extra": "^0.24.0",
+    "inquirer": "^0.11.0",
     "lodash": "^3.10.1",
     "minimist": "^1.2.0",
     "serialport": "^2.0.2",