Skip to main content
Version: 10.x.x

About SerialPort

Node SerialPort is a JavaScript library for connecting to serial ports that works in NodeJS and Electron.

Quick Answers

Core Packages

The core packages provide cross platform serial port hardware access to a javascript environment (eg, NodeJS and Electron). Chances are you're looking for the serialport package which provides a good set of defaults. However it is quite easy to mix and match the parts of serialport you need.

  • serialport provides a good set of defaults for most projects with a node stream api. It includes cross platform and mock bindings for testing.

Interfaces take a binding interface and provide a different API on top of it. Currently we only ship a Node Stream Interface.

The Bindings provide a common interface to work with your serialport cross platform.

Parser Packages

Parsers are used to take raw binary data and transform them into usable messages. This may include tasks such as converting the data to text, emitting useful chunks of data when they have been fully received, or even validating protocols.

Parsers are traditionally Transform streams, but Duplex streams and other non stream interfaces are acceptable.

Command Line Tools

The Command Line Tools provide helpful utilities for working with serial ports.

Helpful Resources for Getting Started with Node-SerialPort

In addition to reading the article mentioned above, these others might help you:

License

SerialPort is MIT licensed but in order to receive support you must follow our code of conduct which includes a "don't build evil robots" clause.