GUIDES

Tutorials

Still deciding whether to adopt Device Agent, rather than already building with it? See the main README's Is this for you? section, plus ../FAQ.md and ../TROUBLESHOOTING.md first — these guides assume you've already decided.

Narrative, step-by-step walkthroughs for Zyvor Device Agent. Read them in order the first time through; after that, jump straight to whichever one matches what you're doing.

Looking for a fact instead of a walkthrough (an API field, a config key, a protocol detail)? See the reference docs linked from the main README's Documentation section instead — these guides link out to them wherever the two overlap, on purpose, rather than repeating them.

#	Guide	You'll come away able to...
1	Getting started	Build the agent and dashboard from source and see live hardware inventory on screen
2	Configuration & the API	Read/edit device-agent.toml with confidence and call the REST API directly
3	Securing your agent	Pick the right auth mode (none / bearer / mTLS / Unix socket) and whether to add plain TLS, for your deployment
4	Industrial buses	Monitor CAN health, declare RS485 ports, and turn on read-only CAN capture
5	Writing a sensor plugin	Write, register and sample a new sensor plugin end to end
6	Deploying to production	Ship a package or remote deployment, reload config live, and scrape metrics
7	Container deployment	Pull the published image and run it, with or without systemd supervision
8	Camera streaming	Live snapshot and MJPEG stream from a USB/CSI camera