List Currently Connected Wired Devices

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 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": [
        {
            "isDeviceFirmwareUpdateAvailable": false,
            "type": "slideModuleV3"
        },
        {
            "isDeviceFirmwareUpdateAvailable": false,
            "type": "headPlusV2"
        }
    ],
    "result": "ok"
}
Label Type Value Description
data - - Array of information about edelkrone motion control system(s) connected to the Link Adapter via 3.5mm Link cable.
Label Type Value Description
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.
type string - See Device Type Table below
Device Type Product Name
slideModuleV3 Slide Module v3
panPro PanPRO
headPlusV2 HeadPLUS v2
headPlusProV2 HeadPLUS v2 PRO
focusPlusPro FocusPLUS PRO

Connect to Wired Device(s)

This command tries to pair the Link Adapter to one or more devices connected with the Link (3.5mm) cables or tries to attach the Link Adapter to an already paired group with wired interface.

URL

/v1/link/{linkID}

Method

POST

Caution

edelkrone SDK does not support CORS, so when you send a request with the "OPTIONS" method, edelkrone 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 Wired 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 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
Pairing State
lastPairError string - See Last Pair Error table below
Last Pair Error Description
none -
impossibleScenario Devices are not compatible with each other and can't be bundled together.
cantAppendDevice At least one device inside the wired network is paired and at least another one is not paired. You can't append an unpaired device to an already paired group.
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. Please retry.

Disconnect

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.