Need private packages and team management tools?Check out npm Teams »

serialport

1.2.1 • Public • Published
  eeeee eeeee eeeee eeee       e  eeeee 
  8   8 8  88 8   8 8          8  8   " 
  8e  8 8   8 8e  8 8eee       8e 8eeee 
  88  8 8   8 88  8 88      e  88    88 
  88  8 8eee8 88ee8 88ee 88 8ee88 8ee88

  eeeee eeee eeeee  e  eeeee e     eeeee eeeee eeeee eeeee 
  8   " 8    8   8  8  8   8 8     8   8 8  88 8   8   8   
  8eeee 8eee 8eee8e 8e 8eee8 8e    8eee8 8   8 8eee8e  8e  
     88 88   88   8 88 88  8 88    88    8   8 88   8  88  
  8ee88 88ee 88   8 88 88  8 88eee 88    8eee8 88   8  88

Version: 1.1.3 - Released July 29, 2013


Imagine a world where you can write JavaScript to control blenders, lights, security systems, or even robots. Yes, I said robots. That world is here and now with node-serialport. It provides a very simple interface to the low level serial port code necessary to program Arduino chipsets, X10 wireless communications, or even the rising Z-Wave and Zigbee standards. The physical world is your oyster with this goodie. For a full break down of why we made this, please read NodeBots - The Rise of JS Robotics.


Robots, you say?

This library is admittedly a base level toolkit for building amazing things with real world (including robots). Here are a couple of those amazing things that leverage node-serialport:

  • firmata Talk natively to Arduino using the firmata protocol.
  • tmpad source - a DIY midi pad using infrared, arduino, and nodejs. Video
  • duino - A higher level framework for working with Arduinos in node.js.
  • Arduino Drinking Game Extravaganza - AKA "The Russian" a hexidecimal drinking game for geeks by Uxebu presented at JSConf EU 2011.
  • Arduino controlling popcorn.js - Controlling a popcorn.js video with an Arduino kit.
  • Robotic JavaScript - The first live presentation of the node-serialport code set as presented at JSConf EU 2010.
  • devicestack - This module helps you to represent a device and its protocol.
  • reflecta A communication protocol that combines Arduino Libraries and NodeJS into an integrated system.

For getting started with node-serialport, we recommend you begin with the following articles:

How To Use

Using node-serialport is pretty easy because it is pretty basic. It provides you with the building block to make great things, it is not a complete solution - just a cog in the (world domination) machine.

To Install

This assumes you have everything on your system necessary to compile ANY native module for Node.js. This may not be the case, though, so please ensure the following are true for your system before filing an issue about "Does not install". For all operatings systems, please ensure you have Python 2.x installed AND not 3.0, node-gyp (what we use to compile) requires Python 2.x.

Windows:

   set path=%path%;C:\Python27
   npm install serialport --msvs_version=2012

This switch works for both Visual Studio Express 2012 and 2013.

Mac OS X:

Ensure that you have at a minimum the xCode Command Line Tools installed appropriate for your system configuration. If you recently upgraded the OS, it probably removed your installation of Command Line Tools, please verify before submitting a ticket.

Desktop (Debian/Ubuntu) Linux:

You know what you need for you system, basically your appropriate analog of build-essential. Keep rocking!

   sudo apt-get install build-essential
   npm install serialport

Raspberry Pi Linux:

  • Starting with a a vanilla New Out of the Box Software (NOOBS) Raspbian image (currently tested: 5/25/2013)
  • Log into your Raspberry Pi through whatever means works best and ensure you are on a terminal prompt for the remaining steps. This could be local or through an SSH (or a serial connection if you like).
  • Issue the following commands to ensure you are up to date:
   sudo apt-get update
   sudo apt-get upgrade -y
  • Download and install node.js:
   wget http://nodejs.org/dist/v0.10.12/node-v0.10.12-linux-arm-pi.tar.gz
   tar xvfz node-v0.10.12-linux-arm-pi.tar.gz
   sudo mv node-v0.10.12-linux-arm-pi /opt/node/
  • Set up your paths correctly:
   echo 'export PATH="$PATH:/opt/node/bin"' >> ~/.bashrc
   source ~/.bashrc
  • Install using npm, note this will take a while as it is actually compiling code and that ARM processor is getting a workout.
   npm install serialport

