Main Menu

Sub menu

Descriptions

Files

Minimize

Hide the application window, icon to system tray

Log in (Out)

Log in or Log Out MyID. It requires password to log in

Exit

Terminate and close MyID

Tools

Options

Set up ports and IP services

Client Manager

Manage Client base information

Event Manager

Manage Contact ID event massages

Load Alarm sample

For test purpose, a set of alarm message may be  loaded to the alarm buffer

Clear Alarm Buffer

Remove and Clear existing alarm from the alarm buffer

Themes

Application Destop Setting

  Standard

White back ground, Black text

  Black & Green

Black back ground, Green text

  Blue and White

Blue back ground, White text

Utilities

Debug Line 1

Start and Stop line 1 Debug

Debug Line 2

Start and Stop line 2 Debug

Debug Line 3

Start and Stop line 3 Debug

Debug Line 4

Start and Stop line 4 debug

Debug System

Start and Stop System debug

Control

Line 1

Start and Stop line 1 and modem

Line 2

Start and Stop line 2 and modem

Line 3

Start and Stop line 3 and modem

Line 4

Start and Stop line 4 and modem

HTTPD

Start and Stop embedded web server

MyID Alarm Server

Start and Stop MyID Server, Receive Alarm Messages in IP

MyID Event Server

Start and Stop MyID Event Server, Receive Activities in IP

Mode

Data port

Start and Stop Ademco 685 port

MyID Client

Start and Stop MyID Client, Send Alarm message in TCP/IP

IP685 Client

Start and Stop IP685 Client if required

SNPP Client

Start and Stop SNPP Client if required

Event Client

Start and Stop MyID Event Client, Send Activities in TCP/IP

Windows

App. Events

The Main window show application activities

Alarm Buffer

Any alarm message received during CS server outage

Alarm Text

Shows the alarm buffer contents in text mode

Show Queue

Display the message located in memory buffer waiting to be sent

Helps

Contents

Helps in HTML format, web browser is required

Registration

Source of Information and registration entry

Remove registration

Unregister MyID application from the Computer

License Agreement

Disclaimer etc

About

Application and system information

Appendix

System Event

ContactID report for system event

Application Desktop

Three FIFO buffer and display windows are provided. Together, they are capturing almost all activities of MyID operation.

Both windows may be open or closed as required by click the Windows menu.

Event window

Event Window located on top of the form. It displays the application events in a FIFO buffer and the event is saved on the disk if enabled.

Alarm buffer

The alarm buffer is for buffering the alarm signals (messages) from the local modem or/and from IP client with the TCP/IP network in the event of lost communication to the CS Server. The buffered alarm message also saved to the hard drive for save keeping. All alarm messages are secure, except that of complete hardware failure.

Status Panel

The Status Panel located at the bottom, separate fields are provided to indicate the status of each receiver line and network communication activities and their status in text.

The application uses a set up file stored in the hard drive for it communication parameters. If no file is found the Configuration is automatically launched, to begin the set up process. User should have the system hardware information ready.

There are two areas of considerations Data Port setup and Modem port setup.

Utilities Menu

Debug: Menu option 1 to 4 enables/disables debug mode on the correspondent line/modem. When activated, the modem activities will be logged with more detailed description, and all these events are display and saved to the disk. The increase activity will increase the demand on processor power and increase disk access related latency. It is the feature for debugging and training. This setting only active for the current session, and should be unchecked if the details is no longer required.

Debug System: When this menu option is checked, the system related activities are logged will more detailed description, and all these events are display and saved to the disk. The increase activity will increase the demand on processor power and increase disk access related latency. It is the feature for debugging and training. This setting only active for the current session, and should be unchecked if the needs is no longer required, This option is automatically enabled when the Event Client is enabled.

Control Menu

(Start/Stop) Line*: Menu option 1 to 4 starts/Stops modems on the correspondent line/connection. When checked, the modem is active and is ready to receive signals.

Data Port: This menu option starts/Stops Ademco 685 serial communication.

MyID Client: This menu item is used to indicates MyID Alarm Client status only. MyID alarm client connection to the Alarm Server is alarm driven. The connection to the server is drop as soon as the message string is completed and acknowledged.

IP685 Client: This menu option starts/Stops IP685 Client. IP685 Client may be connect to the Central Station as required or maintain an dedicated port/connection from the start.

SNPP Client: This menu option starts/Stops SNPP Client if required. SNPP Client connects to the SNPP gateway when required, and disconnect when page is finished.

