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

+ 72 - 122
product/deviceconfig.md

@@ -111,15 +111,15 @@ Authorization: Bearer {{token}}
             "bus":    "canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/gpio/zigbee/bluetooth/dali/knx/plc-iot
             "control_type": "protocol",//protocol协议类型,relay为继电器,门禁门锁时有single和keep,为窗帘single单信号窗帘相当于按键,off继电器断信号,double继电器双信号窗帘用,touch为干节点按键,可选
             "address": "12345678", //地址,canbus或485,蓝牙,zegbee,地址
-            "port": 1, //端口号,1-16,协议转换器的端口号,或开关,灯对应的单个继电器的端口号
+            "port": "1", //端口号,1-16,协议转换器的端口号,或开关,灯对应的单个继电器的端口号,//端口号十六进制字符串 1和01是一样的
             "control_bits": [//继电器或协议转换器关联端口控制位,可选,不传为空
                  {
                    "name":"curtain_on_port",//curtain_on_port开,curtain_off_port关,//speed1_port风速1档端口,speed1-speed6风速1到6档端口配置,valve_switch_port 冷热阀门控制开关
                    "type":"touch",//touch为干节点按键,switch为开关
                    "keep_time":1000,//延时时间,0-65535毫秒
-                   "address":"12",//485或canbus继电器地址,没有此项为上级adress定义的设备配置地址
+                   "address":"A2",//485或canbus继电器地址,没有此项为上级adress定义的设备配置地址
                    "associated_scene":[],//关联的场景列表,可选,不传为空
-                   "value":1,//端口号
+                   "value":"1",//端口号十六进制字符串 1和01是一样的
                  }
               ],
             "broadcast":    false,//跨网关是否广播  false为不广播,true为广播
@@ -193,7 +193,8 @@ Authorization: Bearer {{token}}
             "live_detection":    false,//是否开启活体检测
             "face_valve":0.55,//人脸阀值 0-1
             "mask_detection":    false,//是否开启口罩检测
-            "background":["internal://background1","http://www.abc.com/img/background.png"] //背景图列表,本地没有指定时显示默认第一个下标背景图,网关或面板要下载的背景图列表
+            "background":["internal://bg1","http://www.abc.com/img/id/background.png"] //bg1-bg4 4张背景图为内置,本地没有指定时显示默认第一个下标背景图,网关或面板要下载的背景图列表
+
         }
     }
 ]
@@ -246,12 +247,13 @@ Authorization: Bearer {{token}}
         "bus":"canbus",
         "address": "A5", //地址
         "port": 1,  //设备端口
