|
|
@@ -30,10 +30,10 @@
|
|
|
|
|
|
此开发文档只针对智能家居面板，门禁，网关等设备。
|
|
|
|
|
|
-# 设备配置数据格式
|
|
|
+# 设备配置数据获取接口说明
|
|
|
|
|
|
GET 请求URL：
|
|
|
-[https://dev.izhiju.cn/device](https://dev.izhiju.cn/device)
|
|
|
+[https://dev.izhiju.cn/config](https://dev.izhiju.cn/config)
|
|
|
|
|
|
请求头参数：
|
|
|
Content-Type: application/json
|
|
|
@@ -60,11 +60,11 @@ Authorization: Bearer {{token}}
|
|
|
| 415 | 请求失败，不支持的媒体类型 |
|
|
|
| 500 | 请求失败，服务端内部错误 |
|
|
|
|
|
|
-## 获取设备配置列表数据
|
|
|
+## 同步设备配置列表数据
|
|
|
|
|
|
### GET请求URL
|
|
|
|
|
|
- {{api_url}}/config?{{query_params}}
|
|
|
+ {{api_url}}/sync?{{query_params}}
|
|
|
|
|
|
### 查寻参数
|
|
|
|
|
|
@@ -73,7 +73,7 @@ Authorization: Bearer {{token}}
|
|
|
| package | string | cn.izhiju.android.xxx | 获取配置的应用包名，必须字段如：cn.izhiju.android.panela |
|
|
|
| key | string | 平台相关的密钥 | 应用获取升级的密钥，必须字段 |
|
|
|
| deviceId | string | ac:bc:cd:ee:11:22 | 设备ID或MAC地址，必须字段，后台添加限制时保持一致即可，智能家居应用目前定为大写MAC去冒号 |
|
|
|
-| type | string | device | 获取哪些配置 all和不传为所有，device为设备配置
|
|
|
+| type | string | device | 获取哪些配置 all和不传为所有，device为设备配置列表，scene为场景配置列表，area为区域配置列表，all为所有组合配置
|
|
|
|
|
|
### 返回结果
|
|
|
|
|
|
@@ -520,28 +520,86 @@ Authorization: Bearer {{token}}
|
|
|
"ports": [1], //端口为canbus或485本机地址，纯网络面板，端口保留，或为网关本地id，跨网关时使用
|
|
|
"background":["http://192.168.0.1/bg.jpg", "http://192.168.0.1/bg.jpg"],//要下载同步缓存的背景图片，数组
|
|
|
"city":{
|
|
|
- "Location_ID": "101010800",
|
|
|
- "Location_Name_EN": "Yanqing",
|
|
|
- "Location_Name_ZH": "延庆",
|
|
|
- "ISO_3166_1": "CN",
|
|
|
- "Country_Region_EN": "China",
|
|
|
- "Country_Region_ZH": "中国",
|
|
|
- "Adm1_Name_EN": "Beijing",
|
|
|
- "Adm1_Name_ZH": "北京市",
|
|
|
- "Adm2_Name_EN": "Beijing",
|
|
|
- "Adm2_Name_ZH": "北京市",
|
|
|
- "Timezone": "Asia/Shanghai",
|
|
|
- "Latitude": "40.465324",
|
|
|
- "Longitude": "115.985008",
|
|
|
- "Adcode": "110119"
|
|
|
- },
|
|
|
- "season":"common", //summer/winter/common(不区分时令),或者时令只能本地配置
|
|
|
+ "Location_ID": "101010800",
|
|
|
+ "Location_Name_EN": "Yanqing",
|
|
|
+ "Location_Name_ZH": "延庆",
|
|
|
+ "ISO_3166_1": "CN",
|
|
|
+ "Country_Region_EN": "China",
|
|
|
+ "Country_Region_ZH": "中国",
|
|
|
+ "Adm1_Name_EN": "Beijing",
|
|
|
+ "Adm1_Name_ZH": "北京市",
|
|
|
+ "Adm2_Name_EN": "Beijing",
|
|
|
+ "Adm2_Name_ZH": "北京市",
|
|
|
+ "Timezone": "Asia/Shanghai",
|
|
|
+ "Latitude": "40.465324",
|
|
|
+ "Longitude": "115.985008",
|
|
|
+ "Adcode": "110119"
|
|
|
+ },
|
|
|
+ "season":"common", //summer/winter/common(不区分时令),第一次配置的默认值，或者时令只能本地配置
|
|
|
|
|
|
}
|
|
|
},
|
|
|
]
|
|
|
```
|
|
|
|
|
|
+### 智能系统场景配置数据格式
|
|
|
+
|
|
|
+```json
|
|
|
+[
|
|
|
+ {
|
|
|
+ "id": 1,
|
|
|
+ "pid": 1,
|
|
|
+ "areaId": "区域id",
|
|
|
+ "area": "区域名称",
|
|
|
+ "name": "0001",
|
|
|
+ "displayName": "设备显示名称",
|
|
|
+ "type": "scene",
|
|
|
+ "subtype": "work",
|
|
|
+ "actions": //场景动作执行项
|
|
|
+ {
|
|
|
+ "common":[
|
|
|
+ {
|
|
|
+ "name": "0001",
|
|
|
+ "channels":[{ //具体数据项看设备控制协议定义
|
|
|
+ "value": "off",
|
|
|
+ "name": "action",
|
|
|
+ "type": "STRING"}]
|
|
|
+ },
|
|
|
+ {
|
|
|
+ "name": "0002",
|
|
|
+ "channels": [{
|
|
|
+ "value": "off",
|
|
|
+ "name": "action",
|
|
|
+ "type": "STRING"}]
|
|
|
+ }
|
|
|
+ ], //场景默认配置，不区分时令，一般处理非温控类设备,不管哪个季节都执行
|
|
|
+ "summer":[],//夏季配置,处理温控类设备，夏季要执行的场景
|
|
|
+ "winter":[],//冬季配置,处理温控类设备，冬季要执行的场景
|
|
|
+ }
|
|
|
+ }
|
|
|
+ ]
|
|
|
+
|
|
|
+```
|
|
|
+
|
|
|
+### 智能系统区域数据格式
|
|
|
+
|
|
|
+```json
|
|
|
+[
|
|
|
+ {
|
|
|
+ "id":"1",
|
|
|
+ "pid":"1",
|
|
|
+ "name":"区域名称",
|
|
|
+ "groupable":true,//是否可分组显示,可分组为分类目录，不可分组为叶目录
|
|
|
+ },
|
|
|
+ {
|
|
|
+ "id":"2",
|
|
|
+ "pid":"1",
|
|
|
+ "name":"区域名称",
|
|
|
+ "groupable":false,//是否可分组显示,可分组为分类目录，不可分组为叶目录
|
|
|
+ }
|
|
|
+]
|
|
|
+```
|
|
|
+
|
|
|
### 组合配置数据格式实例
|
|
|
|
|
|
```json
|
miricy