窗帘控制

通过设备ID控制窗帘开关

公共参数

请求地址:
环境 方法 HTTP请求地址
正式环境 POST http://ota.yystart.com/api/pms/device/curtain/setting/{deviceId}
头部信息:
名称 类型 是否必须 描述
authId String 用户唯一标识符
authToken String 用户管理凭证
Content-Type String 固定为application/json

请求参数

名称 类型 是否必须 示例值 描述
deviceId Long 244 设备唯一编号
status String 04 需要设定的开关状态位,04:开启,05:关闭,06:暂停

响应参数

名称 类型 示例值 描述
status String 04 需要设定的开关状态位,04:开启,05:关闭,06:暂停
code Integer 0 返回码,0表示成功,其余为失败
msg String success 返回信息,成功时信息固定为success,失败为具体的错误信息

请求示例

http://ota.yystart.com/api/pms/device/curtain/setting/244
  • JSON请求示例
{
  "status": "04"
}

响应示例

  • JSON成功示例
{
  "status": "04",
  "code": 0,
  "msg": "success"
}

状态码解释

状态码 描述
200 请求成功
400 参数错误(请检查参数名和值是否正确)
401 管理凭证不合法(请检查authId,authToken正确性)
415 MediaType错误(请在header中添加Content-Type:application/json)
500 服务器内部错误(服务器错误,请联系管理员)

窗帘百分比控制

通过设备ID控制窗帘开关

公共参数

请求地址:
环境 方法 HTTP请求地址
正式环境 POST http://ota.yystart.com/api/pms/device/curtain/settingPercentage/{deviceId}
头部信息:
名称 类型 是否必须 描述
authId String 用户唯一标识符
authToken String 用户管理凭证
Content-Type String 固定为application/json

请求参数

名称 类型 是否必须 示例值 描述
deviceId Long 244 设备唯一编号
percentage String 50 需要设定窗帘开启百分比:0~100

响应参数

名称 类型 示例值 描述
value String 50 操作设定的百分比
code Integer 0 返回码,0表示成功,其余为失败
msg String success 返回信息,成功时信息固定为success,失败为具体的错误信息

请求示例

http://ota.yystart.com/api/pms/device/curtain/settingPercentage/244
  • JSON请求示例
{
  "percentage": "50"
}

响应示例

  • JSON成功示例
{
  "value":"50",
  "code": 0,
  "msg": "success"
}

状态码解释

状态码 描述
200 请求成功
400 参数错误(请检查参数名和值是否正确)
401 管理凭证不合法(请检查authId,authToken正确性)
415 MediaType错误(请在header中添加Content-Type:application/json)
500 服务器内部错误(服务器错误,请联系管理员)

窗帘状态查询

通过设备ID查询窗帘状态

公共参数

请求地址:
环境 方法 HTTP请求地址
正式环境 GET http://ota.yystart.com/api/pms/device/curtain/{deviceId}
头部信息:
名称 类型 是否必须 描述
authId String 用户唯一标识符
authToken String 用户管理凭证
Content-Type String 固定为application/json

请求参数

名称 类型 是否必须 示例值 描述
deviceId Long 244 设备唯一编号

响应参数

名称 类型 示例值 描述
code Integer 0 返回码,0表示成功,其余为失败
msg String success 返回信息,成功时信息固定为success,失败为具体的错误信息
percent String 50 当窗帘支持百分比控制时才会有此参数,窗帘打开的百分比
status String 04 当窗帘不支持百分比控制时才会有此参数,04:开启,05:关闭,06:暂停

请求示例

http://ota.yystart.com/api/pms/device/curtain/244
  • JSON请求示例

										

响应示例

  • JSON成功示例
窗帘支持百分比控制:{
  "code": 0,
  "msg": "success",
  "percent":"50"
}
窗帘不支持百分比控制:{
  "code": 0,
  "msg": "success",
  "status":"05"
}

状态码解释

状态码 描述
200 请求成功
400 参数错误(请检查参数名和值是否正确)
401 管理凭证不合法(请检查authId,authToken正确性)
415 MediaType错误(请在header中添加Content-Type:application/json)
500 服务器内部错误(服务器错误,请联系管理员)