Report OTA


The Report OTA node reports OTA information such as the device firmware version, OTA progress, etc. For more information about firmware upgrade OTA in EnOS, see Firmware Upgrade OTA.

Node Type

IoT Hub.

Input and Output Ability

This node has multiple entry points and 1 exit point. Both input and output format are JSON.


The input needs to follow the EnOS OTA update format, as per the example below.

{
    "assetId":"assetId",
    "params": {
        "version":"2.1"
    }
}


Possible parameters inside params include the below.

  • verison: The firmware version number that the device reports.

  • progress: The device OTA progress, which corresponds to the the OTA step. For more information, see Developing OTA Capabilities on Devices. Positive values can indicate the OTA progress, and negative values can indicate a failure.

  • desc: Additional descriptive information, such as describing a failure.

Note

An error will be reported in these 2 scenarios.

  • When assetId is not given.

  • When both version and progress exist at the same time. Only one can be used at any one time.

Node Properties

../../_images/report_ota.png


Name

The name for this node.


Description

The description for this node.

Limitations

  • Needs to follow the EnOS OTA protocol update format.

Samples

Input Samples

{
  "assetId": "BzWDwkn1",
  "params": {
    "progress": "66"
  }
}

Output Sample

The output is the same as the input.