13. 智能照明API

API列表

agent调用

13.0.1 查询智能照明设备列表

描述

请求信息

HTTP协议：HTTP,HTTPS

method：device_list_service

请求参数

请求Body描述(非Form表单数据)

{
    "groupId": 610,
    "mac":131231,
    "deviceName":"大厅LED_005",
    "gatewayId":"020200005005",
    "pageNum":"1",
    "pageSize":"20"

}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "msg": "获取列表成功",
    "code": 200,
    "data": {
        "total": 20,
        "pageSize": 999,
        "list": [
            {
                "id": 2346,
                "deviceId": "76906876e46e9839",
                "projectId": "21321157",
                "templateId": "a0f4e7601d65b4f1c40d39cb4892f114",
                "platformId": "21321157_3_219",
                "deviceName": "大厅LED_001",
                "lastOnlineStatus": 1,
                "lastOnlineCheckTime": "2020-10-09T02:04:03.000+00:00",
                "address": "020200005001",
                "productType": "0",
                "isOnline": 1,
                "gatewayId": 15,
                "gatewayName": "网关",
                "ledGroup": 1,
                "coordinate": "12610950.4882717,2645707.7207494,2",
                "orderNum": 1,
                "remark": "1231",
                "productName": "物联网智能灯",
                "platformProductId": "3",
                "platformProjectId": "10",
                "platformDeviceId": "219",
                "brightness": "50",
                "groupName": "测试B区",
                "groupId": "10"
            }
        ],
        "pageNum": 1
    }
}

13.0.2 新增设备列表

描述

请求信息

HTTP协议：HTTP,HTTPS

method：device_add_service

请求参数

请求Body描述(非Form表单数据)

{
    "groupId": 610,
    "mac":131231,
    "deviceName":"大厅LED_005",
    "gatewayId":"020200005005",
    "pageNum":"1",
    "pageSize":"20"

}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

13.0.3 关联网关

描述

请求信息

HTTP协议：HTTP,HTTPS

method：rel_gw_service

请求参数

请求Body描述(非Form表单数据)

{
    "deviceIds": ["11","22"],
    "gatewayId":12,
    "gatewayName":"网关"

}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

13.0.4 读取配置

描述

请求信息

HTTP协议：HTTP,HTTPS

method：read_gateway_config

请求参数

请求Body描述(非Form表单数据)

{
    "groupId": "10"

}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "message": "OK"
}

13.0.5 更新设备

描述

请求信息

HTTP协议：HTTP,HTTPS

method：update_device_info

请求参数

请求Body描述(非Form表单数据)

{
    "groupId": "10",
    "deviceName": "211",
    "address": "122",
    "ledGroup": "ss",
    "coordinate": "111",
    "productTypeId": "111",
    "orderNum": "111",
    "remark": "1222",
    "deviceId": "222222"


}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "message": "OK"
}

13.0.6 删除设备

描述

请求信息

HTTP协议：HTTP,HTTPS

method：del_device_info

请求参数

请求Body描述(非Form表单数据)

{
    "deviceIds": ["11","22"]


}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "message": "OK"
}

13.0.7 单个灯控

描述

请求信息

HTTP协议：HTTP,HTTPS

method：open_device_lamp

请求参数

请求Body描述(非Form表单数据)

{
    "deviceIds": ["11","22"]


}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "message": "OK"
}

13.0.8 全控

描述

请求信息

HTTP协议：HTTP,HTTPS

method：open_device_all_lamp

请求参数

请求Body描述(非Form表单数据)

{
    "deviceIds": ["11","22"]


}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "message": "OK"
}

13.0.9 取消网关关联

描述

请求信息

HTTP协议：HTTP,HTTPS

method：cancel_rel_gw

请求参数

请求Body描述(非Form表单数据)

{
    "deviceIds": ["11","22"]


}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "message": "OK"
}

13.0.9.1 增加分组

描述

请求信息

HTTP协议：HTTP,HTTPS

method：add_area

请求参数

请求Body描述(非Form表单数据)

{
    "name": "xxxxx"


}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "message": "OK"
}

13.0.9.2 网关列表

描述

请求信息

HTTP协议：HTTP,HTTPS

method：gateway_list

请求参数

请求Body描述(非Form表单数据)

{
    "deviceIds": ["11","22"]


}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "data": [
        {
            "deviceIds": null,
            "gatewayName": "网关",
            "orderNum": 1,
            "updateTime": "2020-10-09 04:10:01",
            "remark": null,
            "dataScope": null,
            "params": {},
            "delFlag": "0",
            "lastLoginTime": "2020-10-09 04:10:01",
            "createBy": "admin",
            "createTime": "2020-05-25 21:28:08",
            "updateBy": "admin",
            "serial": "MHT_202007060005",
            "position": "测试房",
            "channelReceive": "/platformled/MHT_202007060005/update",
            "ipaddr": "192.168.12.134",
            "searchValue": null,
            "projectId": 10,
            "channelSend": "/platformled/MHT_202007060005/get",
            "gatewayId": 15,
            "gatewayStatus": "on_line",
            "status": "0"
        }

    ],
    "message": "操作成功"
}

13.0.9.3 新增网关

描述

请求信息

HTTP协议：HTTP,HTTPS

method：add_gw

请求参数

请求Body描述(非Form表单数据)

{
    "gatewayName": "xxx",
    "orderNum": "xxx",
    "position": "xxx",
    "groupId": "1",
    "remark": "1122",
    "serial": "1223"

}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "message": "OK"
}

13.0.9.4 删除网关

描述

请求信息

HTTP协议：HTTP,HTTPS

method：del_gw

请求参数

请求Body描述(非Form表单数据)

{
    "gatewayId": "xxx"


}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "message": "OK"
}

13.0.9.5 更新网关

