Joystick Move

URL

/v1/bundle/{linkID}

Method

POST

Caution

edelkrone SDK does not support CORS, so when you send a request with "OPTIONS" method, edelkrone SDK returns an error because an HTTP request of "Content-Type" is always sent as "text/plain" NOT "application/json".

Payload

{
  "command": "joystickMove",
  "{axis_name}": "{speed_ratio}"
}

Label Type Value Description
command string joystickMove Command name
axis_name string - See table below.
speed_ratio float - Relative speed you want that axis to move.

Axis Name Type Value Range
headPan float -1.0 - +1.0
headTilt float -1.0 - +1.0
slide float -1.0 - +1.0
jibPlusPan float -1.0 - +1.0
jibPlusTilt float -1.0 - +1.0

Example JSON

You can send multiple joystick move setpoints for different axes in a single command. You can find an example payload for similar scenario below.

{
  "command": "joystickMove",
  "headPan": -0.05,
  "headTilt": 0.25,
  "slide": 0.4
}

Return value

See default return values.

Focus Manual Move

URL

/v1/bundle/{linkID}

Method

POST

Caution

edelkrone SDK does not support CORS, so when you send a request with "OPTIONS" method, edelkrone SDK returns an error because an HTTP request of "Content-Type" is always sent as "text/plain" NOT "application/json".

Payload

{
  "command": "focusManualMove",
  "deltaEnc": 4360
}

Label Type Value Description
command string focusManualMove Command name
deltaEnc integer - Encoder step amount you want focus motor to move. Can be positive or negative.
Example: Full round rotation of focus motor is roughly equivalent to 44500 units of encoder movement.

Return value

See default return values.

Motion Abort

You can send this command to stop any ongoing motion activity.

URL

/v1/bundle/{linkID}

Method

POST

Caution

edelkrone SDK does not support CORS, so when you send a request with "OPTIONS" method, edelkrone SDK returns an error because an HTTP request of "Content-Type" is always sent as "text/plain" NOT "application/json".

Payload

{
  "command": "motionAbort"
}
Label Type Value Description
command string motionAbort Command name

Return value

See default return values.