@serialport/parser-delimiter

What is @serialport/parser-delimiter?

@serialport/parser-delimiter is a parser for the serialport library that allows you to split data into chunks based on a specified delimiter. This is particularly useful for processing data streams where messages are separated by a specific character or sequence of characters.

What are @serialport/parser-delimiter's main functionalities?

Basic Usage

This code demonstrates how to set up a basic serial port connection and use the delimiter parser to split incoming data based on newline characters.

const SerialPort = require('serialport');
const Delimiter = require('@serialport/parser-delimiter');

const port = new SerialPort('/dev/tty-usbserial1');
const parser = port.pipe(new Delimiter({ delimiter: '\n' }));

parser.on('data', data => {
  console.log('Received data:', data.toString());
});

Custom Delimiter

This example shows how to use a custom delimiter (in this case, a carriage return followed by a line feed) to split incoming data.

const SerialPort = require('serialport');
const Delimiter = require('@serialport/parser-delimiter');

const port = new SerialPort('/dev/tty-usbserial1');
const parser = port.pipe(new Delimiter({ delimiter: Buffer.from([0x0D, 0x0A]) })); // Carriage return and line feed

parser.on('data', data => {
  console.log('Received data:', data.toString());
});

Handling Binary Data

This example demonstrates how to handle binary data streams by using a custom binary delimiter.

const SerialPort = require('serialport');
const Delimiter = require('@serialport/parser-delimiter');

const port = new SerialPort('/dev/tty-usbserial1');
const parser = port.pipe(new Delimiter({ delimiter: Buffer.from([0xFF]) })); // Custom binary delimiter

parser.on('data', data => {
  console.log('Received binary data:', data);
});

0

README

See our api docs https://serialport.io/docs/api-parser-delimiter

Changelog

8.0.4 (2019-10-27)

This is the first non beta release of serialport version 8! 🎉 The biggest change in 8x is our version numbers. We now user lerna's "fixed versioning" to allow for a much easier documentation experience. This makes all our packages share a version number when they're released. Our website now has versioned docs so you can see what they looked like for the version of serialport you're using today. (Check out our 7x docs if you still need them.)

With this change we've moved a centralized changelog (this file!) and we'll be moving older release notes here. We also moved the website to it's own repo.

A few breaking api changes have been introduced over the 8x beta releases. You can find out more about them in the Upgrade Guide

We dropped node6 support and now support node12 (and we work on node 13) which allowed us to migrate to async/await. The reduced a fair bit of code and was a welcome change.

Windows got a few notable bug fixes from contributors and RTS/CTS flow control should now work as expected.

And lastly our CI system has mostly been moved to GitHub Actions, they are much much faster than our travis/appveyor combo and cheaper too (free!). We still pay for Appveyor because we still use them with travis for binary builds. When that process is migrated we should be able to drop both services completely.

This is also our first major release since starting the serialport collective! Like a lot of projects we rely on volunteers, students, professionals and the backing of companies using the project for their businesses. If you find serialport helpful, please read about why you might want to donate to the project and our project's goals.

Thanks to @boneskull, @BryanHunt, @hipsterbrown, @Holger-Will, @icebob, @jacobq, @jowy, @krutkay, @maxvgi, @nornagon, @podarok, @reconbot, and @warp for their help with this release!

And Thanks to our first 5 open collective backers! https://opencollective.com/serialport#backers for help with sustaining this project!

Bug Fixes

• improve the options and output of terminal (#1962) (4b23928)
• learn now needs the package-lock.json files (4b8fc24)
• npmignore should ignore .DS_Store files (#1954) (eb6b57b)