描述

请求信息

HTTP协议：HTTP,HTTPS

method：update_gw

请求参数

请求Body描述(非Form表单数据)

{
    "gatewayId": "xxx"


}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "message": "OK"
}

13.0.9.6 分组列表

描述

请求信息

HTTP协议：HTTP,HTTPS

method：area_list

请求参数

| 名称 | 位置 | 类型 | 必填 | 描述 |

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "data": [
        {
            "subList": null,
            "icon": null,
            "updateTime": "2020-08-27 16:35:12",
            "remark": null,
            "dataScope": null,
            "params": {},
            "type": 2,
            "delFlag": "0",
            "parentId": 1,
            "createBy": "",
            "parentName": null,
            "createTime": "2020-05-25 21:27:05",
            "updateBy": "admin",
            "children": [],
            "name": "测试B区",
            "checked": null,
            "planId": 9,
            "id": 10,
            "position": null,
            "bid": null,
            "ancestors": "0,1",
            "searchValue": null,
            "status": "0"
        }
    ],
    "message": "OK"
}

13.0.9.7下发配置

描述

请求信息

HTTP协议：HTTP,HTTPS

method：write_gw_config

请求参数

| 名称 | 位置 | 类型 | 必填 | 描述 | | groupId | BODY | String | 否 | 分组Id |

请求Body描述(非Form表单数据)

{
"groupId": "10"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

API调用

13.1 空间相关接口

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/master-data/xxxxx

方法：POST

见主数据-2.空间项目列表

13.2 查询智能照明设备列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/device/list

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId": 610,
    "groupId": "10",
    "deviceName":"大厅LED_005",
    "mac":"020200005005",
    "gatewayId":"321"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
        "result":[{
            "deviceId":"sdsf32r23d2",
            "deviceName":"大厅LED",
            "mac":"020200005001" ,
            "deviceTypeId":"5",
            "deviceTypeName":"互联智能灯",
            "gatewayId":"35",
            "gatewayName":"测试网关",
            "online":"1",
            "allocate":"50000023"
            "brightness":50
            "groupId":"pub"
            "groupName":"测试停车场"
        }]
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.3 设备类型列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/device/type/list

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
  "pageNum": 1,
  "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
        "result":[{
            "deviceTypeId":"2",
            "deviceTypeName":"物联网智能灯" 
        }]
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.4 查询网关

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/gateway/list

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId":"610",
    "groupId":"10"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
        "result":[{
            "gatewayId":"网关ID",
            "gatewayName":"网关名称",
            "remark":"备注"
        }]
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.5 添加设备

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/device/add

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId": "671024",
    "groupId": "10",
    "spaceName" : "测试停车场",
    "deviceTypeId": "12345678",
    "deviceName": "671024",
    "mac": "12345678",
    "ledGroup": "671024",
    "coordinate": "12345678"
    "orderNum": "671024",
    "remark": "12345678"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.6 修改设备

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/device/modify

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId": "671024",
    "spaceId": "12345678",
    "spaceType": "671024",
    "spaceName" : "测试停车场",
    "deviceTypeId": "12345678",
    "deviceName": "671024",
    "mac": "12345678",
    "ledGroup": "671024",
    "coordinate": "12345678"
    "orderNum": "671024",
    "remark": "12345678"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.7 删除设备

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/device/delete

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId": "671024",
    "deviceIds": ["1d3d4d9a","b3fb2d32d"]
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.8 批量添加设备

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/device/batchAdd

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId":"610",
    "groupId":"23",
    "spaceName":"测试公共区域",
    "deviceTypeId":"2",
    "deviceNamePrefix":"测试灯",
    "macPrefix":"2345671",
    "deviceNum":5
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.9 查询网关未授权/已授权设备

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/gateway/queryDeviceList

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "gatewayId":"321",
    "deviceName":"测试灯",
    "mac":"2345671",
    "allocated":true,
    "pageNum": 1,
    "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
        "result":[{
            "deviceId":"223",
            "deviceName":"测试LED",
            "mac":"12344",
            "deviceTypeId":"234",
            "allocated":true
        }]
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.10 设备关联网关

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/gateway/allocateDevice

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "gatewayId":"321",
    "gatewayName": "网关",
    "deviceIds": ["2190000", "2200000", "2210000"],
    "allocate": true
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.11 灯控

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/device/lightControl

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId": "123456",
    "deviceIds": ["2190000", "2200000", "2210000"],
    "brightness" : 23
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.12 全控

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/device/lightGatewayControl

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId": "123456",
    "groupIds":["10"],
    "brightness" : 23
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.13 读取配置

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/device/loadConfig

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId": "123456",
    "groupIds":["10"]
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.14 下发配置

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/device/deliverConfig

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId": "123456",
    "groupIds":["10"]
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.15 查询分组

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/group/list

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId": "123456"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
        "result":[
            "name":"测试B区",
            "id":"10"
        ]
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.16 增加分组

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/group/add

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId": "123456",
    "groupName": "新增分组名"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.17 增加网关

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/gateway/add

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId":"610",
    "groupId":"10",
    "gatewayName":"网关名",
    "position":"位置",
    "orderNum":"233",
    "serial":"456u",
    "remark":"备注"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.18 删除网关

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/gateway/delete

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId":"610",
    "gatewayId":"网关名"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}

13.19 修改网关

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/smart-light/gateway/modify

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "projectId":"610",
    "groupId":"10",
    "gatewayId":"网关Id",
    "gatewayName":"网关名",
    "position":"位置",
    "orderNum":"233",
    "serial":"456u",
    "remark":"备注"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "返回码,0成功,其他失败",
    "message": "成功或失败提示信息",
    "data": {
    }
}

异常返回示例

{"code":"401","message":"error message"}