gitmyhub

node-serialport

TypeScript ★ 6.0k updated 5mo ago

Access serial ports with JavaScript. Linux, OSX and Windows. Welcome your robotic JavaScript overlords. Better yet, program them!

A Node.js library for reading and writing data through serial ports, letting JavaScript programs communicate with hardware like Arduino boards, GPS receivers, and industrial sensors on Linux, macOS, and Windows.

TypeScriptNode.jsJavaScriptC++setup: moderatecomplexity 3/5

Serial ports are the communication channel used by many hardware devices, including Arduino microcontrollers, GPS receivers, industrial sensors, and older peripherals. Node Serialport is a Node.js library that lets JavaScript programs send and receive data through these ports on Linux, macOS, and Windows.

The project is organized as a collection of related packages in one repository. Most users start with the serialport package, which bundles everything needed for common use cases. Lower-level packages are also available for developers who need more control over parsing, binding, or stream behavior. Full API documentation and getting-started guides are hosted at serialport.io rather than in the README.

Node Serialport is commonly used in robotics, IoT projects, and any application that needs to communicate with physical hardware from a JavaScript environment. It works in Node.js and also runs inside Electron, making it useful for desktop apps that interface with connected devices.

The project follows a community governance model. Anyone can contribute by opening issues or pull requests. Contributors who participate regularly may be given write access as committers. A small group of maintainers handles technical disputes and oversees the project direction. All packages in the repository are MIT licensed, and the community follows the Nodebots Code of Conduct.

The README is brief and defers most technical content to the external documentation site at serialport.io. Installation is done through npm.

Where it fits