Digilent Agent Protocol

• The JSON data below is expanded for readability. All JSON should be minified (white space removed) before transmission.
• Unless otherwise noted all commands are sent using the POST method when using HTTP.
• All Digilent Agent Protocol commands must be a JSON object or a chunked transfer:
  • JSON Object
    • Must start with a '{' character and ends with a '}' character.
    • May be followed by one or more '\r\n'.
  • Chunked Transfer
    • Composed of one or more chunks.
    • Each chunk must begin with the number of bytes in the chunk inASCIIhexidecimal format followed by one '\r\n', the binary data, and one '\r\n'.
      • The chunk length does not include the '\r\n' between the chunk length and the data.
      • The chunk length does not include the trailing '\r\n' after the binary data.
    • Each chunked transfer is terminated with a zero length chunk.
    • Ex.

6\r\n chunk1\r\n 8\r\n somedata\r\n E\r\n in\r\n\r\nchunks.\r\n 0\r\n \r\n

Enumerate devices on the system and return a device list.

Command

• command- (String) - The Enumerate Devices command “enumerateDevices”.

Response

• command- (String) - The Enumerate Devices command “enumerateDevices”.
• statusCode(整数) - A numeric value representing the device status. SeeDigilent Agent Status Codes
• devices- (Array) - An array of device names.

Get information about the Digilent agent.

Command

• command- (String) - The Get Info command “getInfo”.

Response

• command- (String) - The Get Info command “getInfo”.
• statusCode(整数) - A numeric value representing the device status. SeeDigilent Agent Status Codes
• version- (Object) - An object representing the Agent version.
  • major(整数) - The Agent major version.
  • minor(整数) - The Agent minor version.
  • patch(整数) - The Agent patch version.

Note: Not yet implemented as of Digilent Agent 1.2.1.Get the active device.

Command

• command- (String) - The Get Active Device command “getActiveDevice”.

Response

• command- (String) - The Get Active Device command “getActiveDevice”.
• statusCode(整数) - A numeric value representing the device status. SeeDigilent Agent Status Codes
• device- (String) - The active device name.

Set the active device.

Command

• command- (String) - The Set Active Device command “setActiveDevice”.
• device- (String) - The name of the device to set as the active device.

Response

• command- (String) - The Set Active Device command “setActiveDevice”.
• statusCode(整数) - A numeric value representing the device status. SeeDigilent Agent Status Codes

Put the active device in JSON command mode.

Command

• command- (String) - The Enter JSON Mode command “enterJsonMode”.

Response

• command- (String) - The Enter JSON Mode command “enterJsonMode”.
• statusCode(整数) - A numeric value representing the device status. SeeDigilent Agent Status Codes

Release the active device and free the hardware resource.Command

• command- (String) - The Release Active Device command “releaseActiveDevice”.

Response

• command- (String) - The Release Active Device command “releaseActiveDevice”.
• statusCode(整数) - A numeric value representing the device status. SeeDigilent Agent Status Codes

Save the provided binary data as the specified file in a temp directory.

Command

• command- (String) - The Save Temp File command “saveTempFile”.
• 文件名- (String) - The file name used when saving the binary data.

Response

• command- (String) - The Save Temp File command “saveTempFile”.
• statusCode(整数) - A numeric value representing the device status. SeeDigilent Agent Status Codes

Upload new firmware to the active device.

Command

• command- (String) - The Upload Firmware command “updateFirmware”.
• enterBootloader- (Boolean) - If true the Agent will attempt to put the device in bootloader mode.
• firmwarePath- (String) - The path to the firmware file. If only the file name is provided the directory is assumed to be the temp directory.

Response

• command- (String) - The Upload Firmware command “updateFirmware”.
• statusCode(整数) - A numeric value representing the device status. SeeDigilent Agent Status Codes

Update the offline browser version of WaveForms Live.

Command

• command- (String) - The Update WaveForms Live Browser command “updateWaveFormsLiveBrowser”.
• updateZipFileName- (String) - The path to the file name of the zip file containing the update including the .zip extension (file must be in temp directory).

Response

• command- (String) - The Update WaveForms Live Browser command “updateWaveFormsLiveBrowser”.
• statusCode(整数) - A numeric value representing the device status. SeeDigilent Agent Status Codes

Get the status of the firmware update process.

Command

• command(字符串)更新固件comman获得地位d “updateFirmwareGetStatus”.

Response

• command- (String) - The Update Firmware Get Status “updateFirmwareGetStatus”.
• statusCode(整数) - A numeric value representing the device status. SeeDigilent Agent Status Codes
• status- (String) - The status of the firmware update process ('idle', 'uploading', 'failed');
• progress(整数) - An integer value 0-100 representing the percent complete.

Response