Event Client: This menu option starts/Stops MyID Event Client. MyID Event Client connection to the Event Server is permanent. The connection may be terminated either by the Event Server or MyID Event Client.

MyID Server: This menu option starts/Stops MyID Alarm Server. MyID Alarm Server can host multiple connection or sessions.

Event Server: This menu option starts/Stops MyID Event Server. MyID Event Server can host multiple connections.

Data Port Setup:

The data port set up arranging the how and where the received alarm messages are processed.

The standard Ademco 685 protocol sends data to the CS server via serial port.

MyID has provided TCP/IP options to make the application flexible and more scalable. MyID Server and MyID Client, two new options are licensed for Customer looking for a cost effective and networked solution to their Monitoring Automation operation.

Ademco 685: This is an emulation of standard Ademco 685 receiver. The serial Data Comport and data rate must be selected to match the physical connection that you are using for communication with a CS Server.

MyID client: MyID Client receives alarm messages from its local modem, and then the Alarm messages are relayed to the remote MyID server anywhere within the network utilizing the standard TCP/IP protocol. There is no serial Ademco 685 output when the IP Client more is selected.

When selecting the IP Client mode, the destination IP address must be provided. There are two IP addresses: one for primary server, and one for a backup server. The IP address must belong to an active host that the server is running on. And an IP port is required (default is 5005).

IP685 client: IP 685 Client send ademco 685 formated alarm messages via a TCP port instead of serial connection to a Central Station Server. To use this feature the Central Station software must also support this protocol.

SNPP client: SNPP Client is another protocol support by MyID. SNPP client send alarm message to relevant pager via a SNPP paging gateway. To support account and point related information, A powerful but light way SQL database has introduced from version 3.19.

MyID Server: MyID server is designed to act as an alarm server for MyID clients. MyID Server enables alarm transportations in LAN and WAN environment. My IP client communicates with MyID server utilize TCP/IP Protocol. MyID Server can receive alarm messages locally via Modems and relays alarm messages from MyID Clients. MyID server output serial Ademco 685 data to a local CS server using RS232.

An available IP Port (default 5005) is required to for MyID Server.

Poll Server: While in MyID client mode, the application offers the option of polling the Server at a given interval. The purpose of this option is to re-route alarm message to a backup server automatically in the event of lost communication to the primary Server.

Receiver ID: A CS server may be connects more than one alarm-receiver. Please make sure that two receivers are allocated with the same ID number. Maximum of 8 receivers is allowed per CS server. Duplicated receiver ID may be used for experienced CS engineer.

Line Setting:

Maximum of four modems may be used on one single computer. The communication parameters between the computer and the modems are hard coded with MyID software, only the Windows comport number is required for the modem to operate. The hardware parameter of a serial port is defined within Windows operating system.

Com port: The com port must be unique for each modem/line, if duplicated com port is selected, it will be reset to 0 automatically and display a notice on the screen.

Telephone Number: The phone number for each line is not part of operational requirement but it is recommended for the benefit of system maintenance.

Auto Start: if the checkbox "Start Line X automatically" is checked, the modem will be initialized automatically every time the application is launched. Otherwise, the modem is required to initialize manually after the application has started.

Controls:

Save: If the button is clicked during the configuration, the data entered in all edit boxes of check boxes are saved to the computer and the display also refreshes to reflex the change. The change has not effects on current session.

Save & Exit: If the button is clicked during the configuration, the data entered in all edit boxes of check boxes are saved to the computer and close the configuration utility. The change will be active in next session.

Restart: If the button is clicked during the configuration, MyID will temporary suspends all its operations and reload all operation parameters from the configuration file and restart all communication tasks.

System Settings:

CS Account: Contact ID account or Central Station Account. MyID is now provides contactID message for key system & modem related events. Enter to four-digit number as required. The ContactID messages generated by MYID with are sending to this account. Events can be monitored and viewed within the Monitoring Automation System. The default account is 9991, MyID accepts any four digit number (Leading "0" is consider in valid)

HTTP Port: The HTTP protocol uses port 80 as standard, when the web browser is launched, it automatically seek data from port 80, if port other port 80 is used to provide HTTP services, the port must be specified in the web browser URL field. If the page is accessed from the local computer, the following URL shall be used: htp://127.0.0.1/. If the default port (80) is used, or http://127.0.0.1:8080/ if the other port (8080) is used.

With HTTPD, most MyID operation and system parameters may be accessed from any computer anywhere within the network or via Internet using a standard Web browser. The default port is 80, and the other popular port is 8080.

