Protequ Adapter Developer Docs¶
Build a device adapter that bridges physical security hardware — controllers, readers, NVRs, panels — to the Protequ platform. You describe the device in YAML and write thin C# protocol logic; the framework and its source generator handle the rest.
Start here¶
- Overview — what an adapter is and how it fits together
- Getting started — from zero to your first event
- Local dev setup — run and debug an adapter locally
Understand the model¶
- Code generation — how YAML + your C# become typed Things, commands, and events
- Framework architecture — the runtime: Thing tree, lifecycle, messaging, capabilities
- Core concepts — events, status, commands, functions, and the rest of the vocabulary
Build¶
- Patterns — proven recipes: command handling, event translation, status polling, video streaming, and more
- Archetypes — end-to-end shapes for common device families
- Reference — the generated API, functions registry, and YAML properties
Prove it works¶
- Definition of done — what "finished" means, and the states a capability can end in
- Acceptance tests — the behavior your adapter has to produce on real hardware, scenario by scenario
New to the framework? Read Code generation and Framework architecture first — they are the mental model everything else builds on.