一、简要说明
服务器地址: http://ai.home.etapi.com.cn/api/
控制器:Device
示例:
请求方式:
http://ai.home.etapi.com.cn/api/Device
服务器返回数据说明
每个接口都返回下面JSON数据集合。Data数据集是多维数组,客户端可以直接转。
{ "State": true, --请求结果状态 true "Data": "[]", --服务器返回的数据 "Message": "请求完成", --消息 "Code": "0011" --状态码 }
二、注册接口
名称:
Add
请求方式:POST
示例:http://ai.home.etapi.com.cn/api/Device/Add
参数名 | 描述 |
---|---|
Name | 设备名称 |
Type | 设备类型: Light 灯 DoorLock 门 AirCondition 空调 RiceCooker 电饭煲 Curtain 窗帘 |
PubIP | 公网IP |
PrivIP | 私有IP |
Mac | MAC地址 |
三、获取设备命令
名称:
EquipmentInfo
请求方式:POST
示例:http://ai.home.etapi.com.cn/api/Device/EquipmentInfo
参数名 | 描述 |
---|---|
MAC | 设备的MAC地址 |
Type | 设备类型: Light 灯 DoorLock 门 AirCondition 空调 RiceCooker 电饭煲 Curtain 窗帘 |
三、设备控制
请求方式:
POST
控制设备:
灯
名称:ControlDeviceLight
示例:http://ai.home.etapi.com.cn/api/Device/ControlDeviceLight控制设备:
门
名称:ControlDeviceDoorLock
示例:http://ai.home.etapi.com.cn/api/Device/ControlDeviceDoorLock控制设备:
空调
名称:ControlDeviceAirCondition
示例:http://ai.home.etapi.com.cn/api/Device/ControlDeviceAirCondition控制设备:
电饭煲
名称:ControlDeviceRiceCooker
示例:http://ai.home.etapi.com.cn/api/Device/ControlDeviceRiceCooker控制设备:
窗帘
名称:ControlDeviceCurtain
示例:http://ai.home.etapi.com.cn/api/Device/ControlDeviceCurtain
四、控制参数
所有设备的参数都必须带有MACAddress ,其余参数则根据具体设备控制的内容改变而改变,详细参数见“五、所有设备获取或者控制的数据”,以下是控制灯的例子:
参数名 | 描述 |
---|---|
MACAddress | 设备的MAC地址 |
OnOff | 开关,On是开启,Off是关闭 |
Brightness | 亮度,0-100,0是暗,100是亮 |
OnTime | 预约每天开启,取时分 |
OffTime | 预约每天关闭,取时分 |
五、设备获取或控制的数据
灯,返回JSON数据说明。
{ "OnOff": "On", --开关,On是开启,Off是关闭 "Brightness": "50", --亮度,0-100,0是暗,100是亮 "OnTime": "2018-09-28 11:18:00.000", --预约每天开启,取时分 "OffTime": "2018-09-19 20:33:00.000", --预约每天关闭,取时分 }
门,返回JSON数据说明。
{ "OnOff": "On", --开关,On是开启,Off是关闭 "BackLocking": "On", --反锁,On是开启,Off是关闭 "Password": "dadad48641513", --门锁密码 }
空调,返回JSON数据说明。
{ "OnOff": "On", --开关,On是开启,Off是关闭 " Temperature": "26", --温度,16-30度之间 "SwingFlapLevel": "On", --水平/左右扫风,On是开启,Off是关闭 "SwingFlapVertical": "On", --垂直/上下扫风,On是开启,Off是关闭 "AirSpeed": "Auto", --风速,Auto是自动,One是一档,Two是二档,Three是三档 "Model": "Refrigeration", --模式,Refrigeration是制冷,Air是吹风,Heat是加热 "Sleep": "On", --睡眠模式,On是开启,Off是关闭 "Silence": "On", --静音模式,On是开启,Off是关闭 "OnTime": "2018-09-28 11:18:00.000", --预约每天开启,取时分 "OffTime": "2018-09-19 20:33:00.000", --预约每天关闭,取时分 "RunTime": "2018-09-19 20:33:00.000", --预约运行多久后关闭,取时分 }
电饭煲,返回JSON数据说明。 注:Cook系列的功能同一时间只能开启一个
{ "OnOff": "On", --开关,On是开启,Off是关闭 "CookRice": "On", --煮饭功能,On是开启,Off是关闭 "CookPorridge": "On", --粥/羹功能,On是开启,Off是关闭 "CookChicken": "On", --鸡/排骨功能,On是开启,Off是关闭 "CookSteamed": "On", --蒸功能,On是开启,Off是关闭 "CookBean": "On", --豆/蹄筋功能,On是开启,Off是关闭 "CookSoup": "On", --煲汤功能,On是开启,Off是关闭 "CookBabyFood": "On", --婴儿辅食功能,On是开启,Off是关闭 "CookCake": "On", --蛋糕功能,On是开启,Off是关闭 "CookHeat": "On", --加热功能,On是开启,Off是关闭 "CookWarm": "On", --保温功能,On是开启,Off是关闭 "AutoWarm": "On", --自动保温,On,Off是关闭,当Cook系列功能结束时判断是开启保温 "FinishRemind ": "2018-09-28 11:18:00.000", --烹饪完成后隔多久发出提示(伴随振铃),取时分 "OpenWarn": "On", --烹饪未完成时开盖发出警告,On是开启,Off是关闭 "OpenStopHeat": "On", --烹饪未完成时开盖停止加热,On是开启,Off是关闭 }
窗帘,返回JSON数据说明。
{ "OnOff": "On", --开关,On是开启,Off是关闭 "Degree": "30", --开启程度,0-100,0是关闭,100是打开 "OnTime": "2018-09-28 11:18:00.000", --预约每天开启,取时分 "OffTime": "2018-09-19 20:33:00.000", --预约每天关闭,取时分 }