Package matrix

Package	What it does	Depends on
`serialpilot`	Auto-detected bindings, the stream wrapper, every parser re-exported. Most projects only need this one.	everything below

Bindings

Package	What it does
`@serialpilot/bindings-cpp`	Native N-API bindings. Ships with prebuilds for the common (OS, arch, Node) triples; falls back to a source build if none match.
`@serialpilot/bindings-interface`	The TypeScript interface every binding implements. Import this if you're writing your own backend (a virtual port, a TCP-bridged port, a CI mock).
`@serialpilot/binding-mock`	In-memory binding for tests. Echo, record, periodic data, programmable responders. See Mocking.

A pure-Rust binding ships in the same monorepo as a Cargo crate at crates/bindings-rust. It's not on npm because it isn't a JavaScript package — use it from Rust projects directly.

Interfaces

Package	What it does
`@serialpilot/stream`	The Node.js Duplex stream wrapper that `SerialPilot` extends. Re-export it directly if you want a different binding without the parser bundle.

High-level helpers

Package	What it does
`@serialpilot/reconnect`	Auto-reconnect wrapper with exponential backoff and device-filter rediscovery. See the recipe.
`@serialpilot/command-queue`	Request/response over half-duplex links — AT commands, Modbus RTU, ccTalk. Per-command timeout, retry, regex match. See the Modbus recipe.

CLI

Package	Binary	Purpose
`@serialpilot/list`	`serialpilot-list`	Enumerate ports.
`@serialpilot/terminal`	`serialpilot-terminal`	Interactive console.
`@serialpilot/repl`	`serialpilot-repl`	Scriptable Node REPL.

Parsers

Package	Class	For
`parser-byte-length`	`ByteLengthParser`	Fixed-size frames.
`parser-cctalk`	`CCTalkParser`	Coin/bill validators.
`parser-delimiter`	`DelimiterParser`	Split on byte sequence.
`parser-inter-byte-timeout`	`InterByteTimeoutParser`	Quiescence-based framing.
`parser-packet-length`	`PacketLengthParser`	Length-prefixed packets.
`parser-readline`	`ReadlineParser`	Line-by-line text.
`parser-ready`	`ReadyParser`	Wait for sentinel.
`parser-regex`	`RegexParser`	Split on a pattern.
`parser-slip-encoder`	`SlipEncoder` / `SlipDecoder`	RFC 1055 SLIP framing.
`parser-spacepacket`	`SpacePacketParser`	CCSDS Space Packet.
`parser-start-end`	`StartEndParser`	STX/ETX-style frames.

How the layers fit

┌────────────────────────────────────────────────────┐
│  serialpilot      (meta — re-exports everything)   │
└────────────────────────────────────────────────────┘
│            │             │
┌────▼────┐  ┌────▼────┐   ┌────▼────────────┐
│ stream  │  │ parsers │   │ helpers         │
│ Duplex  │  │ × 11    │   │ reconnect       │
│ wrapper │  │         │   │ command-queue   │
└────┬────┘  └─────────┘   └─────────────────┘
│
┌────▼─────────────────────────┐
│ bindings-interface           │
│  ↑ implemented by ↑          │
│ bindings-cpp · binding-mock  │
└──────────────────────────────┘

Versioning

All @serialpilot/* packages are released in lock-step. A 1.x release of the meta package always pins exact 1.x versions of its dependencies — there is no scenario where you should mix-and-match minor versions across the scope.

Pick the smallest set

If you're worried about install size or cold-start time:

Just opening a port and reading raw bytes? @serialpilot/bindings-cpp + @serialpilot/stream.
Plus line-oriented protocols? Add @serialpilot/parser-readline.
Need the mock for tests but only in dev? npm i -D @serialpilot/binding-mock.
Production resilience? @serialpilot/reconnect.

← BackErrors Next →Recipes

Meta