Initiate wireless scan

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

Payload

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

Return value

See default return values.

Get current wireless scan results

URL

/v1/link/{linkID}

Method

POST

Caution

The SDK does not supported 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":"wirelessPairingScanResults"
}
Label Type Description
command string wirelessPairingScanResults

Return value

{
    "data": [
        {
            "deviceFirmware": 18,
            "groupId": 65535,
            "isDeviceFirmwareUpdateAvailable": false,
            "isRadioFirmwareUpdateAvailable": false,
            "linkPairigingActive": true,
            "mac": "A4:E5:7C:CF:4F:66",
            "radioFirmware": 32,
            "rssi": -32.0,
            "setup": "groupMember",
            "type": "slideModuleV3"
        },
        {
            "deviceFirmware": 101,
            "groupId": 23113,
            "isDeviceFirmwareUpdateAvailable": false,
            "isRadioFirmwareUpdateAvailable": false,
            "mac": "E8:DB:84:2C:C4:76",
            "radioFirmware": 32,
            "rssi": -76.0,
            "setup": "panTilt",
            "type": "headPlusV2"
        },
        {
            "deviceFirmware": 101,
            "groupId": 65535,
            "isDeviceFirmwareUpdateAvailable": false,
            "isRadioFirmwareUpdateAvailable": false,
            "linkPairigingActive": true,
            "mac": "E8:DB:84:2C:D2:AE",
            "radioFirmware": 33,
            "rssi": -58.0,
            "setup": "panTiltAndSlide",
            "type": "headPlusV2"
        },
        {
            "deviceFirmware": 101,
            "groupId": 16519,
            "isDeviceFirmwareUpdateAvailable": false,
            "isRadioFirmwareUpdateAvailable": false,
            "mac": "98:F4:AB:21:A7:7E",
            "radioFirmware": 32,
            "rssi": -66.0,
            "setup": "panTilt",
            "type": "headPlusProV2"
        }
    ],
    "result": "ok"
}
Label Type Value Description
data device array [deviceinfo1, deviceinfo2] Array of information of devices on canbus
Label Type Value Description
deviceFirmware int Device fimrware number
groupId int Which group device is in
linkPairigingActive bool
IsTilted bool
mac string FF:FF:FF:FF:FF:FF Mac address as string, it should
be hex string
rssi int Received signal
strength indication
isDeviceFirmwareUpdateAvailable bool If there is exist a update available,
this flag will be true
isRadioFirmwareUpdateAvailable bool If there is exist a update available,
this flag will be true
radioFirmware int Radio Firmware Version
setup string If device is master device:
  • panOnly
  • tiltOnly
  • panTilt
  • slideOnly
  • dollyOnly
  • panAndSlide
  • tiltAndSlide
  • panAndDolly
  • tiltAndDolly
  • panTiltAndSlide
  • panTiltAndDolly
    • panAndJib
    • tiltAndJib
    • panTiltAndJib
    • jibOnly
    • panAndJibPlus
    • tiltAndJibPlus
    • panTiltAndJibPlus
    • jibPlusOnly
    • followFocusOnly
    • possibleCanbusMaster
    If it is only bundle member:
  • groupMember
    • If it is not paired yet:
  • none
    • Other state:
  • bootingUp
  • firmwareError
  • ignore
 -
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

Note

The scan wireless command should be sent before that command is sent. Otherwise, Link adapter does not return any device info.

Create Bundle

Pairs devices and joins to them.

URL

/v1/link/{linkID}

Method

POST

Caution

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

Payload

{
    "command": "wirelessPairingCreateBundle",
    "deviceCount": 1,
    "forcedMasterDevice": "none",
    "macList": [
        "E8:68:E7:2E:B5:E2"
    ]
}
Label Type Value Description
command string wirelessPairingCreateBundle command name
deviceCount integer 0 - ... Number of device to be paired
forcedMasterDevice string - Forced Device Type
macList string FF:FF:FF:FF:FF:FF Mac list of devices. Mac pattern
should be like "xx:xx:xx:xx:xx"
Forced Master Device
slideModule
headPlus
headPlusPro
headOne
surfaceOne
dollyPlus
sliderOnePro
sliderOne
dollyOne
dollyPlusPro
jibOne
goldFinch
slideModuleV3
panPro
jibOneMk2
focusPlusPro
headPlusV2
headPlusProV2
slideModuleV1
none

Return value

See default return values.

Note

The send mac addresses are reachable while creating the bundle. Otherwise, the pairing process will be crashed, in which case get pair state by using this command.

Attach to Exist Bundle

Attach to already existing paired devices.

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 sent always as "text/plain" NOT "application/json".

Payload

{
    "command": "wirelessPairingAttachToBundle",
    "mac": "30:AE:A4:8F:B1:46"
}
Label Type Value Description
command string wirelessPairingAttachToBundle command name
mac string FF:FF:FF:FF:FF:FF Which device mac you want to connect.
Mac pattern should be like "xx:xx:xx:xx:xx"

Return value

See default return values.

Note

The send mac addresses are reachable while creating the bundle. Otherwise, the pairing process will be crashed, in which case get pair state by using this command.

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

Payload

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

Return value

{
    "data": {
        "lastPairError": "none",
        "wirelessPairState": "idle"
    },
    "result": "ok"
}
Label Type Value Description
lastPairError string
  • none
  • wifiChannelMismatch
  • impossibleScenario
  • radioFirmwareUpdateRequired
  • deviceFirmwareUpdateRequired
  • unknown
  • deviceSearchProblem
  • alreadyGroupMember
  • connectionProblem
    		•  Last pair error
    pairState string
    • idle
    • connecting
    • connectionOk
    • problem

    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.