To Use

Opening a serial port:

var SerialPort = require("serialport").SerialPort
var serialPort = new SerialPort("/dev/tty-usbserial1", {
  baudrate: 57600
});

When opening a serial port, you can specify (in this order).

  1. Path to Serial Port - required.
  2. Options - optional and described below.

The options object allows you to pass named options to the serial port during initialization. The valid attributes for the options object are the following:

  • baudrate: Baud Rate, defaults to 9600. Must be one of: 115200, 57600, 38400, 19200, 9600, 4800, 2400, 1800, 1200, 600, 300, 200, 150, 134, 110, 75, or 50.
  • databits: Data Bits, defaults to 8. Must be one of: 8, 7, 6, or 5.
  • stopbits: Stop Bits, defaults to 1. Must be one of: 1 or 2.
  • parity: Parity, defaults to 'none'. Must be one of: 'none', 'even', 'mark', 'odd', 'space'
  • buffersize: Size of read buffer, defaults to 255. Must be an integer value.
  • parser: The parser engine to use with read data, defaults to rawPacket strategy which just emits the raw buffer as a "data" event. Can be any function that accepts EventEmitter as first parameter and the raw buffer as the second parameter.

Note, we have added support for either all lowercase OR camelcase of the options (thanks @jagautier), use whichever style you prefer.

open event

You MUST wait for the open event to be emitted before reading/writing to the serial port. The open happens asynchronously so installing 'data' listeners and writing before the open event might result in... nothing at all.

Assuming you are connected to a serial console, you would for example:

serialPort.on("open", function () {
  console.log('open');
  serialPort.on('data', function(data) {
    console.log('data received: ' + data);
  });  
  serialPort.write("ls\n", function(err, results) {
    console.log('err ' + err);
    console.log('results ' + results);
  });  
});

You can also call the open function, in this case instanciate the serialport with an additional flag.

var SerialPort = require("serialport").SerialPort
var serialPort = new SerialPort("/dev/tty-usbserial1", {
  baudrate: 57600
}, false); // this is the openImmediately flag [default is true]
 
serialPort.open(function () {
  console.log('open');
  serialPort.on('data', function(data) {
    console.log('data received: ' + data);
  });  
  serialPort.write("ls\n", function(err, results) {
    console.log('err ' + err);
    console.log('results ' + results);
  });  
});

List Ports

You can also list the ports along with some metadata as well.

serialport.list(function (err, ports) {
  ports.forEach(function(port) {
    console.log(port.comName);
    console.log(port.pnpId);
    console.log(port.manufacturer);
  });
});

Parsers

Out of the box, node-serialport provides two parsers one that simply emits the raw buffer as a data event and the other which provides familiar "readline" style parsing. To use the readline parser, you must provide a delimiter as such:

var serialport = require("serialport");
var SerialPort = serialport.SerialPort; // localize object constructor
 
var sp = new SerialPort("/dev/tty-usbserial1", { 
  parser: serialport.parsers.readline("\n") 
});

To use the raw parser, you just provide the function definition (or leave undefined):

var serialport = require("serialport");
var SerialPort = serialport.SerialPort; // localize object constructor
 
var sp = new SerialPort("/dev/tty-usbserial1", { 
  parser: serialport.parsers.raw
});

You can get updates of new data from the Serial Port as follows:

serialPort.on("data", function (data) {
  sys.puts("here: "+data);
});

You can write to the serial port by sending a string or buffer to the write method as follows:

serialPort.write("OMG IT WORKS\r");

Enjoy and do cool things with this code.