serialport /node-serialport
Access serial ports with JavaScript. Linux, OSX and Windows. Welcome your robotic JavaScript overlords. Better yet, program them!
★ 5,996⑂ 1,007👁 172⑃ 1,288● 1,730▤ 100
+0
Daily
5,996
stars
1,007
forks
172
watchers
1,288
prs
1,730
issues
100
releases
README
Node Serialport Access serial ports with JavaScript. Linux, OSX and Windows. Welcome your robotic JavaScript overlords. Better yet, program them! Go to to learn more, find guides and api documentation. Quick Links - Guides - The serialport package api docs (most people start here) Developing Developing node serialport projects 1. Clone this repo git clone [email protected]:serialport/node-serialport.git 1. Run npm install to setup local package dependencies (run this any time you depend on a package local to this repo) 1. Run npm test to ensure everything is working properly 1. Add dev dependencies to the root package.json and package dependencies to the package's one. Developing Docs See https://github.com/serialport/website License SerialPort packages are all MIT licensed and all it's dependencies are MIT licensed. Code of Conduct 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. TLDR - Be respectful. - Abusive behavior is never tolerated. - Data published to NodeBots is hosted at the discretion of the service administrators, and may be removed. - Don't build evil robots. - Violations of this code may result in swift and permanent expulsion from the NodeBots community. Governance and Community 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. - A Contributor is any individual creating or commenting on an issue or pull request. By participating, this is you. - Committers are contributors who have been given write access to the repository. They can review and merge pull requests. - Maintainers are committers representing the required technical expertise to resolve rare disputes. If you have a PR that improves the project people in any or all of the above people will help you land it. Maintainers - Francis Gulotta | reconbot - Nick Hehr | hipsterbrown Contributors This project exists thanks to all the people who contribute. [Contribute]. Backers Thank you to all our backers! 🙏 [Become a backer] Sponsors Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor] --
Top issues
#2464`No native build was found for platform` when using Electron Forge + Webpack49 comments · 2022-03-25#2266Linux prebuild 9.1.0 not compatible with musl libc48 comments · 2021-06-11#924Changing parity on the fly26 comments · 2016-09-08#2619Error "is not Win32 application" when use electron-builder24 comments · 2023-04-08#1476List symlinks or by ID-path22 comments · 2018-02-13#2344Windows install does not download binaries / Builds broken on node 1720 comments · 2021-11-06#2735Resource temporarily unavailable Cannot lock port17 comments · 2023-12-05#2656Port not closed, process doesn't exit on OpenSuse Tumbleweed with Node v2017 comments · 2023-07-18
Discussions
#3147Why this project is actually abandoned?1 comments · 2026-06-30#3146Use node-serialport in Android web-based application?0 comments · 2026-02-18#3045What happens if `read()` never resolves data?1 comments · 2025-05-30#3022Error Resource temporarily unavailable Cannot lock port0 comments · 2025-04-28#3012Incorrect reading from serial port0 comments · 2025-04-01#3011NPM Install lists quite a number of errors.0 comments · 2025-03-31#2983Parsing list of serialports within nodejs1 comments · 2025-02-17#2981Using serialport inside strict snap confinement on Ubuntu1 comments · 2025-02-06
Latest release
13.0.0 (2024-12-24) v13.0.0 2024-12-24Breaking Changes - Drop Node 16 and 18 - Lots of bug fixes and people to thank from [email protected]. Big thanks to; - @bbeck13 for https://github.com/serialport/node-serialport/pull/2709 - @rotu for https://github.com/serialport/node-serialport/pull/2879 (huge help) - @GazHank for fixing types in https://github.com/serialport/node-serialport/pull/2643 - @glenn-kroeze for https://github.com/serialport/node-serialport/pull/2591