Node.js package to access serial ports. Linux, OSX and Windows. Welcome your robotic JavaScript overlords. Better yet, program them!
JavaScript C++ Other
Clone or download
reconbot chore: merge serialport-utils into main repo
- integrate the generators
- integrate the docs
- move files into the right location
- update readmes
- lint fix
Latest commit 1523233 Jul 24, 2018
Permalink
Failed to load latest commit information.
.generators chore: merge serialport-utils into main repo Jul 24, 2018
.github chore: merge serialport-utils into main repo Jul 24, 2018
docs chore: merge serialport-utils into main repo Jul 24, 2018
packages chore: merge serialport-utils into main repo Jul 24, 2018
test chore: change to a monorepo structure with Lerna (#1586) Jul 24, 2018
.eslintignore chore: change to a monorepo structure with Lerna (#1586) Jul 24, 2018
.eslintrc chore: change to a monorepo structure with Lerna (#1586) Jul 24, 2018
.gitignore chore: change to a monorepo structure with Lerna (#1586) Jul 24, 2018
.jsdoc.json chore: change to a monorepo structure with Lerna (#1586) Jul 24, 2018
.travis.yml chore: change to a monorepo structure with Lerna (#1586) Jul 24, 2018
CHANGELOG.md chore: merge serialport-utils into main repo Jul 24, 2018
CODE_OF_CONDUCT.md Code of Conduct Apr 10, 2016
CONTRIBUTING.md chore: merge serialport-utils into main repo Jul 24, 2018
LICENSE Pull README edits into the template and JS Doc Jun 19, 2017
README.md chore: merge serialport-utils into main repo Jul 24, 2018
UPGRADE_GUIDE.md chore: merge serialport-utils into main repo Jul 24, 2018
appveyor.yml chore: change to a monorepo structure with Lerna (#1586) Jul 24, 2018
codecov.yml chore: change to a monorepo structure with Lerna (#1586) Jul 24, 2018
lerna.json chore: change to a monorepo structure with Lerna (#1586) Jul 24, 2018
package.json chore: merge serialport-utils into main repo Jul 24, 2018
plopfile.js chore: merge serialport-utils into main repo Jul 24, 2018
test-config.json feat(linux): Custom baud rates for linux (eg 250k baudrate) (#1464) Feb 5, 2018

README.md

Node Serialport

npm Gitter chat Known Vulnerabilities codecov Build Status Build status Greenkeeper badge

Working with serialports can be hard, this is a collection of projects that make it easier. We currently have the following projects.

Quick Answers to Important Questions

Intro to Node-Serialport

Imagine a world where you can write JavaScript to control blenders, lights, security systems, or even robots. That's right—robots! Thanks to Node Serialport, that world is here.

Node-Serialport provides an interface for the low-level serial port code necessary to control Arduino chipsets, X10 interfaces, Zigbee radios, highway signs, lcd screens, cash drawers, motor controllers, sensor packages, fork lifts, modems, drones, CNC machines, plotters, vending machines, ccTalk coin accecptors, SMS Gateways, RFID scanners and much more. If you have a hardware device with a UART we can speak to it. The physical world is your oyster with this goodie.

For a full breakdown of why we made Node-Serialport, please read NodeBots - The Rise of JS Robotics. It explains why one would want to program robots in JS in the first place. It's not being against firmware but we can be better than it.

Developing node serialport projects

  1. Clone this repo git clone git@github.com:node-serialport/node-serialport.git
  2. Run npx lerna bootstrap 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

API Documentation

You can generate the docs by running

npm run docs

And browsing to ./docs/index.html.

License

SerialPort Utilities are all MIT licensed and all it's dependencies are MIT or BSD licensed.