miricy 1 год назад
Родитель
Сommit
15ab4ec92e
1 измененных файлов с 228 добавлено и 13 удалено
  1. 228 13
      product/deviceconfig.md

+ 228 - 13
product/deviceconfig.md

@@ -102,26 +102,28 @@ Authorization: Bearer {{token}}
                 "mode": "READ_WRITE",
                 "value": "off"
                 }],
+        "description":    "设备描述",//可选,可为空
         "config":  //所有设备整体配置
         {
             "address": "12345678", //地址
             "ports": [1,2,3,4,5], //多端口 当为继电器窗帘时,继电器按顺序排列1为开,2为关端口,当为空调时,按数组顺序 1,2,3为一二三档对应的继电器端口,4为制冷,5为制热端口,当为风扇或新风时,1,2,3为一二三档对应的继电器端口,当为浴霸时,1,2为灯光,3,4为取暖,5,6为排风
             "broadcast":    false,//跨网关是否广播  false为不广播,true为广播
-            "sub_address":["22","33","44"],  //如485协议窗帘,第一个即窗帘485地址,当为空调时,第一个为空调外机地址,第二个为内机地址,433协议窗帘时为遥控器id,433设备对应的遥控码,3字节16进制字符串格式, 取值范围 0-16777215(小端在后比如20:000014)
+            "sub_address":[22,33,44],  //如485协议窗帘,第一个即窗帘485地址,当为空调时,第一个为空调外机地址,第二个为内机地址,433协议窗帘时为遥控器id,433设备对应的遥控码,3字节16进制字符串格式, 取值范围 0-16777215(小端在后比如20:000014)
             "device_control":"protocol", //protocol(协议),central(继电器)
             "control_type":    2,  //控制类型 0协议类型,1为继电器,当为窗帘时1为单信号,2继电器断信号,3继电器双信号,4为干节点
             "keep_time": 5, //--门锁为单信号时,控制延时上锁时间,默认值为5秒,范围(1到30秒)如门禁开后5秒后自动上锁
             "icons":["internal://array_light","http://www.abc.com/img/light.png"],//设备图标列表
             "order":    1,//排序,值越小越靠前,相同的值按设备先后顺序
             "temp": 30,//默认温度
-            "humidity": 60,//默认湿度
+            "humidity":    50,//默认湿度
             "speed":3 ,//空调,风扇风力档位数量,默认为3档,低,中,高
             "modes": ["","","",""],//支持模式列表 fan,cool,heat,auto,saving,dehumidify,sleeping,fan_inner(内循环),fan_side(旁通)/heat_exchange(热交换)
             "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
             "associated_sensor":    //关联传感器,如温湿度传感器,第一个为环境温湿度传感器,当为地暖时,第二个为报警温度传感器,默认45度
                           [{"name":"humiture1","calibration":10},
                                      {"name":"humiture2", //关联传感器2,设备唯一的名称
-                                             "calibration":5  //校正温度度数
+                                             "calibration":5,  //校正温度度数
+                                             "alarm_temp":45//报警温度
                                              }],
             "associated_scene": //-设备关联的场景,一般是输入类型设备,如干节点输入,按键,传感器等,场景数组中每次只出发一个场景
                     [
@@ -132,9 +134,9 @@ Authorization: Bearer {{token}}
                         "name":"scene2",
                          "expression":"value=10",//value为设备属性的某个键,取值后和具体数字或字符串比较,为真时执行
                       }
-                     ] 
+                     ],
             "card_format":1,//卡数据格式 0为无,1为10位10进制,2为10位10进制反向输出,3为8位16进制,4为8位16进制反向输出,5为8位10进制(id后3字节转换),6为00+8位10进制,7为8位10进制(id后4字节转换),8为5位10进制
