@lzcontest/peripherals

Typed identities, connection profiles, and evidence records for station peripherals.

Install

npm install @lzcontest/peripherals

Create a connection profile

import {
  peripheralInstanceId,
  type PeripheralConnectionProfile,
} from '@lzcontest/peripherals';

const profile: PeripheralConnectionProfile = {
  schemaVersion: 1,
  peripheralId: peripheralInstanceId('station-controller-backup'),
  modelProfileId: 'example-controller',
  serial: {
    baudRate: 9_600,
    dataBits: 8,
    stopBits: 1,
    parity: 'none',
    flowControl: 'none',
    bufferSize: 4_096,
  },
  portMatch: { usbVendorId: null, usbProductId: null },
  updatedAt: '2026-07-30T12:00:00.000Z',
};

Core API

| Export | Purpose | | --- | --- | | peripheralInstanceId | Validate and brand a peripheral instance ID | | stationControllerPeripheralId | Default station-controller identity | | cwKeyerPeripheralId | Default CW-keyer identity | | PeripheralConnectionProfile | Persisted model, serial, and USB matching data | | PeripheralConnectionProfileRepository | Load, save, and remove profiles | | PeripheralEvidenceReference | Manufacturer or reference-logger evidence |

License

AGPL-3.0-only