@serialpilot/parser-ready
v1.0.1
Published
A transform stream that waits for a sentinel byte sequence before emitting downstream.
Maintainers
Readme
A Transform stream that buffers incoming data until a configured ready sequence has been received, then emits a ready event and forwards everything afterwards as plain stream data. Useful for boards (Arduino, ESP) that print a banner when they boot.
npm install @serialpilot/parser-readyUsage
const { SerialPilot, ReadyParser } = require('serialpilot')
const port = new SerialPilot({ path: '/dev/ttyUSB0', baudRate: 9600 })
const parser = port.pipe(new ReadyParser({ delimiter: 'READY' }))
parser.on('ready', () => console.log('Device is ready'))
parser.on('data', console.log) // data after the bannerAPI
new ReadyParser({ delimiter })
| Option | Type | Description |
| ----------- | ------------------ | -------------------------------------------- |
| delimiter | string \| Buffer | Required. The byte sequence to wait for. |
See the SerialPilot README for the full set of parsers.
