Serial library overview

@v5x/serial implements the V5 serial protocol in TypeScript. It provides a high-level device model for connections, brain state, programs, files, controllers, smart devices, radio state, and screenshots.

import { V5SerialDevice } from "@v5x/serial";

const device = new V5SerialDevice(navigator.serial);

try {
  const connected = await device.connect();
  if (connected.isErr()) throw connected.error;

  console.log(device.brain.systemVersion.toUserString());
} finally {
  await device.dispose();
}

Web Serial requires a secure context and explicit user permission. Browser support is not universal.

The package also exports packet-level protocol classes. Those are internals and not covered here.

Install the serial library

Serial library overview - v5x

Serial library

Guides

Reference

Help

Serial library overview