Browser setup

Requirements

A browser implementing Web Serial.
HTTPS in production or localhost during development.
A user action, such as a button click, before opening the device chooser.
Exclusive access to the selected serial port.

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

const connectButton = document.querySelector<HTMLButtonElement>("#connect");

connectButton?.addEventListener("click", async () => {
  const device = new V5SerialDevice(navigator.serial);
  const connected = await device.connect();

  console.log({ connected: connected.isOk() });
});

Keep a reference to the device instance so you can dispose it later. Automatic refresh is disabled by default; set device.autoRefresh = true if your application needs periodic state updates.

Install the serial library Connect and disconnect

Serial library

Guides

Reference

Help

Browser setup

Requirements

​Requirements

Requirements