serialport
    Overview
    Documentation
    Insights
    Code
    Contributors
    Dependencies
    Alternatives

serialport

Node.js package to access serial ports. Linux, OSX and Windows. Welcome your robotic JavaScript overlords. Better yet, program them!

7.1.5  •  Published 7 months ago  •  by serialport  •  MIT License

Working with serial ports can be hard, this is a collection of projects that make it easier.

Go to https://serialport.io/ to learn more, find guides and api documentation.

Quick Links

Serialport

  • serialport 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.

Interfaces

Interfaces take a binding object and provide a different API on top of it. Currently we only ship a Node 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.

Developing

Developing node serialport projects

  1. Clone this repo git clone git@github.com:node-serialport/node-serialport.git
  2. Run npm install to setup local package dependencies (run this any time you depend on a package local to this repo)
  3. Run npm test to ensure everything is working properly
  4. Run npm run generate to generate a new project
  5. Add dev dependencies to the root package.json and package dependencies to the package’s one.

Developing Docs

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

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

How do you feel about the name Devstore for this site?

Popularity

Weekly Downloads
20.9K
Stars
4.2K

Maintenance

Development

Last ver 7 months ago
Created 9 years ago
Last commit 1 month ago
2 days between commits

Technology

Node version: 10.15.3
52.3K unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

126 contributors
Francis Gulotta
Maintainer, 548 commits, 405 merges, 279 PRs
Works at justworkshr
Ralf Barth
140 commits
Chris Williams
Maintainer, 98 merges, 6 PRs
Works at Emerging Technology Advisors
Jacob Rosenthal
Maintainer, 61 commits, 10 merges, 13 PRs
Greenkeeper
30 commits, 47 PRs
Works at greenkeeperio
greenkeeper[bot]
27 commits

Tags

ccTalk
com port
data logging
hardware
iot
johnny-five
modem
nodebots
RFID
robotics
sensor
serial port
serial
serialport
sms gateway
sms
stream
tty
UART
Ready for the next level?
Join Devstore's founding team to help us build the ultimate open-source app store, work with the latest technologies, and enjoy great culture, impact and autonomy
© 2019 Devstore, Inc.
Devstore helps developers find and use open-source packages, so they can focus on building amazing things