Просмотр исходного кода

修改类型不一致问题,统一id,pid,port为字符串

miricy 1 год назад
Родитель
Сommit
6a528484ce
1 измененных файлов с 333 добавлено и 328 удалено
  1. 333 328
      product/deviceconfig.md

+ 333 - 328
product/deviceconfig.md

@@ -8,12 +8,10 @@
 
 <font size=12> 历史记录 </font>
 
-
 | 修订日期  | 版本 | 作者       | 说明     |
 | --------- | ---- | ---------- | -------- |
 | 2024-11-18 | V1.0 | alva.huang | 初始版本 |
 
-
 <div style="page-break-after: always;"></div>
 
 [toc]
@@ -60,79 +58,86 @@ Authorization: Bearer {{token}}
 | 415    | 请求失败,不支持的媒体类型                    |
 | 500    | 请求失败,服务端内部错误                      |
 
-
 ## 返回结果规范
+
 ```json
 {
     "code": 200,
     "msg": "操作成功",
-    "data": 一个标准的json对象或者数组对象
+    "data": {}//一个标准的json对象或者数组对象
 }
 ```
 
 ## 服务器配置
+
 ### GET 请求URL
+
 {{api_url}}/v1/device/configs
+
 ### 返回结果
+
 ```json
 {
-	"code": 200,
-	"msg": "操作成功",
-	"data": {
-		"custid": "1",
-		"req_ip": "127.0.0.1",
-		"mqtt_username": "bill",
-		"mqtt_password": "activemq",
-		"mqtt_server": "tcp://dev.neucore.com:1783",
-		"upload_server": "https://dev.neucore.com/v1/smrtlibs/neulink/upload2cloud",
-		"ftp_server": "dev.neucore.com",
-		"ftp_username": "neu2ftp",
-		"ftp_password": "123456"
-	},
-	"time": "1736902247895"
+ "code": 200,
+ "msg": "操作成功",
+ "data": {
+  "custid": "1",
+  "req_ip": "127.0.0.1",
+  "mqtt_username": "bill",
+  "mqtt_password": "activemq",
+  "mqtt_server": "tcp://dev.neucore.com:1783",
+  "upload_server": "https://dev.neucore.com/v1/smrtlibs/neulink/upload2cloud",
+  "ftp_server": "dev.neucore.com",
+  "ftp_username": "neu2ftp",
+  "ftp_password": "123456"
+ },
+ "time": "1736902247895"
 }
 ```
 
 ## 背景图片列表
+
 ### GET 请求URL
+
 {{api_url}}/v1/device/configs/background
 
 ### 返回结果
+
 ```json
 {
-	"code": 200,
-	"msg": "操作成功",
-	"data": [
-		{
-			"id": "1",
-			"name": "111..png",
-			"displayName": "111",
-			"size": "63163",
-			"backgroundPxId": "1",
-			"pxName": "1x2",
-			"imgUrl": "v1/static/project/2025/03/03/default/111.png",
-			"version": 1,
-			"status": 0,
-			"isDel": 0,
-			"createTime": "2025-03-03 11:47:09",
-			"updateTime": "2025-03-03 11:47:09"
-		},
-		{
-			"id": "2",
-			"name": "312312..png",
-			"displayName": "312312",
-			"size": "49672",
-			"backgroundPxId": "4",
-			"pxName": null,
-			"imgUrl": "v1/static/project/2025/03/07/default/312312.png",
-			"version": 1,
-			"status": 0,
-			"isDel": 0,
-			"createTime": "2025-03-07 06:38:39",
-			"updateTime": "2025-03-07 06:38:39"
-		}
-	],
-	"time": "1741663562859"
+ "code": 200,
+ "msg": "操作成功",
+ "data": [
+  {
+   "id": "1",
+   "name": "111..png",
+   "displayName": "111",
+   "size": "63163",
+   "backgroundPxId": "1",
+   "pxName": "1x2",
+   "imgUrl": "v1/static/project/2025/03/03/default/111.png",
+   "version": 1,
+   "status": 0,
+   "isDel": 0,
+   "createTime": "2025-03-03 11:47:09",
+   "updateTime": "2025-03-03 11:47:09"
+  },
+  {
+   "id": "2",
+   "name": "312312..png",
+   "displayName": "312312",
+   "size": "49672",
+   "backgroundPxId": "4",
+   "pxName": null,
+   "imgUrl": "v1/static/project/2025/03/07/default/312312.png",
+   "version": 1,
+   "status": 0,
+   "isDel": 0,
+   "createTime": "2025-03-07 06:38:39",
+   "updateTime": "2025-03-07 06:38:39"
+  }
+ ],
+ "time": "1741663562859"
 }
 ```
 