There are limit of maximum ten simultaneous connections to the HTTPS Server.

Poll Time: This defines the interval in seconds (default: 60) for MyID Alarm Client to poll the Server.

Line Test Time: This defines the interval in seconds (default: 600) for MyID to initiate the Dial tone test on the configured modem, to ensure that the telephone line is in fact live. If line fault is detected, a message is sent to the server and log to the disk. In the latest version of MyID release, this timer of used in SNPP client, to initiate Watchdog timer checking procesure.

The modem is tested every 6 seconds. Any faulty connection or lost of power in the modem is reported and log to the disk. If the modem is reconnected or power returns to the modem, the modem(s) is re-initialized with 12 seconds.

Start HTTPD: This checkbox is to activate the embedded web server. If the checkbox is checked, the web server will be started automatically.

Enable Extra Menu: This checkbox is to activate the extra menu: utilities and Control. These two menus is disabled by default, when activated, the two menu options is available on log in.

Poll MyID Alarm Server: This checkbox is to enable Periodic Polling when it is in MyID Client Mode. This setting has no effect on other operating modes.

Change password: When the "Change password" checkbox is checked, it will check to make sure that both password entries are matched before the password is encrypted and saved. Otherwise password boxes are cleared.

Password is require for Log in, Access Options, or Exit(close) the application.

Monitor Ademco 685 Poll: Activate this checkbox to track that the Central Station Server poll activity.

Periodic Tone Test: This checkbox to enable the application to initiate telephone line test by the detecting the presence of dial tone. Line Test Time determines the test interval. If this checkbox is checked, every modem will be placed in test mode in sequence.

Database:

Client Database: This is a SQL table. Each client is disabled by default. Operator is required to set client to the active status by set the status field to "1" and edit the relevant information as appropriate. In the SNPP application, Account 1 to 10 is reserved for group processes. (For the future expansion, we are strongly recommend operator to reserve the first 32 account for system based features)

Event Database: This is a SQL table. The contact ID event type located in this table may be edited if required but it recommended to experienced operator only.

Account Database: These are SQL tables. Each Client has an unique account number and an associated table (pre-fix 'A' + account number) for alarm zone and user information. The Zone description and user name entered to this table are used to formulates alarm message for transmission.

Watchdog Alarm Watch and Timing

Watchdog alarm is generated on the satisfactory of all conditions below:

Watchdog Controls:

Watchdog Timeout time(number of Seconds):

SNPP Page

Each time an alarm message is processed for SNPP transmission, the account number is parsed from the alarm message, it used to query the database for the relevant pager ID. If the account is invalid, disabled or any reason returns a SQL error, the alarm message will be logged and message discarded.  

The pager ID returned from the query is used for the message on the transmission queue only. If the pager or the alarm message is declined by the SNPP Gateway, the alarm message will be logged and the message discarded. However, if the SNPP Gateway is experiencing technical difficulty, the alarm message will be queued and retry indefinitely.

Watchdog page

Watchdog violation will be checked every 30 minutes or poll time setup if greater. This means that the possibility of actual page could occurs between the Watchdog timeout time (say 8 hours) plug 1 to 30 minutes. The check is done at the beginning of the minute, with one group following another in numeric order every new minute each round (if too many violation occurred adjust may be required because each page takes two 2 – 3 seconds).

For each group, a shared account will be used to look up the pager ID where the account number is the watchdog tag (default 1to 8).

SQL Messages

MyID uses SQLite, a public domain database (www.sqlite.org). It is a very small (200k), text based SQL database. It supports all frequently used SQL commands and is based on SQL specification.

The SQLite database interface is based on TSQLite by Ben Hochstrasser.

SQL Logic or table/data match error:

SQLite database Errors:

MyID SQL Error Messages:

Error	Description
DBat	Creating Account Table
Dbla	Load Account Table
DBlt	Load Account Table
DBae	Insert default Account entries
DBevt	Creating Event Table
Aevt1..30	Creating Event Table entries
WDac	Load Account Table
QEvtT	Query Event Text
QAcntN	Query Account Name
QusrN	Query User name
QznN	Query Zone name
TSC	Timestamp call
Qwp0..9	Query Watchdog pager ID group 0..9
DBnc	Insert new client record
Dbu	Update table cell
DBlt	Load Client Table contents

MyID Event Description and Identification

MyID report system activity to the CS server using standard contactID message. A unique account number is required when multiple receivers are deployed. This provision facilitates integrated monitoring including the receiver itself within the CS environment. The events used by MyID are list as follow:

System Activities:

Line Activities: