窗帘设备接口

GVP提供窗帘设备功能的查询接口和控制接口,第三方平台请根据业务需求使用相关的接口。

1、获取单个或所有窗帘状态数据

请求接口示例,192.168.1.108是GVP服务端所在电脑的IP地址,请根据实际情况调整

http://192.168.1.108:8008/api/?HDLRequest=GetCurtainStatus

请求方式:POST

接口地址:/api/?HDLRequest=GetCurtainStatus

请求数据类型: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": [
        {
            "DeviceGuid": "ce658f64-7a77-42eb-8a79-353a6feae3ad", // 窗帘设备唯一GUID
            "DeviceName": "卷帘2", // 窗帘名称
            "DeviceType": 512, // 窗帘类型:512开合帘电机,513卷帘,514普通窗帘,515百叶窗
            "DeviceOnlineState": 2, // 设备状态,2故障,1在线
            "CurtainStatus": 0, // 窗帘状态,0=停止,1=打开,2=关闭
            "CutainPercentage": 0, // 窗帘百分比值
            "CutainAngle": 0, // 窗帘角度值
            "RegionName": "河东企业→天河办公室→一楼→大会议室" // 窗帘设备所在位置信息
        },       
        {
            "DeviceGuid": "c113ffe3-6f3f-427c-b836-4c9e0eac3a71",
            "DeviceName": "卷帘3",
            "DeviceType": 512,
            "DeviceOnlineState": 2,
            "CurtainStatus": 0,
            "CutainPercentage": 0,
            "CutainAngle": 0,
            "RegionName": "河东企业→天河办公室→一楼→大会议室"
        }        
    ],
    "TotalRowCount": 0,
    "AlarmCount": 0,
    "PageCount": 0
}

2、控制单个窗帘

请求接口示例,192.168.1.108是GVP服务端所在电脑的IP地址,请根据实际情况调整

http://192.168.1.108:8008/api/?HDLRequest=ControlCurtain

请求方式:POST

接口地址:/api/?HDLRequest=ControlCurtain

请求数据类型:application/json

响应数据类型:application/json

接口描述: 控制窗帘设备的接口,指定单个窗帘进行控制

Headers参数

Key Value 描述
Authorization Token值 登录成功时获取到的Token值,如果过期请重新登录

请求参数

字段 类型 是否必须 描述
DeviceGuid String true 窗帘设备唯一Guid
CurtainActionType String true 窗帘的动作值:Stop=停止,Open=打开,Close=关闭,Percent=百分比控制,AngleControl=角度控制
CutainPercentage int true 窗帘百分比值,或,窗帘角度值0-180;窗帘动作值为“Percent”或“AngleControl”时使用,其它情况默认0

请求示例,但是最后要使用加密方法加密字符串才提交

{"DeviceGuid":"","CurtainActionType":"","CutainPercentage":0}

响应参数:

字段 类型 描述
ReplyCode String 响应码
ReplyMessage String 响应消息提示
ReplyDataType Integer 响应数据类型,可忽略
ReplyObject Array 响应数据,详细信息参考示例说明

响应成功示例:

{
    "ReplyCode": "Success",
    "ReplyMessage": "成功",
    "ReplyDataType": 0,
    "ReplyObject": {},
    "TotalRowCount": 0,
    "AlarmCount": 0,
    "PageCount": 0
}

results matching ""

    No results matching ""