URL

/bundle/{linkID}/status

Method

GET

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

Return value

{
    "data": {
        "calibratedAxes": [
            {
                "axis": "headPan",
                "device": "headPlusV2"
            },
            {
                "axis": "headTilt",
                "device": "headPlusV2"
            }
        ],
        "deviceInfo": [
            {
                "batteryLevel": 1.0,
                "deviceFirmwareVersion": 101,
                "type": "headPlusV2"
            }
        ],
        "deviceInfoEverythingReady": true,
        "keyposeLoopActive": false,
        "keyposeMotionAimIndex": 0,
        "keyposeMotionStartIndex": 0,
        "keyposeSlotsFilled": [
            false,
            false,
            false,
            false,
            false,
            false
        ],
        "plannedMotionProgress": 1.0,
        "plannedMotionSecs": 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	string array	Head_Pan Head_Tilt Slide Focus Jib_Pan Jib_Tilt	Calibrated axes as string array
deviceInfo	device info array	Each elements describes in below table	Array of information of devices
deviceInfoEverythingReady	bool	true - false	It means that when it is true, that can get information. Otherwise, you can not get information.
keyposeLoopActive	bool	true - false	It means that if it is true, your bundle is looping between the specified keypose indexes.
keyposeMotionAimIndex	int	0 - 5	aim index for keypose motion.
keyposeMotionStartIndex	int	0 - 5	Index that before start keypose motion.
keyposeSlotsFilled	bool array	true - false	Array has six elements, each element represents that whether index is filled.
plannedMotionProgress	float	0.0 - 1.0	It shows the percentage of how many complete of keypose motion. It is mapped between 0.0 - 1.0.
plannedMotionSecs	float		How many seconds the keypose motion will take
readings	key-value pair array	Each elements describes in below table	Array of information of each axis
realTimeSupportedAxes	string array	Head_Pan Head_Tilt Slide Focus Jib_Pan Jib_Tilt	Which axes the bundle has are supported in Real-Time Move.
state	string	Idle Keypose_Move RealTime_Move Focus_Calibration Slider_Calibration Joystick_Move Unsupported_Activity	Shows state of the bundle movement.
timestampDevice	long int		The status was generated at this timestamp on the master device.
timestampEpoch	long int		The status was grabbed from the SDK at this timestamp.

Label	Type	Value	Description
deviceFirmwareVersion	int		Device fimrware version
batteryLevel	int	0 - 100	Battery level
type	string	-	Device Type

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

Label	Type	Value	Description
readings It may consist of one or more of the following: Head_Pan Head_Tilt Slide Focus Jib_Pan Jib_Tilt	float	Head_Pan: -180 - 180 Head_Tilt: -180 - 180 Slide: Focus: Jib_Pan: Jib_Tilt:	In which axis direction you want to move and its speed ratio.