Machine control

Holds one axis at a fraction of its described velocity. action is begin, update or end. Needs an armed session. GET /dense-execution/jog/state returns the current state.

Send begin, then update every 50 ms while the operator holds the control, then end. An update may not change axis, direction or fraction; end the hold and begin a new one. Each update lives for the cell's jog input age (250 ms on a LAN cell). If updates stop, the jog ends with jog_input_deadline_expired and the axis ramps to a hold.

Errors (409 unless noted): jog_session_stale, jog_mode_conflict (a move, a program or another hold is active), no_grant, jog_not_ready, invalid_axis_mask, 400 jog_invalid_vector, jog_input_deadline_expired, jog_transport_congested, dense_target_unavailable, and native jog reasons.

post/dense-execution/jog/{action}

Request

  • Base URL: http://127.0.0.1:8794/api/offline-programming/v1
  • URL: http://127.0.0.1:8794/api/offline-programming/v1/dense-execution/jog/{action}
  • Auth: none required

Path parameters

action'begin' | 'update' | 'end' required

Request body

target_idstring required

Type: string. The cell's pair ID, capabilities.cell

session_idstring required

Type: string. status.session.id

revisioninteger required

Type: integer. jog/state.revision. It advances when a jog ends or a move starts, so a late request from an old hold is refused.

axisinteger required

Type: integer. Axis index, within the cell's axis mask

directioninteger required

Type: integer. 1 or -1

fractionnumber required

Type: number. (0, 1]. The axis moves at fraction × max_velocity × 0.75.

Response

OK

Changes

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