设备绑定

用于设备绑定，设备绑定后会生成设备编号

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	POST	http://ota.yystart.com/api/pms/device/bind

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证
Content-Type	String	是	固定为application/json

请求参数

名称	类型	是否必须	示例值	描述
bucketId	String	是	A1001	绑定标识唯一编号，由开发者自己决定，可以是房间编号，可以是用户编号
mac	String	是	202020202054	网关MAC地址
ieee	String	是	00124B000B7CC466	设备的IEEE
port	String	是	08	设备的端口号

响应参数

名称	类型	示例值	描述
deviceId	Long	244	设备唯一编号
code	Integer	0	返回码，0表示成功，其余为失败
msg	String	success	返回信息，成功时信息固定为success,失败为具体的错误信息

请求示例

JSON请求示例

{
  "bucketId": "A1001",
  "mac": "202020202054",
  "ieee": "00124B000B7CC466",
  "port": "08"
}

响应示例

JSON成功示例

{
  "deviceId": 244,
  "code": 0,
  "msg": "success"
}

状态码解释

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

设备解绑

用于设备和房间解除绑定

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	POST	http://ota.yystart.com/api/pms/device/unbind/{deviceId}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证
Content-Type	String	是	固定为application/json

请求参数

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

响应参数

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

请求示例

http://ota.yystart.com/api/pms/device/unbind/244

JSON请求示例

响应示例

JSON成功示例

{
  "code": 0,
  "msg": "success"
}

状态码解释

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

设备重命名

通过设备编号给设备重命名

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	POST	http://ota.yystart.com/api/pms/device/rename/{deviceId}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证
Content-Type	String	是	固定为application/json

请求参数

名称	类型	是否必须	示例值	描述
deviceId	Long	是	244	设备唯一编号
deviceName	String	是	客厅大灯	设备名称

响应参数

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

请求示例

http://ota.yystart.com/api/pms/device/rename/244

JSON请求示例

{
  "deviceName": "客厅大灯"
}

响应示例

JSON成功示例

{
  "code": 0,
  "msg": "success"
}

状态码解释

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

查找指定设备列表

通过设备编号查找设备信息

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	GET	http://ota.yystart.com/api/pms/device/list/{deviceIds}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证

请求参数

名称	类型	是否必须	示例值	描述
deviceIds	String	是	371,372	设备编号，多个请用[,]隔开

响应参数

名称	类型	示例值	描述
deviceId	Long	244	设备唯一编号,如果该设备没有绑定，则不存在该字段，是否绑定可以通过[binding]这个字段判断
deviceType	String	0100	设备类型
deviceName	String	三路开关	设备名称
mac	String	202020202054	网关MAC地址
ieee	String	00124B000B7CC466	设备的IEEE
port	String	08	设备的端口号
status	String	01	设备的状态位，如果是开关，00:关闭，01:开启
online	Boolean	true	是否在线
binding	Boolean	true	是否已绑定房间
bucketId	String	A1001	绑定标识唯一编号，由开发者自己决定，可以是房间编号，可以是用户编号
bindTime	Date	1495682044258	绑定时间
deviceFirmware	String	1.2.3	设备固件版本

请求示例

http://ota.yystart.com/api/pms/device/list/371,372

JSON请求示例

响应示例

JSON成功示例

[{
  "deviceId": 244,
  "deviceType": "0100",
  "deviceName": "三路开关",
  "mac": "202020202054",
  "ieee": "00124B000B7CC466",
  "port": "08",
  "status": "01",
  "online": true,
  "binding": true,
  "bucketId": "A1001",
  "bindTime": 1495682044258,
  "deviceFirmware": "1.2.3"
}]

状态码解释

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

查找在线设备列表

通过网关查找在线设备列表,包括绑定和未绑定的设备

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	GET	http://ota.yystart.com/api/pms/device/list/online/{mac}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证

请求参数

名称	类型	是否必须	示例值	描述
mac	String	是	202020202054	网关MAC地址
type	Integer	是	1	需要查找的设备类型，无type参数为所有设备， 1门锁，2电表，3水表，4插座开关，5窗帘，6中央空调，7取电开关

响应参数