+        
     }
   },
   {
     "id": 1, "pid": 1,"area_id": "CAN区域", "area": "区域名称", "name": "0001", "display_name": "灯光",
     "type":    "lightdim",//调光灯,
-    "subtype":    "dimming_single", //"dimming_single", "单路调光灯"/"dimming_color_temp", "调亮度调色温灯"
+    "subtype":    "dimming_single", //"dimming_single", "单路调光灯"/"dimming_color_temp", "调亮度调色温灯",
     "config":  
     {
         "bus":"bluetooth",
@@ -261,6 +263,26 @@ Authorization: Bearer {{token}}
   },
   {
     "id": 1, "pid": 1,"area_id": "CAN区域", "area": "区域名称", "name": "0001", "display_name": "灯光",
+    "type":    "lightdim",//调光灯,
+    "subtype":    "dimming_color_temp", //"dimming_single", "单路调光灯"/"dimming_color_temp", "调亮度调色温灯",
+    "config":  
+    {
+        "bus":"canbus",
+        "address": "11", 
+        "control_bits": [
+                 {
+                   "name":"brightness_port",
+                   "value":1,//端口号
+                 },
+                  {
+                   "name":"dimming_color_port",
+                   "value":2,//端口号
+                 },
+              ],
+    }
+  },
+  {
+    "id": 1, "pid": 1,"area_id": "CAN区域", "area": "区域名称", "name": "0001", "display_name": "灯光",
     "type":    "lightrgb",//彩光灯,
     "subtype":    "lightrgb_common", // "lightrgb_common", "彩灯"/"lightrgb_rgbw", "带白光彩灯"
     "config":  
@@ -286,15 +308,15 @@ Authorization: Bearer {{token}}
     "config":  
     {
         "bus":"canbus",
-        "control_type":    2,  //控制类型 0协议类型,1为继电器,当为窗帘时1为继电器单信号,2继电器断信号,3继电器双信号
+        "control_type":    "single", //protocol协议类型,为窗帘single单信号窗帘,off继电器断信号,double继电器双信号窗帘
         "address": "A5", //地址继电器地址或协议转换器地址
         "control_bits":[{
                    "name":"curtain_on_port",//common_port通用开关,protocol_transition协议转换器端口,curtain_on_port开,curtain_off_port关,speed1风速1档,speed2风速2档,speed3风速3档,valve_switch 阀门控制开关
-                   "value":1,//端口号
+                   "value":"1",//端口号
                  },
                  {
                    "name":"curtain_off_port",
-                   "value":2,
+                   "value":"2",
                 }], 
     }
   },
@@ -305,10 +327,11 @@ Authorization: Bearer {{token}}
     "config":  
     {
         "bus":"canbus",
-        "control_type":    0,  //控制类型 0协议类型,1为继电器,当为窗帘时1为单信号,2继电器断信号,3继电器双信号
+        "control_type":    "protocol",  //控制类型 0协议类型,1为继电器,当为窗帘时1为单信号,2继电器断信号,3继电器双信号
         "address": "A5", //地址继电器地址或协议转换器地址
-        "port": 1,  //对应为协议转换器端口,取值范围1-4
-        "control_addr":33, //485窗帘为电机地址,0-255,433协议窗帘时为遥控器id,433设备对应的遥控码,3字节16进制字符串格式, 取值范围 0-16777215(小端在后比如20:000014)
+        "port": "1",  //对应为协议转换器端口,取值范围1-4
+        "control_addr":"33", //485窗帘为电机地址,0-255,
+        "remote_id":"FF11A0" //433协议窗帘时为遥控器id,433设备对应的遥控码,3字节16进制字符串格式,
     }
   },
 ]
@@ -325,9 +348,8 @@ Authorization: Bearer {{token}}
     "config":  
     {
         "bus":"canbus",
-        "control_type":   "single",  //控制类型 protocol协议类型,single为单次,keep为保持
         "address": "A5", //地址继电器地址或协议转换器地址
-        "port": 1,
+        "port": "1",
         "keep_time":10,//保持时间,单位为秒
     }
   }
@@ -346,9 +368,10 @@ Authorization: Bearer {{token}}
     {
         "bus":"canbus",
         "address": "A5", //地址继电器地址或协议转换器地址
-        "port": 1,
+        "port": "1",
         "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进制
-        "control_addr":  12,  //485协议时为刷卡器地址,0-255
+        "control_addr":  "12",  //485协议时为刷卡器地址,0-255
+        "associated_device":[{"name":"lockdevice1","action":"unlock"}],    //关联要开的锁,如门锁,窗锁,干节点关联设备
     }
   }
 ]
