HTTP API¶
A running instance serves the interactive Swagger UI at /docs and ReDoc at /redoc.
| Method | Path | Summary |
|---|---|---|
GET |
/api/config |
Active configuration |
GET |
/api/events |
Live key presses as server-sent events (KeyEvent as JSON) |
GET |
/api/health |
Liveness check |
PUT |
/api/invert |
Set the axes whose keys move the other way and save the configuration |
PUT |
/api/keys/{action} |
Assign keys to an action and save the configuration |
GET |
/api/languages |
Languages the web page can be shown in |
GET |
/api/layouts |
Known pad layouts |
GET |
/api/layouts/{layout_id} |
One pad layout |
POST |
/api/learn |
For a while keys only show up here and move nothing; STOP still works |
GET |
/api/messages |
Texts of the web page |
GET |
/api/pad |
Configured pad layout and the action of each control |
GET |
/api/panel |
jogpad's view in Mainsail and Fluidd |
PUT |
/api/panel |
Show jogpad's view in Mainsail and Fluidd as the camera jogpad |
DELETE |
/api/panel |
Remove jogpad's view from Mainsail and Fluidd |
GET |
/api/state |
Current step size, selected axis and HOME selection |
PUT |
/api/switch |
Switch jogpad on or off, like its switch in Mainsail and Fluidd |
GET |
/api/version |
Installed jogpad version |