Serial Packet Parser

A serial packet parser library for TypeScript.

Features

Supported serial packet formats:

• length-prefixed packets: [prefix][length][payload]

Install

npm install serial-packet-parser

or using pnpm:

pnpm add serial-packet-parser

or using yarn:

yarn add serial-packet-parser

Usage

Prefix Length Parser

import { PrefixLengthParser } from 'serial-packet-parser';

// Create a parser for length-prefixed packets
const parser = new PrefixLengthParser({
  prefix: new Uint8Array([0xAA, 0xBB]), // Packet start marker
  lengthFieldSize: 2, // 2-byte length field
  onMessage: (message, totalLen) => {
    console.log('Received message:', message);
  },
  onError: (error) => {
    console.error('Parse error:', error);
  }
});

// Feed serial data to the parser
const serialData = new Uint8Array([/* your serial data */]);
parser.push(serialData);

Development

• Install dependencies:

npm install

• Run the unit tests:

npm run test

• Build the library:

npm run build