Read device settings

POST

/op/v1/device/setting/get

Capability-first workflow:

Call /op/v1/device/setting/capability/get with the same SN.

Find the requested group and confirm readable=true.

If mode=SINGLE, select a field with readable=true and send both group and field.

If mode=BLOCK, send only group; do not send field.

Read the current value from result.value for SINGLE or result.values for BLOCK.

SINGLE example:

{
  "sn": "DEVICE_SN",
  "group": "basicParameter1",
  "field": "password"
}

BLOCK example:

{
  "sn": "DEVICE_SN",
  "group": "chargingTime"
}

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Examples

Read a single settingRead a setting block

{
    "sn": "DEVICE_SN",
    "group": "basicParameter1",
    "field": "password"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Read a single settingRead a setting block

curl --location '/op/v1/device/setting/get' \
--header 'token;' \
--header 'signature;' \
--header 'timestamp;' \
--header 'lang;' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "sn": "DEVICE_SN",
    "group": "basicParameter1",
    "field": "password"
}'

Responses

🟢200

application/json

Business response. Check errno even though the HTTP status is 200.

Bodyapplication/json

Example

{
    "errno": 0,
    "msg": "Operation successful",
    "result": {
        "group": "basicParameter1",
        "field": "password",
        "writeMode": "SINGLE",
        "value": 1234,
        "precision": 1,
        "range": {
            "min": 0,
            "max": 9999
        }
    }
}

Modified at 2026-09-02 03:05:18

Get device setting capabilities

Write device settings