Skip to content

Commit 4bccb62

Browse files
committed
chore: move parsers to their new packages and clean up docs
1 parent 8a13e9f commit 4bccb62

40 files changed

+96
-2979
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,17 @@ We're not against firmware but we're better than it.
2020

2121
## Quick Answers to Important Questions
2222
- [**API Docs**](https://node-serialport.github.io/node-serialport/)
23+
- [Parsers API Docs](https://node-serialport.github.io/parsers/)
2324
- **For support**, open a [GitHub issue](https://github.com/node-serialport/node-serialport/issues/new).
2425
- **For discussions, design ideas, and clarifications**, please join our [Gitter chat room](https://gitter.im/EmergingTechnologyAdvisors/node-serialport).
25-
- **To test Node-Serialport**, we recommend two related projects—[Browser Serialport](https://github.com/garrows/browser-serialport) ("just like Node Serialport, but for browser apps") and [Serialport Test Piliot](https://github.com/j5js/serialport-test-pilot).
2626
- **To contribute**, please review our [contribution guide](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md). You might want to check out our [roadmap](https://github.com/node-serialport/node-serialport/issues/746). We also have issues tagged ["good first PR"](https://github.com/node-serialport/node-serialport/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+pr%22), if you'd like to start somewhere specific. We'll do our best to support you until we merge your PR.
2727

2828
***
2929

3030
## API Documentation
3131

32-
Can be found at https://node-serialport.github.io/node-serialport/
32+
- [API Docs](https://node-serialport.github.io/parsers/)
33+
- [Parsers API Docs](https://node-serialport.github.io/parsers/)
3334

3435
See our [changelog](CHANGELOG.md) for what's new, and our [upgrade guide](UPGRADE_GUIDE.md) for a walk-through on differences between major versions.
3536

@@ -43,6 +44,8 @@ npm run docs
4344

4445
And browsing to `./docs/index.html`.
4546

47+
Parsers have been spun out in to their own [GitHub Repo](https://github.com/node-serialport/parsers).
48+
4649
***
4750
## Helpful Resources for Getting Started with Node-Serialport
4851

@@ -69,7 +72,7 @@ In addition to reading the [article mentioned above](http://www.voodootikigod.co
6972
* [Testing](#testing)
7073
* [Debugging](#debugging)
7174
* [Error Handling](#error-handling)
72-
d* [Command Line Tools](#command-line-tools)
75+
* [Command Line Tools](#command-line-tools)
7376
* [Serial Port List](#serial-port-list)
7477
* [Srial Port Terminal](#serial-port-terminal)
7578
* [Serial Port Repl](#serial-port-repl)

docs/BaseBinding.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<label for="nav-trigger" class="overlay"></label>
2323

2424
<nav>
25-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BaseBinding.html">BaseBinding</a><ul class='methods'><li data-type='method'><a href="BaseBinding.html#.list">list</a></li><li data-type='method'><a href="BaseBinding.html#close">close</a></li><li data-type='method'><a href="BaseBinding.html#drain">drain</a></li><li data-type='method'><a href="BaseBinding.html#flush">flush</a></li><li data-type='method'><a href="BaseBinding.html#get">get</a></li><li data-type='method'><a href="BaseBinding.html#getBaudRate">getBaudRate</a></li><li data-type='method'><a href="BaseBinding.html#open">open</a></li><li data-type='method'><a href="BaseBinding.html#read">read</a></li><li data-type='method'><a href="BaseBinding.html#set">set</a></li><li data-type='method'><a href="BaseBinding.html#update">update</a></li><li data-type='method'><a href="BaseBinding.html#write">write</a></li></ul></li><li><a href="ByteLengthParser.html">ByteLengthParser</a></li><li><a href="CCTalkParser.html">CCTalkParser</a></li><li><a href="DelimiterParser.html">DelimiterParser</a></li><li><a href="Poller.html">Poller</a><ul class='methods'><li data-type='method'><a href="Poller.html#once">once</a></li><li data-type='method'><a href="Poller.html#poll">poll</a></li><li data-type='method'><a href="Poller.html#stop">stop</a></li></ul></li><li><a href="ReadLineParser.html">ReadLineParser</a></li><li><a href="ReadyParser.html">ReadyParser</a></li><li><a href="RegexParser.html">RegexParser</a></li><li><a href="SerialPort.html">SerialPort</a><ul class='members'><li data-type='member'><a href="SerialPort.html#.Binding">Binding</a></li><li data-type='member'><a href="SerialPort.html#.parsers">parsers</a></li></ul><ul class='methods'><li data-type='method'><a href="SerialPort.html#.list">list</a></li><li data-type='method'><a href="SerialPort.html#close">close</a></li><li data-type='method'><a href="SerialPort.html#drain">drain</a></li><li data-type='method'><a href="SerialPort.html#flush">flush</a></li><li data-type='method'><a href="SerialPort.html#get">get</a></li><li data-type='method'><a href="SerialPort.html#open">open</a></li><li data-type='method'><a href="SerialPort.html#pause">pause</a></li><li data-type='method'><a href="SerialPort.html#read">read</a></li><li data-type='method'><a href="SerialPort.html#resume">resume</a></li><li data-type='method'><a href="SerialPort.html#set">set</a></li><li data-type='method'><a href="SerialPort.html#update">update</a></li><li data-type='method'><a href="SerialPort.html#write">write</a></li></ul></li></ul><h3>Events</h3><ul><li><a href="global.html#event:close">close</a></li><li><a href="global.html#event:data">data</a></li><li><a href="global.html#event:error">error</a></li><li><a href="global.html#event:open">open</a></li></ul><h3><a href="global.html">Global</a></h3>
25+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BaseBinding.html">BaseBinding</a><ul class='methods'><li data-type='method'><a href="BaseBinding.html#.list">list</a></li><li data-type='method'><a href="BaseBinding.html#close">close</a></li><li data-type='method'><a href="BaseBinding.html#drain">drain</a></li><li data-type='method'><a href="BaseBinding.html#flush">flush</a></li><li data-type='method'><a href="BaseBinding.html#get">get</a></li><li data-type='method'><a href="BaseBinding.html#getBaudRate">getBaudRate</a></li><li data-type='method'><a href="BaseBinding.html#open">open</a></li><li data-type='method'><a href="BaseBinding.html#read">read</a></li><li data-type='method'><a href="BaseBinding.html#set">set</a></li><li data-type='method'><a href="BaseBinding.html#update">update</a></li><li data-type='method'><a href="BaseBinding.html#write">write</a></li></ul></li><li><a href="Poller.html">Poller</a><ul class='methods'><li data-type='method'><a href="Poller.html#once">once</a></li><li data-type='method'><a href="Poller.html#poll">poll</a></li><li data-type='method'><a href="Poller.html#stop">stop</a></li></ul></li><li><a href="SerialPort.html">SerialPort</a><ul class='members'><li data-type='member'><a href="SerialPort.html#.Binding">Binding</a></li><li data-type='member'><a href="SerialPort.html#.parsers">parsers</a></li></ul><ul class='methods'><li data-type='method'><a href="SerialPort.html#.list">list</a></li><li data-type='method'><a href="SerialPort.html#close">close</a></li><li data-type='method'><a href="SerialPort.html#drain">drain</a></li><li data-type='method'><a href="SerialPort.html#flush">flush</a></li><li data-type='method'><a href="SerialPort.html#get">get</a></li><li data-type='method'><a href="SerialPort.html#open">open</a></li><li data-type='method'><a href="SerialPort.html#pause">pause</a></li><li data-type='method'><a href="SerialPort.html#read">read</a></li><li data-type='method'><a href="SerialPort.html#resume">resume</a></li><li data-type='method'><a href="SerialPort.html#set">set</a></li><li data-type='method'><a href="SerialPort.html#update">update</a></li><li data-type='method'><a href="SerialPort.html#write">write</a></li></ul></li></ul><h3>Events</h3><ul><li><a href="global.html#event:close">close</a></li><li><a href="global.html#event:data">data</a></li><li><a href="global.html#event:error">error</a></li><li><a href="global.html#event:open">open</a></li></ul><h3><a href="global.html">Global</a></h3>
2626
</nav>
2727

2828
<div id="main">
@@ -2383,7 +2383,7 @@ <h5>Returns:</h5>
23832383
<br class="clear">
23842384

23852385
<footer>
2386-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Feb 27 2018 23:06:42 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2386+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Mar 10 2018 23:07:13 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
23872387
</footer>
23882388

23892389
<script>prettyPrint();</script>

docs/ByteLengthParser.html

Lines changed: 0 additions & 292 deletions
This file was deleted.

0 commit comments

Comments
 (0)