URL

/v1/link/{linkID}

Method

POST

Caution

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

Payload

{
  "command":"link2PairingScanResults"
}
Label Type Value Description
command string link2PairingScanResults command name

Return value

{
    "data": [
        {
            "firmwareVersionMajor": 0,
            "firmwareVersionMinor": 18,
            "isDeviceFirmwareUpdateAvailable": false,
            "type": "slideModuleV3"
        },
        {
            "firmwareVersionMajor": 0,
            "firmwareVersionMinor": 101,
            "isDeviceFirmwareUpdateAvailable": false,
            "type": "headPlusV2"
        }
    ],
    "result": "ok"
}
Label Type Value Description
data device array [deviceinfo1, deviceinfo2] Array of information of devices on Link
Label Type Value Description
type string - Device Type
firmwareVersionMajor int - Device Firmware Major Version
firmwareVersionMinor int - Device fimrware Minor number
isDeviceFirmwareUpdateAvailable bool - If there is exist a update available,
this flag will be true
Device Type
slideModule
headPlus
headPlusPro
headOne
surfaceOne
dollyPlus
sliderOnePro
sliderOne
dollyOne
dollyPlusPro
jibOne
goldFinch
slideModuleV3
panPro
jibOneMk2
focusPlusPro
headPlusV2
headPlusProV2
slideModuleV1
none

Connect to Bundle

Pairs devices and joins to them.

URL

/v1/link/{linkID}

Method

POST

Caution

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

Payload

{
  "command":"link2PairingConnect"
}
Label Type Value Description
command string link2PairingConnect command name

Return value

See default return values.

Get Pairing Status

URL

/v1/link/{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 of HTTP request of "Content-Type" is sent always as "text/plain" NOT "application/json".

Payload

{
  "command":"link2PairingStatus"
}
Label Type Value Description
command string link2PairingStatus command name

Return value

{
    "data": {
        "canbusPairState": "pingReceived",
        "lastPairError": "none"
    },
    "result": "ok"
}
Label Type Value Description
canbusPairState string
  • idle
  • pingReceived
  • connecting
  • connectionOk
 Master device state
lastPairError string
  • none
  • imposiblleScenario
  • deviceFirmwareUpdateRequired
  • unknown
  • cantAppendDevice

Disconnect from bundle

URL

/v1/link/{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":"disconnect"
}
Label Type Value Description
command string disconnect command name

Return value

See default return values.

Default Return Values

{
  "result": "ok"
}

System executed your command without any issues.

{
  "result": "Invalid Arguments"
}

Given arguments are invalid.