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 as Server.port.
Catalog and capabilities
| Method | Path | Meaning |
|---|---|---|
| GET | /capabilities | Process-wide flags. The current set 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. The current directory fills both min and max as null.
Write and read-back
| Method | Path | Meaning |
|---|---|---|
| POST | /set_command | Write setpoints |
| POST | /get_command | Read current values |
The write body is a data array. Each item has device, command, and params.value. params.max_step is optional. It must be a positive finite number and applies only to numeric values. A dropped client cancels writes that are not finished.
The read-back body is also a data array. Each item has only device and command.
The process uses its device name as system, then writes or reads {system}.{device}.{command} in lowercase. Unknown command ids are rejected.
Probes
GET /live, GET /ready, and GET /health are process probes for local supervision.