@@ -153,14 +158,15 @@ Authorization: Bearer {{token}}
     
 }
 ```
+
 ## 同步设备配置列表数据
 
 ### GET请求URL
   
   {{api_url}}/v1/device/configs/:deviceId/:scope
+
 ### HEAD 参数
 
-  
 ### 查寻参数
 
 | 参数名   |   参数类型   | 值    | 说明              |
@@ -176,281 +182,280 @@ Authorization: Bearer {{token}}
 
 ```json
 {
-	"code": 200,
-	"msg": "操作成功",
-	"data": {
-		"city": {
-			"location_id": "101010400",
-			"location_name_en": "Shunyi",
-			"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.128937",
-			"longitude": "116.653526",
-			"adcode": "110113"
-		},
-		"areas": [
-			{
-				"id": "2",
-				"pid": "0",
-				"name": "1",
-				"groupable": false
-			}
-		],
-		"devices": [
-			{
-				"opr": "addOrUpd",
-				"id": "16",
-				"pid": "8",
-				"area_id": "2",
-				"type": "humiture",
-				"subtype": "humiture_common",
-				"name": "00000009",
-				"display_name": "温湿度",
-				"description": "122",
-				"version": 2,
-				"config": {
-					"broadcast": false,
-					"bus": "canbus",
-					"temp": 24,
-					"address": "22",
-					"port": "1",
-					"humidity": 60
-				}
-			},
-			{
-				"opr": "addOrUpd",
-				"id": "18",
-				"pid": "8",
-				"area_id": "2",
-				"type": "panel",
-				"subtype": "canbus",
-				"name": "20000001",
-				"display_name": "面板",
-				"description": "112",
-				"version": 2,
-				"config": {
-					"broadcast": false,
-					"bus": "canbus",
-					"address": "1",
-					"display_scene": [],
-					"associated_machine": [],
-					"is_gateway": false,
-					"associated_sensor": [
-						{
-							"type": "humiture",
-							"name": "00000009",
-							"calibration": 0
-						}
-					],
-					"lock_end_time": "23:59:59",
-					"icons": [],
-					"control_bits": [],
-					"background": [],
-					"lock_weekday": [
-						1,
-						2,
-						3,
-						4,
-						5,
-						6,
-						7
-					],
-					"display_device": [
-						{
-							"name": "00000002",
-							"lock": false
-						},
-						{
-							"name": "00000005",
-							"lock": false
-						},
-						{
-							"name": "00000007",
-							"lock": false
-						},
-						{
-							"name": "00000008",
-							"lock": false
-						}
-					],
-					"lock_start_time": "00:00:00"
-				}
-			},
-			{
-				"opr": "addOrUpd",
-				"id": "8",
-				"pid": "0",
-				"area_id": "2",
-				"type": "gateway",
-				"subtype": "YG001",
-				"name": "40000001",
-				"display_name": "网关",
-				"description": "2",
-				"version": 2,
-				"config": {
-					"broadcast": false,
-					"bus": "canbus",
-					"address": "1",
-					"master": true
-				}
-			},
-			{
-				"opr": "addOrUpd",
-				"id": "9",
-				"pid": "8",
-				"area_id": "2",
-				"type": "light",
-				"subtype": "light_common",
-				"name": "00000002",
-				"display_name": "灯光11",
-				"description": "112333333333333333333",
-				"version": 2,
-				"config": {
-					"broadcast": false,
-					"bus": "canbus",
-					"address": "21",
-					"port": "1"
-				}
-			},
-			{
-				"opr": "addOrUpd",
-				"id": "12",
-				"pid": "8",
-				"area_id": "2",
-				"type": "aircon",
-				"subtype": "aircon_common",
-				"name": "00000005",
-				"display_name": "空调",
-				"description": "112",
-				"version": 2,
-				"config": {
-					"broadcast": false,
-					"bus": "canbus",
-					"temp": 26,
-					"modes": [
-						"fan",
-						"cool",
-						"heat"
-					],
-					"address": "22",
-					"associated_sensor": [
-						{
-							"type": "humiture",
-							"name": "00000009",
-							"calibration": 0
-						}
-					],
-					"control_addr": "1",
-					"temp_max": 30,
-					"hvac_addr": "1",
-					"accessibilities": [
-						"smart_up",
-						"smart_left",
-						"smart_auto"
-					],
-					"temp_min": 16,
-					"port": "1",
-					"speeds": [
-						"2",
-						"1",
-						"3"
-					],
-					"control_type": "protocol"
-				}
-			},
-			{
-				"opr": "addOrUpd",
-				"id": "14",
-				"pid": "8",
-				"area_id": "2",
-				"type": "airfresh",
-				"subtype": "airfresh_daikin",
-				"name": "00000007",
-				"display_name": "新风",
-				"description": "112",
-				"version": 2,
-				"config": {
-					"broadcast": false,
-					"bus": "canbus",
-					"temp": 20,
-					"modes": [
-						"fan_side",
-						"heat_exchange",
-						"auto"
-					],
-					"address": "12",
-					"control_addr": "1",
-					"hvac_addr": "1",
-					"control_bits": [
-						{
-							"name": "speed_1_port",
-							"value": "1"
-						},
-						{
-							"name": "speed_3_port",
-							"value": "1"
-						}
-					],
-					"port": "1",
-					"speeds": [
-						"1",
-						"3"
-					]
-				}
-			},
-			{
-				"opr": "addOrUpd",
-				"id": "15",
-				"pid": "8",
-				"area_id": "2",
-				"type": "aircon-outside",
-				"subtype": "aircon_outside_common",
-				"name": "00000008",
-				"display_name": "空调外机",
-				"description": "112",
-				"version": 2,
-				"config": {
-					"broadcast": false,
-					"bus": "canbus",
-					"temp": 26,
-					"modes": [
-						"fan",
-						"cool",
-						"heat"
-					],
-					"address": "12",
-					"associated_sensor": [
-						{
-							"type": "humiture",
-							"name": "00000009",
-							"calibration": 0
-						}
-					],
-					"port": "1"
-				}
-			}
-		]
-	},
-	"time": "1741658338428"
+ "code": 200,
+ "msg": "操作成功",
+ "data": {
+  "city": {
+   "location_id": "101010400",
+   "location_name_en": "Shunyi",
+   "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.128937",
+   "longitude": "116.653526",
+   "adcode": "110113"
+  },
+  "areas": [
+   {
+    "id": "2",
+    "pid": "0",
+    "name": "1",
+    "groupable": false
+   }
+  ],
+  "devices": [
+   {
+    "opr": "addOrUpd",
+    "id": "16",
+    "pid": "8",
+    "area_id": "2",
+    "type": "humiture",
+    "subtype": "humiture_common",
+    "name": "00000009",
+    "display_name": "温湿度",
+    "description": "122",
+    "version": 2,
+    "config": {
+     "broadcast": false,
+     "bus": "canbus",
+     "temp": 24,
+     "address": "22",
+     "port": "1",
+     "humidity": 60
+    }
+   },
+   {
+    "opr": "addOrUpd",
+    "id": "18",
+    "pid": "8",
+    "area_id": "2",
+    "type": "panel",
+    "subtype": "canbus",
+    "name": "20000001",
+    "display_name": "面板",
+    "description": "112",
+    "version": 2,
+    "config": {
+     "broadcast": false,
+     "bus": "canbus",
+     "address": "1",
+     "display_scene": [],
+     "associated_machine": [],
+     "is_gateway": false,
+     "associated_sensor": [
+      {
+       "type": "humiture",
+       "name": "00000009",
+       "calibration": 0
+      }
+     ],
+     "lock_end_time": "23:59:59",
+     "icons": [],
+     "control_bits": [],
+     "background": [],
+     "lock_weekday": [
+      1,
+      2,
+      3,
+      4,
+      5,
+      6,
+      7
+     ],
+     "display_device": [
+      {
+       "name": "00000002",
+       "lock": false
+      },
+      {
+       "name": "00000005",
+       "lock": false
+      },
+      {
+       "name": "00000007",
+       "lock": false
+      },
+      {
+       "name": "00000008",
+       "lock": false
+      }
+     ],
+     "lock_start_time": "00:00:00"
+    }
+   },
+   {
+    "opr": "addOrUpd",
+    "id": "8",
+    "pid": "0",
+    "area_id": "2",
+    "type": "gateway",
+    "subtype": "YG001",
+    "name": "40000001",
+    "display_name": "网关",
+    "description": "2",
+    "version": 2,
+    "config": {
+     "broadcast": false,
+     "bus": "canbus",
+     "address": "1",
+     "master": true
+    }
+   },
+   {
+    "opr": "addOrUpd",
+    "id": "9",
+    "pid": "8",
+    "area_id": "2",
+    "type": "light",
+    "subtype": "light_common",
+    "name": "00000002",
+    "display_name": "灯光11",
+    "description": "112333333333333333333",
+    "version": 2,
+    "config": {
+     "broadcast": false,
+     "bus": "canbus",
+     "address": "21",
+     "port": "1"
+    }
+   },
+   {
+    "opr": "addOrUpd",
+    "id": "12",
+    "pid": "8",
+    "area_id": "2",
+    "type": "aircon",
+    "subtype": "aircon_common",
+    "name": "00000005",
+    "display_name": "空调",
+    "description": "112",
+    "version": 2,
+    "config": {
+     "broadcast": false,
+     "bus": "canbus",
+     "temp": 26,
+     "modes": [
+      "fan",
+      "cool",
+      "heat"
+     ],
+     "address": "22",
+     "associated_sensor": [
+      {
+       "type": "humiture",
+       "name": "00000009",
+       "calibration": 0
+      }
+     ],
+     "control_addr": "1",
+     "temp_max": 30,
+     "hvac_addr": "1",
+     "accessibilities": [
+      "smart_up",
+      "smart_left",
+      "smart_auto"
+     ],
+     "temp_min": 16,
+     "port": "1",
+     "speeds": [
+      "2",
+      "1",
+      "3"
+     ],
+     "control_type": "protocol"
+    }
+   },
+   {
+    "opr": "addOrUpd",
+    "id": "14",
+    "pid": "8",
+    "area_id": "2",
+    "type": "airfresh",
+    "subtype": "airfresh_daikin",
+    "name": "00000007",
+    "display_name": "新风",
+    "description": "112",
+    "version": 2,
+    "config": {
+     "broadcast": false,
+     "bus": "canbus",
+     "temp": 20,
+     "modes": [
+      "fan_side",
+      "heat_exchange",
+      "auto"
+     ],
+     "address": "12",
+     "control_addr": "1",
+     "hvac_addr": "1",
+     "control_bits": [
+      {
+       "name": "speed_1_port",
+       "value": "1"
+      },
+      {
+       "name": "speed_3_port",
+       "value": "1"
+      }
+     ],
+     "port": "1",
+     "speeds": [
+      "1",
+      "3"
+     ]
+    }
+   },
+   {
+    "opr": "addOrUpd",
+    "id": "15",
+    "pid": "8",
+    "area_id": "2",
+    "type": "aircon-outside",
+    "subtype": "aircon_outside_common",
+    "name": "00000008",
+    "display_name": "空调外机",
+    "description": "112",
+    "version": 2,
+    "config": {
+     "broadcast": false,
+     "bus": "canbus",
+     "temp": 26,
+     "modes": [
+      "fan",
+      "cool",
+      "heat"
+     ],
+     "address": "12",
+     "associated_sensor": [
+      {
+       "type": "humiture",
+       "name": "00000009",
+       "calibration": 0
+      }
+     ],
+     "port": "1"
+    }
+   }
+  ]
+ },
+ "time": "1741658338428"
 }
 ```
 
 ## 返回数据格式总体定义说明
-1. 数据格式为json,返回数据为数据列表,json中采用驼峰命名方式
 
+1. 数据格式为json,返回数据为数据列表,json中采用驼峰命名方式
 
 ### 所有设备具有的配置属性返回数据格式示例
 
 为支持增量同步机制;所有对象新增操作模式字段:opr;枚举有:addOrUpd|del
 
-
 ```json
 [
     //第一个模板为所有配置,包含必选配置和可选配置,不同设备类型的配置都有说明
@@ -587,7 +592,7 @@ Authorization: Bearer {{token}}
     {
         "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot,默认canbus
         "address": "A5", //地址
-        "port": 1,  //端口,只用一个端口的设备取数组第一个值
+        "port": "1",  //端口,只用一个端口的设备取数组第一个值
         "temp": 24,//默认温度24
         "humidity":    50,//默认湿度
         "associated_scene": //-设备关联的场景,一般是输入类型设备,如干节点输入,按键,传感器等,场景数组中每次只触发一个场景
@@ -616,7 +621,7 @@ Authorization: Bearer {{token}}
     "config":  
     {
         "address": "A5A812344545", //地址蓝牙设备mac地址
-        "port": 1,  //端口,只用一个端口的设备取数组第一个值,保留,蓝牙设备配置时可为空
+        "port": "1",  //端口,只用一个端口的设备取数组第一个值,保留,蓝牙设备配置时可为空
         "bus":"bluetooth",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot,默认canbus
         "temp": 26,//默认温度
         "humidity":    50//默认湿度
@@ -639,7 +644,7 @@ Authorization: Bearer {{token}}
     {
         "bus":"canbus",
         "address": "A5", //地址
-        "port": 1,  //设备端口
+        "port": "1",  //设备端口
         
     }
   },
@@ -652,7 +657,7 @@ Authorization: Bearer {{token}}
     {
         "bus":"bluetooth",
         "address": "F012345678FF", 
-        "port": 1,  
+        "port": "1",  
     }
   },
   {
@@ -684,7 +689,7 @@ Authorization: Bearer {{token}}
     "config":  
     {
         "address": "F012345678FF", //地址
-        "port": 1,  //端口,只用一个端口的设备取数组第一个值
+        "port": "1",  //端口,只用一个端口的设备取数组第一个值
         "bus":"bluetooth",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot,默认canbus
     }
   }
@@ -807,7 +812,7 @@ Authorization: Bearer {{token}}
                    "value":3,
                  },
                  {
-                   "name":"heater1_port",
+                   "name":"heater1_port",  //heater1_port加热端口,heater2_port加热端口配置
                    "address":"A5",
                    "value":1,
                 },
