chore: Upgrade SerialPort

SerialPort v8 brings support for the latest versions of node and electron. The api has had two major breaking changes. `.list()` no longer takes a callback and only returns a promise. And the `PortInfo` object now has `path` instead of `comName`. This would probably be a breaking change for Firmata as well.
firmata · Dec 28, 2019 · 1ccfac8 · 1ccfac8
1 parent a38f464
commit 1ccfac8
Show file tree

Hide file tree

Showing 24 changed files with 231 additions and 254 deletions.
diff --git a/packages/firmata-io/lib/firmata.js b/packages/firmata-io/lib/firmata.js
@@ -2427,15 +2427,15 @@ class Firmata extends Emitter {
   }
 
   /**
-   * Firmata.isAcceptablePort Determines if a `port` object (from SerialPort.list(...))
+   * Firmata.isAcceptablePort Determines if a `port` object (from SerialPort.list())
    * is a valid Arduino (or similar) device.
    * @return {Boolean} true if port can be connected to by Firmata
    */
 
   static isAcceptablePort(port) {
     let rport = /usb|acm|^com/i;
 
-    if (rport.test(port.comName)) {
+    if (rport.test(port.path)) {
       return true;
     }
 
@@ -2452,22 +2452,18 @@ class Firmata extends Emitter {
       process.nextTick(() => {
         callback(new Error("No Transport provided"), null);
       });
-    } else {
-      Transport.list((error, ports) => {
-        const port = ports.find(port => Firmata.isAcceptablePort(port) && port);
-
-        /* istanbul ignore if */
-        if (error) {
-          callback(error, null);
-        } else {
-          if (port) {
-            callback(null, port);
-          } else {
-            callback(new Error("No Acceptable Port Found"), null);
-          }
-        }
-      });
+      return
     }
+    Transport.list().then((ports) => {
+      const port = ports.find(port => Firmata.isAcceptablePort(port) && port);
+      if (port) {
+        callback(null, port);
+      } else {
+        callback(new Error("No Acceptable Port Found"), null);
+      }
+    }).catch(error => {
+      callback(error, null);
+    });
   }
 
   // Expose encode/decode for custom sysex messages

diff --git a/packages/firmata-io/readme.md b/packages/firmata-io/readme.md
@@ -10,7 +10,7 @@ Install Firmata-io:
 npm install firmata-io --save
 ```
 
-Install a Transport: 
+Install a Transport:
 
 
 ```sh
@@ -30,11 +30,11 @@ Here's an example using the `Serialport` class:
 
 ```js
 // Require your Transport!
-const Serialport = require("serialport"); 
-// Pass the Transport class to the transport binding 
+const Serialport = require("serialport");
+// Pass the Transport class to the transport binding
 // function exported by firmata-io. The transport binding
 // function will return the Firmata class object with
-// the Transport class bound in its scope. 
+// the Transport class bound in its scope.
 const Firmata = require("firmata-io")(Serialport);
 
 Firmata.requestPort((error, port) => {
@@ -43,7 +43,7 @@ Firmata.requestPort((error, port) => {
     return;
   }
 
-  const board = new Firmata(port.comName);
+  const board = new Firmata(port.path);
 
   board.on("close", () => {
     // Unplug the board to see this event!
@@ -59,15 +59,15 @@ Here's an example using a `Serialport` instance:
 ```js
 // Require your Transport!
 const Serialport = require("serialport");
-// Get the Firmata class without a bound transport. 
+// Get the Firmata class without a bound transport.
 const Firmata = require("firmata-io").Firmata;
 
 Serialport.list().then(ports => {
   // Figure which port to use...
   const port = ports.find(port => port.manufacturer.startsWith("Arduino"));
-  
+
   // Instantiate an instance of your Transport class
-  const transport = new Serialport(port.comName);
+  const transport = new Serialport(port.path);
 
   // Pass the new instance directly to the Firmata class
   const board = new Firmata(transport);

diff --git a/packages/firmata.js/examples/adxl345.js b/packages/firmata.js/examples/adxl345.js
@@ -12,7 +12,7 @@ Board.requestPort((error, port) => {
     READ: 0xB2,
   };
 
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   board.on("ready", function() {
     console.log("Ready");

diff --git a/packages/firmata.js/examples/blink.js b/packages/firmata.js/examples/blink.js
@@ -6,7 +6,7 @@ Board.requestPort((error, port) => {
     return;
   }
 
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   board.on("ready", () => {
     const pin = 13;

diff --git a/packages/firmata.js/examples/close-events.js b/packages/firmata.js/examples/close-events.js
@@ -6,7 +6,7 @@ Board.requestPort((error, port) => {
     return;
   }
 
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   board.on("close", () => {
     // Unplug the board to see this event!

diff --git a/packages/firmata.js/examples/hw-serial-read-gps.js b/packages/firmata.js/examples/hw-serial-read-gps.js
@@ -6,7 +6,7 @@ Board.requestPort((error, port) => {
     return;
   }
 
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   board.on("ready", () => {
     console.log("READY");

diff --git a/packages/firmata.js/examples/johnny-five-io-plugin.js b/packages/firmata.js/examples/johnny-five-io-plugin.js
@@ -2,8 +2,8 @@ const SerialPort = require("serialport");
 const five = require("johnny-five");
 const Firmata = require("../");
 
-SerialPort.list((error, list) => {
-  const device = list.reduce((accum, item) => {
+SerialPort.list().then(ports => {
+  const device = ports.reduce((accum, item) => {
     if (item.manufacturer.indexOf("Arduino") === 0) {
       return item;
     }
@@ -17,7 +17,7 @@ SerialPort.list((error, list) => {
    */
 
   const board = new five.Board({
-    io: new Firmata(device.comName)
+    io: new Firmata(device.path)
   });
 
   board.on("ready", () => {

diff --git a/packages/firmata.js/examples/k22.js b/packages/firmata.js/examples/k22.js
@@ -10,7 +10,7 @@ Board.requestPort((error, port) => {
     console.log(error);
     return;
   }
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   board.on("ready", () => {
     const k22 = 0x68;

diff --git a/packages/firmata.js/examples/mma8452.js b/packages/firmata.js/examples/mma8452.js
@@ -12,7 +12,7 @@ Board.requestPort((error, port) => {
     READ_X_MSB: 0x01,
   };
 
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
   // var board = new Board("/dev/cu.usbmodem1411");
 
   board.on("ready", function() {

diff --git a/packages/firmata.js/examples/reporting.js b/packages/firmata.js/examples/reporting.js
@@ -5,7 +5,7 @@ Board.requestPort((error, port) => {
     console.log(error);
     return;
   }
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   board.on("ready", function() {
     const a = 6;

diff --git a/packages/firmata.js/examples/servosweep.js b/packages/firmata.js/examples/servosweep.js
@@ -5,7 +5,7 @@ Board.requestPort((error, port) => {
     console.log(error);
     return;
   }
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   board.on("ready", () => {
     let degrees = 10;

diff --git a/packages/firmata.js/examples/stepper-accel.js b/packages/firmata.js/examples/stepper-accel.js
@@ -6,7 +6,7 @@ Board.requestPort((error, port) => {
     return;
   }
 
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   board.on("ready", () => {
 

diff --git a/packages/firmata.js/examples/stepper-driver.js b/packages/firmata.js/examples/stepper-driver.js
@@ -6,7 +6,7 @@ Board.requestPort((error, port) => {
     return;
   }
 
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   board.on("ready", () => {
 

diff --git a/packages/firmata.js/examples/stepper-multi.js b/packages/firmata.js/examples/stepper-multi.js
@@ -6,7 +6,7 @@ Board.requestPort((error, port) => {
     return;
   }
 
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   board.on("ready", () => {
 

diff --git a/packages/firmata.js/examples/stepper-three-wire.js b/packages/firmata.js/examples/stepper-three-wire.js
@@ -6,7 +6,7 @@ Board.requestPort(function(error, port) {
     return;
   }
 
-  var board = new Board(port.comName);
+  var board = new Board(port.path);
 
   board.on("ready", function() {
 

diff --git a/packages/firmata.js/examples/sw-serial-read-gps.js b/packages/firmata.js/examples/sw-serial-read-gps.js
@@ -5,7 +5,7 @@ Board.requestPort((error, port) => {
     console.log(error);
     return;
   }
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   board.on("ready", () => {
     console.log("READY");

diff --git a/packages/firmata.js/examples/test-analog-read.js b/packages/firmata.js/examples/test-analog-read.js
@@ -6,7 +6,7 @@ Board.requestPort((error, port) => {
     return;
   }
 
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   console.log(__filename);
   console.log("------------------------------");

diff --git a/packages/firmata.js/examples/test-i2c-read.js b/packages/firmata.js/examples/test-i2c-read.js
@@ -6,7 +6,7 @@ Board.requestPort((error, port) => {
     return;
   }
 
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   console.log(__filename);
   console.log("------------------------------");

diff --git a/packages/firmata.js/examples/test-serial-read.js b/packages/firmata.js/examples/test-serial-read.js
@@ -6,7 +6,7 @@ Board.requestPort((error, port) => {
     return;
   }
 
-  const board = new Board(port.comName);
+  const board = new Board(port.path);
 
   console.log(__filename);
   console.log("------------------------------");