Difference between revisions of "AlarmEvent"

From ESS-WIKI
Jump to: navigation, search
 
(38 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
= Introduction =
 
= Introduction =
 +
 +
Alarm event that is a service to subscribe MQTT borker topic to get message code.
 +
 +
Accroding to message code mapping event message and send event to EI server. Event message is setting in the "event_config.json". And event_config.json that can set handler name, tag name to subscribe specific handler and message code.
  
 
= Alarm Event =
 
= Alarm Event =
<p style="text-align: center;">[[File:AlarmEvent Architecture.jpg|500x400px]]</p>
+
<p style="text-align: center;">[[File:AlarmEvent Architecture3.jpg|600x500px|AlarmEvent Architecture.jpg]]</p>
 
 
 
= How to =
 
= How to =
  
 
== Software Requirements ==
 
== Software Requirements ==
  
*MQTT broker&nbsp; V1.0.3
+
*MQTT broker v1.0.3
 
*EI Agent
 
*EI Agent
*Agent_Modbus_Handler_2.0.1-rc2 or newer
+
*Modbus_Handler v2.0.1
  
 
== Installation ==
 
== Installation ==
Line 32: Line 35:
 
<span style="font-size:medium;">'''event_config.json (location: C:\Program Files (x86)\Advantech\AlarmEvent\config)'''</span>
 
<span style="font-size:medium;">'''event_config.json (location: C:\Program Files (x86)\Advantech\AlarmEvent\config)'''</span>
  
*handler_name: Subcribe handler name
 
 
*tag_name:&nbsp;Subcribe tag name
 
*tag_name:&nbsp;Subcribe tag name
 
*subtype: Event subtype
 
*subtype: Event subtype
 
*event:
 
*event:
*#severity: Emergency = 0 ,Warning = 4
+
**severity: Emergency = 3&nbsp;,Warning = 4
*#msg_code: Device output code&nbsp;
+
**msg_code: Device output code&nbsp;
*#msg: Output code&nbsp;express message
+
**msg: Output code&nbsp;express message
*#error_code: Output code express error code
+
**error_code: Output code express error code
*#extmsg: Externel event message
+
**extmsg: Externel event message
 
*server: MQTT broker ip
 
*server: MQTT broker ip
 
*server_port:&nbsp; MQTT broker port
 
*server_port:&nbsp; MQTT broker port
<pre>{
+
<pre>{   
    "handler_name":"Modbus_Handler",    
 
 
     "tag_name":"Error_Code",
 
     "tag_name":"Error_Code",
 
     "subtype":"TC_AC",
 
     "subtype":"TC_AC",
Line 50: Line 51:
 
     "event":
 
     "event":
 
     {
 
     {
         "1": {"severity":0, "msg_code":241, "msg":"Door Open","error_code": "E:0030", "extmsg":"Immediate stop: Enclosure door open"},
+
         "1": {"severity":3, "msg_code":241, "msg":"E:0030 Door Open","error_code": "E:0030", "extmsg":"Immediate stop: Enclosure door open"},
         "2": {"severity":4, "msg_code":242, "msg":"Door Open", "error_code": "A:0030","extmsg":"Warning: Enclosure door open"},
+
         "2": {"severity":4, "msg_code":242, "msg":"A:0030 Door Open", "error_code": "A:0030","extmsg":"Warning: Enclosure door open"},
         "3": {"severity":4, "msg_code":250, "msg":"CAB FTR DP ALM","error_code": "A:0031", "extmsg":"Warning: Cabinet filter differential pressure"},
+
         "3": {"severity":4, "msg_code":250, "msg":"A:0031 CAB FTR DP ALM","error_code": "A:0031", "extmsg":"Warning: Cabinet filter differential pressure"},
         "4": {"severity":0, "msg_code":321, "msg":"Oil level","error_code": "E:0040", "extmsg":"Immediate stop: Oil level alarm"},
+
         "4": {"severity":3, "msg_code":321, "msg":"E:0040 Oil level","error_code": "E:0040", "extmsg":"Immediate stop: Oil level alarm"},
         "5": {"severity":4, "msg_code":322, "msg":"Oil level alarm","error_code": "A:0040", "extmsg":"Warning: Oil level high"},
+
         "5": {"severity":4, "msg_code":322, "msg":"A:0040 Oil level alarm","error_code": "A:0040", "extmsg":"Warning: Oil level high"},
         "6": {"severity":0, "msg_code":401, "msg":"RD alarm","error_code": "E:0050", "extmsg":"Immediate stop: Refrigerant dryer"},
+
         "6": {"severity":3, "msg_code":401, "msg":"E:0050 RD alarm","error_code": "E:0050", "extmsg":"Immediate stop: Refrigerant dryer"},
         "7": {"severity":4, "msg_code":402, "msg":"RD alarm","error_code": "A:0050", "extmsg":"Warning: Refrigerant dryer"},
+
         "7": {"severity":4, "msg_code":402, "msg":"A:0050 RD alarm","error_code": "A:0050", "extmsg":"Warning: Refrigerant dryer"},
         "8": {"severity":0, "msg_code":481, "msg":"Belt drive SERV","error_code": "E:0060", "extmsg":"Immediate stop: Belt drive service"},
+
         "8": {"severity":3, "msg_code":481, "msg":"E:0060 Belt drive SERV","error_code": "E:0060", "extmsg":"Immediate stop: Belt drive service"},
         "9": {"severity":0, "msg_code":561, "msg":"Fan MTR IMM stop","error_code": "E:0070", "extmsg":"Immediate stop: Fan motor trip"}
+
         "9": {"severity":3, "msg_code":561, "msg":"E:0070 Fan MTR IMM stop","error_code": "E:0070", "extmsg":"Immediate stop: Fan motor trip"}
 
     },       
 
     },       
  
Line 67: Line 68:
 
== Import event table ==
 
== Import event table ==
  
*Add RMM_Event data source
+
A SwanAir Table supports maximizue 東正 AIR Compressor devices' event message.
 +
 
 +
*Add RMM_Event data source =>&nbsp;Configuration / DataSources
  
 
[[File:AlarmEvent dashboard 1.JPG|600x300px|AlarmEvent dashboard 1.JPG]]
 
[[File:AlarmEvent dashboard 1.JPG|600x300px|AlarmEvent dashboard 1.JPG]]
Line 73: Line 76:
  
  
*Upload plugin (swanair-datatable-panel_2018-11-21.zip)
+
*Upload plugin (swanair-datatable-panel_2018-11-21.zip) => Configuration / Plugins
  
 
[[File:AlarmEvent dashboard 5.JPG|800x150px|AlarmEvent dashboard 5.JPG]]
 
[[File:AlarmEvent dashboard 5.JPG|800x150px|AlarmEvent dashboard 5.JPG]]
Line 81: Line 84:
 
*Add panel
 
*Add panel
  
[[File:AlarmEvent dashboard 6.JPG|700x300px|AlarmEvent dashboard 6.JPG]]
+
[[File:SwanairTable.jpg|800x350px|AlarmEvent dashboard 6.JPG]]
  
  
Line 90: Line 93:
  
  
 +
 +
*Hidden Column
 +
 +
[[File:Grafana hidden column.jpg|600x250px|Grafana hidden column.jpg]]
  
 
*Event table
 
*Event table
  
[[File:AlarmEvent dashboard 7.JPG|1100x300px|AlarmEvent dashboard 7.JPG]]
+
[[File:Grafana customization event table.jpg|1200x250px|Grafana customization event table.jpg]]
  
= Json Data Format =
+
= Event JSON Message&nbsp;for Air Compressor =
 
<pre>{
 
<pre>{
 
     "susiCommData":
 
     "susiCommData":
Line 114: Line 121:
 
           "n": "Warning: Enclosure door open",
 
           "n": "Warning: Enclosure door open",
 
           "ErrorCode":"A:0030",
 
           "ErrorCode":"A:0030",
           "eventID":242
+
           "eventID":242,
 +
          "ModBusDeviceID":"Modbus_Device0",
 +
          "HandlerName":"Modbus_Handler"
 
         }
 
         }
 
       }
 
       }
Line 120: Line 129:
 
}</pre>
 
}</pre>
  
