Platform Setting Device Properties

Function

This API is used by the platform to set properties of a device. The product model of a device defines the device properties that can be set by the platform. For the details of the API, see Modify Device Properties. When a device receives a property setting request, the device needs to return the execution result to the platform. Otherwise, the request is considered to have timed out by the platform.

It is not suitable to report data in JSON format for devices with low configuration and limited resources or with limits on bandwidth usage. In this case, devices can transparently transmit the original binary data to the platform, but a codec is required to convert binary data to JSON format. For details about how to develop codecs, see Developing a Codec.

Topic

Downstream: $oc/devices/{device_id}/sys/properties/set/request_id={request_id}

Upstream: $oc/devices/{device_id}/sys/properties/set/response/request_id={request_id}

• When an application modifies device properties, the platform generates a unique ID to identify the request. This ID is carried in request_id in the downstream topic of the platform-side device property configuration.
• The device cannot detect the request_id in advance. When a device subscribes to a topic that ends with request_id={request_id}, the number sign (#) can be used to replaced request_id={request_id}, for example, $oc/devices/{device_id}/sys/properties/set/#.

Downstream Request Parameters

ServiceProperty structure

Upstream Response Parameters

Example Downstream Request

Topic: $oc/devices/{device_id}/sys/properties/set/request_id={request_id} 
Data format:
{
    "object_device_id":"{object_device_id}",
    "services": [{
            "service_id": "Temperature",
            "properties": {
                "value": 57,
                "value2": 60
            }
        },
        {
            "service_id": "Battery",
            "properties": {
                "level": 80,
                "level2": 90
            }
        }
    ]
}

Example Upstream Response

Topic: $oc/devices/{device_id}/sys/properties/set/response/request_id={request_id}
Data format:
{
    "result_code": 0,
    "result_desc": "success"
}