@@ -852,11 +857,11 @@ Authorization: Bearer {{token}}
                    "value":"1A",//端口号
                  },
                  {
-                   "name":"valve_heater_port",
+                   "name":"valve_heater_port",   //热水阀门控制端口
                    "value":1,
                 },
                  {
-                   "name":"valve_cool_port",
+                   "name":"valve_cool_port",  //冷水阀门控制端口
                    "value":"1A",//端口号
                 }
               ],
@@ -906,7 +911,7 @@ Authorization: Bearer {{token}}
         "bus":"canbus",
         "control_type":    "relay",  //控制类型 0协议类型,1为继电器
         "address": "A5", //canbus总线时,地址为继电器地址或协议转换器地址,网络总线时,地址为网络设备mac地址
-        "port": 1,  
+        "port": "1",  
         "temp": 30,//默认温度
         "temp_min":    5,//温控类设备默认可调最小温度 
         "temp_max":    30,//温控类设备默认可调最大温度
@@ -929,7 +934,7 @@ Authorization: Bearer {{token}}
         "bus":"canbus",
         "control_type":    "protocol",  //控制类型 0协议类型,1为继电器
         "address": "A5", //canbus总线时,地址为继电器地址或协议转换器地址,网络总线时,地址为网络设备mac地址
-        "port": 1,  //按数组顺序 1为对应的协议转换器端口,取值范围1-4,当为继电器新风时,1,2,3分别为1,2,3档对应继电器端口
+        "port": "1",  //按数组顺序 1为对应的协议转换器端口,取值范围1-4,当为继电器新风时,1,2,3分别为1,2,3档对应继电器端口
         "control_addr":"22",  //新风机地址
         "hvac_addr":    22,//暖通设备外机地址,0-255
         "temp": 26,//默认温度
@@ -1055,7 +1060,7 @@ Authorization: Bearer {{token}}
     {
         "bus":"network",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
         "address": "A51234F85667", //地址为网络设备mac地址
-        "port": 1,  //端口为canbus或485本机地址,纯网络面板,端口保留
+        "port": "1",  //端口为canbus或485本机地址,纯网络面板,端口保留
         "associated_machine":["AABBCC0011","AABBCC0022","AABBCC0022"],//设备识别码,资源授权给有权限的面板使用
         "brightness":    100,//亮度
         "screen_off":    2,//屏幕关闭时间,单位为分钟,0为不关闭,和系统的熄屏列表对应