Files
parking_solution/wiki/concepts/device-adapter-pattern.md
julian 72ba4099ea Device-agnostic driver registry + first-run setup
Make the device-adapter pattern selectable so the admin chooses hardware at
install — per lane, from a catalog of supported drivers. Adding a device =
registering one more driver; no business-logic change.

packages/devices:
- interfaces.ts: AccessControlDevice / ReaderDevice / CameraDevice / PrinterDevice
  (adds CameraDevice for entry/exit snapshot-on-event; access relay stays
  intent-only per "a barrier is not a door").
- registry.ts: driver catalog with per-driver config fields + factory, config
  validation, and a catalog payload for the setup UI.
- drivers/: stub adapters — access (zkteco, esp32-relay), reader (wiegand,
  tcp-ip), camera (hikvision, dahua). Real vendor protocols TBD.

packages/db:
- lane_devices + setup_state tables (migration 0001); re-export query helpers.

apps/server:
- routes/setup.ts: GET /api/setup/catalog (public schema), and admin-only
  /assign, /state, /complete with registry validation before persisting.
- extract auth.ts (requireJwtSecret, requireRole, JWT type aug).

apps/web:
- SetupWizard scaffold + api client: pick a driver per category for a lane,
  render its config fields.

wiki: device-registry + first-run-setup concept pages; cross-link from
device-adapter-pattern; index + log updated.

Verified: full turbo build (5/5); catalog lists all drivers; admin assign
persists; missing-config and no-token requests are rejected.
2026-06-14 07:59:46 +02:00

1.6 KiB

type, tags, sources, updated
type tags sources updated
concept
parking
architecture
devices
parking-system-architecture
2026-06-14

Device-Adapter Pattern

How the system stays device-agnostic: business logic talks only to interfaces, never to a device SDK. Each physical device is an adapter implementing one interface; swapping hardware means writing a new adapter and nothing else changes. Implemented as isolated fastify plugins emitting onto a shared internal event bus. (See parking-system-architecture §5.)

interface CardReaderDevice {
  connect(): Promise<void>
  onCardRead(cb: (cardNumber: string, door: number) => void): void
  disconnect(): Promise<void>
}
interface PrinterDevice {
  printTicket(data: TicketData): Promise<void>
  checkStatus(): Promise<'ready' | 'offline' | 'paper_out'>
}
interface RelayDevice {
  pulseOpen(doorId: number): Promise<void>   // intent only — see safety note
  getDoorStatus(doorId: number): Promise<'open' | 'closed'>
}

Note the RelayDevice expresses intent only — see the barrier-not-a-door safety principle. The choice of which adapter to trust is the trust-boundary decision.

In practice the adapters are made selectable: a device-registry catalogs the supported drivers (ZKTeco / ESP32 relay, Wiegand / TCP-IP readers, Hikvision / Dahua cameras), and the admin assigns one per lane during first-run-setup. Adding hardware support = one more registered driver, no business-logic change. (The implemented interfaces add a CameraDevice for entry/exit snapshots alongside reader/relay/printer.)