Control

Send one JSON command; `operation` selects which

Every JSON command is a POST /v1/control whose body is one Request. After acquire, every command carries the session and generation of the current grant (the fence). Decoding is strict: unknown fields, duplicate fields and trailing data are refused. Operations: mark_telemetry (implemented), acquire (implemented), renew (implemented), release (implemented), stop (implemented), enable (implemented), arm (implemented), home (implemented), reset_fault (interim), recovery_status (implemented), jog (test_only), begin_jog (implemented), end_jog (implemented), prepare_trajectory (implemented), start_trajectory (implemented), discard_trajectory (implemented), start_program (implemented), halt (implemented), restore_anchor (implemented), io_arm (implemented), io_disarm (implemented). Per-operation state, required fields, result type, reasons and docs are in x-rosieos-operations.

post/v1/control

Request

  • Base URL: http://localhost
  • URL: http://localhost/v1/control
  • Auth: one of:
    • none
    • mutualTLS (defined in the document in a form this page cannot read)

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Response

Admitted. For motion this acknowledges admission, not physical completion.

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Changes

No recorded changes to this operation across all 1 revision of this API.