cbrx_firmware (status)

This method can be used to obtain the status of a firmware update.

Syntax: see Call Structure

{

"method": "cbrx_firmware",

"params": [

"status",

"connection-handle",

]

}

connection-handle is the Connection Handles as an integer

Returns:

{

"result": [

"Version": "firmware-version", "Type": "firmware-type", "Progress": progress-percentage, "Stage": "stage-value" ]

}
Parameter Description
firmware-version Version number of the firmware
firmware-type Used to denote the type of firmware
progress-percentage The update progress as a percentage
stage-value The "stage" the firmware update is currently in
stage-value Description
none Firmware is not being updated
connecting Connecting to the hub to update the firmware
init The update is initialising
erasing Erasing current firmware
erased Current firmware has been erased
updating New firmware is being installed
updated New firmware has finished being installed
verifying Checking that the firmware has installed correctly
complete The check has completed
rebooting Rebooting the hub after all checks and installation complete
rebooted Hub has been rebooted and is ready for use
skipped Update skipped as hub already updated
  • Errors

    • If there is an error in the stage then one of the below errors will appear in the stage values. Any of these stage errors mean that the hub’s firmware is in an invalid state and would need to be re-done.

    stage-error Description
    crypt-init-failed The wrong type of firmware was used for the selected device
    init-failed The initialisation stage failed
    erase-failed The current firmware could not be erased
    flash-failed The new firmware could not be installed onto the hub
    check-failed The installation checks failed
    reboot-failed The hub was unable to be rebooted
    Example

    Example JSON-RPC request:

    Copy 
    {
      "jsonrpc": "2.0",
      "id": 0,
      "method": "cbrx_firmware",
      "params": [
        "status",
        "7654"
      ]
    }

    Example successful response:

    Copy 
    {
      "jsonrpc": "2.0",
      "id": 0,
      "result": [
        "Version": "1.79",
        "Type": "un",
        "Progress": 60,
        "Stage": "verifying"
      ]
    }