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

1、添加短信推送设计文档;
2、添加MQTT接口设计文档。

liyuezong лет назад: 2
Родитель
Сommit
c3877e3988

BIN
Liyuezong/MQTT接口设计/MQTT结构.vsdx


+ 813 - 0
Liyuezong/MQTT接口设计/PDU MQTT接口协议设计.docx

@@ -0,0 +1,813 @@
+ 系统架构
+
+Mqtt broker服务器由pdu端配置统一的IP和端口。
+协议使用JSON格式。
+ 接口协议
+2.1 PDU发布接口
+2.1.1 PDU设备基本信息
+Topic:  /pdu/<pdu id >/info/device
+Data: 
+{
+"id": "A6D8B103-0838-4F14-27A4-FD3CA1998EF9",
+"name": "购旺智能PDU",
+"type": "交流单项智能PDU",
+"firmware": "V1.0.3.5",
+"channel_num": "64",
+"sensor _num": "6",
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                   Value值
+                                       1
+                                      id
+                                   Pdu编号
+                                       
+                                       2
+                                     name
+                                   Pdu名称
+                                       
+                                       3
+                                     type
+                                   Pdu类型
+                                       
+                                       4
+                                   firmware
+                                Pdu固件版本
+                                       
+                                       5
+                                  channel_num
+                                 通道个数
+                                     1-255
+                                       6
+                                  sensor _num
+                                传感器个数
+                                     1-255
+
+2.1.2 PDU网络状态信息
+Topic:  /PDU/{PDU id}/status/network
+Data: 
+{
+"lan_ipv4_link": "1",  
+"lan_ipv4_address": "192.168.3.10",
+"lan_ipv4_mask": "255.255.255.0",
+"lan_ipv6_link": "1",
+"lan_ipv6_address": "FC00:0000:130F:0000:0000:09C0:876A:130B",
+"lan_ipv6_subnet_length": "64",
+"wifi_enable": "1",  
+"wifi_ipv4_link": "1",  
+"wifi _ipv4_address": "192.168.2.33",
+"wifi _ipv4_mask": "255.255.255.0",
+"wifi _ipv6_link": "1",
+"wifi _ipv6_address": "FC00:0000:130F:0430:0864:09C0:346B:916F",
+"wifi _ipv6_subnet_length": "64",
+"modbus_address": "08",
+"modbus_baud": "9600",
+"modbus_mode": "0,
+"vpn_enable": "0",  
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                   Value值
+                                        
+                                 lan_ipv4_link
+                               网口IPV4状态 
+                                   0-断开
+                                   1-连接
+                                        
+                               lan_ipv4_address
+                             网口IPV4 ip地址 
+                                       
+                                        
+                                 lan_ipv4_mask
+                               网口IPV4掩码
+                                       
+                                        
+                                 lan_ipv6_link
+                               网口IPV6状态
+                                   0-断开
+                                   1-连接
+                                        
+                               lan_ipv6_address
+                               网口IPV6地址
+                                       
+                                        
+                            lan_ipv6_subnet_length
+                           网口Ipv6子网段长度
+                                       
+                                        
+                                  wifi_enable
+                               Wifi使能状态
+                                  0-未启用
+                                   1-启用
+                                        
+                                wifi_ipv4_link
+                               Wifi IPV4状态 
+                                   0-断开
+                                   1-连接
+                                        
+                              wifi _ipv4_address
+                              Wifi IPV4 ip地址 
+                                       
+                                        
+                                wifi _ipv4_mask
+                                Wifi IPV4掩码
+                                       
+                                        
+                                wifi _ipv6_link
+                                Wifi IPV6状态
+                                   0-断开
+                                   1-连接
+                                        
+                              wifi _ipv6_address
+                                Wifi IPV6地址
+                                       
+                                        
+                          "wifi _ipv6_subnet_length
+                           Wifi Ipv6子网段长度
+                                     0-128
+                                        
+                                modbus_address
+                                485串口地址
+                                     0-255
+                                        
+                                  modbus_baud
+                              485串口波特率
+                                       
+                                        
+                                  modbus_mode
+                                485级联模式
+                                     从机
+                                     主机
+                                        
+                                  vpn_enable
+                                   VPN启用
+                                  0-未启用
+                                   1-启用
+
+2.1.3 PDU电源总体状态信息
+Topic:  /pdu/<pdu id >/status/power/all_channel
+Data:
+{
+"voltage": "220",
+"current": "0.1",
+"power": "22",
+"consumption": "122",
+"power_factor": "0.98",
+"pactive_power": "20",
+"reactive_power": "2",
+"apparent_power": "22",
+"date": "2024-01-22",
+"time": "13:23:45",
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                   Value值
+                                        
+                                    voltage
+                                   总电压
+                                    单位V
+                                        
+                                    current
+                                  总电流 
+                                    单位A
+                                        
+                                     power
+                                   总功率
+                                    单位W
+                                        
+                                  consumption
+                                   总能耗
+                                   单位kwh
+                                        
+                                 power_factor
+                                总功率因数
+                                      0-1
+                                        
+                                 pactive_power
+                                总有功功率
+                                    单位W
+                                        
+                                reactive_power
+                               总无功功率 
+                                    单位W
+                                        
+                                apparent_power
+                               总视在功率 
+                                    单位W
+                                        
+                                     date
+                                    日期
+                                  yyyy-mm-dd
+                                        
+                                     time
+                                    时间
+                                   hh:mm:ss
+
+2.1.4 PDU通道状态信息
+Topic:  /pdu/<pdu id>/status/power/ <channel id>
+Data:
+{
+"name": "应用服务器通道",
+"status": "1",
+"voltage": "220",
+"current": "0.1",
+"power": "22",
+"power_freq": "50",
+"consumption": "122",
+"power_factor": "0.98",
+"pactive_power": "20",
+"reactive_power": "2",
+"apparent_power": "22",
+"date": "2024-01-22",
+"time": "13:23:45",
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                Value值范围
+                                        
+                                     name
+                                 通道名称
+                                       
+                                        
+                                    status
+                                 通道状态
+                                     断开
+                                     接通
+                                        
+                                    voltage
+                                 通道电压
+                                    单位V
+                                        
+                                    current
+                                 通道电流 
+                                    单位A
+                                        
+                                     power
+                                 通道功率
+                                    单位W
+                                        
+                                  Power_freq
+                                 通道频率
+                                   单位Hz
+                                        
+                                  consumption
+                                 通道能耗
+                                   单位kwh
+                                        
+                                 power_factor
+                              通道功率因数
+                                      0-1
+                                        
+                                 pactive_power
+                              通道有功功率
+                                    单位W
+                                        
+                                reactive_power
+                              通道无功功率 
+                                    单位W
+                                        
+                                apparent_power
+                              通道视在功率 
+                                    单位W
+                                        
+                                     date
+                                    日期
+                                  yyyy-mm-dd
+                                        
+                                     time
+                                    时间
+                                   hh:mm:ss
+
+2.1.5 PDU传感器状态信息
+Topic:  /pdu/<pdu id>/status/sensor/ <sensor id>
+Data:
+{
+"name": "温湿度传感器1",
+"type": "0",
+"modbus_address": "12",
+"node": "-1",
+"status": "1",
+"value_num": "2",
+"value1": "28",
+"value2": "65",
+"date": "2024-01-22",
+"time": "13:23:45",
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                Value值范围
+                                        
+                                     name
+                                传感器名称
+                                       
+                                        
+                                     type
+                                传感器类型
+0:温湿度传感器(2个值)
+1:烟雾传感器(1个值)
+2:水浸传感器
+3:门禁传感器
+4:气体传感器
+5:气压气流传感器
+6:空调红外控制器
+                                        
+                                modbus_address
+                                 Modbus地址
+                                     1-255
+                                        
+                                     node
+                                  节点号 
+                                     1-100
+                                        
+                                    status
+                                 在线状态
+0-离线
+1-在线
+                                        
+                                   value_num
+                                   值数量
+                                     1或2
+                                        
+                                    value1
+                                     值1
+                   温湿度传感器:温度值(℃);
+                  烟雾探测器:1-报警/0-未报警);
+                   水位探测器:1-侵入/0-未侵入;
+                     门禁传感器:1-锁闭/0-释放;
+           专用气体传感器:气体浓度(mg/m³或PPM);
+                   气流气压传感器:气流值(m/s)
+                                        
+                                    value2
+                                     值2
+                    温湿度传感器:湿度值(%);
+                   气流气压传感器:气压值(MPa)
+                                        
+                                     date
+                                    日期
+                                  yyyy-mm-dd
+                                        
+                                     time
+                                    时间
+                                   hh:mm:ss
+
+2.1.7 PDU网络报警信息
+Topic:  /pdu/<pdu id>/alarm/network
+Data:
+{
+"num": "1231",
+"context": "有线网络未接入或中途掉线!",
+"action": "1",
+"action_para": "7",
+"date": "2024-01-22",
+"time": "13:23:45",
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                Value值范围
+                                        
+                                      num
+                                 报警编号
+                                       
+                                        
+                                    context
+                                 报警内容
+
+                                        
+                                    action
+                              报警关联动作
+                             0-关闭所有通道
+                             1-打开所有通道
+                             2-打开对应通道
+                             3-关闭对应通道
+                                4-邮件告警
+                                5-短信告警
+                            6-复位烟雾探测器
+                                7-门禁释放
+                                8-打开空调
+                                9-关闭空调
+                                        
+                                  action_para
+                              动作关联参数
+                            通道号/传感器号
+                                        
+                                     date
+                                    日期
+                                  yyyy-mm-dd
+                                        
+                                     time
+                                    时间
+                                   hh:mm:ss
+
+2.1.8 PDU电源报警信息
+Topic:  /pdu/<pdu id>/alarm/power
+Data:
+{
+"num": "1231",
+"context": "通道2电压值超过下限,当前值202V,下限值210V!",
+"channel": "6",
+"action": "1",
+"action_para": "7",
+"date": "2024-01-22",
+"time": "13:23:45",
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                Value值范围
+                                        
+                                      num
+                                 报警编号
+                                       
+                                        
+                                    context
+                                 报警内容
+                                       
+                                        
+                                    channel
+                                   通道号
+                                     1-255
+                                        
+                                    action
+                              报警关联动作
+                             0-关闭所有通道
+                             1-打开所有通道
+                             2-打开对应通道
+                             3-关闭对应通道
+                                4-邮件告警
+                                5-短信告警
+                            6-复位烟雾探测器
+                                7-门禁释放
+                                8-打开空调
+                                9-关闭空调
+                                        
+                                  action_para
+                              动作关联参数
+                            通道号/传感器号
+                                        
+                                     date
+                                    日期
+                                  yyyy-mm-dd
+                                        
+                                     time
+                                    时间
+                                   hh:mm:ss
+2.1.9 PDU传感器报警信息
+Topic:  /pdu/<pdu id>/alarm/sensor
+Data:
+{
+"num": "1231",
+"context": "温湿度传感器1监测到温度超过限值,当前60℃,限值55℃",
+"sensor": "6",
+"action": "1",
+"action_para": "7",
+"date": "2024-01-22",
+"time": "13:23:45",
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                Value值范围
+                                        
+                                      num
+                                 报警编号
+                                       
+                                        
+                                    context
+                                 报警内容
+                                       
+                                        
+                                    sensor
+                                  传感器id
+                                     1-255
+                                        
+                                    action
+                              报警关联动作
+                             0-关闭所有通道
+                             1-打开所有通道
+                             2-打开对应通道
+                             3-关闭对应通道
+                                4-邮件告警
+                                5-短信告警
+                            6-复位烟雾探测器
+                                7-门禁释放
+                                8-打开空调
+                                9-关闭空调
+                                        
+                                  action_para
+                              动作关联参数
+                            通道号/传感器号
+                                        
+                                     date
+                                    日期
+                                  yyyy-mm-dd
+                                        
+                                     time
+                                    时间
+                                   hh:mm:ss
+
+2.1.10 PDU服务状态信息
+Topic:  /PDU/{PDU id}/status/service
+Data: 
+{
+"telnet": "1",  
+"smtp": "1",  
+"snmp_v1": "1",  
+"snmp_v2": "1",  
+"snmp_v3c": "1",  
+"snmp_trap": "1",  
+"message": "1",  
+"mqtt": "1",  
+"cloud": "1",  
+"ntp": "1",  
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                   Value值
+                                        
+                                    telnet
+                              Telnet启用状态
+                                  0-未启用
+                                   1-启用
+                                        
+                                     smtp
+                               smtp启用状态
+                                  0-未启用
+                                   1-启用
+                                        
+                                    snmp_v1
+                              snmp_v1启用状态
+                                  0-未启用
+                                   1-启用
+                                        
+                                    snmp_v2
+                              snmp_v2启用状态
+                                  0-未启用
+                                   1-启用
+                                        
+                                   snmp_v3c
+                             snmp_v3c启用状态
+                                  0-未启用
+                                   1-启用
+                                        
+                                   snmp_trap
+                             snmp_trap启用状态
+                              Telnet开启状态
+                                        
+                                    message
+                              message启用状态
+                                  0-未启用
+                                   1-启用
+                                        
+                                     mqtt
+                               mqtt启用状态
+                                  0-未启用
+                                   1-启用
+                                        
+                                     cloud
+                               cloud启用状态
+                                  0-未启用
+                                   1-启用
+                                        
+                                      ntp
+                                ntp启用状态
+                                  0-未启用
+                                   1-启用
+                                        
+                                     date
+                                    日期
+                                  yyyy-mm-dd
+                                        
+                                     time
+                                    时间
+                                   hh:mm:ss
+
+2.2 PDU订阅接口
+2.2.1 PDU电源总体控制指令
+Topic:  /pdu/<pdu id >/control/power/all_channel
+Data: 
+{
+"order": "1",
+"date": "2024-01-22",
+"time": "13:23:45",
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                   Value值
+                                       1
+                                     order
+                                 控制指令
+                                     关闭
+                                     打开
+                                       2
+                                     date
+                                    日期
+                                  yyyy-mm-dd
+                                       3
+                                     time
+                                    时间
+                                   hh:mm:ss
+
+2.2.2 PDU电源通道控制指令
+Topic:  /pdu/<pdu id >/control/power/<channel id>
+Data: 
+{
+"order": "1",
+"date": "2024-01-22",
+"time": "13:23:45",
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                   Value值
+                                       1
+                                     order
+                                 控制指令
+                                     关闭
+                                     打开
+                                       2
+                                     date
+                                    日期
+                                  yyyy-mm-dd
+                                       3
+                                     time
+                                    时间
+                                   hh:mm:ss
+
+2.2.3 PDU传感器控制指令
+Topic:  /pdu/<pdu id >/control/sensor/< sensor id>
+Data: 
+{
+"order": "1",
+"date": "2024-01-22",
+"time": "13:23:45",
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                   Value值
+                                       1
+                                     order
+                                 控制指令
+ 烟雾探测器:1-复位其报警状态;
+ 门禁传感器:1-门禁释放;
+ 空调红外控制器:1-开启/0-关闭指令。
+                                       2
+                                     date
+                                    日期
+                                  yyyy-mm-dd
+                                       3
+                                     time
+                                    时间
+                                   hh:mm:ss
+
+   2.2.4 PDU重启控制指令
+Topic:  /pdu/<pdu id >/control/device/restart
+Data: 
+{
+"order": "1",
+"date": "2024-01-22",
+"time": "13:23:45",
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                   Value值
+                                       1
+                                     order
+                                  控制指令
+ 关机
+ 重启
+                                       2
+                                     date
+                                    日期
+                                  yyyy-mm-dd
+                                       3
+                                     time
+                                    时间
+                                   hh:mm:ss
+
+   2.2.5 PDU重置控制指令
+Topic:  /pdu/<pdu id >/control/device/reset
+Data: 
+{
+"order": "1",
+"date": "2024-01-22",
+"time": "13:23:45",
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                   Value值
+                                       1
+                                     order
+                                  控制指令
+ 1-恢复出厂设置
+                                       2
+                                     date
+                                    日期
+                                  yyyy-mm-dd
+                                       3
+                                     time
+                                    时间
+                                   hh:mm:ss
+
+2.2.6 PDU服务控制指令
+Topic:  /PDU/{PDU id}/ control/service
+Data: 
+{
+"telnet": "1",  
+"smtp": "1",  
+"snmp_v1": "1",  
+"snmp_v2": "1",  
+"snmp_v3c": "1",  
+"snmp_trap": "1",  
+"message": "1",  
+"mqtt": "1",  
+"cloud": "1",  
+"ntp": "1",  
+}
+数据说明:
+                                    序号
+                                      Key
+                                   Key名称
+                                   Value值
+                                        
+                                    telnet
+                              Telnet启用指令
+                                  0-未启用
+                                   1-启用
+                                        
+                                     smtp
+                               smtp启用指令
+                                  0-未启用
+                                   1-启用
+                                        
+                                    snmp_v1
+                              snmp_v1启用指令
+                                  0-未启用
+                                   1-启用
+                                        
+                                    snmp_v2
+                              snmp_v2启用指令
+                                  0-未启用
+                                   1-启用
+                                        
+                                   snmp_v3c
+                             snmp_v3c启用指令
+                                  0-未启用
+                                   1-启用
+                                        
+                                   snmp_trap
+                             snmp_trap启用指令
+                              Telnet开启状态
+                                        
+                                    message
+                              message启用指令
+                                  0-未启用
+                                   1-启用
+                                        
+                                     mqtt
+                               mqtt启用指令
+                                  0-未启用
+                                   1-启用
+                                        
+                                     cloud
+                               cloud启用指令
+                                  0-未启用
+                                   1-启用
+                                        
+                                      ntp
+                                ntp启用指令
+                                  0-未启用
+                                   1-启用
+                                        
+                                     date
+                                    日期
+                                  yyyy-mm-dd
+                                        
+                                     time
+                                    时间
+                                   hh:mm:ss
+

+ 1 - 0
Liyuezong/短信推送设计/短信SDK其他参数说明.txt

@@ -0,0 +1 @@
+SDKAppID:1400895227

+ 9 - 0
Liyuezong/短信推送设计/短信模版导出20240315.csv

@@ -0,0 +1,9 @@
+模版ID,模版类型,模版名称,模版内容,状态,申请时间
+2096306,普通短信,PDU监测湿度超限报警,PDU设备{1}温湿度传感器{2}的监测到湿度超过{3},当前值{4} %,限值{5} % ,请及时关注电源状态!,已审核,2024/3/15 11:51
+2096300,普通短信,PDU监测温度超限报警,PDU设备{1}温湿度传感器{2}的监测到超过{3},当前值{4} ℃,限值{5}℃ ,请及时关注电源状态!,已通过,2024/3/15 11:49
+2096295,普通短信,PDU三相缺相报警,PDU设备{1}通道{2}缺相报警,请及时关注电源状态!,已通过,2024/3/15 11:44
+2096289,普通短信,PDU通道耗电量超上限值报警,PDU设备{1}通道{2}的耗电量超过上限值,当前值{3} kwh,上限值{4} kwh,请及时关注电源状态!,已通过,2024/3/15 11:40
+2096277,普通短信,PDU通道功率超上限值报警,PDU设备{1}通道{2}的功率值超过上限值,当前值{3} W,上限值{4} W,请及时关注电源状态!,已通过,2024/3/15 11:38
+2096272,普通短信,PDU通道电流超上限值报警,PDU设备{1}通道{2}的电流值超过上限值,当前值{3} A,上限值{4} A,请及时关注电源状态!,已通过,2024/3/15 11:36
+2096267,普通短信,PDU通道电压超下限值报警,PDU设备{1}通道{2}的电压值超过下限值,当前值{3} V,下限值{4} V,请及时关注电源状态!,已通过,2024/3/15 11:35
+2096259,普通短信,PDU通道电压超上限值报警,PDU设备{1}通道{2}的电压值超过上限值,当前值{3} V,上限值{4} V,请及时关注电源状态!,已通过,2024/3/15 11:25

+ 2 - 0
Liyuezong/短信推送设计/短线SecretKey.csv

@@ -0,0 +1,2 @@
+SecretId,SecretKey
+AKID1vnmgR1PgmktyqU2NVQ8ex61iWHrJfrw,zvhGcljT6nPq470fBSaWFvT5ZvLfdTQJ