URL

/bundle/{linkID}/status

Method

GET

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".

Return value

{
    "data": {
        "calibratedAxes": [
            {
                "axis": "headPan",
                "device": "headPlusV2"
            },
            {
                "axis": "headTilt",
                "device": "headPlusV2"
            }
        ],
        "deviceInfo": [
            {
                "batteryLevel": 1.0,
                "type": "headPlusV2"
            }
        ],
        "deviceInfoEverythingReady": true,
        "keyposeLoopActive": false,
        "keyposeMotionAimIndex": 0,
        "keyposeMotionStartIndex": 0,
        "keyposeSlotsFilled": [
            false,
            false,
            false,
            false,
            false,
            false
        ],
        "plannedMotionProgress": 1.0,
        "plannedMotionDuration": 0.0,
        "readings": {
            "headPan": 89.95600128173828,
            "headTilt": 0.0
        },
        "realTimeSupportedAxes": [],
        "state": "idle",
        "supportedAxes": [
            {
                "axis": "headPan",
                "device": "headPlusV2"
            },
            {
                "axis": "headTilt",
                "device": "headPlusV2"
            }
        ],
        "timestampDevice": 303462,
        "timestampEpoch": 1634645133077
    },
    "result": "ok"
}

Label Type Value Description
calibratedAxes list - List of calibrated axes.
deviceInfo list - List of information of device(s) in the bundle. See table below.
deviceInfoEverythingReady bool - deviceInfo list is incomplete while this flag is false
keyposeLoopActive bool - If true, keypose move is in loop mode.
keyposeMotionAimIndex int 0 - 5 (max) Which keypose slot are we moving towards?
keyposeMotionStartIndex int -1 - 5 (max) If keyposeLoopActive flag is true, this value represents starting index of the keypose loop. Otherwise, this value is -1 to indicate that system has started the keypose move from its current position.
keyposeSlotsFilled list - Each element represents which keypose slot is filled or not. Length of this array also represents how many keypose slots are available for this particular bundle.
plannedMotionProgress float 0.0 - 1.0 How much of the currently planned motion is finished?
plannedMotionDuration float - How many seconds the currently planned motion is going to take?
realTimeSupportedAxes list - Which of the currently available axes are capable for realTimeMove commands?
state string
  • idle
  • keyposeMove
  • realTimeMove
  • focusCalibration
  • sliderCalibration
  • joystickMove
  • unsupportedActivity
Current state of bundle.
timestampDevice long - Local device timestamp for this particular update. Starts from zero and counted inside the motion control system firmware with 1 milisecond increments.
timestampEpoch long - Local computer epoch timestamp for this parcticular update. Synchronised to the computer time.

Label Type Value Description
batteryLevel float 0.0 - 1.0 Battery level
type string - Device Type

Device Type Product Name
slideModule Slide Module v2
slideModuleV3 Slide Module v3
sliderOnePro SliderONE PRO v2
sliderOne SliderONE v2
dollyPlus DollyPLUS
dollyOne DollyONE
dollyPlusPro DollyPLUS PRO
panPro PanPRO
headOne HeadONE
headPlus HeadPLUS v1
headPlusPro HeadPLUS v1 PRO
headPlusV2 HeadPLUS v2
headPlusProV2 HeadPLUS v2 PRO
focusPlusPro FocusPLUS PRO
jibOne JibONE

Axis Name Type Unit Value Range
headPan float degree -36000.0 - +36000.0
headTilt float degree -89.1 - +89.1
slide float centimeter Depends on the slider type.
focus float raw encoder There is no limit if calibration is not done.
After calibration, the limit is between two endpoints of your lens
jibPlusPan float degree -36000.0 - +36000.0
jibPlusTilt float degree -43.8 - +43.8

Note

See axis name convention chapter for details.