@serialpilot/driver-kit

Tiny shared building blocks for SerialPilot device drivers.

⚠️ This package is intentionally small. It is not an SDK or framework. It exists so the three flagship drivers (GRBL, GPS, ESP-flasher) don't duplicate basic plumbing.

What's exported

• Device — abstract EventEmitter subclass with an open → opening → open → closing → closed state machine.
• MockTransport — in-memory Transport implementation used by every driver's tests.
• Transport — the duplex interface drivers expect from a port.
• DeviceState, BaseEventName, BaseEventPayloads, DriverError, makeDriverError — shared event taxonomy types and error helper.
• createLogger(namespace) — debug-namespaced logger factory (serialpilot:driver:<name>).
• LineBuffer — CRLF/LF line splitter with stateful chunk buffering. Used by every text-based driver.
• RequestQueue<TResp> — generic FIFO request/response queue with per-item timeouts, cancelAll, write-failure handling, and configurable maxInFlight. The driver supplies response recognition via resolveCurrent() / rejectCurrent().
• Optional Transport.setSignals({dtr, rts}) for modem control. MockTransport records all calls to signalsLog.

Install

npm install @serialpilot/driver-kit

Example

import { Device, MockTransport, createLogger } from '@serialpilot/driver-kit'

const log = createLogger('mydriver')
const transport = new MockTransport()

class MyDriver extends Device {
  async open() {
    log('opening')
    await super.open()
  }
}

License

MIT