-            "associated_lock":    //关联的锁,如门锁,窗锁,门禁等
+            "associated_lock":["lock1","lock1"],    //关联的锁,如门锁,窗锁,门禁等唯一名称
             //智能控制面板配置 panel
             "display_device":    //面板上要显示的设备列表
                 [{
@@ -184,12 +186,46 @@ Authorization: Bearer {{token}}
     }]
 ```
 
-### 灯光设备配置数据示例
+### 温湿度传感器配置数据示例
 
 ```json
 [
    {
     "id": 1, "pid": 1,"areaId": "CAN区域", "area": "区域名称", "name": "0001", "displayName": "灯光",
+    "type":    "humiture",
+    "subtype":    "humiture_common", //humiture_common,默认值,通用温湿度
+    "config":  
+    {
+        "address": "A5", //地址
+        "ports": [1],  //端口,只用一个端口的设备取数组第一个值
+        "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot,默认canbus
+        "temp": 30,//默认温度
+        "humidity":    50//默认湿度
+    }
+  },
+  {
+    "id": 1, "pid": 1,"areaId": "CAN区域", "area": "区域名称", "name": "0001", "displayName": "灯光",
+    "type":    "humiture",
+    "subtype":    "humiture_common", //humiture_common,默认值,通用温湿度
+    "config":  
+    {
+        "address": "A5A812344545", //地址蓝牙设备mac地址
+        "ports": [1],  //端口,只用一个端口的设备取数组第一个值,保留,暂时没有使用
+        "bus":"bluetooth",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot,默认canbus
+        "temp": 30,//默认温度
+        "humidity":    50//默认湿度
+    }
+  }
+  
+]
+```
+
+### 灯光开关设备配置数据示例
+
+```json
+[
+   {//通用灯光开关配置
+    "id": 1, "pid": 1,"areaId": "CAN区域", "area": "区域名称", "name": "0001", "displayName": "灯光",
     "type":    "light",
     "subtype":    "light_common", //subtype为子类型,light_common为普通灯光,默认值
     "config":  
@@ -252,7 +288,7 @@ Authorization: Bearer {{token}}
     {
         "address": "A5", //地址继电器地址或协议转换器地址
         "ports": [1,2],  //继电器按顺序排列1为开,2为关端口,can协议转换窗帘为协议转换器端口
-        "sub_address":["22FA33"],  //如485协议窗帘,第一个即窗帘485地址,或433窗帘的遥控器id,433设备对应的遥控码,3字节16进制字符串格式, 取值范围 0-16777215(小端在后比如0x112233)
+        "sub_address":[225533],  //如485协议窗帘,第一个即窗帘485地址,或433窗帘的遥控器id,433设备对应的遥控码,3字节16进制字符串格式, 取值范围 0-16777215(小端在后比如0x112233)
         "control_type":    0,  //控制类型 0协议类型,1为继电器,当为窗帘时1为单信号,2继电器断信号,3继电器双信号,4为干节点
         "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot,默认canbus
     }
@@ -260,7 +296,7 @@ Authorization: Bearer {{token}}
 ]
 ```
 
-### 暖通空调设备配置数据示例
+### 暖通设备,空调新风地暖配置数据示例
 
 ```json
 [
@@ -273,11 +309,10 @@ Authorization: Bearer {{token}}
     "config":  
     {
         "address": "A5", //canbus总线时,地址为继电器地址或协议转换器地址,网络总线时,地址为网络设备mac地址
-        "ports": [1,2],  //按数组顺序 1,2,3为一二三档对应的继电器端口,4为制冷,5为制热端口
-        "control_type":    2,  //控制类型 0协议类型,1为继电器,当为窗帘时1为单信号,2继电器断信号,3继电器双信号,4为干节点
+        "ports": [1,2,3,4,5],  //按数组顺序 1,2,3为一二三档对应的继电器端口,4为制冷,5为制热端口
+        "control_type":    1,  //控制类型 0协议类型,1为继电器,当为窗帘时1为单信号,2继电器断信号,3继电器双信号,4为干节点
         "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot,默认canbus
         "temp": 30,//默认温度
-        "humidity": 60,//默认湿度
         "speed":3 ,//空调,风扇风力档位数量,默认为3档,低,中,高,取值1-6
         "modes": ["fan","cool","heat",""],//支持模式列表 fan,cool,heat,auto,saving,dehumidify,sleeping
         "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
@@ -288,7 +323,188 @@ Authorization: Bearer {{token}}
                                              }],
     }
   },
