Move

Joystick Move

URL

/v1/bundle/{linkID}

Method

POST

Caution !!! The SDK does not support CORS, so when you send a request with "OPTIONS" method, the 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`	`float`	-	In which axis direction you want to move and its speed ratio.

Axis Name	Type	Value Range
`headPan`	`float`	`-180.0 - +180.0`
`headTilt`	`float`	`-180.0 - +180.0`
`slide`	`float`	`It depends your calibrations.`
`focus`	`float`
`jibPlusPan`	`float`
`jibPlusTilt`	`float`

Note

As in the example below, the desired direction to move must be given as the key and the speed value as a value.

Caution

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

Example JSON You want to send command for three axes; Head Pan, Head Tilt and Slide;

{
  "command":"joystickMove",
  "index":0,
  "headPan":0.0,
  "headTilt":0.0,
  "slide":0.0,
}

Focus Manual Move

URL

/v1/bundle/{linkID}

Method

POST

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

Payload

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

Label	Type	Value	Description
`command`	`string`	`focusManualMove`	command name
`deltaEnc`	`integer`	``	encoder step

Motion Abort

URL

/v1/bundle/{linkID}

Method

POST

Caution !!! The SDK does not support CORS, so when you send a request with "OPTIONS" method, the 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

Calibration

URL

/v1/bundle/{linkID}

Method

POST

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

Payload

{
    "command": "calibrate",
    "device": "slideModuleV3",
    "isOnGround": true,
    "isOnLeftSide" : false,
    "jibLength" = 2,
    "rodLength" = 3
}

|Label| Type | Value |Description| |:--- |:---- |:-----------| |command | string | motionAbort |calibrate name| |device| string | Each device has own configuratation | Which axis you want to calibrate it.| | jibLength | float | | length of jib| | rodLength | float | | length of camera rod of jib| | isOnGround | bool | | If slider is on tripod, it should be true| | isOnLeftSide | bool | | If slide module is left side of slider, it should be true otherwise it will be false |

`slideModule`
`headPlus`
`headPlusPro`
`headOne`
`surfaceOne`
`dollyPlus`
`sliderOnePro`
`sliderOne`
`dollyOne`
`dollyPlusPro`
`jibOne`
`goldFinch`
`slideModuleV3`
`panPro`
`jibOneMk2`
`focusPlusPro`
`headPlusV2`
`headPlusProV2`
`slideModuleV1`
`none`

Device Type	Need Parameter
`slideModule`	`isOnGround` `isOnLeftSide`
`headPlus`	-
`headPlusPro`	-
`headOne`	-
`surfaceOne`	-
`dollyPlus`	-
`sliderOnePro`	`isOnGround` `isOnLeftSide`
`sliderOne`	`isOnGround` `isOnLeftSide`
`dollyOne`	-
`dollyPlusPro`	-
`jibOne`	`jibLength` `rodLength`
`goldFinch`	-
`slideModuleV3`	`isOnGround` `isOnLeftSide`
`panPro`	-
`jibOneMk2`	-
`focusPlusPro`	-
`headPlusV2`	-
`headPlusProV2`	-
`slideModuleV1`	-
`none`	-

Example JSON You may want to send command for three axes; Head Pan, Head Tilt and Slide;

{
    "command": "calibrate",
    "device": "slideModuleV3",
    "isOnGround": true,
    "isOnLeftSide" : false
}

Numeric Limits

Each axis has specific limit value and step value, this command returns these.

URL

/v1/bundle/{linkID}

Method

POST

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

Payload

{
  "command":"numericLimitValues"
}

Label	Type	Value	Description
`command`	`string`	`numericLimitValues`	command name

Return value

{
    "pan_maxLimit": 36000.0,
    "pan_minLimit": -36000.0,
    "pan_step": 0.0006099999882280827,
    "result": "ok",
    "tilt_maxLimit": 89.0999984741211,
    "tilt_minLimit": -89.0999984741211,
    "tilt_step": 0.0006099999882280827
}

Label	Type	Value	Description
`panMaxLimit`	`float list`
`panMinLimit`	`float`
`panStep`	`float`
`tiltMaxLimit`	`float`
`tiltMinLimit`	`float`
`tiltStep`	`float`
`focusMaxLimit`	`float`
`focusMinLimit`	`float`
`focusStep`	`float`
`jibPanMaxLimit`	`float`
`jibPanMinLimit`	`float`
`jibPanStep`	`float`
`jibTiltMaxLimit`	`float`
`jibTiltMinLimit`	`float`
`jibPanStep`	`float`
`isDataReady`	`bool`

Default Return Values

{
  "result": "ok"
}

System executed your command without any issues.

{
  "result": "invalid setup"
}

Given device is invalid