This is a
playground to test code. It runs a full
Node.js environment and already has all of
npm’s 400,000 packages pre-installed, including
serialport with all
npm packages installed. Try it out:
This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.
Go to https://serialport.io/ to learn more, find guides and api documentation.
serialportChances are you're looking for the
serialportpackage which provides a good set of defaults for most projects. However it is quite easy to mix and match the parts of serialport you need.
The Bindings provide a low level interface to work with your serialport. It is possible to use them alone but it's usually easier to use them with an interface.
@serialport/bindingsbindings for Linux, Mac and Windows
@serialport/binding-abstractas an abstract class to use if you're making your own bindings
@serialport/binding-mockfor a mock binding package for testing
Interfaces take a binding object and provide a different API on top of it. Currently we only ship a Node Stream Interface.
@serialport/streamour traditional Node.js Stream interface
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.
git clone email@example.com:serialport/node-serialport.git
npm installto setup local package dependencies (run this any time you depend on a package local to this repo)
npm testto ensure everything is working properly
npm run generateto generate a new project
You can develop the docs by running
npm run docs:dev
And build them by running
npm run docs
Docs are automatically built with netlify including previews on branches. The master branch is deployed to https://serialport.io
SerialPort packages are all MIT licensed and all it's dependencies are MIT licensed.
SerialPort follows the Nodebots Code of Conduct. While the code is MIT licensed participation in the community has some rules to make this a good place to work and learn.
SerialPort is currently employees a governance with a group of maintainers, committers and contributors, all fixing bugs and adding features and improving documentation. You need not apply to work on SerialPort, all are welcome to join, build, and maintain this project.
If you have a PR that improves the project people in any or all of the above people will help you land it.