灯光设备接口
GVP提供灯光设备功能的查询接口和控制接口，第三方平台请根据业务需求使用相关的接口。
1、获取单个或所有灯光状态数据
请求接口示例，192.168.1.108是GVP服务端所在电脑的IP地址，请根据实际情况调整
http://192.168.1.108:8008/api/?HDLRequest=GetLampDeviceStatus
请求方式:POST
接口地址:/api/?HDLRequest=GetLampDeviceStatus
请求数据类型:application/json
响应数据类型:application/json
接口描述： 获取单个或所有灯光状态数据
Headers参数
| Key | Value | 描述 |
|---|---|---|
| Authorization | Token值 | 登录成功时获取到的Token值,如果过期请重新登录 |
请求参数
| 字段 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| DeviceGuid | String | true | 功能设备的GUID，值为“all”时获取所有灯光，否则只获取GUID指定的单个灯光设备 |
请求示例，但是最后要使用加密方法加密字符串才提交
{"DeviceGuid":"all"}
响应参数:
| 字段 | 类型 | 描述 |
|---|---|---|
| ReplyCode | String | 响应码 |
| ReplyMessage | String | 响应消息提示 |
| ReplyDataType | Integer | 响应数据类型，可忽略 |
| ReplyObject | Array<Object> | 响应数据，详细信息参考示例说明 |
响应示例:
{
"ReplyCode": "Success",
"ReplyMessage": "成功",
"ReplyDataType": 0,
"ReplyObject": [
{
"LampStatus": 0,// 灯光状态，0关闭，1打开
"LampBrightness": 0, // 灯光亮度
"CCTValue": 4500, // 色温灯才有的色温值
"LampDelayTime": 0,
"LampColor": null, // RGB灯才有的颜色值，如#FFFFFF
"AutoCloseLampCount": 0,
"DeviceGuid": "7e3966be-2900-4e13-a6cc-101a08132823", // 灯光设备唯一GUID
"DeviceName": "大门口天花藏光灯带",
"DeviceType": 257, // 灯光类型:256调光灯，257开关灯，258色温灯，259RGB灯，262DALI可调光灯,268带电流检测继电器
"VirtualZoneGuidList": "e8557096-ae0b-4c10-b224-4b6b00c43c8c", // 灯光设备所在区域GUID
"DeviceOnlineState": 2, // 设备状态:2故障或离线，1在线
"ProjectGuid": null,
"DeviceHoursLife": 0,
"DeviceProtocolStyle": 0,
"ProjectName": null,
"LastCountPowerDatetime": 0
}
],
"TotalRowCount": 0,
"AlarmCount": 0,
"PageCount": 0
}
2、控制单个灯光
请求接口示例，192.168.1.108是GVP服务端所在电脑的IP地址，请根据实际情况调整
http://192.168.1.108:8008/api/?HDLRequest=ControlLampDevice
请求方式:POST
接口地址:/api/?HDLRequest=ControlLampDevice
请求数据类型:application/json
响应数据类型:application/json
接口描述： 控制灯光设备的接口，指定单个灯光设备控制的
Headers参数
| Key | Value | 描述 |
|---|---|---|
| Authorization | Token值 | 登录成功时获取到的Token值,如果过期请重新登录 |
请求参数
| 字段 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| DeviceGuid | String | true | 灯光设备唯一Guid |
| LampActionType | String | true | 控制灯光的动作类型：TurnOn，TurnOff，Dimmer，RGB，CCT 注意：TurnOn或TurnOff适用于所有灯光设备打开或关闭；Dimmer调光、这个动作类型，灯光如果是关闭的会直接打开，并设置对应的亮度；同理，RGB颜色控制、CCT色温控制也是如此，先开灯再设置对应的值； |
| LampBrightness | int | true | 控制灯光的亮度值: 0-100; 只有灯光动作为Dimmer时有效，其它动作设置默认值为0 |
| LampColor | String | true | RGB控制时的颜色值,如“#FF0000”，纯红色；只有灯光动作为RGB时有效，其它动作设置默认值为“#000000” |
| CCTValue | int | true | CCT色温灯控制时的范围值，2000~7000; 只有灯光动作为CCT时有效，其它动作设置默认值为0 |
请求示例，但是最后要使用加密方法加密字符串才提交
{"DeviceGuid":"","LampActionType":"","LampBrightness":0,"LampColor":"","CCTValue":0}
响应参数:
| 字段 | 类型 | 描述 |
|---|---|---|
| ReplyCode | String | 响应码 |
| ReplyMessage | String | 响应消息提示 |
| ReplyDataType | Integer | 响应数据类型，可忽略 |
| ReplyObject | Array | 响应数据，详细信息参考示例说明 |
响应成功示例:
{
"ReplyCode": "Success",
"ReplyMessage": "成功",
"ReplyDataType": 0,
"ReplyObject": {},
"TotalRowCount": 0,
"AlarmCount": 0,
"PageCount": 0
}
3、查询灯光的电流值
请求接口示例，192.168.1.108是GVP服务端所在电脑的IP地址，请根据实际情况调整
http://192.168.1.108:8008/api/?HDLRequest=GetLampCurrent
请求方式:POST
接口地址:/api/?HDLRequest=GetLampCurrent
请求数据类型:application/json
响应数据类型:application/json
接口描述： 获取指定灯光的电流值
Headers参数
| Key | Value | 描述 |
|---|---|---|
| Authorization | Token值 | 登录成功时获取到的Token值,如果过期请重新登录 |
请求参数
| 字段 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| DeviceGuid | String | true | 获取指定GUID的单个灯光设备的电流值 |
请求示例，但是最后要使用加密方法加密字符串才提交
{"DeviceGuid":""}
响应参数:
| 字段 | 类型 | 描述 |
|---|---|---|
| ReplyCode | String | 响应码 |
| ReplyMessage | String | 响应消息提示 |
| ReplyDataType | Integer | 响应数据类型，可忽略 |
| ReplyObject | Array | 响应数据，详细信息参考示例说明 |
响应示例:
{
"ReplyCode": "Success",
"ReplyMessage": "成功",
"ReplyDataType": 0,
"ReplyObject": {
"DeviceGuid": "c77f0ead-fc97-4085-bd64-e9594ad5b7b3", // 灯光设备唯一GUID
"DeviceName": "1号打位射灯", // 灯光名称
"DeviceType": 268, // 灯光类型:256调光灯，257开关灯，258色温灯，259RGB灯，262DALI可调光灯,268带电流检测继电器
"DeviceOnlineState": 2, // 设备状态，2故障，1在线
"LampStatus": 0, // 开关状态，0关闭，1打开
"LampBrightness": 0, // 亮度值
"LampCurrent": 0.0 // 电流值，单位A
},
"TotalRowCount": 0,
"AlarmCount": 0,
"PageCount": 0
}