Updated on 2023-04-06 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 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

Indicates the system field. The value is fixed to $device_config.

event_type

Mandatory

String

Indicates the system field. The value is fixed to config_update.

event_time

Optional

String

Indicates the time when the event occurs.

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

paras

Mandatory

Object

Indicates the event parameters in JSON format.

paras structure

Parameter

Mandatory or Optional

Type

Description

config_content

Mandatory

Object

Indicates the 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"
                }
            }
        }
    ]
}