Device Management

Query device information

• API intent: query.device.info
• Description: This interface is used to query the basic information of the device, including device ID, position, offline status, firmware version, time zone, etc.
• Request parameters

• Request Demo

{
  "intent": "query.device.info",
  "data": {
    "dids": [
      "virtual2.07737309957642",
      "virtual2.07639066475218"
    ],
    "positionId": "",
    "pageNum": 1,
    "pageSize": 50
  }
}

• Response parameters

data description:

• Response demo

{
  "code": 0,
  "message": "Success",
  "requestId": "",
  "result": {
    "data": [
      {
        "parentDid": "",
        "positionId": "real2.730432352746111072",
        "createTime": 1615899097028,
        "timeZone": "GMT+09:00",
        "model": "lumi.gateway.aqhm01",
        "updateTime": 1615899097028,
        "modelType": 1,
        "state": 1,
        "firmwareVersion": "3.2.6",
        "deviceName": "Aqara Hub",
        "did": "lumi.07737309957642"
      },
      {
        "parentDid": "",
        "positionId": "real2.730432352746111072",
        "createTime": 1615901365498,
        "timeZone": "GMT+09:00",
        "model": "lumi.acpartner.v3",
        "updateTime": 1615901365498,
        "modelType": 1,
        "state": 1,
        "firmwareVersion": "3.2.6",
        "deviceName": "Hub",
        "did": "lumi.07639066475218"
      }
    ],
    "totalCount": 2
  }
}

Query sub-device information based on the Gateway

• API intent: query.device.subInfo
• Description: This interface is used to query the sub-device information under the specified gateway, including device ID, position, offline status, firmware version, time zone, etc.
• Request parameters

• Request Demo

{
  "intent": "query.device.subInfo",
  "data": {
    "did": "virtual2.11774113824794"
  }
}

• Response demo:

{
  "code": 0,
  "message": "Success",
  "requestId": "",
  "result": [
    {
      "parentDid": "virtual2.11774113824794",
      "positionId": "real2.730432352746111072",
      "createTime": 1617871502389,
      "timeZone": "GMT+09:00",
      "model": "lumi.ctrl_ln1.v1",
      "updateTime": 1617871502389,
      "modelType": 3,
      "state": 1,
      "did": "virtual2.64483555231364"
    }
  ]
}

Update device information

• API intent: config.device.name
• Description: This interface is used to modify the device name.
• Request parameters

• Request Demo

{
  "intent": "config.device.name",
  "data": {
    "did": "virtual2.11774113824794",
    "name": "xxxx"
  }
}

• Response parameters: NA

• Response demo

{
  "code": 0,
  "message": "Success",
  "requestId": "",
  "result": ""
}

Update device position

• API intent: config.device.position
• Description: This interface is used to modify device location information.
• Request parameters

• Request Demo

{
    "intent": "config.device.position",
    "data": {
        "dids": ["virtual2.55212213159523"],
        "positionId":"real2.768799734306242560"
    }
}

• Response parameters: NA

• Response demo

{
    "code": 0,
    "message": "Success",
    "msgDetails": null,
    "requestId": "",
    "result": ""
}

Unbind device

• API intent: write.device.unbind
• Description: This interface is used to unbind the gateway and sub-devices.
• Request parameters

• Request Demo

{
  "intent": "write.device.unbind",
  "data": {
    "did": "virtual2.40035874561345"
  }
}

• Response parameters: NA

• Response demo

{
  "code": 0,
  "requestId": "",
  "message": "Success",
  "msgDetails": null,
  "result": ""
}