名称	类型	示例值	描述
deviceId	Long	244	设备唯一编号,如果该设备没有绑定，则不存在该字段，是否绑定可以通过[binding]这个字段判断
deviceType	String	0100	设备类型
deviceName	String	三路开关	设备名称
mac	String	202020202054	网关MAC地址
ieee	String	00124B000B7CC466	设备的IEEE
port	String	08	设备的端口号
status	String	01	设备的状态位，如果是开关，00:关闭，01:开启
online	Boolean	true	是否在线
binding	Boolean	true	是否已绑定房间
bucketId	String	A1001	绑定标识唯一编号，由开发者自己决定，可以是房间编号，可以是用户编号
bindTime	Date	1495682044257	绑定时间
deviceFirmware	String	1.2.3	设备固件版本

请求示例

http://ota.yystart.com/api/pms/device/list/online/202020202054?type=1

JSON请求示例

响应示例

JSON成功示例

[{
  "deviceId": 244,
  "deviceType": "0100",
  "deviceName": "三路开关",
  "mac": "202020202054",
  "ieee": "00124B000B7CC466",
  "port": "08",
  "status": "01",
  "online": true,
  "binding": true,
  "bucketId": "A1001",
  "bindTime": 1495682044257,
  "deviceFirmware": "1.2.3"
}]

状态码解释

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

查找已绑定的设备列表

通过房间编号查找已绑定的设备列表

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	GET	http://ota.yystart.com/api/pms/device/list/bound/{bucketIds}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证

请求参数

名称	类型	是否必须	示例值	描述
bucketIds	String	是	A1001,A1002	绑定编号，如果要查询多个，请用【,】隔开
type	Integer	否	1	需要查找的设备类型，无type参数为所有设备， 1门锁，2电表，3水表，4插座开关，5窗帘，6中央空调，7取电开关

响应参数

名称	类型	示例值	描述
deviceId	Long	244	设备唯一编号,如果该设备没有绑定，则不存在该字段，是否绑定可以通过[binding]这个字段判断
deviceType	String	0100	设备类型
deviceName	String	三路开关	设备名称
mac	String	202020202054	网关MAC地址
ieee	String	00124B000B7CC466	设备的IEEE
port	String	08	设备的端口号
status	String	01	设备的状态位，如果是开关，00:关闭，01:开启
online	Boolean	true	是否在线
binding	Boolean	true	是否已绑定房间
bucketId	String	A1001	绑定标识唯一编号，由开发者自己决定，可以是房间编号，可以是用户编号
bindTime	Date	1495682044256	绑定时间
deviceFirmware	String	1.2.3	设备固件版本

请求示例

http://ota.yystart.com/api/pms/device/list/bound/A1001,A1002?type=1

JSON请求示例

响应示例

JSON成功示例

[{
  "deviceId": 244,
  "deviceType": "0100",
  "deviceName": "三路开关",
  "mac": "202020202054",
  "ieee": "00124B000B7CC466",
  "port": "08",
  "status": "01",
  "online": true,
  "binding": true,
  "bucketId": "A1001",
  "bindTime": 1495682044256,
  "deviceFirmware": "1.2.3"
}]

状态码解释

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

设备信息

通过设备ID查找设备基本信息，包括设备网关，设备IEEE,设备端口，设备是否在线，设备固件版本

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	GET	http://ota.yystart.com/api/pms/device/{deviceId}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证

请求参数

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

响应参数

名称	类型	示例值	描述
deviceId	Long	244	设备唯一编号,如果该设备没有绑定，则不存在该字段，是否绑定可以通过[binding]这个字段判断
deviceType	String	0100	设备类型
deviceName	String	三路开关	设备名称
mac	String	202020202054	网关MAC地址
ieee	String	00124B000B7CC466	设备的IEEE
port	String	08	设备的端口号
status	String	01	设备的状态位，如果是开关，00:关闭，01:开启
online	Boolean	true	是否在线
binding	Boolean	true	是否已绑定房间
bucketId	String	A1001	绑定标识唯一编号，由开发者自己决定，可以是房间编号，可以是用户编号
bindTime	Date	1495682044269	绑定时间
deviceFirmware	String	1.2.3	设备固件版本

请求示例

http://ota.yystart.com/api/pms/device/244

JSON请求示例

响应示例

JSON成功示例

{
  "deviceId": 244,
  "deviceType": "0100",
  "deviceName": "三路开关",
  "mac": "202020202054",
  "ieee": "00124B000B7CC466",
  "port": "08",
  "status": "01",
  "online": true,
  "binding": true,
  "bucketId": "A1001",
  "bindTime": 1495682044269,
  "deviceFirmware": "1.2.3"
}

状态码解释

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