Help Center/ IoT Device Access/ API Reference/ MQTT or MQTTS API Reference on the Device Side/ Software and Firmware Upgrade/ Platform Delivering an Event to Obtain Version Information
Updated on 2024-12-02 GMT+08:00
View PDF
Share

Platform Delivering an Event to Obtain Version Information

Function

This API is used by the platform to deliver an event to obtain version information.

Topic

Downstream: $oc/devices/{device_id}/sys/events/down

Parameters

Parameter

Mandatory/Optional

Type

Description

object_device_id

Optional

String

Explanation:

  • For gateway child device: The value is the child device ID in the topic.
  • For directly connected device: The value is the same that of device_id in the topic.

services

Optional

List<ServiceEvent>

Explanation:

List of services that an event is about.

ServiceEvent structure

Parameter

Mandatory/Optional

Type

Description

service_id

Mandatory

String

Explanation:

System field.

Value range:

Fixed at $ota.

event_type

Mandatory

String

Explanation:

System field.

Value range:

Fixed at version_query.

event_time

Optional

String

Explanation:

Event time. UTC time format: yyyyMMdd'T'HHmmss'Z'.

paras

Optional

Object

Explanation:

Indicates the JSON object of the event parameter. No specific field is delivered when the event to obtain version information is delivered.

paras structure

Parameter

Mandatory/Optional

Type

Description

task_id

Optional

String

Explanation:

ID of a batch software/firmware upgrade task in gateway mode.

sub_device_count

Optional

Integer

Explanation:

Number of child devices to be upgraded in a batch software/firmware upgrade task in gateway mode.

task_ext_info

Optional

Object

Explanation:

Extended information added during software/firmware upgrade task creation.

Example

Topic: $oc/devices/{device_id}/sys/events/down  
Data format:
{
    "object_device_id": "{object_device_id}",
    "services": [
        {
            "service_id": "$ota",
            "event_type": "version_query",
            "event_time": "20151212T121212Z",
            "paras": {
                "task_id": "65d31bf2581ed33a42a58d76",
                "sub_device_count": 2,
                "task_ext_info": {
                    "device_type": "DDC"
                }
            }
        }
    ]
}