Get Link Module List And Status
URL
/v1/device
Method
POST
Payload
{
"command": "linkStatus"
}
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 always sent as "text/plain" NOT "application/json".
Label | Type | Value | Description |
---|---|---|---|
command |
string |
linkStatus |
Command name |
Return value
{
"data": [
{
"initialFoundEpoch": "1634625480462967400",
"isDeviceFirmwareUpdateAvailable": false,
"isDeviceFirmwareUpdateRequired": false,
"isFirmwareCorrupted": false,
"isPairingDone": false,
"isRadioFirmwareUpdateAvailable": false,
"isRadioFirmwareUpdateRequired": false,
"isValid": true,
"linkConnectionType": "none",
"linkID": "206034415530",
"linkType": "linkAdapter",
"portName": "COM7"
}
],
"result": "ok"
}
Label | Type | Value | Description |
---|---|---|---|
data |
device list |
- | List of identified link modules |
Label | Type | Value | Description |
---|---|---|---|
initialFoundEpoch |
string |
- | When did edelkrone SDK enumerated this particular link adapter initially? |
isRadioFirmwareUpdateAvailable |
bool |
- | Update is available for radio firmware of the link adapter. |
isRadioFirmwareUpdateRequired |
bool |
- | Update is required for radio firmware of the link adapter. |
isDeviceFirmwareUpdateRequired |
bool |
- | Update is required for device firmware of the link adapter. |
isDeviceFirmwareUpdateAvailable |
bool |
- | Update is available for device firmware of the link adapter. |
isPairingDone |
bool |
- | Starts off false and goes to true when a pairing operation is completed successfull. Goes back to false when link adapter disconnects from the current bundle. |
isValid |
bool |
- | Starts off true when first enumerated. Goes to false if you unplug the particular link adpater while edelkrone SDK is running. |
linkConnectionType |
string |
|
Link connection type |
linkID |
string |
- | Unique LinkID string for the particular link adapter. |
linkType |
string |
- | Indicates the type of link adapter. |
portName |
string |
- | Hardware port name. |
Link Device Firmware Update
You can update device firmware of your link adapter with this command.
URL
/v1/device
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":"startLinkDeviceFirmwareUpdate"
}
Label | Type | Value | Description |
---|---|---|---|
command |
string |
startLinkDeviceFirmwareUpdate |
Command name |
Return value
Get Link Device Firmware Update Status
Device firmware update progress can be checked with this command.
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":"linkDeviceFirmwareUpdateStatus"
}
Label | Type | Value | Description |
---|---|---|---|
command |
string |
linkDeviceFirmwareUpdateStatus |
Command name |
Return value
{
"status": "noDevice",
"result": "ok"
}
Label | Type | Value | Description |
---|---|---|---|
status |
string |
none | - |
status |
string |
multipleDevice | There are multiple devices in DFU mode. There has to be only one. |
status |
string |
noDevice | There isn't any device in DFU mode. |
status |
string |
running | Firmware update process is running. |
status |
string |
finished | Firmware update process is finished. |
Link Radio Firmware Update
You can update radio firmware of your link adapter with this command.
URL
/v1/device
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":"startLinkRadioFirmwareUpdate"
}
Label | Type | Value | Description |
---|---|---|---|
command |
string |
startLinkRadioFirmwareUpdate |
Command name |
Return value
Get Link Radio Firmware Update Status
Radio firmware update progress can be checked with this command.
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":"linkRadioFirmwarUpdateStatus"
}
Label | Type | Value | Description |
---|---|---|---|
command |
string |
linkRadioFirmwarUpdateStatus |
Command name |
Return value
{
"status": "none",
"result": "ok"
}
Label | Type | Value | Description |
---|---|---|---|
status |
string |
none | - |
status |
string |
running | Firmware update process is running. |
status |
string |
finished | Firmware update process is finished. |
status |
string |
error | An error occured. Please retry. |
Detect Link Adapter
When this command is sent to Link Adapter, LED of the Link Adapter becomes on for 1 second.
URL
/v1/link/{linkID}/detect
Method
GET
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".
Return value