@@ -411,34 +434,32 @@ Authorization: Bearer {{token}}
     "config":  
     {
         "bus":"canbus",
-        "control_type":    1,  //控制类型 0协议类型,1为继电器
+        "control_type":    "relay",  //控制类型 protocol协议类型,relay为继电器
         "address": "A5", //canbus总线时,地址为继电器地址或协议转换器地址,网络总线时,地址为网络设备mac地址
         "control_bits": [//继电器或协议转换器关联端口
                  {
                    "name":"speed1_port",//speed1_port风速1档端口,speed1-speed6风速1到6档端口配置,valve_switch_port 冷热水阀门控制开关
-                   "type":"aircon",//窗帘类型
-                   "value":1,//端口号
+                   "value":"1A",//端口号
                  },
                  {
                    "name":"speed2_port",//speed1_port风速1档端口,speed1-speed6风速1到6档端口配置,valve_switch_port 冷热水阀门控制开关
-                   "type":"aircon",//窗帘类型
                    "value":2,//端口号
                  },
                  {
                    "name":"speed3_port",//speed1_port风速1档端口,speed1-speed6风速1到6档端口配置,valve_switch_port 冷热水阀门控制开关
-                   "type":"aircon",//窗帘类型
-                   "value":3,
+                   "value":"1A",//端口号
                  },
                  {
-                   "name":"valve_switch_port",
-                   "type":"aircon",
-                   "address":"A5",
+                   "name":"valve_heater_port",
                    "value":1,
+                },
+                 {
+                   "name":"valve_cool_port",
+                   "value":"1A",//端口号
                 }
               ],
-        "temp": 30,//默认温度
-        "speed":3 ,//空调,风扇风力档位数量,默认为3档,低,中,高,取值1-6
-        "auto_speed":true,//风力是否支持自动档,true支持,false不支持针对空调,新风空调
+        "temp": 26,//默认温度
+        "speeds":"1,3,5,auto" ,//空调,风扇风力档位数量,默认为3档,低,中,高,取值1-6档
         "modes": ["fan","cool","heat","auto"],//支持模式列表 fan,cool,heat,auto,saving,dehumidify,sleeping
         
         "associated_sensor":    //关联传感器,如温湿度传感器,第一个为环境温湿度传感器,当为地暖时,第二个为报警温度传感器,默认45度
@@ -454,14 +475,13 @@ Authorization: Bearer {{token}}
     "config":  
       {
         "bus":"canbus",
-        "control_type":    0,  //控制类型 0协议类型,1为继电器
+        "control_type":    "protocol",  //控制类型 protocol协议类型,relay为继电器
         "address": "A5", //canbus总线时,地址为继电器地址或协议转换器地址,网络总线时,地址为网络设备mac地址
-        "port": 1,  //按数组顺序 1为对应的协议转换器端口,取值范围1-4
+        "port": "1",  //按数组顺序 1为对应的协议转换器端口,取值范围1-4
         "control_addr":"22",  //空调内机地址
-        "hvac_addr":    22,//暖通设备外机地址,0-255
+        "hvac_addr":    "22",//暖通设备外机地址,0-255
         "temp": 26,//默认温度
-        "speed":3 ,//空调,风扇风力档位数量,默认为3档,低,中,高,取值1-6
-        "auto_speed":true,//风力是否支持自动档,true支持,false不支持针对空调,新风空调
+        "speeds":"1,3,5,auto" ,//空调,风扇风力档位数量,默认为3档,低,中,高,取值1-6档
         "modes": ["fan","cool","heat",""],//支持模式列表 fan,cool,heat,auto,saving,dehumidify,sleeping
         "associated_sensor":    //关联传感器,如温湿度传感器,第一个为环境温湿度传感器,当为地暖时,第二个为报警温度传感器,默认45度
         [{"name":"humiture2", //关联传感器,设备唯一的名称
@@ -478,7 +498,7 @@ Authorization: Bearer {{token}}
     "config":  
     {
         "bus":"canbus",
-        "control_type":    0,  //控制类型 0协议类型,1为继电器
+        "control_type":    "relay",  //控制类型 0协议类型,1为继电器
         "address": "A5", //canbus总线时,地址为继电器地址或协议转换器地址,网络总线时,地址为网络设备mac地址
         "port": 1,  
         "temp": 30,//默认温度
@@ -498,17 +518,14 @@ Authorization: Bearer {{token}}
     "config":  
     {
         "bus":"canbus",
-        "control_type":    0,  //控制类型 0协议类型,1为继电器
+        "control_type":    "protocol",  //控制类型 0协议类型,1为继电器
         "address": "A5", //canbus总线时,地址为继电器地址或协议转换器地址,网络总线时,地址为网络设备mac地址
         "port": 1,  //按数组顺序 1为对应的协议转换器端口,取值范围1-4,当为继电器新风时,1,2,3分别为1,2,3档对应继电器端口
         "control_addr":"22",  //新风机地址
         "hvac_addr":    22,//暖通设备外机地址,0-255
-        "control_type":    0,  //控制类型 0协议类型,1为继电器
         "temp": 26,//默认温度
-        "speed":3 ,//空调,风扇风力档位数量,默认为3档,低,中,高,取值1-6
-        "auto_speed":true,//风力是否支持自动档,true支持,false不支持针对空调,新风空调
+        "speeds":"1,3,5,auto" ,//空调,风扇风力档位数量,默认为3档,低,中,高,取值1-6档  
         "modes": ["fan","cool","heat","auto"],//模式列表 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,  //校正温度度数 
@@ -524,7 +541,7 @@ Authorization: Bearer {{token}}
     {
         "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
         "address": "A5", //canbus总线时,地址为继电器地址或协议转换器地址,网络总线时,地址为网络设备mac地址
-        "port": 1,  //按数组顺序 1为对应的协议转换器端口,取值范围1-4
+        "port": "1",  //按数组顺序 1为对应的协议转换器端口,取值范围1-4
         "temp": 26,//默认温度
         "modes": ["fan","cool","heat"],//支持模式列表 fan,cool,heat,auto
         "associated_sensor":    //关联传感器,如温湿度传感器,第一个为环境温湿度传感器,当为地暖时,第二个为报警温度传感器,默认45度
@@ -556,7 +573,7 @@ Authorization: Bearer {{token}}
     "config":  
     {
         "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
-        "address": "A51234F85667", //地址为网络设备mac地址
+        "address": "1A", //地址为网络设备mac地址
         "is_gateway":true,//是否为网关,true为网关,false为普通面板
         "associated_sensor":    //关联传感器,如温湿度传感器,第一个为环境温湿度传感器,当为地暖时,第二个为报警温度传感器,默认45度
         [{"name":"humiture2", //关联传感器,设备唯一的名称
@@ -582,15 +599,12 @@ Authorization: Bearer {{token}}
                     "name":    "100B",
                     "lock":    false
                 }],
-        "lock_weekday":    [1, 2, 3, 4, 5], //一周中哪些天需要锁定
+        "associated_machine":["AABBCC0011","AABBCC0022","AABBCC0022"],//设备识别码,资源授权给有权限的面板使用
+        "lock_weekday":    [1, 2, 3, 4, 5,6,7], //一周中哪些天需要锁定
         "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,//是否静音
+        "icons":["","",""],
+        "background":["","","",""]
     }
   },
 ]
@@ -609,8 +623,7 @@ Authorization: Bearer {{token}}
         "bus":"network",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
         "address": "A51234F85667", //地址为网络设备mac地址
         "port": 1,  //端口为canbus或485本机地址,纯网络面板,端口保留
-        //门禁面板配置 entrance_guard
-        "camera_type": "IR",// 门禁摄像头类型,IR红外,RGB为全彩,RGB_IR为红外+彩
+        "associated_machine":["AABBCC0011","AABBCC0022","AABBCC0022"],//设备识别码,资源授权给有权限的面板使用
         "brightness":    100,//亮度
         "screen_off":    2,//屏幕关闭时间,单位为分钟,0为不关闭,和系统的熄屏列表对应
         "volume":    50,//音量设置
@@ -648,53 +661,28 @@ Authorization: Bearer {{token}}
     "config":  
     {
         "bus":"canbus",
-        "control_type":    0,  //控制类型 4为干节点开关switch,5为干节点轻触touch
-        "address": "11", //地址为网络设备mac地址
-        "port": 1,  //端口为canbus或485本机地址,纯网络面板,端口保留
+        "control_type":    "switch",  //控制类型 干节点开关switch固定两个场景,一个开,一个关,干节点轻触touch类型是按顺序序列执行
         "control_number":1,//普通面板控制位数,比如2位,4位面板
         "control_bits": [
           {
             "name":"dry_contact",
             "address":"12",
-            "port": 1,
+            "tag":"左床头",
+            "port": "1A",
             "associated_scene": //-设备关联的场景,一般是输入类型设备,如干节点输入,按键,传感器等,场景数组中每次只出发一个场景
                     [
                       {"name":"scene1",//场景名称
-                       "mode":"order",//
-                       "expression":"order",//场景执行条件,表达式为真执行,order为执行顺序和下标一致时执行,其他为表达式判断为真时执行
+                       "mode":"on",//order为顺序执行序列的场景,on,off为开关型执行的场景
                       },
                       {
                         "name":"scene2",
-                        "expression":"value=10",//value为设备属性的某个键,取值后和具体数字或字符串比较,为真时执行
+                        "mode":"off",
                       }
                      ]
           }
         ],
-        // "associated_device":[{"name":"dry_contact_device1"}],    //关联要开的锁,如门锁,窗锁,干节点关联设备
-    }
-  },
-  {//干节点面板关联的设备,这部分合并到上面,不再自动创建每个键位对应的设备
-    "id": 1, "pid": 1,"area_id": "CAN区域", "area": "区域名称", "name": "dry_contact_device1", "display_name": "空调",
-    "type":    "dry_contact",
-    "subtype":    "common", 
-    "config":  
-    {
-        "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/gpio/RS485/zigbee/bluetooth/dali/knx/plc-iot
-        "address": "11", //地址为网络设备mac地址
-        "port":1,
-        "associated_scene": //-设备关联的场景,一般是输入类型设备,如干节点输入,按键,传感器等,场景数组中每次只出发一个场景
-                    [
-                      {"name":"scene1",//场景名称
-                       "mode":"order",//
-                       "expression":"order",//场景执行条件,表达式为真执行,order为执行顺序和下标一致时执行,其他为表达式判断为真时执行
-                      },
-                      {
-                        "name":"scene2",
-                        "expression":"value=10",//value为设备属性的某个键,取值后和具体数字或字符串比较,为真时执行
-                      }
-                     ]
     }
-  },
+  }
 ]
 ```
 
@@ -705,28 +693,11 @@ Authorization: Bearer {{token}}
 {
     "id": 1, "pid": 1,"area_id": "CAN区域", "area": "区域名称", "name": "0001", "display_name": "空调",
     "type":    "gateway",
-    "subtype":    "YG001", //YG001为默认值,第一代网关,YG003为第二代网关
+    "subtype":    "YG003", //YG001为默认值,第一代网关YG001,YG002为第二代网关,YG003为第三代网关,
     "config":  
     {
         "address": "A51234F85667", //地址为网络设备mac地址,或can地址或虚拟id
-        "background":["http://192.168.0.1/bg.jpg", "http://192.168.0.1/bg.jpg"],//要下载同步缓存的背景图片,数组
         "master":true,//是否为主网关,主网关为true,其他网关为false,主网关可对各子网关进行转发,主网关包含mqtt本地服务
-        "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"
-              }
     }
   },
 ]
@@ -778,52 +749,31 @@ Authorization: Bearer {{token}}
 {
     "id": 1, "pid": 1,"area_id": "CAN区域", "area": "区域名称", "name": "0001", "display_name": "空调",
     "type":    "display_board",
-    "subtype":    "display_board_common", //
+    "subtype":    "display_board_common", //display_board_common,display_board_meeting
     "config":  
     {
         "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
         "address": "A51234F85667", //地址为网络设备mac地址
-        "control_bits": [
-            {
-                "type":"canbus", //端口为canbus或485本机地址,纯网络面板,端口保留
-                "value": 1
-            }
-        ],  //端口为canbus或485本机地址,纯网络面板,端口保留,或为网关本地id,跨网关时使用
-        "background":["url1","url2"],//要下载同步缓存的背景图片
         "associated_device":[
             {
                 "name":"0001",
                 "action":"on"
             }
         ],
-        "associated_scene":[
-            {
-                "name":"0001",
-                "mode":"order",
-                "expression": "value=10"
-            }
-        ]
     }
   },
 {
     "id": 1, "pid": 1,"area_id": "CAN区域", "area": "区域名称", "name": "0001", "display_name": "空调",
     "type":    "central_control",
-    "subtype":    "central_control_common", //
+    "subtype":    "central_control_common", //中控
     "config":  
     {
         "bus":"canbus",//设备接入总线或协议类型,canbus/network/serial/RS485/zigbee/bluetooth/dali/knx/plc-iot
         "address": "A51234F85667", //地址为网络设备mac地址
-        "control_bits": [
-            {
-                "type":"canbus", //端口为canbus或485本机地址,纯网络面板,端口保留
-                "value": 1
-            }
-        ],  //端口为canbus或485本机地址,纯网络面板,端口保留,或为网关本地id,跨网关时使用
-        "background": "http://192.168.0.1/bg.jpg",//要下载同步缓存的背景图片
         "associated_device":[
             {
                 "name":"0001",
-                "action":"on"
+                "action":"unlock",
             }
         ],
         "associated_scene":[