= Use Case =
+
= Release =
  
...
+
{| border="1" cellspacing="1" cellpadding="1" style="width:1300px;"
 +
|-
 +
| style="text-align: center; width: 45px;" | <span style="font-size:medium;">Index</span>
 +
| style="text-align: center; width: 77px;" | <span style="font-size:medium;">Version</span><br/>
 +
| style="text-align: center; width: 74px;" | <span style="font-size:medium;">Date</span><br/>
 +
| style="text-align: center; width: 89px;" | <span style="font-size:medium;">Platform</span><br/>
 +
| style="text-align: center; width: 116px;" | <span style="font-size:medium;">OS</span><br/>
 +
| style="text-align: center; width: 242px;" | <span style="font-size:medium;">Release Note</span><br/>
 +
| style="text-align: center; width: 396px;" | Download
 +
| style="text-align: center; width: 131px;" | Note
 +
|-
 +
| style="text-align: center; width: 45px;" | 1
 +
| style="text-align: center; width: 77px;" | 1.0.1
 +
| style="text-align: center; width: 74px;" | 2018/12/10
 +
| style="text-align: center; width: 89px;" | x64 CPU<br/>
 +
| style="text-align: center; width: 116px;" | Windows 10 x64
 +
| style="width: 242px;" | [http://ess-wiki.advantech.com.tw/wiki/images/7/7a/AlarmEvent_ReleaseNote_1.0.1.pdf AlarmEvent_ReleaseNote_1.0.1.pdf]<br/>
 +
| style="width: 396px;" |
 +
*EI Agent ( Download from WISE-PaaS/EdgeSense )
 +
*[file://eossfs/ESS-Release/EdgeSense/Release/ESS-Release/Windows/MQTTBroker MQTT broker&nbsp; v1.0.3]
 +
*[file://eossfs/ESS-Release/EdgeSense/Release/ESS-Release/Windows/Modbus_Handler/2.0.1 Modbus_Handler v2.0.1]
 +
*[file://eossfs/ESS-Release/EdgeSense/Design-in_Services/東正-air%20compressor-20181020/1.0.1/ AlarmEvent-1.0.1.exe]
  
= Release =
+
| style="width: 131px;" | [[Media:AlarmEventFormat_TONG_CHENG.txt|Event Format v1.0.1]]
{| border="1" cellspacing="1" cellpadding="1" style="width:500px;"
 
 
|-
 
|-
| style="text-align: center;" | <span style="font-size:medium;">Index</span>
+
| style="text-align: center; width: 45px;" | 2
| style="text-align: center;" | <span style="font-size:medium;">Version</span><br/>
+
| style="text-align: center; width: 77px;" | 1.0.2
| style="text-align: center;" | <span style="font-size:medium;">Date</span><br/>
+
| style="text-align: center; width: 74px;" | 2019/03/05
| style="text-align: center;" | <span style="font-size:medium;">Platform</span><br/>
+
| style="text-align: center; width: 89px;" | x64 CPU
| style="text-align: center;" | <span style="font-size:medium;">OS</span><br/>
+
| style="text-align: center; width: 116px;" | Windows 10 x64
| style="text-align: center;" | <span style="font-size:medium;">Release Note</span><br/>
+
| style="width: 242px;" |  
|-
+
[[Media:AlarmEvent_ReleaseNote-1.0.2.pdf|AlarmEvent_ReleaseNote-1.0.2.pdf]]
| style="text-align: center;" | <span style="font-size:medium;"></span>
+
 
| style="text-align: center;" | <span style="font-size:medium;"></span>
+
[[Media:Swanair-Table-ReleaseNotel-V3.pdf|Swanair-Table-ReleaseNotel-V3.pdf]]
| style="text-align: center;" | <span style="font-size:medium;"></span>
+
 
| style="text-align: center;" | <span style="font-size:medium;"></span><br/>
+
| style="width: 396px;" |  
| style="text-align: center;" | <span style="font-size:medium;"></span><br/>
+
*[file://eossfs/ESS-Release/EdgeSense/Design-in_Services/swan-air-compressor-20181020/1.0.2 AlarmEvent-1.0.2-Windows_x64.zip]
| <span style="font-size:medium;"></span><br/>
+
*[file://eossfs/ESS-Release/EdgeSense/Design-in_Services/swan-air-compressor-20181020/1.0.2 swanair-table-panel-Version3.zip]
 +
*EI Agent ( WISE-PaaS/EdgeSense version 1.0.96 )
 +
*[file://eossfs/ESS-Release/EdgeSense/Release/ESS-Release/Windows/MQTTBroker MQTT broker&nbsp; v1.0.3]
 +
*[file://eossfs/ESS-Release/EdgeSense/Release/ESS-Release/Windows/Modbus_Handler/2.0.1 Modbus_Handler v2.0.1]
 +
 
 +
| style="width: 231px;" |  
 +
[[Media:event_config-1.0.2.zip|event_config.json]]
 +
 
 +
[[Media:Advantech-SW-Specification-for-SWANAIR-20190315.pdf|Software Specification-signed by customer]]
 +
 
 
|}
 
|}

Latest revision as of 04:13, 11 June 2019

Introduction

Alarm event that is a service to subscribe MQTT borker topic to get message code.

Accroding to message code mapping event message and send event to EI server. Event message is setting in the "event_config.json". And event_config.json that can set handler name, tag name to subscribe specific handler and message code.

Alarm Event

AlarmEvent Architecture.jpg

How to

Software Requirements

  • MQTT broker v1.0.3
  • EI Agent
  • Modbus_Handler v2.0.1

Installation

1.Double click AlarmEvent-X.X.X.exe to install.

2.Click "Next" to continue the setup wizard.

3.Select installation folder then click "Next"

4.Click "Next" to begin the installation

5.Complete the installation, click "Finish" to exit the setup wizard

6.Edit event_config.json (if need)

7.Restart device

Configuration​

event_config.json (location: C:\Program Files (x86)\Advantech\AlarmEvent\config)

  • tag_name: Subcribe tag name
  • subtype: Event subtype
  • event:
    • severity: Emergency = 3 ,Warning = 4
    • msg_code: Device output code 
    • msg: Output code express message
    • error_code: Output code express error code
    • extmsg: Externel event message
  • server: MQTT broker ip
  • server_port:  MQTT broker port
{   
    "tag_name":"Error_Code",
    "subtype":"TC_AC",

    "event":
    {
        "1": {"severity":3, "msg_code":241, "msg":"E:0030 Door Open","error_code": "E:0030", "extmsg":"Immediate stop: Enclosure door open"},
        "2": {"severity":4, "msg_code":242, "msg":"A:0030 Door Open", "error_code": "A:0030","extmsg":"Warning: Enclosure door open"},
        "3": {"severity":4, "msg_code":250, "msg":"A:0031 CAB FTR DP ALM","error_code": "A:0031", "extmsg":"Warning: Cabinet filter differential pressure"},
        "4": {"severity":3, "msg_code":321, "msg":"E:0040 Oil level","error_code": "E:0040", "extmsg":"Immediate stop: Oil level alarm"},
        "5": {"severity":4, "msg_code":322, "msg":"A:0040 Oil level alarm","error_code": "A:0040", "extmsg":"Warning: Oil level high"},
        "6": {"severity":3, "msg_code":401, "msg":"E:0050 RD alarm","error_code": "E:0050", "extmsg":"Immediate stop: Refrigerant dryer"},
        "7": {"severity":4, "msg_code":402, "msg":"A:0050 RD alarm","error_code": "A:0050", "extmsg":"Warning: Refrigerant dryer"},
        "8": {"severity":3, "msg_code":481, "msg":"E:0060 Belt drive SERV","error_code": "E:0060", "extmsg":"Immediate stop: Belt drive service"},
        "9": {"severity":3, "msg_code":561, "msg":"E:0070 Fan MTR IMM stop","error_code": "E:0070", "extmsg":"Immediate stop: Fan motor trip"}
    },       

    "server":"127.0.0.1",
    "server_port": 3000
}

Import event table

A SwanAir Table supports maximizue 東正 AIR Compressor devices' event message.

  • Add RMM_Event data source => Configuration / DataSources

AlarmEvent dashboard 1.JPG


  • Upload plugin (swanair-datatable-panel_2018-11-21.zip) => Configuration / Plugins

AlarmEvent dashboard 5.JPG


  • Add panel

AlarmEvent dashboard 6.JPG


  • Panel setting

AlarmEvent dashboard 4.JPG


  • Hidden Column

Grafana hidden column.jpg

  • Event table

Grafana customization event table.jpg

Event JSON Message for Air Compressor

{
     "susiCommData":
     {
       "commCmd":2059,
       "requestID":2001,
       "agentID":"Modbus_Handler",
       "handlerName":"general",
       "sendTS":1541992952337,
       "eventnotify":
       {
         "subtype":"TC_AC",
         "msg":"Door Open",
         "severity":4,
         "handler":"Modbus_Handler",
         "extMsg":
         {
           "n": "Warning: Enclosure door open",
           "ErrorCode":"A:0030",
           "eventID":242,
           "ModBusDeviceID":"Modbus_Device0",
           "HandlerName":"Modbus_Handler"
         }
       }
     }
}

Release

Index Version
Date
Platform
OS
Release Note
Download Note
1 1.0.1 2018/12/10 x64 CPU
Windows 10 x64 AlarmEvent_ReleaseNote_1.0.1.pdf
Event Format v1.0.1
2 1.0.2 2019/03/05 x64 CPU Windows 10 x64

AlarmEvent_ReleaseNote-1.0.2.pdf

Swanair-Table-ReleaseNotel-V3.pdf

event_config.json

Software Specification-signed by customer