-  
+  {//协议空调
+    "id": 1, "pid": 1,"areaId": "CAN区域", "area": "区域名称", "name": "0001", "displayName": "空调",
+    "type":    "aircon",
+    //aircon_common 默认类型 aircon_fcu 风机盘管 aircon_daikin 大金空调 aircon_haier 海尔空调
+    //aircon_gree 格力空调 aircon_hisense 海信空调 aircon_midea 美的空调 aircon_hitachi 日立空调
+    "subtype":    "aircon_common", //subtype为子类型,aircon_common为默认值,通用空调
+    "config":  
+    {
+        "address": "A5", //canbus总线时,地址为继电器地址或协议转换器地址,网络总线时,地址为网络设备mac地址
+        "ports": [1],  //按数组顺序 1为对应的协议转换器端口,取值范围1-4
+        "sub_address":[22,33],  //第一个为空调外机地址,第二个为内机地址
+        "control_type":    0,  //控制类型 0协议类型,1为继电器,当为窗帘时1为单信号,2继电器断信号,3继电器双信号,4为干节点
+        "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot,默认canbus
+        "temp": 30,//默认温度
+        "speed":3 ,//空调,风扇风力档位数量,默认为3档,低,中,高,取值1-6
+        "modes": ["fan","cool","heat",""],//支持模式列表 fan,cool,heat,auto,saving,dehumidify,sleeping
+        "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
+        "associated_sensor":    //关联传感器,如温湿度传感器,第一个为环境温湿度传感器,当为地暖时,第二个为报警温度传感器,默认45度
+        [{"name":"humiture2", //关联传感器,设备唯一的名称
+          "calibration":5,  //校正温度度数 
+          }],
+    }
+  },
+  {//继电器地暖
+    "id": 1, "pid": 1,"areaId": "CAN区域", "area": "区域名称", "name": "0001", "displayName": "空调",
+    "type":    "heater",
+    //aircon_common 默认类型 aircon_fcu 风机盘管 aircon_daikin 大金空调 aircon_haier 海尔空调
+    //aircon_gree 格力空调 aircon_hisense 海信空调 aircon_midea 美的空调 aircon_hitachi 日立空调
+    "subtype":    "heater_floor", //subtype为子类型,aircon_common为默认值,通用空调
+    "config":  
+    {
+        "address": "A5", //canbus总线时,地址为继电器地址或协议转换器地址,网络总线时,地址为网络设备mac地址
+        "ports": [1,2,3,4,5],  //按数组顺序 1,2,3为一二三档对应的继电器端口,4为制冷,5为制热端口
+        "control_type":    1,  //控制类型 0协议类型,1为继电器,当为窗帘时1为单信号,2继电器断信号,3继电器双信号,4为干节点
+        "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot,默认canbus
+        "temp": 30,//默认温度
+        "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
+        "associated_sensor":    //关联传感器,如温湿度传感器,第一个为环境温湿度传感器,当为地暖时,第二个为报警温度传感器,默认45度
+        [{"name":"humiture1","calibration":10},
+         {"name":"humiture2", //关联传感器2,设备唯一的名称
+          "calibration":5,  //校正温度度数
+          "alarm_temp":45  //报警温度度数
+          }],
+    }
+  },
+  {//新风
+    "id": 1, "pid": 1,"areaId": "CAN区域", "area": "区域名称", "name": "0001", "displayName": "空调",
+    "type":    "airfresh", //airfresh_common 默认类型 airfresh_home 新风家用 airfresh_work 新风大楼用
+       //airfresh_daikin 大金新风 airfresh_net_relay 网络面板继电器新风 airfresh_can_relay canbus继电器新风
+    "subtype":    "airfresh_common", //airfresh_common为默认值,通用新风
+    "config":  
+    {
+        "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot,默认canbus
+        "address": "A5", //canbus总线时,地址为继电器地址或协议转换器地址,网络总线时,地址为网络设备mac地址
+        "ports": [1,2,3,4],  //按数组顺序 1为对应的协议转换器端口,取值范围1-4,当为继电器新风时,1,2,3分别为1,2,3档对应继电器端口
+        "sub_address":[22,33],  //第一个为新风外机地址,第二个为新风内机地址,继电器新风不存在子地址
+        "control_type":    0,  //控制类型 0协议类型,1为继电器,当为窗帘时1为单信号,2继电器断信号,3继电器双信号,4为干节点
+        "temp": 30,//默认温度
+        "speed":3 ,//空调,风扇风力档位数量,默认为3档,低,中,高,取值1-6
+        "modes": ["fan","cool","heat",""],//模式列表 fan,cool,heat,auto,saving,dehumidify,sleeping,fan_inner(内循环),fan_side(旁通)/heat_exchange(热交换)
+        "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
+        "associated_sensor":    //关联传感器,如温湿度传感器,第一个为环境温湿度传感器,当为地暖时,第二个为报警温度传感器,默认45度
+        [{"name":"humiture2", //关联传感器,设备唯一的名称
+          "calibration":5,  //校正温度度数 
+          }],
+    }
+  },
+  {//空调外机
+    "id": 1, "pid": 1,"areaId": "CAN区域", "area": "区域名称", "name": "0001", "displayName": "空调",
+    "type":    "aircon-outside",
+    //airconout_common 默认类型 airconout_onoff 状态外机,只线时外机状态 airconout_home 家用外机 airconout_work 大楼外机
+    "subtype":    "airconout_common", //subtype为子类型,aircon_common为默认值,通用空调
+    "config":  
+    {
+        "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
+        "address": "A5", //canbus总线时,地址为继电器地址或协议转换器地址,网络总线时,地址为网络设备mac地址
+        "ports": [1],  //按数组顺序 1为对应的协议转换器端口,取值范围1-4
+        "sub_address":[22,33],  //第一个为空调外机地址,第二个为内机地址
+        "control_type":    0,  //控制类型 0协议类型,1为继电器,当为窗帘时1为单信号,2继电器断信号,3继电器双信号,4为干节点
+        "temp": 30,//默认温度
+        "speed":3 ,//空调,风扇风力档位数量,默认为3档,低,中,高,取值1-6
+        "modes": ["fan","cool","heat",""],//支持模式列表 fan,cool,heat,auto
+        "associated_sensor":    //关联传感器,如温湿度传感器,第一个为环境温湿度传感器,当为地暖时,第二个为报警温度传感器,默认45度
+        [{"name":"humiture2", //关联传感器,设备唯一的名称
+          "calibration":5,  //校正温度度数 
+          }],
+    }
+  },
+]
+```
+
+### 控制面板设备配置数据格式
+
+```json
+[
+{//触摸控制面板
+    "id": 1, "pid": 1,"areaId": "CAN区域", "area": "区域名称", "name": "0001", "displayName": "空调",
+    "type":    "panel",
+    "subtype":    "panel_common", //panel_common为默认值,canbus/serial/network/network_gpio/dry_contact
+    "config":  
+    {
+        "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
+        "address": "A51234F85667", //地址为网络设备mac地址
+        "ports": [1],  //端口为canbus或485本机地址,纯网络面板,端口保留
+        "associated_sensor":    //关联传感器,如温湿度传感器,第一个为环境温湿度传感器,当为地暖时,第二个为报警温度传感器,默认45度
+        [{"name":"humiture2", //关联传感器,设备唯一的名称
+          "calibration":5,  //校正温度度数 
+          }],
+        //智能控制面板配置 panel
+        "display_device":    //面板上要显示的设备列表
+                [{
+                    "name":    "0001", 
+                    "lock":    false  //是否锁定
+                }, {
+                    "name":    "0003",
+                    "lock":    false
+                }],
+        "display_scene":    //面板上要显示的场景列表
+                [{
+                    "name":    "1009",
+                    "lock":    false
+                }, {
+                    "name":    "100A",
+                    "lock":    false
+                }, {
+                    "name":    "100B",
+                    "lock":    false
+                }],
+        "lock_weekday":    [1, 2, 3, 4, 5], //一周中哪些天需要锁定
+        "lock_start_time":    "12:00:00",  //一天中锁定的开始时间,格式为24小时制
+        "lock_end_time":    "23:59:59",  //一天中锁定的结束时间,格式为24小时制
+        //门禁面板配置 entrance_guard
+        "camera_type": "IR",// 门禁摄像头类型,IR红外,RGB为全彩,RGB_IR为红外+彩
+        "brightness":    100,//亮度
+        "screen_off":    2,//屏幕关闭时间,单位为分钟,0为不关闭,和系统的熄屏列表对应
+        "volume":    50,//音量设置
+        "mute":    false,//是否静音
+    }
+  },
+]
+```
+
+### 门禁面板设备配置数据格式
+
+```json
+[
+{
+    "id": 1, "pid": 1,"areaId": "CAN区域", "area": "区域名称", "name": "0001", "displayName": "空调",
+    "type":    "entrance_guard",
+    "subtype":    "guard_face", //guard_face(人脸)/guard_face_card(人脸+刷卡)/guard_face_keypad(人脸+键盘)/guard_face_card_keypad
+    "config":  
+    {
+        "bus":"network",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
+        "address": "A51234F85667", //地址为网络设备mac地址
+        "ports": [1],  //端口为canbus或485本机地址,纯网络面板,端口保留
+
+        
+        //门禁面板配置 entrance_guard
+        "camera_type": "IR",// 门禁摄像头类型,IR红外,RGB为全彩,RGB_IR为红外+彩
+        "brightness":    100,//亮度
+        "screen_off":    2,//屏幕关闭时间,单位为分钟,0为不关闭,和系统的熄屏列表对应
+        "volume":    50,//音量设置
+        "mute":    false,//是否静音
+        "associated_scene": //-设备关联的场景,一般是输入类型设备,如干节点输入,按键,传感器等,场景数组中每次只出发一个场景
+                    [
+                      {"name":"scene1",//场景名称
+                       "expression":"order",//场景执行条件,表达式为真执行,order为执行顺序和下标一致时执行,其他为表达式判断为真时执行
+                      },
+                      {
+                        "name":"scene2",
+                        "expression":"value=10",//value为设备属性的某个键,取值后和具体数字或字符串比较,为真时执行
+                      }
+                     ],
+        "card_format":1,//卡数据格式 0为无,1为10位10进制,2为10位10进制反向输出,3为8位16进制,4为8位16进制反向输出,5为8位10进制(id后3字节转换),6为00+8位10进制,7为8位10进制(id后4字节转换),8为5位10进制
+        "associated_lock":["lock1","lock1"],    //关联的锁,如门锁,窗锁,门禁等唯一名称
+        "camera_type": "IR",// 门禁摄像头类型,IR红外,RGB为全彩,RGB_IR为红外+彩
+        "fill_light":    false,//是否开启补光灯
+        "live_detection":    false,//是否开启活体检测
+        "face_valve":0.55,//人脸阀值 0-1
+        "mask_detection":    false,//是否开启口罩检测
+    }
+  },
 ]
 ```
 
@@ -376,7 +592,6 @@ Authorization: Bearer {{token}}
 }
 ```
 
-
 ## 配置中的各字段数据库定义json表达
 
 ```json