Expose a serial port over a instance
Last updated 4 years ago by pghalliday .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install 
SYNC missed versions from official npm registry.

Expose a serial port over a instance. Particular thanks go to the serialport, and hterm projects.


npm install --save
npm install --save

Then to connect to a serial port and open it (note that the options field is passed directly to the serialport instance, however the autoOpen option will always be forced to false)

const Server = require('');
const SerialPort = require('');

const io = new Server(8080);

const serialport = new SerialPort({
  io: io,
  route: '/port/ttyS0',
  captureFile: '/var/log/serialport/ttyS0',
  retryPeriod: 1000,
  device: '/dev/ttyS0',
  options: {
    baudrate: 115200
.then(() => {
  console.log('port opened');

  // And when done (shutting down, etc)
  .then(() => {
    console.log('port closed');

Then connect clients to the following endpoint

var io = require('');

var ttyS0 = io('http://localhost:8080/port/ttyS0');

with the instance you can just use data events

// listen for data from the serial port
ttyS0.on('data', function(data) {

// Send some data to the serial port
ttyS0.emit('data', 'pwd\n');

Or connect clients to use streams

// Create a duplex stream
var ttyS0Stream = ss.createStream();

// listen for data from the serial port
ttyS0Stream.on('data', function(data) {

// Notify the server with a `stream` event to setup
// a duplex stream at the other end which will
// pipe to and from the serial port
ss(ttyS0).emit('stream', ttyS0Stream);

// Send some data to the serial port

or both :)

Handling serial port disconnects, etc

Events will be emitted when the state of the remote serial port changes. You can use these events to notify a user, etc.

Also on initial connection of the socket an event should be received giving the current status of the port.

ttyS0.on('status', function(status) {

where status will be one of

  • {status: 'open'} - the port is open
  • {status: 'closing'} - the port is closing after calling #close
  • {status: 'closed'} - the port is closed after calling #close
  • {status: 'disconnected', error: error} - the port disconnected and should be reopened after the retryPeriod
  • {status: 'opening', error: error} - the port is opening, the error field will be set if it is reopening after an error

Current Tags

  • 2.0.1                                ...           latest (4 years ago)

3 Versions

  • 2.0.1                                ...           4 years ago
  • 2.0.0                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
Maintainers (1)
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (3)
Dev Dependencies (1)

Copyright 2014 - 2016 © |