Initiate wireless scan

URL

/v1/link/{linkID}

Method

POST

Caution

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

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

Payload

{
  "command":"wirelessPairingScanResults"
}
Label Type Value Description
command string wirelessPairingScanResults Command name

Return value

{
    "data": [
        {
            "groupId": 65535,
            "isDeviceFirmwareUpdateAvailable": false,
            "isRadioFirmwareUpdateAvailable": false,
            "mac": "A4:E5:7C:CF:4F:66",
            "rssi": -49.0,
            "setup": "none",
            "type": "slideModuleV3"
        },
        {
            "groupId": 65535,
            "isDeviceFirmwareUpdateAvailable": false,
            "isRadioFirmwareUpdateAvailable": false,
            "mac": "98:F4:AB:21:A7:7E",
            "rssi": -88.0,
            "setup": "none",
            "type": "headPlusProV2"
        },
        {
            "groupId": 24883,
            "isDeviceFirmwareUpdateAvailable": false,
            "isRadioFirmwareUpdateAvailable": false,
            "mac": "E8:DB:84:2C:C4:76",
            "rssi": -87.0,
            "setup": "panTilt",
            "type": "headPlusV2"
        },
        {
            "groupId": 25052,
            "isDeviceFirmwareUpdateAvailable": false,
            "isRadioFirmwareUpdateAvailable": false,
            "mac": "F0:08:D1:85:BD:1A",
            "rssi": -86.0,
            "setup": "groupMember",
            "type": "slideModuleV3"
        },
        {
            "groupId": 65535,
            "isDeviceFirmwareUpdateAvailable": false,
            "isRadioFirmwareUpdateAvailable": false,
            "isTilted": 1,
            "mac": "C4:4F:33:65:D9:CF",
            "rssi": -81.0,
            "setup": "none",
            "type": "headOne"
        }
    ],
    "result": "ok"
}
Label Type Value Description
data - - Array of information about edelkrone motion control system(s) found in wireless range
Label Type Value Description
groupId int - GroupID for the device. This value is 65535 for non paired devices. All devices belong in a specific bundle share the same GroupID.
linkPairigingActive bool - Link (3.5mm) cable is connected to this device and this device received a ping from at least one other link connected device.
isTilted bool - This flag is valid when HeadONE's axis is tilted.
mac string FF:FF:FF:FF:FF:FF Mac address as hex string.
rssi int - Received signal strength indication.
isDeviceFirmwareUpdateAvailable bool - Device firmware update available for device.
You can connect with mobile app to your device which can be updated & follow the instructions from the mobile app to continue.
isRadioFirmwareUpdateAvailable bool - Radio firmware update available for device.
You can connect with mobile app to your device which can be updated & follow the instructions from the mobile app to continue.
setup string If device is a bundle master:
  • panOnly
  • tiltOnly
  • panTilt
  • slideOnly
  • dollyOnly
  • panAndSlide
  • tiltAndSlide
  • panAndDolly
  • tiltAndDolly
  • panTiltAndSlide
  • panTiltAndDolly
    • panAndJib
    • tiltAndJib
    • panTiltAndJib
    • jibOnly
    • panAndJibPlus
    • tiltAndJibPlus
    • panTiltAndJibPlus
    • jibPlusOnly
    • followFocusOnly
    If device is a bundle member:
  • groupMember

  • If device is not paired yet:
  • none
  • possibleCanbusMaster

  • Other states:
  • bootingUp
  • firmwareError
-
type string - See Device Type Table below
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

Note

You must send wirelessPairingScanStart command before sending wirelessPairingScanResults command.

Create Bundle

You can initiate a bundling operation by sending the MAC address(es) of the motion control system(s) you want to connect with Link Adapter.

URL

/v1/link/{linkID}

Method

POST

Caution

edelkrone SDK does not support CORS, so when you send a request with "OPTIONS" method, edelkrone 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 - Number of devices to be paired
forcedMasterDevice string - See Forced Master Device table below.
Critical for JibONE + Pan PRO bundle.
macList string FF:FF:FF:FF:FF:FF Mac address list of devices. Mac addresses should follow "xx:xx:xx:xx:xx" pattern
Forced Master Device Description
jibOne If Pan PRO is to be used as panning Jib with JibONE + Pan PRO bundle
panPro If Pan PRO is to be used as panning Head with JibONE + Pan PRO bundle
none For all other setups

jibone_top_bottom

Figure1: Pan PRO pairing scenarios with JibONE 

Return value

See default return values.

Note

edelkrone motion control system(s) you want to connect must be in wireless range and powered on before sending this command. If not, process will fail. You can check the pairing progress with wirelessPairingStatus command.

Attach to Existing Bundle

You can attach your Link Adapter to previously created bundle by sending the MAC adress of the main edelkrone motion control system for the particular bundle.

URL

/v1/link/{linkID}

Method

POST

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 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 Mac address of the main device.
Mac addresses should follow "xx:xx:xx:xx:xx" pattern

Return value

See default return values.

Note

edelkrone motion control system(s) you want to connect must be in wireless range and powered on before sending this command. If not, process will fail. You can check the pairing progress with wirelessPairingStatus command.

Get Pairing Status

URL

/v1/link/{linkID}

Method

POST

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

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 - See Last Pair Error Descriptions table below
pairState string
  • idle
  • connecting
  • connectionOk
  • problem
Last Pair Error Description
none -
impossibleScenario Devices are not compatible with each other and can't be bundled together.
radioFirmwareUpdateRequired Radio firmware update required for one or more device in the current bundle. Please connect with mobile app to your bundle to check wihch device(s) need update & follow the instructions from the mobile app to continue.
deviceFirmwareUpdateRequired Device firmware update required for one or more device in the current bundle. Please connect with mobile app to your bundle to check wihch device(s) need update & follow the instructions from the mobile app to continue.
unknown Unknown problem occured. Please retry.
deviceSearchProblem Link adapter could not find one or more device(s) with given mac address list.
alreadyGroupMember Device you want to pair is already in a bundle.
connectionProblem Connection problem occured. Please retry.

Disconnect from bundle

URL

/v1/link/{linkID}

Method

POST

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

Payload

{
  "command":"disconnect"
}
Label Type Value Description
command string disconnect Command name

Return value

See default return values.