Help Center/ IoT Device Access/ API Reference/ MQTT or MQTTS API Reference on the Device Side/ Software and Firmware Upgrade/ Device Reporting the Software and Firmware Versions
Updated on 2023-02-16 GMT+08:00
View PDF
Share

Device Reporting the Software and Firmware Versions

Function

This API is used by a device to report the software and firmware versions.

Topic

Upstream: $oc/devices/{device_id}/sys/events/up

Parameters

Parameter

Mandatory or Optional

Type

Description

object_device_id

Optional

String

Indicates the device that the event is about. If this parameter is not carried, the device specified in the topic is considered to be the device involved.

services

Optional

List<ServiceEvent>

Indicates a list of services that the event is about.

ServiceEvent structure

Parameter

Mandatory or Optional

Type

Description

service_id

Mandatory

String

System field. The value is fixed to $ota.

event_type

Mandatory

String

System field. The value is fixed to version_report.

event_time

Optional

String

Indicates the time when the event occurs.

paras

Mandatory

Object

Indicates the event parameters in JSON format.

paras structure

Parameter

Mandatory or Optional

Type

Description

sw_version

Optional

String

Indicates the software version.

fw_version

Optional

String

Indicates the firmware version.

Example

Topic: $oc/devices/{device_id}/sys/events/up  
Data format:
{ 
    "object_device_id": "{object_device_id}", 
    "services": [{ 
        "service_id": "$ota", 
        "event_type": "version_report", 
        "event_time": "20151212T121212Z", 
        "paras": { 
            "sw_version": "v1.0", 
            "fw_version": "v1.0" 
        } 
    }] 
}