Do you use node-serialport, but don't have your device connected for development or testing?

virtual-serialport provides a virtual drop-in replacement for an actual SerialPort object.

We'll try to keep up to date with the latest node-serialport stable version. For compatibility with older versions of node-serialport you can install an older version of this library.

var SerialPort = require('node-serialport').SerialPort;
if (process.env.NODE_ENV == 'development') {
  SerialPort = require('virtual-serialport');
}

var sp = new SerialPort('/dev/ttyUSB0', { baudrate: 57600 }); // still works if NODE_ENV is set to development!

sp.on('open', function (err) {

  sp.on("data", function(data) {
    console.log("From Arduino: " + data);
  });

  if (process.env.NODE_ENV == 'development') {
    sp.on("dataToDevice", function(data) {
      sp.writeToComputer(data + " " + data + "!");
    });
  }

  sp.write("BLOOP"); // "From Arduino: BLOOP BLOOP!"
});

var VirtualSerialPort = require('virtual-serialport');
var sp = new VirtualSerialPort(path, [opts={}]);

instantiates a virtual SerialPort object. Currently does nothing with the parameters.

var sp = new VirtualSerialPort("/dev/ttyUSB0");
// No device has to actually exist at /dev/ttyUSB0 :)

sp.on("data", function(data) {
	console.log("Computer says, " + data);
});

sp.writeToComputer("BLEEP!"); // "Computer says, BLEEP!"

sp.on("dataToDevice", function(data) {
	console.log("Arduino says, " + data);
});

sp.write("BLOOP!"); // "Arduino says, BLOOP!"

Simulates the port opening. It returns the callback execution and emits the open event on process.nextTick()

Writes data to the virtual device. Equivalent to sp.emit("dataToDevice", data).

Writes data to the virtual device. Equivalent to sp.emit("dataToDevice", data).

Reads data from the virtual device. (The last data written by sp.writeToComputer(data)).

Returns boolean indicating wether the port is open or not. It returns the value of sp.open which you may set manually.

This method is for API compatibility. It actually does nothing here.

This method is for API compatibility. It actually does nothing here.

This method is for API compatibility. It actually does nothing and returns the callback call.

This method is for API compatibility. It actually does nothing and returns the callback call.

This method is for API compatibility. It actually does nothing and returns the callback call.

Runs function once SerialPort is ready, as you would with an actual SerialPort instance.

Act on data sent to the computer, as you would with an actual SerialPort instance.

Act on when readable data ready to be read by the computer, as you would with an actual SerialPort instance.

Writes data to computer. Equivalent to sp.emit("data", data) and sp.emit("readable") Also set data next read by sp.read()

Act on data sent to the device.

node-serialport is listed as an optional dependency. If some version of node-serialport is installed, virtual-serialport will load it's parsers.

For more information about parsers, please refer to the specific version of node-serialport docs.

• move to automated testing (assertions and more)
• better match voodootikigod's node-serialport api