Adds --list to list available serial ports.

Also exits when there's a serial port error.
mildmojo · Sep 23, 2017 · 71221bb · 71221bb
1 parent ccfbcce
commit 71221bb
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 9 deletions.
diff --git a/index.js b/index.js
@@ -1,6 +1,7 @@
 'use strict';
 const fs = require('fs');
 const {spawn} = require('child_process');
+const SerialPort = require('serialport');
 const nconf = require('nconf');
 const cjson = require('cjson');
 const chalk = require('chalk');
@@ -13,14 +14,13 @@ nconf.set('port', nconf.get('PORT') || nconf.get('port') || 3000)
 nconf.set('testmode', nconf.get('TESTMODE') || nconf.get('testmode'));
 verifyConfig(nconf);
 
-if (nconf.get('version')) {
-  console.log(version);
-  process.exit();
-}
+if (nconf.get('version')) showVersionQuit();
+if (nconf.get('list')) showPortsQuit();
 
 if (nconf.get('help')) {
   console.log('Options:');
   console.log('  --help          - Prints this usage info');
+  console.log('  --list          - Prints available serial ports');
   console.log('  --port n        - Listen port number for HTTP server (default: 3000)');
   console.log("  --testmode      - Simulate serial port activity, don't open real ports");
   console.log('  --wrap-cmd cmd  - Spawn `cmd` as a subprocess; kill server when subprocess dies and vice versa');
@@ -36,6 +36,26 @@ server
   .then(() => nconf.get('wrap-cmd') && spawnChild())
   .catch(console.error);
 
+function showVersionQuit() {
+  console.log(version);
+  process.exit();
+}
+
+function showPortsQuit() {
+  SerialPort.list()
+    .then(portList => {
+      console.log(chalk.yellow.bold("Paste one or more of these serial ports into 'config.json':"));
+      for (let port of portList) {
+        let attrs = Object.keys(port)
+          .filter(key => key !== 'comName')
+          .reduce((sum, key) => port[key] ? sum.concat(`${key}: ${port[key]}`) : sum, []);
+        console.log(chalk.yellow(`"${port.comName}", ` + (attrs.length ? `// ${attrs.join(', ')}` : '')));
+      }
+      process.exit();
+    })
+    .catch(console.error);
+}
+
 function readConfig(file) {
   if (!fs.existsSync('./config.json')) {
     console.warn(chalk.red.bold(`Could not find ${file}. Please copy` +

diff --git a/lib/server.js b/lib/server.js
@@ -70,13 +70,17 @@ function openSerialPorts(portNames, testmode) {
       console.warn(`Error with port ${portName}: ${err}`);
       SerialPort.list()
         .then(portList => {
-          console.log("Make sure you've configured the right ports. Maybe paste" +
-            " one or more of these into 'config.json':");
+          console.log(chalk.yellow.bold("Make sure you've configured the right" +
+            " ports. Maybe paste one or more of these into 'config.json':"));
           for (let port of portList) {
-            let attrs = Object.keys(port).reduce((sum, key) => port[key] ? sum.concat(`${key}: ${port[key]}`) : sum, []);
-            console.log(`"${port.comName}", // ${attrs.join(', ')}`);
+            let attrs = Object.keys(port)
+              .filter(key => key !== 'comName')
+              .reduce((sum, key) => port[key] ? sum.concat(`${key}: ${port[key]}`) : sum, []);
+            console.log(chalk.yellow(`"${port.comName}", ` + (attrs.length ? `// ${attrs.join(', ')}` : '')));
           }
-        });
+          process.exit(1);
+        })
+        .catch(console.error);
     });
 
     return serial;