Add Device Interface

Obtain temporary credentials(bindKey) before the device is registered

• API intent: query.device.bindKey
• Description: This interface is mainly used for Add Hub, which needs to be combined with SDK to execute.
• Request parameters

• Request Demo:

{
  "intent": "query.device.bindKey",
  "data": {
    "positionId": "real2.768799734306242560",
    "connectType": "lumi"
  }
}

• Response parameters

• Response demo:

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

Device registration status query

• API intent: query.device.bind
• Description: This interface is used in conjunction with "query.device.bindKey" to query the actual status of the gateway device.
• Request parameters

• Request Demo:

{
  "intent": "query.device.bind",
  "data": {
    "bindKey": "lumiuK68vu9IYBAB"
  }
}

• Response parameters

subInfos description:

• Response demo:

{
  "code": 0,
  "message": "Success",
  "requestId": "",
  "result": {
    "code": 0,
    "parentDid": "virtual2.13107395143333",
    "createTime": 1619489728008,
    "subInfos": [
      {
        "createTime": 1619489743705,
        "timeZone": "GMT+09:00",
        "model": "lumi.airrtc.tcpecn01",
        "updateTime": 1619489743705,
        "modelType": 3,
        "state": 1,
        "did": "virtual2.44788360390062"
      }
    ],
    "timeZone": "GMT+09:00",
    "model": "lumi.gateway.acn01",
    "updateTime": 1619489728008,
    "modelType": 1,
    "state": 1
  }
}

Enable Hub to add subdevice mode

• API intent: write.device.openConnect
• Description: This interface is mainly used to add sub-device, to enable the add sub-device mode of the specified gateway device.
• Request parameters

• Request Demo

{
  "intent": "write.device.openConnect",
  "data": {
    "did": "virtual2.59214901702075"
  }
}

• Response parameters: NA

• Response demo

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

Disable Hub to add subdevice mode

• API intent: write.device.closeConnect
• Description: This interface is used in conjunction with "write.device.openConnect" to close the add sub-device mode of the gateway device.
• Request parameters

• Request Demo

{
  "intent": "write.device.closeConnect",
  "data": {
    "did": "virtual2.59214901702075"
  }
}

• Response parameters: NA

• Response demo

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

Query the list of gateways that support sub-devices

• API intent: query.device.supportGateway
• Description: Since each gateway supports different types of sub-devices, the list of gateways supported by the specified sub-device can be queried through this interface. Used to add sub-device.
• Request parameters

• Request demo

{
    "intent": "query.device.supportGateway",
    "data": {
        "model": "lumi.ctrl_ln1.aq1"
    }
}

• Response parameters

• Response demo

{
    "code": 0,
    "message": "Success",
    "msgDetails": null,
    "requestId": 5278.138.16239230111747455,
    "result": [
        {
            "model": "lumi.gateway.acn01",
            "deviceName": "Hub M1S"
        },
        {
            "model": "lumi.gateway.iragl5",
            "deviceName": "Hub M2"
        }
    ]
}

Query the list of gateways that support sub-devices based on location

• API intent: query.position.supportGateway
• Description: Through this interface, you can query the list of gateways supported by the sub-device in the specified location. Used to add sub-device.
• Request parameters

• Request demo

{
    "intent": "query.position.supportGateway",
    "data": {
        "positionId": "real1.768799734012641280",
        "model": "lumi.ctrl_ln1.aq1",
        "pageNum": "1",
        "pageSize": "3"
    }
}

• Response parameters

gateways description

• Response demo

{
    "code": 0,
    "message": "Success",
    "msgDetails": null,
    "requestId": 5278.138.16239211117747455,
    "result": {
        "gateways": [
            {
                "model": "lumi.gateway.aqhm01",
                "state": 1,
                "deviceName": "Hub-1",
                "parentId": "virtual2.03022099714910"
            },
            {
                "model": "lumi.acpartner.aq1",
                "state": 1,
                "deviceName": "Air Conditioning Controller-2",
                "parentId": "virtual2.70319255630325"
            },
            {
                "model": "lumi.acpartner.aq1",
                "state": 1,
                "deviceName": "Air Conditioning Controller-1",
                "parentId": "virtual2.53946223162278"
            }
        ],
        "count": 3
    }
}