Driver control API
This page is for factory adaptation. Day-to-day reads and writes use Manual control.
Paths sit at the process root. There is no /api/v1 prefix. Callers must not add one. The listen port is written in that device’s point table.
Catalog and capabilities
| Method | Path | Meaning |
|---|---|---|
| GET | /capabilities | Process-wide flags. The current network includes max_step |
| GET | /devices | Devices in this process |
| GET | /devices/{device}/commands | Commands on that device |
Command fields are id, label, description, datatype, min, and max. min and max may exist on one side only. The other side may be null.
Write and read-back
| Method | Path | Meaning |
|---|---|---|
| POST | /set_command | Write setpoints. Each item may include max_step. Out-of-range values are rejected. A dropped client cancels writes that are not finished |
| POST | /get_command | Read current values |
A command id is {system}.{device}.{command}, then lowercased. system is this Driver process’s device name.
Probes
GET /live, GET /ready, and GET /health are process probes for local supervision.