About SerialPort
Quick Answers to Important Questions
- For support, open a GitHub issue.
- To contribute, please review our contribution guide and Code of Conduct. We also have issues tagged "good first PR", if you'd like to start somewhere specific. We'll do our best to support you until we merge your PR.
Helpful Resources for Getting Started with Node-Serialport
In addition to reading the article mentioned above, these others might help you:
- Johnny-Five: The Johnny-Five Robotics and IoT platform's six-line "Hello World" (awesome).
- Arduino Node Security Sensor Hacking: A great all-around "how do I use this" article.
Packages
Chances are you're looking for the serialport package 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.
Bindings
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
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
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.
@serialport/parser-byte-length@serialport/parser-cctalk@serialport/parser-delimiter@serialport/parser-readline@serialport/parser-ready@serialport/parser-regex@serialport/parser-slip-encoder
Command Line Tools
The Command Line Tools provide helpful utilities for working with serial ports.
License
SerialPort is MIT licensed and all it's dependencies are MIT licensed.