Updated on 2024-12-02 GMT+08:00

Platform Delivering a Configuration Notification

Function

This API is used by the platform to deliver a configuration notification to a device. The platform allows you to perform remote configuration. You can remotely update device configuration items such as system and running parameters without interrupting device running. For example, you can remotely modify system parameters of cashiers running in Windows and the data reporting frequency of T-Boxes in the Internet of Vehicles (IoV) scenarios.

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 $device_config.

event_type

Mandatory

String

Explanation:

System field.

Value range:

Fixed at config_update.

event_time

Optional

String

Explanation:

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

paras

Mandatory

Object

Explanation:

Event parameters in JSON format.

paras structure

Parameter

Mandatory/Optional

Type

Description

config_content

Mandatory

Object

Explanation:

Configuration content.

Example

Topic: $oc/devices/{device_id}/sys/events/down  
Data format:
{
    "object_device_id":"{object_device_id}",
    "services":[
        {
            "service_id":"$device_config",
            "event_type":"config_update",
            "event_time":"20151212T121212Z",
            "paras":{
                "config_content":{
                    "config_key1":"device config1",
                    "config_key2":"device config2"
                }
            }
        }
    ]
}