Files
parking_solution/wiki/concepts/device-registry.md
T
julian a0e0fd9118 Add device discovery (UHPPOTE LAN scan) to setup
UHPPOTE controllers self-announce via UDP broadcast, but the frontend had no way
to find them — the admin had to type the serial blind. Add a generic discovery
capability and surface it in the setup wizard.

packages/devices:
- DiscoverableDriver capability + DiscoveredDevice type + isDiscoverable() guard
  on the registry (optional, so any driver can opt in).
- uhppote driver implements discover() via uhppoted getDevices (UDP broadcast),
  mapping each controller's serial/IP/firmware into a DiscoveredDevice; extract
  shared buildCtx().

apps/server:
- GET /api/setup/discover/:driverId (admin-only): runs discover() and
  health-checks each found device so reachability shows before assigning.
- catalog now returns a `discoverable` driver-id list.

apps/web:
- SetupWizard "Scan for controllers" button for discoverable drivers; lists found
  devices with health badges; selecting one auto-fills serial + host. api client
  gains discoverDevices().

wiki: new device-discovery concept; cross-link from registry/setup/uhppote;
note the broadcast-permission (EACCES) deployment caveat; index + log.

Verified: catalog flags uhppote discoverable; discover runs and fails gracefully
without hardware; non-discoverable driver -> 400; missing token -> 401.
2026-06-14 08:21:27 +02:00

46 lines
2.4 KiB
Markdown

---
type: concept
tags: [parking, architecture, devices, configurable]
sources: [parking-system-architecture]
updated: 2026-06-15
---
# Device Registry (selectable drivers)
How the system goes from "device-agnostic in principle" ([[device-adapter-pattern]]) to
"**admin picks the device at setup**" in practice. A **registry** holds a catalog of supported
**drivers**, grouped by category; the [[first-run-setup]] UI reads it so an
operator can choose a device per lane and fill in its connection config.
> Implementation-derived (from `packages/devices`), not the source doc.
## The four categories
| Category | Examples (drivers) | Interface |
| --- | --- | --- |
| **access** | ZKTeco, ESP32 relay (also UHPPOTE) | `AccessControlDevice` — intent-only relay ([[barrier-not-a-door]]) |
| **reader** | Wiegand-into-controller, TCP/IP reader | `ReaderDevice` — RF/optical; two paths ([[entry-exit-readers]]) |
| **camera** | Hikvision, Dahua | `CameraDevice` — entry/exit snapshot-on-event |
| **printer** | (ticket dispenser / booth printer) | `PrinterDevice` |
## How a driver is described
Each driver declares: a stable `id`, its `category`, a human `label`/`description`, the
`transports` it uses (`tcp-ip`, `wiegand`, …), a list of **`configFields`** (host, port,
credentials, selects — what the setup UI renders), and a `create(config)` **factory** that
validates config and returns a live adapter. Adding hardware support = registering one more
driver; **no business-logic change** — this is the [[device-adapter-pattern]] made selectable.
## Why a registry (not hard-coded wiring)
- The admin chooses between **multiple devices per category** at install time, per lane
(mirrors the "mixable per lane" principle — see [[trust-boundary]], [[entry-exit-readers]]).
- Config is **validated against the driver's declared fields** before persisting.
- Selections persist in the `lane_devices` table and drive runtime adapter construction.
- Drivers may optionally implement **[[device-discovery]]** (`discover()`), so the admin can scan
the LAN instead of typing connection details — UHPPOTE does this today.
Cameras are modelled as **snapshot-on-event**: the host requests an image at entry/exit; it's
stored and referenced from the signed event as an **independent record** — a fraud-control input
to the [[append-only-event-chain]] (cf. [[lpr-camera]] as the recognition-based identity source).