Device

Get Link Module List And Status

This command returns the status of link modules. Connection time if link modules are no longer plugged into the PC

URL

/v1/device

Method

POST

Payload


{
    "command": "linkStatus"
}

Caution

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

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`	`[deviceinfo1, deviceinfo2]`	List of identified link modules

Label	Type	Value	Description
`initialFoundEpoch`	`string`	-	Epoch time that the link module was first defined
`isRadioFirmwareUpdateAvailable`	`bool`		If there is an available update for Link Radio device.
`isRadioFirmwareUpdateRequired`	`bool`		If there is a required update for Link Radio device.
`isDeviceFirmwareUpdateRequired`	`bool`		If there is a required update for Link device.
`isDeviceFirmwareUpdateAvailable`	`bool`		If there is an available update for Link device.
`isPairingDone`	`bool`	`true - false`	The value is true when pairing is done, otherwise false.
`isValid`	`bool`	`true - false`	Returns true as long as the module is connected to the computer. Otherwise returns false.
`linkConnectionType`	`string`	`wireless` `canbus` `rj45` `none`	List of identified link modules
`linkID`	`string`	`For Stop Motion Module: 24 character length` `For Link Adapter: 12 character length`	List of identified link modules
`linkType`	`string`	`stopMotionModule` `linkAdapter`	Indicates the type of module
`portName`	`string`	`For Windows: COM* - For Linux: ttyUSB*`	USB port name, it varies according to OS.

Note

Link ID vary between link modules. For example; the Stop Motion Module has 24 character length Link ID But Link Adapter has a 12 character length

Link Device Firmware Update

When Link device update is available or required. You can update this command.

URL

/v1/device

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":"startLinkDeviceFirmwareUpdate"
}

Label	Type	Description
`command`	`string`	`startLinkDeviceFirmwareUpdate`

Return value

See default return values.

Get Link Device Firmware Update Status

When update is started, it can be following with this command.

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":"linkDeviceFirmwareUpdateStatus"
}

Label	Type	Value	Description
`command`	`string`	`linkDeviceFirmwareUpdateStatus`	command name

Return value

{
  "status": "noDevice",
  "result": "ok"
}

Label	Type	Value	Description
NoDevice	`string`	`none` `running` `error` `multipleDevice` `noDevice` `finished`	Update status

Link Radio Firmware Update

When Link radio update is available or required. It can be updated with this command.

URL

/v1/device

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":"startLinkRadioFirmwareUpdate"
}

Label	Type	Description
`command`	`string`	`startLinkRadioFirmwareUpdate`

Return value

See default return values.

Get Link Radio Firmware Update Status

When update is started, it can be following with this command.

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":"linkRadioFirmwarUpdateStatus"
}

Label	Type	Value	Description
`command`	`string`	`linkRadioFirmwarUpdateStatus`	command name

Return value

{
  "status": "none",
  "result": "ok"
}

Label	Type	Value	Description
NoDevice	`string`	`none` `running` `error` `finished`	Update status

Default Return Values

{
  "result": "ok"
}

System executed your command without any issues.

{
  "result": "Invalid Arguments"
}

Given arguments are invalid.

{
  "result": "Not found Any Device"
}