To use the `ByteLength` parser:
-```js
+ // To use the `ByteLength` parser:
const SerialPort = require('serialport');
const ByteLength = SerialPort.parsers.ByteLength
const port = new SerialPort('/dev/tty-usbserial1');
const parser = port.pipe(new ByteLength({length: 8}));
-parser.on('data', console.log); // will have 8 bytes per data event
-```
+parser.on('data', console.log); // will have 8 bytes per data eventCCTalk Messages are emitted as buffers.
-```js
+ // CCTalk Messages are emitted as buffers.
const SerialPort = require('serialport');
const CCTalk = SerialPort.parsers.CCTalk;
const port = new SerialPort('/dev/ttyUSB0');
const parser = port.pipe(new CCtalk());
-parser.on('data', console.log);
-```
+parser.on('data', console.log);To use the `Delimiter` parser, provide a delimiter as a string, buffer, or array of bytes:
-```js
+ // To use the `Delimiter` parser, provide a delimiter as a string, buffer, or array of bytes:
const SerialPort = require('serialport');
const Delimiter = SerialPort.parsers.Delimiter;
const port = new SerialPort('/dev/tty-usbserial1');
-const parser = port.pipe(new Delimiter({ delimiter: Buffer.from('EOL') }));
-parser.on('data', console.log);
-```
+const parser = port.pipe(new Delimiter({ delimiter: '\n' }));
+parser.on('data', console.log);A transform stream that emits data after a newline delimiter is received.
A transform stream that emits data after a newline delimiter is received.
+ To use the Readline parser, provide a delimiter (defaults to \n). Data is emitted as string controllable by the encoding option (defaults to utf8).
To use the `Readline` parser, provide a delimiter (defaults to '\n'). Data is emitted as string controllable by the `encoding` option (defaults to `utf8`).
-```js
-const SerialPort = require('serialport');
+ const SerialPort = require('serialport');
const Readline = SerialPort.parsers.Readline;
const port = new SerialPort('/dev/tty-usbserial1');
const parser = port.pipe(new Readline({ delimiter: '\r\n' }));
-parser.on('data', console.log);
-```
+parser.on('data', console.log);A transform stream that waits for a sequence of "ready" bytes before emitting a ready event and emitting data events
A transform stream that waits for a sequence of "ready" bytes before emitting a ready event and emitting data events
+To use the Ready parser provide a byte start sequence. After the bytes have been received a ready event is fired and data events are passed through.
To use the `Ready` parser provide a byte start sequence. After the bytes have been received a ready event is fired and data events are passed through.
-```js
-const SerialPort = require('serialport');
+ const SerialPort = require('serialport');
const Ready = SerialPort.parsers.Ready;
const port = new SerialPort('/dev/tty-usbserial1');
const parser = port.pipe(new Ready({ delimiter: 'READY' }));
parser.on('ready', () => console.log('the ready byte sequence has been received'))
-parser.on('data', console.log); // all data after READY is received
-```
+parser.on('data', console.log); // all data after READY is receivedA transform stream that uses a regular expression to split the incoming text upon.
A transform stream that uses a regular expression to split the incoming text upon.
+To use the Regex parser provide a regular expression to split the incoming text upon. Data is emitted as string controllable by the encoding option (defaults to utf8).
To use the `Regex` parser provide a regular expression to split the incoming text upon. Data is emitted as string controllable by the `encoding` option (defaults to `utf8`).
-```js
-const SerialPort = require('serialport');
+ const SerialPort = require('serialport');
const Regex = SerialPort.parsers.Regex;
const port = new SerialPort('/dev/tty-usbserial1');
const parser = port.pipe(new Regex({ regex: /[\r\n]+/ }));
-parser.on('data', console.log);
-```
+parser.on('data', console.log);serialport-list will list all available
diff --git a/docs/index.js.html b/docs/index.js.html
index 02b58dc00..8660eaa41 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -65,7 +65,7 @@