Dualtech IPEagle / IPEagleCMS Installation and User guide
InstallIPEagle_EN_r4.doc, 2008-12-16
Prerequests: -
Microsoft SQL Server 2005 Express Microsoft .NET Framework 3.0 Windows XP with SP2 (IPEagle is not yet verified on Windows Vista)
1. If not already available, download and install Microsoft .NET Framework 3.0. Download and install information: http://www.microsoft.com/downloads/details.aspx?FamilyID=10CC340B-F8574A14-83F5-25634C3BF043&displaylang=en NOTE: Use a standard installation, click next on every question. 2. If not already available, download and install Microsoft SQL Server 2005 Express. Download and install information: http://www.microsoft.com/downloads/details.aspx?familyid=220549b5-0b07-44488848-dcc397514b41&displaylang=en NOTE: Use a standard installation, click next on every question. 3. Unzip the IPEagle zip file and run the setup.exe file. 4. Once the installation is complete, run the file attachDB.bat located in the folder where IPEagle was installed to initialize the database used by IPEagle. NOTE: this init is only done on the first installation of the IPEagle. If the file is executed later on, after for example an IPEagle software upgrade, all alarm messages etc will be deleted and the database reset. 5. Once the attachDB.bat is executed, reboot the computer. After the reboot, the service IPEagleServer is started and ready to receive alarm message on port 18100. The service will run in the background at all times as long as the computer is on. NOTE: make sure that possible firewalls are open for incoming TCP/IP messages on port 18100. 6. Double click the shortcut IPEagleClient on the PC desktop to start the IPEagle application. Login Username: Admin, Login Password: admin.
The IPEagle Client
To test the software, add a new transmitter. In the above example the new transmitter is simply named IP100. Note that the authenctication code must be the same as the code entered in the IP100 transmitter to test.
Select the heartbeat intervall to use. The transmitter itself must obviously be set to the same value. The transmitter will deliver short heartbeat messages to the IPEagle at a rate of three times the programmed pace. Once three heartbeats in a row are missed, an internal alarm will be activated and displayed in the IPEagle Alarm view.
To enter members in the contact list, first click Save&Close in the bottom of the page and then re-open the transmitter by clicking it in the transmitter list to the left. Click Edit in the contact list field and change the N.N person into valid data. To save, click Save and enter more persons if desired. Once all done, click Save&Close to save all the transmitter parameters. IPEagle Alarm view
In the above example there is a new alarm message from transmitter IK980006. New message is indicated by that the message is displayed in red colour. To open the message details, double click the alarm in the list.
To be able to “kiss off” the alarm, an action must be entered in the field Operator Actions.
After entereing an activity in “Operator Actions” the alarm message may be “kissed off” by clicking the “Sign” button. The message is then moved into the History section.
Forwarding alarm messages to other system The IPEagle may also forward incoming alarm messages to other system. Incoming messages that are forwarded is automatically stored into the history section. Messages may be forwarded in three different ways:
1. Transparent. Incoming alarm messages in IP protocol V4 will be transparently forwarded to other IP receiver. 2. From serial port on the receiver server using protocol Contact ID (IPEagleCMS only). 3. From serial port on the receiver server using protocol SIA (IPEagleCMS only).
Transparent
Incoming alarm messages in IP protocol V4 will be transparently forwarded to other IP receiver. Kiss off from the external IP receiver will be transparently forwarded to the IP dialer.
Contact ID & SIA (IPEagleCMS only) Alarm messages are forwarded via serial port on the receiver server using protocols Contact ID or SIA. Serial port settings are done under ”Settings”.
Contact ID Frames delivered from IPEagleCMS via serial port: 5MMLs18IIIIKAAAOOSSS Pos 1 2,3 4 5 6,7 8-11 12 13-15 16,17 18-20 21
Innehåll '5' MM L s '18' IIII K AAA OO SSS
Beskrivning Protocol number (always 5) Receiver number (always 01) Line card (always 1) SPACE Contact ID identifier (always 18) Transmitter ID (V4 tag: Transmitter Code) E = Alarm, R = Restoral Event code (V4 tag: event code) Area (always 00) Section (V4 tag: section) End character = hex 0x14
Transmitter ID, Event code and section is retrieved from the incoming IP alarm message and entered in to the Contact ID string that is delivered on the serial port. Example: 5011 181234E13000001 where transmitter ID in this case is 1234, event code = 130, area is always set to 00 and section = 001.
Contact ID requires that the section number is three digits. If the tag section in the inscoming V4 alarm message is shorter, for example 01, IPEagle will automatically enter an extra zero first in the section number meaning that 01 will be delivered as 001. If section is missing, IPEagle will distribute as 000. If the section tag is longer than three digits, IPEagle will cut the starting characters to reach the length of three digits, for example 1234 will be delivered as 234. The above also goes for event codes. If the event code received is shorter than three digits a starting zero will be added, for example 82 will be delivered as 082. If the event code is longer than three digits it will reduced to three digits, for example 5678 will be delivered as 678. Internal alarm events from an IP500 IP alarm dialer 81 Low supply voltage 82 Internet error 83 GPRS error 84 IP500 bypassed 85 Tamper switch 86 Com error external system (special case for OEM client) In case of Contact ID, the above event codes will be delivered as 081, 082 etc. from the serial port.
SIA Frames delivered from IPEagleCMS via serial port: Pos 1-4 5-6 7-12 13 14 15-16 17-[18:20] 19 20 21 22 23
Förklaring Always ’S’ ’0’ ’1’ ’A’ ’[’ ’#’ Transmitter ID ’|’ ’N’ (New event) Event code Section, 1-4 chars ’*’ Free text ’*’ ’]’ Stop character, hex 0x14
V4 tag transmittercode eventcode section eventtext -
Transmitter ID, Event code, section and event text is retrieved from the incoming IP alarm message and entered in to the SIA string that is delivered on the serial port. Example: S01A[#123456|NBA01*Valfri text*] where Stop character = hex 0x14.
Internal alarm events from an IP500 IP alarm dialer 81 Low supply voltage 82 Internet error 83 GPRS error 84 IP500 bypassed 85 Tamper switch 86 Com error external system (special case for OEM client) If one of the above event codes is received, the IPeagleCMS automatically will check the event type (AL for alarm or RE for restoral). If type AL, the above event code will be modified by that the “8” is removed and replaced by an “A”, for example 81 will be A1, 82 will be A2 etc. If type RE, the above event code will be modified by that the “8” is removed and replaced by an “R”, for example 81 will be R1, 82 will be R2 etc.
