智能楼宇API-新华三开发者中心-H3C

DI.Lab

首页

解决方案

API Explorer

智能楼宇API

控制设备指令下发

下发设备控制指令

接口URL

https://lvzhouapi.h3c.com/iot/iot_smartbuilding_app/switchcontroller

访问方法

HTTP 方法

POST

参数

scenarioId

场所ID。

String类型，必选。

tmnOIDList

终端OID数组，数组元素即为"tmnOIDIndex"。

String类型，必选。

deviceStatus

预操作设备状态："0"表示关闭"1"表示打开

String类型，必选。

返回结果

状态码

消息头

消息体

元素含义

Links各子元素

Object

控制下发data为空，下发结果在获取设备信息时获取。

String类型。

应用举例

请求

回应

获取场景下开关设备实时信息

下发设备控制指令

接口URL

https://lvzhouapi.h3c.com/iot/iot_smartbuilding_app/switchinfo?scenarioId={scenarioId}&pageSize={pageSize}&pageNum={pageNum}&tmnType={tmnType}&state={state}&deviceStatus={deviceStatus}

访问方法

HTTP 方法

GET

参数

scenarioId	场所ID。 String类型，必选。
pageSize	分页大小。 Number类型，必选。
pageNum	分页当前页数。 Number类型，必选。
tmnType	设备类型，”zigbee开关”，为了区分不同设备类型，当前暂时只有”zigbee开关”。 String类型，必选。
state	设备在线状态：online表示在线,offline表示离线。 String类型，可选。
deviceStatus	设备状态，用于按状态查找设备：“0”表示关闭，”1”表示打开。 String类型，可选。

返回结果

状态码

消息头

消息体

{
                        <br>"data": [
                        <br> {
                        <br>     "totals": 2,
                        <br>     "scenarioId":"123",
                        <br>     "pageSize": 1,
                        <br>     "pageNum": 3,
                        <br>     "dviceData": {
                        <br>     "tmnOIDIndex":"123",
                        <br>     "tmnDevSN":"210236A35VA10A488888",
                        <br>     "updateTime":12345,
                        <br>     "firmTopic":"123"
                        <br>     "setStatus":1,
                        <br>     "state":"1",
                        <br>     "deviceStatus":"1"
                        <br> }]
                        <br>}

元素含义

Links各子元素
totals	场所中智能开关的总个数。 Number类型。
scenarioId	场景id。 String类型。
pageSize	分页大小。 Number类型。
pageNum	分页当前页数。 Number类型。
tmnOIDIndex	终端唯一标识。 String类型。
tmnDevSN	终端序列号。 String类型。
updateTime	更新时间（ms）。 Number类型。
firmTopic	厂商Topic。 String类型。
setStatus	指令下发状态。 Number类型。
state	设备在线状态。 String类型。
deviceStatus	设备状态。 String类型。

应用举例

请求

回应

HTTP/1.1 200 OK
                            <br> Content-Type: application/json
                            <br> ...
                            <br>
                            <br>{
                            <br>    "data": [
                            <br>     {
                            <br>        "totals": 2,
                            <br>        "scenarioId":"123",
                            <br>        "pageSize": 1,
                            <br>        "pageNum": 3,
                            <br>        "dviceData": {
                            <br>        "tmnOIDIndex":"123",
                            <br>        "tmnDevSN":"210236A35VA10A488888"
                            <br>        "updateTime":12345,
                            <br>        "firmTopic":"123"
                            <br>        "setStatus":1,
                            <br>        "state":"1"
                            <br>        "deviceStatus":"1",
                            <br>     },]
                            <br>}

获取场景下某一设备的实时信息

下发设备控制指令

接口URL

https://lvzhouapi.h3c.com/iot/iot_smartbuilding_app/singleswitchinfo?scenarioId={scenarioId}&tmnOIDIndex={tmnOIDIndex}

访问方法

HTTP 方法

GET

参数

scenarioId

场景id。

String类型，必选。

tmnOIDIndex

设备OID,设备唯一标识

String类型，必选。

返回结果

状态码

0：成功
其他：失败

消息头

消息体

元素含义

Links各子元素
scenarioId	场景id。 String类型。
tmnOIDIndex	终端唯一标识。 String类型。
tmnDevSN	终端序列号。 String类型。
updateTime	更新时间（ms）。 Number类型。
firmTopic	厂商Topic。 String类型。
setStatus	指令下发状态。 Number类型。
state	设备在线状态。 String类型。
deviceStatus	设备状态。 String类型。

应用举例

请求

回应

HTTP/1.1 200 OK
                            <br> Content-Type: application/json
                            <br> ...
                            <br>
                            <br>{
                            <br>"data": [
                            <br> {
                            <br>    "scenarioId":"123",
                            <br>    "tmnOIDIndex":”123”,
                            <br>    "tmnDevSN":"210236A35VA10A488888",
                            <br>    "updateTime":12345,
                            <br>    "firmTopic":"123",
                            <br>    "setStatus":1,
                            <br>    "state":"1",
                            <br>    "deviceStatus":"1",
                            <br> }]
                            <br>}