gsm base logger manual - vansoft.co.za filegsm base logger manual version 2-2-0-3 before attempting...

GSM BASE LOGGER

MANUALVERSION 2-2-0-3

Before attempting to operate this software,please read these instructions in its entirety.

Table of Contents1.INTRODUCTION.................................................................................................................1

2.SOFTWARE COMPARASON............................................................................................2

3.SQL SERVER INSTALLATION..........................................................................................33.1.Connecting to an existing SQL Server...................................................................................33.2.Installing SQL Server Express...............................................................................................3

3.2.1.Windows XP required Modules.......................................................................................33.2.2.SQL Server Installation...................................................................................................33.2.3.License Terms................................................................................................................43.2.4.Feature Selection...........................................................................................................43.2.5.Instance Configuration...................................................................................................53.2.6.Server Configurations.....................................................................................................5

Server Configuration – Step 1.............................................................................................5Server Configuration – Step 2.............................................................................................5Server Configuration – Step 3.............................................................................................6

3.2.7.Database Engine Configuration......................................................................................63.2.8.Error Reporting...............................................................................................................73.2.9.Installation Progress.......................................................................................................73.2.10.Complete Installation....................................................................................................7

4.GSM BASELOGGER INSTALLATION..............................................................................84.1.Install the DOT Net Framework..............................................................................................84.2.Install the GSM Base Logger Software..................................................................................8

4.2.1.Setting Administrator mode in Windows 7......................................................................94.3.How to obtain an Activation Key...........................................................................................104.4.How to connect the GSM Modem........................................................................................104.5.How to create the Data Base...............................................................................................114.6.How to Upgrade the GSM Base Logger Software................................................................12

5.SCREEN DESCRIPTIONS...............................................................................................135.1.GSM Base Logger Main Screen..........................................................................................13

5.1.1.Main Display Screen....................................................................................................135.1.2.System Security...........................................................................................................135.1.3.System Exit..................................................................................................................14

5.2.GSM Modem Section...........................................................................................................155.2.1.Modem Display Screen................................................................................................155.2.2.Modem Screen Option Buttons....................................................................................15

5.3.Site Summary Section.........................................................................................................175.3.1.Site Display Screen......................................................................................................175.3.2.Site Summary Option Buttons......................................................................................17

5.4.Site Display Section.............................................................................................................185.4.1.Site Display Screen......................................................................................................185.4.2.Site Display Option Buttons..........................................................................................185.4.3.Reported SMS Pop-Up.................................................................................................21

5.5.Graphs Display Section.......................................................................................................225.5.1.Graphs Display Screen.................................................................................................225.5.2.Graph Display Option Buttons......................................................................................22

Graph Filter.......................................................................................................................22Analog Graph Section.......................................................................................................23Digital Input Graph Section...............................................................................................23Digital Output Graph Section............................................................................................23Analog Input Graph Section..............................................................................................24GSM Unit Graph Section..................................................................................................24Displayed Data Statistics..................................................................................................24

© Polygon Technologies. All rights reserved Page i

5.6.Database Configuration Section..........................................................................................255.6.1.Database Display Screen.............................................................................................255.6.2.Database Display Options............................................................................................255.6.3.Database Tools Options...............................................................................................285.6.4.Database Maintenance.................................................................................................295.6.5.Import Site Descriptions...............................................................................................29

Discrete – Digital Input Syntax..........................................................................................30Coils – Digital Output Syntax............................................................................................30Registers – Analog Input Syntax.......................................................................................31Holding Registers – Analog Output Syntax.......................................................................32

5.6.6.Export Site Descriptions...............................................................................................335.7.User Notification Section......................................................................................................33

5.7.1.Notification Display Screen...........................................................................................335.7.2.Modbus Display Option Buttons...................................................................................345.7.3.Modbus Scanning Functions........................................................................................34

6.SYSTEM CONFIGURATION............................................................................................356.1.General Buttons...................................................................................................................356.2.GSM Modem Configuration Dialogue...................................................................................36

6.2.1.GSM Modem Buttons...................................................................................................366.2.2.GSM Modem Wizard....................................................................................................36

Start-up Screen................................................................................................................37Modem Type.....................................................................................................................37Serial Port and Baud Rate................................................................................................38Modem Auto Reset...........................................................................................................38Signal Strength Reading...................................................................................................39SIM Card Network Type....................................................................................................39SIM Card Number and PIN...............................................................................................40Final Screen.....................................................................................................................40

6.3.General Settings Configuration Dialogue.............................................................................416.3.1.General Buttons...........................................................................................................416.3.2.General Wizard............................................................................................................41

Start-up Screen................................................................................................................42Polling and Security Time-outs.........................................................................................42Auto Save and Receive Screen Size................................................................................43User Defined SMS Logging..............................................................................................43Mail Server Settings..........................................................................................................44Software Update Settings.................................................................................................44Final Screen.....................................................................................................................45

6.4.Database Connections Configuration Dialogue....................................................................456.4.1.Database Buttons.........................................................................................................466.4.2.Database Wizard..........................................................................................................46

Start-up Screen................................................................................................................46SQL Server Selection.......................................................................................................47Connection Authentication Selection.................................................................................47Log-on User Name and Password....................................................................................48Final Screen.....................................................................................................................48

6.4.3.How to manually enter the SQL Server Name..............................................................496.5.GSM Site Configuration Dialogue........................................................................................50

6.5.1.GSM Site Buttons.........................................................................................................506.5.2.GSM Site Wizard..........................................................................................................50

Start-up Screen................................................................................................................51Site Name and Cell Number.............................................................................................51Site Identification Code.....................................................................................................52Installed Unit.....................................................................................................................52Enable Automatic Polling..................................................................................................53

© Polygon Technologies. All rights reserved Page ii

Automatic Polling Type.....................................................................................................53Daily Poll Time..................................................................................................................54Defined Polling Times.......................................................................................................54Modbus Communications.................................................................................................55Select Modbus Unit ID......................................................................................................55TCP/IP Connections.........................................................................................................56Site Display Type..............................................................................................................56Final Screen.....................................................................................................................57

6.6.Configure RTM Screens.......................................................................................................576.7.SMS Trigger Text Configuration Dialogue............................................................................58

6.7.1.SMS Trigger Buttons....................................................................................................586.7.2.SMS Trigger Wizard.....................................................................................................58

Start-up Screen................................................................................................................59Trigger Identification Name...............................................................................................59Trigger Text and Font........................................................................................................60Text Fore and Background Colours..................................................................................60Pop-Up Alarm and Time-out..............................................................................................61Final Screen.....................................................................................................................61

6.8.Configure Summary Dialogue..............................................................................................626.8.1.Summary Buttons.........................................................................................................626.8.2.Summary Wizard..........................................................................................................62

Start-up Screen................................................................................................................63System and Unit Display Selection...................................................................................63Digital Input Selection.......................................................................................................64Digital Output Selection....................................................................................................64Analog Input Selection......................................................................................................65Final Screen.....................................................................................................................65

6.9.User Notification Configuration Dialogue.............................................................................666.9.1.Notification Buttons......................................................................................................666.9.2.Notification Wizard Description.....................................................................................66

Start-up Screen................................................................................................................67Notification Identification Name........................................................................................67Connection IP Address.....................................................................................................68Remote Connection Type.................................................................................................68Final Screen.....................................................................................................................69

6.10.User Configuration Dialogue..............................................................................................696.10.1.User Buttons...............................................................................................................706.10.2.User Wizard Description.............................................................................................70

Start-up Screen................................................................................................................70User Name and Contact Number......................................................................................71Log-on Name and Password............................................................................................71Operational Function and e-Mail address.........................................................................72User Security Level...........................................................................................................72User Notifications..............................................................................................................73Final Screen.....................................................................................................................73

7.REMOTE SMS NOTIFICATION.......................................................................................747.1.Remote SMS Interface Screen............................................................................................747.2.Remote SMS Configuration.................................................................................................74

7.2.1.TCP/IP Connection.......................................................................................................747.2.2.Notification Users Configuration...................................................................................757.2.3.Predefined Message Configuration..............................................................................76

Message Configuration Screen.........................................................................................76Message Configuration Buttons........................................................................................77

8.COMMAND LINE UTILITY...............................................................................................78

© Polygon Technologies. All rights reserved Page iii

8.1.Command Line Execution....................................................................................................788.2.Connect Configuration.........................................................................................................79

9.IMPORTANT NOTICE (DISCLAIMER/COPYRIGHT)......................................................80

10.MANUFACTURER CONTACT DETAILS.......................................................................81

Document Changes

Version Revision History Date

1.0.0 First release November 2010

1.0.2 Corrections and software updates February 2011

1.1.0 Software version update April 2011

1.1.0.8 Summary screen added and software updates May 2011

1.1.0.9 Summary screen configuration and backup/restore added June 2011

2.0.0 Version 2 Software release January 2012

2.1.2 Version 2-1-2 Software release September 2012

2.1.2b Setting Windows 7 administrator key section added 23 September 2012

2.1.2c Upgrading software section added 1 October 2012

2.2.0 Expanded configuration section to include Wizards 19 November 2012

2.2.0.3 Added new software features and how to create databases

© Polygon Technologies. All rights reserved Page iv

1. INTRODUCTION

The windows based server GSMBaseLog is a stand alone server that can monitor a number of sites controlled by GSM Commanders. The server sends predefined or user defined commands to these units to control equipment and receives SMS's from the units. The received statuses are logged to a SQL database. These statuses are also decoded and mapped to modbus slots that can then be retrieved by a standard scada system using the modbus IP protocol. The system caters for digital inputs and outputs as well as analog inputs.

© Polygon Technologies. All rights reserved Page 1

2. SOFTWARE COMPARASON

The following table lists the functions available in each of the packages.

GSM Base LoggerFunction Description Lite Standard Professional Evaluation

Pricing Free On Request On Request 30 Day Trial

Maximum number of sites 1 10 / 20 / 30 127 5

GSM modem type selection

Triggered SMS's displayed in pop-up

Number of SMS triggers 2 8 / 12 / 16 32 4

Automatic polling of sites

Selection of polling types

SMS notifications of changes to users

e-Mail notifications of changes to users

Number of User Notification Connections 0 2 / 4 / 8 16 2

Number of Users 0 40 100 4

Scada system modbus interface

Scada system notification interface

Send digital output control SMS's

Send analog output control SMS's

Send manually entered SMS's

Log received Base-log messages

Log received SMS' messages

Log transmitted SMS messages

Log system events

Select site graphical displays

Security functions


3. SQL SERVER INSTALLATION

In order for the GSM Base Logger to function it needs to connect to a Microsoft SQL server database. The following section describes the installation of the server.

3.1. Connecting to an existing SQL Server

If an SQL Server is already present on the network it can be used. Contact the Database Administrator of the server to create a database called BaseLog and then to assign connection and administrative privileges for the base logger to connect to. The base logger will create all the required tables.

3.2. Installing SQL Server Express

The following section describes the process to install Microsoft's SQL Server 2008 R2 Express with tools and is free from Microsoft. The server is used by the GSM Base Logger to store information in the configured databases. It is freely available to download from Microsoft, just click on the following link: SQL Express 2008 R2 with Tools

3.2.1. Windows XP required Modules

If the server is to be installed on a Windows XP operating system make sure that the following two components are installed.

➢ Windows Installer 4.2: WindowsXP-KB942288-v3-x86➢ Power Shell: WindowsXP-KB968930-x86-ENG

3.2.2. SQL Server Installation

To start, run the installation file SQLEXPRWT_x86_ENU. (SQL Express With Tools) This will install the SQL Server and Management Studio. The first screen displayed is the Installation Center as shown below. Click the New installation or add features to an existing installation to start the installation.


3.2.3. License Terms

The license terms screen is displayed, select the I accept the license terms option then click Next to continue to the next screen as shown below.

3.2.4. Feature Selection

Make sure that all the features are selected, then click Next to continue to the next screen as shown below.


3.2.5. Instance Configuration

Select the option Named instance and leave all the default settings as is shown below. Then click Next to continue to the next screen.

3.2.6. Server Configurations

The following steps configure the server.

Server Configuration – Step 1

Click the button Use the same account for all SQL Server services as shown below.


When the dialogue screen is displayed, select the drop-down list Account Name. In the selection list select the option:

NT AUTHORITY\SYSTEM.

Then click the OK button as shown below.



Make sure that the following settings are selected as shown below. Then click Next to continue to the next screen.

3.2.7. Database Engine Configuration

Select Windows authentication mode as shown below. Then click Next to continue to the next screen.


3.2.8. Error Reporting

Un-check the error reporting to Microsoft option as shown below. Then click Next to continue to the next screen.

3.2.9. Installation Progress

The progress screen will be displayed during the installation as shown below.

3.2.10. Complete Installation

Once completed the final screen is displayed, click the Close button to finalize the installation.

Note:The SQL Server is now installed. Use the SQL Server Management Studio to view and edit the GSM Base Logger database and tables in the server.


4. GSM BASELOGGER INSTALLATION

4.1. Install the DOT Net Framework

The dot net version 4 framework is the core of the server and needs to be installed on the PC that will be running the program. It is freely available to download from Microsoft, just click on the following link: Microsoft NET Framework 4

4.2. Install the GSM Base Logger Software

The GSM Base Logger uses a SQL Server database engine to log all system configurations and received SMS’s. This section will guide you trough the installation process. To begin the process, forward your name, company, e-mail and contact number to GSM Base Logger in order to obtain the download link. Once the download has been completed, double-click on the set-up file to start the installation process. The installation selection screen will be displayed as shown below. Follow the dialogue screens until the installation has been completed.

Please Note: Run as Administrator in Vista and Windows 7 operating systems.Under 64 Bit operating system run in XP compatible mode.


mailto:[email protected]?subject=GSM%20Base%20Logger%20Software

http://www.microsoft.com/en-us/download/details.aspx?id=17718

http://www.microsoft.com/en-us/download/details.aspx?id=17718

4.2.1. Setting Administrator mode in Windows 7

When operating the GSM Base Logger under Vista or Windows 7 the properties of the executable file has to be set to Administrator. This will allow the Base Logger to interact with system resources. Follow the steps below to set the properties.

➢ Right click on the GSM Base Logger link in Windows Start All Programs Vansoft Technologies GSM Base Logger 2011 GSM Base Logger

➢ Select the Open file location option as shown below.

➢ When the file location is open select the BaseLog2011 application, right click on it and open the properties option.

➢ Select the Compatibility tab in the dialog, then click the Change settings for all users.

➢ Select the option Run this program as an administrator, then click the OK buttons to save and close the dialog screens. See below for details.


4.3. How to obtain an Activation Key

Menu: Help Register GSM Base Logger …

In order to activate the GSM Base Logger software, follow the steps below. See image below for detail.

➢ Open the registration screen, copy and mail the software serial number together with your name, company name, e-mail address and contact number to [email protected] to obtain your 30 day free Evaluation Version key.

➢ A key will be generated and mailed back to the you within 24 hours.➢ Enter the supplied key into the software registration screen and then click the register

button. (Clicking on the Software Key text will display a screen where the key can be pasted into and then automatically enter into the key fields.)

➢ Once registered click the OK button to exit.

4.4. How to connect the GSM Modem

In order for the GSM Base logger to communicate to the remote sites, a modem has to be connected to the system. The steps below describe how to connect the BASIC GSM Commander to your PC.

➢ Locate the serial communications port on your PC (Normally marked as COM1). See image below for more detail.


mailto:[email protected]?subject=Request%20for%20evaluation%20key

➢ If there is no connector on the PC or another device is using it, then install a USB to RS232 adapter. See the image below for an example of an adapter.

➢ Locate the serial port on the GSM Commander and then insert the supplied cable in the connector. Insert the other side of the connector into the serial port of the PC. See the image below for the location of the GSM Commanders serial port.

4.5. How to create the Data Base

After installation the first step is to create the database and all the required tables. Follow the steps below

➢ Log on to the GSM Base Logger as Technical or above.

➢ Open the options dialog by selecting Menu: Tools Options …

➢ Select the option tab Database Connections

➢ Create the connection to the database as described in section 6.4.

➢ Test the connection to the database by clicking the Test Connection button.

➢ If successful, create the database by clicking the Create Database button and follow the instructions.


➢ When created, the button changes to Create Tables. Click the button to create the tables.

➢ When completed close the options dialog, the GSM Base logger is now ready to be configured.

4.6. How to Upgrade the GSM Base Logger Software

When a new version of the software must be installed, follow the steps as described below.

➢ Log on to the GSM Base Logger as Technical or above.

➢ Select the Database screen.

➢ Export the base logger configuration to the text file by selecting Menu: Tools Export Configuration to Text File

➢ Exit the Base Logger and run the new installation software.

➢ When completed execute the new Base Logger software.

Note: If the new version fails to connect to the database, follow the steps below to reload the configurations.

➢ Log on to the GSM Base Logger as Administrator using the default user name and password.

➢ Open the configuration dialog by selecting Menu: Tools Options

➢ Select the Database Connections tab and then click the Import button.

➢ When the Open File dialog is displayed select the ExportVer2 text file. Click the Open button to load it.

➢ When the Import Configuration confirmation dialog is displayed as shown below, click the OK button to set the configurations.

➢ Repeat the steps for the General Settings and GSM Modem tabs.

➢ When completed close the options configuration dialog.

➢ The server is now back in full operation.


5. SCREEN DESCRIPTIONS

The following sections describe the function of the seven main screens. These are the modem, all sites status display, single site display, status graphs, database, notification and modbus screens.

5.1. GSM Base Logger Main Screen

5.1.1. Main Display Screen

The main screen is the container screen for the server, system configuration and display screens are accessed from this screen.

5.1.2. System Security

To be able to configure and operate the server you have to log onto the system. Three levels of security are provided and a configurable global time-out will automatically log you off. Use the security option in the main screen to log on and off the system. The icon next to the security menu option indicates that a user has logged onto the system. See the image below for detail.


Menu: Security System Log-on

Menu: Security System Log-off

The screen below is displayed when trying to log onto the system. Enter the user name and password then click OK. If logged on, an icon will be displayed next to the security menu.

If it is a new installation, use the default settings to log on and then configure at least one user with administrator rights. Please note that the default setting is disabled once a user has been added. See section 5.5 on how to configure a user.

The default settings to be used are as follows:

User name: Polygon

Password: polygon

5.1.3. System Exit

File Exit

(Security: Technical)

The option exits the GSM Base logger server, an exit dialogue is displayed giving the option to save the status of all the sites before exiting as shown below.


5.2. GSM Modem Section

This section describes the functions found in the modem display screen.

5.2.1. Modem Display Screen

The image below represents the GSM modem communications screen that controls the communication between the server and the GSM modem. Support is provided for a GSM Commander BASE KIT (Model: GC0321-BASE).

5.2.2. Modem Screen Option Buttons

Tools Clear Displays

Use clear displays to clear the right hand side display panes.

Tools Clear Buffer


Use clear buffer to clear the transmit buffer from all scheduled messages.


Tools Get Network Status

(Security: Operator)

Sends commands to the modem to retrieve the network status.

Tools Send PIN Number


Retrieves the configured PIN number and sends it to the modem to log onto the GSM network.

Tools Load Prepaid Airtime


The option displays a screen where the recharge voucher number can be entered to update the prepaid SIM airtime.

Tools SMS Simulator

(Security: Administrator)

The option displays the SMS simulation screen as shown below. Use this screen to “send” an SMS to the base logger to check the system configuration.

The simulation screen now has six tabs and there functions are as follow:

General Settings: Select the type of message to be send.Unit Settings: Set the temperatures, battery, power, signal, pre-paid and cell phone

numbers.Digital Inputs: Set the status of all 32 digital inputs.Digital Outputs: Set the status of all 32 digital outputs.Analog Inputs: Set the value of the 8 analog inputs.User SMS: A user generated SMS for the notification sub module.


5.3. Site Summary Section

This section describes the functions found in the site summary screen.

5.3.1. Site Display Screen

The image below represents the site summary screen that displays a summary of each site. The site communications status, battery voltage, temperatures and all inputs and outputs are displayed for each site. When inputs are configured, there current alarm level is displayed, the analog inputs display the current calculated value. Click on the refresh button to update the information.

5.3.2. Site Summary Option Buttons

Tools Refresh Summary Screen

Refreshes the summery display site information.


5.4. Site Display Section

This section describes the functions found in the site display screen.

5.4.1. Site Display Screen

The image below represents the site screen that displays the received data from the sites. Trigger text values assigned during configuration will display the SMS in a pop-up screen. When configuring inputs, an alarm level can be assigned for each input to be displayed (when failed) in the alarm list at the bottom of the screen. Click on the site name in the left pane to display that site’s information.

The screen below is the general default display screen. Future versions will allow the selection of display screens specific to the Ready To Mount Commanders. Screens can then be assigned per site.

5.4.2. Site Display Option Buttons

Tools Refresh Site Screen


Refreshes the currently selected site information.

Tools Site Statistical Information

Displays the selected site's received and transmitted SMS’s. Statistics is displayed for the current and previous hour, day and month. See image below for details.

Commands Request Site Status


Sends the site status command #REQD to the Commander unit. The complete status of the site will be returned in a single Baselog SMS.

Commands Request Analog Status


Sends the site status command #REQA to the Commander unit. The status of the analog inputs will be returned in a single BaseAnalog SMS.

Commands Set Unit Time


Sends a SETTIME command to the unit to update its internal clock to the received time of the SMS.

Commands System Command 1


Sends a user defined command to the GSM Commander unit.


Commands Digital Output Commands


The option is used to send a defined digital output to the Commander for controlling outputs. When the dialogue is displayed, select the command in the left or right hand pane, click Send Command to send the SMS. See the image above for details.


Commands Analog Output Commands


The option is used to send a defined analog output to the SMS unit for controlling outputs. When the dialogue is displayed, enter the analog value, select the command in the command pane and then click on the Send Command button to send it to the SMS unit. See the image above for details.

Commands Manual Command


The option is used to send a manually typed message to the SMS unit. When the dialogue is displayed, type the message into the field and then click on the Send Command button to send it to the SMS unit. See the image below for details.

5.4.3. Reported SMS Pop-Up

The system supports predefined text triggers. If the text is detected in an incoming SMS the predefined formatting is applied to the text. Each trigger can be configured to display the received SMS in a pop-up screen with an optional time-out that will remove the pop-up. See the image below. Pop-up screens can also give an audible alarm to draw the attention of the operator.


5.5. Graphs Display Section

This section describes the functions found in the graphs and statistical Interface screen.

5.5.1. Graphs Display Screen

The image below represents the graphs and statistical interface screen. Logged data is selected per site and the displayed graphs can be filtered by selecting a start and end date.

5.5.2. Graph Display Option Buttons

Graph Filter

The logged data of the selected site can be filtered by selecting a start and end date. The date selection can be found on either side of the blue title bar above the graphs. See the image below.


Analog Graph Section

The following buttons display the analog graphs if the analog input logging is enabled.

Graphs Analog Input Graphs Temperature Graphs

Display the logged temperatures A and B in the graph.

Graphs Analog Input Graphs Analog Input Graph

Display the logged analog input values in the graph.

Graphs Analog Input Graphs Battery Voltage Graph

Display the logged battery voltage in the graph.

Digital Input Graph Section

The following buttons display the digital inputs if digital input logging is enabled.

Graphs Digital Input Graphs Digital Inputs 1 to 8

Display the logged digital values of inputs 1 to 8 in the graph.







Digital Output Graph Section


Graphs Digital Output Graphs Digital Outputs 1 to 8

Display the logged digital values of outputs 1 to 8 in the graph.








Analog Input Graph Section

SECTION NOT ACTIVE

GSM Unit Graph Section

Graphs GSM Unit Graphs Unit Signal Strength Graph

Display the Units logged signal strength data in a graph.

Graphs GSM Unit Graphs Unit Power Status Graph

Display the Units logged power status in a graph.

Displayed Data Statistics

The following buttons display the analog or digital statistics of the selected graph.

Tools Create Analog Statistics

The maximum, minimum and average readings are calculated for the displayed analog graph.

Tools Create Digital Statistics

The number of on and off events is counted for each input of the displayed digital graph.


5.6. Database Configuration Section

This section describes the functions found in the database screen.

5.6.1. Database Display Screen

The image below represents the database screen and is the interface to the server’s logged data. Logged data can be retrieved on a per site basis. Select a site by clicking on it in the site name list. The site information will be displayed and the site table buttons are activated. Select these buttons to display the tables.

Responding to received SMS's and controlling SMS that will set outputs on a site is configured in these tables. See the “How To …“ section in the base logger help file.

5.6.2. Database Display Options

File Print Selected Site

Print the selected site’s configuration data.


File Preview Selected Site

Preview the selected site’s configuration data printout.

File Export Selected Site as PDF

Export the selected site’s configuration data to a PDF format document.

Database Site List Table

The site option displays all the site configurations in the data display panel. When selected it activates the Reset System SMS Text and Import Slot Descriptions under the Tools menu.

Database Digital Input Table

(Security: Operator – Read, Technical – Edit)

The digital input table (Discrete Inputs) option displays all the inputs that can be monitored with the GSM Commander. The first four inputs are reserved for system use and the next thirty two inputs correspond to the maximum inputs that can be connected to the unit. The text displayed in the off and on fields can be edited to correspond to the received SMS or connected equipment at the SMS unit. If an SMS is received and it is not a site base log message, it is compared to the entries and the corresponding input is set or cleared.

Enabling the display options will activate the input display of the site. The display can be inverted when the inputs normal state is an open condition.

An alarm level can be assigned to the input that will display changes in the selected alarm level, the alarm list, site display and summary screens are affected.

Database Digital Output Table


The digital output table (Coils) option displays all the outputs that can be connected to the GSM Commander. The first four outputs are reserved for system use and the next thirty two outputs correspond to the maximum outputs that can be connected to the unit. The text displayed in the off and on fields is the text that will be send to the unit. Edit the text in the fields to change it to the required SMS text.

Enabling the display options will activate the output display of the site. The display can be inverted when the outputs normal state is an open condition.

Database Analog Input Table


The analog input table (Registers) option displays all the analog values that can be monitored with a GSM Commander. The first six inputs are reserved for system use and holds the date and time of the last received SMS. The next four inputs correspond to the fixed analog readings of the unit.

The next eleven inputs correspond to connected inputs to the unit. The analog text can be edited to describe the equipment connected to the unit. When the minimum and maximum values of the inputs are set the analog reading is converted to represent the configured range.


Four alarm levels can be configured for each input, the first two (Low and Low Low) will trigger when the calculated value is below them and the last two (High and High High) will trigger when the calculated analog value is above them.

Enabling the display options will activate the output display of the site.

Database Analog Output Table


The analog output table (Holding Registers) option displays all the analog outputs that can be controlled by a GSM Commander. The first twelve outputs are reserved for system use and holds the sites received and transmitted SMS statistics. The next eight outputs correspond to the analog outputs of the unit. The analog text displayed is the text that will be transmitted to the unit combined with the analog value. Edit the text in the field to change it to the required SMS text.

Note:This feature is not implemented in the current Commanders hardware and firmware.

Database Site Base-log SMS History

The option displays all the base-log messages that were received from the selected site.

Database Site Analog SMS History

The option displays all the analog messages that were received from the selected site.

Database Site Received SMS History

The option displays all the user defined messages that were received from the selected site.

Database Site Transmitted SMS History

The option displays all the transmitted SMS to the selected site.

Database Site Users Activity

The option displays all the cell numbers an associated users if available from the selected site. Only available in the version 6 Commanders.

Database System Events

The option displays all the system events that where logged by the operating system. The events are displayed in a dialogue screen as shown below.


➢ The Exit & Clear option will clear all logged events then exit the dialogue.

➢ The Exit option will leave all logged events intact.

5.6.3. Database Tools Options

Tools Database Maintenance


The option displays the database maintenance screen.(See section 5.6.4)

Tools Reset System SMS text


When the default system messages has been changed they can be reset to there default values to re-establish base log communications back to the site.

Tools Import Slot Descriptions


Use the import option to configure the on / off text of multiple sites that have identical inputs and outputs. (See section 5.6.5)


Tools Export Configuration to Text File


The option exports all configuration settings to a text file. This replaces the database backup and restore functions in the old version 1 software. Use version 1.2 or greater to export the configurations to a text file. Use this method to migrate from a version 1 installation to a version 2 installation.

5.6.4. Database Maintenance

Tools Database Maintenance

Use the database maintenance option to delete old records from it. See the description and image below for details.

➢ Select the time period in the drop-down lists on the right side

➢ Click the left hand button to perform the task

5.6.5. Import Site Descriptions

Use the database definition import option to configure multiple sites that have identical inputs and outputs. Create a coma delimited file, where each line is an input or output record with the following syntax as given in the sections below.

To import a file select the database screen and then a site from the site display list. Then open the slot import file dialogue screen.


Menu: Tools Import Slot Descriptions


The syntax for all the inputs and outputs are identical and if a field is not used it can be left blank. This was done so that the definitions can be created in a spreadsheet application and then saved as a comma delimited file.

Syntax: [Modbus No],[Open Text],[Closed Text],[Display Enable],[Display

Invert],[Display Text],[Alarm Enable],[Alarm Text],[Alarm Level]

Note: For the Display and Alarm Enable; 0 = Disables option, 1 = Enables Option

Discrete – Digital Input Syntax

In order to configure the digital inputs, create a line in the file with the following syntax. The display field is used to identify the inputs in the site display and graphics sections. See the sample and image below for more detail.

Example: 100006,Main Door Closed,Main Door Open,1,1,Door,1,Main entrance door

Modbus Number: Number found in the modbus column.Open Text: Text indicating the input off state that the Base Logger must react to.Close Text: Text indicating the input on state that the Base Logger must react to.Display Enable: 1 enables the display of the input in the site display.Display Invert: 1 inverts the input status in the site display.Display Text: Text that will be displayed in the input status of the site display.Alarm Enable: 1 enables the alarming of the input.Alarm Text: Text to be displayed in the alarm list.Alarm Level: 0 None; 1 Information; 2 Warning; 3 Alarm; 4 System.

Coils – Digital Output Syntax

In order to configure the digital outputs, create a line in the file with the following syntax. The display field is used to identify the outputs in the site display and graphics sections. Fields not applicable is left blank. See the sample and image below for more detail.


Example: 000005,#DISARM,#ARM,1,0,Arm/Disarm,0,0,0

Modbus Number: Number found in the modbus column.Open SMS: SMS send to the unit to set an output low / off.Close SMS: SMS send to the unit to set an output high / on.Display Enable: 1 enables the display of the output in the site display.Display Invert: 1 inverts the output status in the site display.Display Text: Text that will be displayed in the output status of the site display.Alarm Enable: Leave field blank.Alarm Text: Leave field blank.Alarm Level: Leave field blank.

Registers – Analog Input Syntax

In order to configure the analog inputs, create a line in the file with the following syntax. Fields not applicable is left blank. See the sample and image below for more detail.

Example: 300013,0,Drinking Water Tank,1,0,Water,1,Litres


Modbus Number: Number found in the modbus column.Open Text: Leave field blank.Analog Text: Text to identify the analog input.Display Enable: 1 enables the display of the output in the site display.Display Invert: Leave field blank.Display Text: Text that will be displayed in the analog status of the site display.Alarm Enable: 1 enables the alarming of the analog input.Analog Units: The units indication for the analog display.Alarm Level: Leave field blank.

Holding Registers – Analog Output Syntax

In order to configure the analog outputs, create a line in the file with the following syntax. Fields not applicable is left blank. See the sample and image below for more detail.

Example: 400013,0,Set water flow,0,0,0,0,0

Modbus Number: Number found in the modbus column.Open Text: Leave field blank.Analog SMS: SMS send to the unit to set a analog value.Display Enable: Leave field blank.Display Invert: Leave field blank.Display Text: Leave field blank.Alarm Enable: Leave field blank.Alarm Text: Leave field blank.Alarm Level: Leave field blank.


5.6.6. Export Site Descriptions

Use the database definition export option to create a coma delimited file. This file can then be used to import the descriptions to other sites. Follow the steps below to export the definitions.

➢ To export the definitions select the database screen and then a site from the site display list.

➢ Open the slot export file dialogue screen.

Menu: Tools Export Slot Descriptions


The file will be created in the selected location.

5.7. User Notification Section

This section describes the user notification interface screen.

5.7.1. Notification Display Screen

The image below represents the notification communications screen that provides the connection to send notifications to users.

Two types of connections are catered for:

➢ Command line utility that can be executed from any scripting language that allows it.

➢ The remote SMS user interface module.

Messages can only be send to configured users as the system does not allow the entry of ad hock cell numbers, this is to prevent abuse of the system


5.7.2. Modbus Display Option Buttons

Tools Decode Modbus

The option toggles the display of the modbus packets between a hexadecimal display and the decoded fields of the packets.

Tools Reset TCP/IP Connection

The option resets all the TCP/IP connections and the reinitialise them.

Tools Clear Communications Screen

The option clears the modbus communications screen.

5.7.3. Modbus Scanning Functions

Modbus Type Description Address Range

Coils Digital output status R/W 1 to 36

Discrete Digital input status R 100001 to 100036

Registers Analog input values R 300001 to 300020

Holding Registers Analog output values R/W 400001 to 400020


6. SYSTEM CONFIGURATION

Tools Configure Server

(Security: Administrator)

Selects the system configuration dialogue screens.

6.1. General Buttons

The following buttons are used for all configurations, there functions change depending on the configuration selected.

The Ok button exits the dialogue screen.

Click the <Add New xxxxx> entry in the list to add a new item. If it is not present then the maximum entries has been reached.

The Configure Wizard button launches the editing wizard for the selected item in the list.

The Delete button removes an item from the list

The Import button imports the settings for the selected section from the version 1 or 2 exported text files.


6.2. GSM Modem Configuration Dialogue

The first tab in the configurations dialogue sets the communications options to the connected modem of the GSM Base Logger. See the image below.

6.2.1. GSM Modem Buttons

Click the Configure Wizard button to edit any settings of the modem.

The Import option can import the settings from the version 1 or version 2 configuration text files.

6.2.2. GSM Modem Wizard

Use the wizard to configure the modem settings as described below.


Start-up Screen

When selected the start-up screen will be displayed. Click the Next button to move to the next screen and the Previous button to move back.

Modem Type

Select the type of modem connected to the GSM Base Logger.

Note: The modem type selection is only available in the professional version.


Serial Port and Baud Rate

Select the serial port where the modem is connected to from the drop down list of available ports. Set the Base Logger baud rate to the rate set up in the modem.

Modem Auto Reset

The Base Logger can send the initialisation commands to the modem every hour if it is required.


Signal Strength Reading

Two standards can be selected to display the modem signal strength. A signal level in percentage from 0 to 100% and the actual signal strength measured in decibels.

SIM Card Network Type

Select the network provider type of the SIM card. If there is an unlisted provider select the unlisted type and then enter the SMS text to request the airtime.


SIM Card Number and PIN

Enter the SIM card number and the PIN number if required. It is recommended that the PIN number option is disabled on the SIM card before using it in the modem.

Final Screen

Click the Finish button to accept the settings or the Cancel button to abort the configuration.


6.3. General Settings Configuration Dialogue

The second tab in the configurations dialogue sets the general options of the GSM Base Logger. See the image below.

6.3.1. General Buttons

Click the Configure Wizard button to edit any of the general settings.

The Import option can import the settings from the version 1 or version 2 configuration text files.

6.3.2. General Wizard

Use the wizard to configure the general settings as described below.


Start-up Screen


Polling and Security Time-outs

Set the time-out when sending commands to a site and the time a user log-on is maintained.


Auto Save and Receive Screen Size

Enable the saving and loading of the site status when the Basel Logger exists and starts up. Adjust the size of the modem receive screen between 1 and 4 screen sizes.

User Defined SMS Logging

When a user defined SMS is received it can be logged to the database. Baselog messages are logged automatically.


Mail Server Settings

Enter the mail server settings that the GSM Base Logger must use to send mails to the users that must receive notifications.

Software Update Settings

Enable or disable the checking for new software on start-up. When installed on a corporate network, an internal update web location can be provided to host the new software files.


Final Screen


6.4. Database Connections Configuration Dialogue

The third tab in the configurations dialogue establishes the connection to the database server of the GSM Base Logger. See the image below.


6.4.1. Database Buttons

Click the Test Connection to check if the base logger can connect to the database.

Click the Create Database to create the database and all the tables required.

Click the Configure Wizard button to set the database connection.

The Import option can import the database connection settings from the version 2 configuration text files.

6.4.2. Database Wizard

Use the wizard as shown below to configure the connection to the SQL Database.

Start-up Screen



SQL Server Selection

Any SQL Server that is on the network can be used for the Base Logger. It is however recommended to install SQL Express on the local machine to be used.

Connection Authentication Selection

Two modes of connection is available, Windows Authentication and SQL Server Authentication. The Authentication mode selected during the SQL Server installation must be selected here.


Log-on User Name and Password

Enter the user name and password to log onto the SQL server when server authentication is selected.

Final Screen



6.4.3. How to manually enter the SQL Server Name.

If the Search for Servers option in the Wizard do not return any server names then the SQL Server name that has been installed can be manually entered. Follow the steps to obtain the server name.

➢ Open the Management Studio by running it from Windows Start All Programs Microsoft SQL Server 2008 SQL Server Management Studio

➢ When the log-on dialog is displayed, select the Server name and copy it as shown below.

➢ In the Database configuration wizard, paste the name into the Selected Server field.


6.5. GSM Site Configuration Dialogue

The fourth tab in the configurations dialogue configures all the sites monitored by the GSM Base Logger server. See the image below.

6.5.1. GSM Site Buttons

Click the <Add New Site> in the list to launch the wizard that will add a new site. Select a site and then click the Configure Wizard button to edit any settings of the site. Select a site and then click the Delete button to remove it from the GSM Base Logger server. See the wizard image below.

The Import option can import sites from the version 1 or version 2 configuration text files. Two modes of import exists, the first deletes all current configured sites before importing the sites in the text file. The secondly mode appends all the sites from the configuration file, note that all the sites will be imported but only the number available in the software licence will be activated.

6.5.2. GSM Site Wizard

Use the wizard as shown below to configure the GSM site information.


Start-up Screen


Site Name and Cell Number

Enter the descriptive site name ant the cell number of the SIM card installed in the unit on site.


Site Identification Code

The identification code can only be assigned when the site is created. Changing the code is not allowed to keep the integrity of the database intact.

Installed Unit

Select the unit type installed on site. The version 4 commander does not support the baselog message. It needs to send individual messages that the Base Logger can decode.


Enable Automatic Polling

Enabling automatic polling for a site allows the Base Logger to request the status of the site automatically.

Automatic Polling Type

Select the type of polling the Base Logger must perform when the automatic polling is enabled.


Daily Poll Time

When polling once a day is selected, set the time of day that the poll must be executed.

Defined Polling Times

Enable and set the pre-defined times that the Base Logger has to execute the polling of the site.


Modbus Communications

Enable Modbus TCP/IP communications to access the site information with a scada system.

Select Modbus Unit ID

Set the Modbus Unit ID of the site, each of the sites configured must have a unique ID number.


TCP/IP Connections.

Set the TCP/IP address and port number that the Base Logger must use for the Modbus communications. Click the Default port button to set the port number using the Unit ID value as reference.

Site Display Type

Select the type of display that the Base Logger will use to represent the status of the site to the users. Note that only the default display is currently available in the version of the software.


Final Screen


6.6. Configure RTM Screens

The fifth tab of the configurations dialogue configures the ready to mount displays. The option is not implemented in this version of the software.


6.7. SMS Trigger Text Configuration Dialogue

The sixth tab of the configurations dialogue configures all the text triggers used by the GSM Base Logger. See the image below.

6.7.1. SMS Trigger Buttons

Click the <Add New Trigger> in the list to launch the wizard that will add a new trigger. Select a trigger and then click the Configure Wizard button to edit any settings of the trigger. Select a trigger and then click the Delete button to remove it from the GSM Base Logger server. See the wizard image below.

The Import option can import triggers from the version 1 or version 2 configuration text files. Two modes of import exists, the first deletes all current configured triggers before importing the new triggers in the text file. The second mode appends all the triggers from the configuration file, note that all the triggers will be imported but only the number available in the software licence will be activated.

Click the Test Alarm button to check the audible alarm of the selected trigger.

6.7.2. SMS Trigger Wizard

Use the wizard as shown below to configure the SMS trigger information.


Start-up Screen


Trigger Identification Name

Enter a meaningful name that will describe the trigger.


Trigger Text and Font

Set the text that must be present in the received SMS that will trigger the pop-up. Adjust the font that will be used in the display of the text.

Text Fore and Background Colours

Set the foreground and background colours the text will be displayed in.


Pop-Up Alarm and Time-out

Select if the pop-up must generate an alarm sound and the alarm sound. Set the time that the pop-up will be displayed before it is closed and removed from the screen.

Final Screen



6.8. Configure Summary Dialogue

The seventh tab of the configurations dialogue configures the site summary screen. All the unit readings, digital inputs, digital outputs and analog inputs can be selected individuality. See the image below.

6.8.1. Summary Buttons

Click the Configure Wizard button to enable / disable displays of the summary screen.

6.8.2. Summary Wizard

Use the wizard as shown below to configure the options.


Start-up Screen


System and Unit Display Selection

Select the display of system and unit values in the summary screen.


Digital Input Selection

Select the display of the digital inputs on the summary screen.

Digital Output Selection

Select the display of the digital outputs on the summary screen.


Analog Input Selection

Select the display of the analog inputs on the summary screen.

Final Screen



6.9. User Notification Configuration Dialogue

The seventh tab of the configurations dialogue configures the notification connections to the GSM Base Logger.

6.9.1. Notification Buttons

Click the <Add New Notification> in the list to launch the wizard that will add a new notification connection. Select a notification connection and then click the Configure Wizard button to edit any settings of the connection. Select a notification connection and then click the Delete button to remove it from the GSM Base Logger server. See the wizard image and descriptions below.

The Import option can import notification connections from the version 1 or version 2 configuration text files. Two modes of import exists, the first deletes all current configured notifications before importing the new ones in the text file. The second mode appends all the notifications from the configuration file, note that all notifications will be imported but only the number available in the software licence will be activated.

6.9.2. Notification Wizard Description



Start-up Screen


Notification Identification Name

Enter a meaningful name that will describe the notification connection.


Connection IP Address

Select and set the Host IP address and port number that the remote SMS communicator or command line utility must connect to.

Remote Connection Type

Select the type of remote notification protocol that the link must respond to.


Final Screen


6.10. User Configuration Dialogue

The ninth tab System Users of the configurations dialogue configures all the users that can operate the GSM Base Logger and receives notifications from the system. See the image below.


6.10.1. User Buttons

Click the <Add New User> in the list to launch the wizard that will add a new user. Select a user and then click the Configure Wizard button to edit any settings of the user. Select a user and then click the Delete button to remove him from the GSM Base Logger server. See the wizard image and descriptions below.

The Import option can import users from the version 1 or version 2 configuration text files. Two modes of import exists, the first deletes all current configured users before importing the new users in the text file. The second mode appends all the users from the configuration file, note that all users will be imported but only the number available in the software licence will be activated.

6.10.2. User Wizard Description


Start-up Screen



User Name and Contact Number

Enter the users full name and cellphone number in the fields provided. Enter a user code that will be used by the notification modules to identify him.

Log-on Name and Password

Enter the user name and password that the user must use to log onto the Base Logger.


Operational Function and e-Mail address

Select the function that the user will be allowed on the Base Logger.

User Security Level

Set the allowed security level when the user is operating the Base Logger.


User Notifications

Add sites with the >> button or remove sites with the << button that must send notifications to the user. Select each site and then set the type of notification that it must send to the user.

Final Screen



7. REMOTE SMS NOTIFICATION

The remote SMS controller Remote SMS is a remote notification interface that sends entered and predefined messages to configured users in the GSM Base logger.

7.1. Remote SMS Interface Screen

7.2. Remote SMS Configuration

Menu: Tools Configure SMS Communicator

The following topic explains the configuration of the users that will receive an SMS notification from the remote SMS user interface. The configuration is described below:

7.2.1. TCP/IP Connection

For the remote SMS software to communicate with the GSM Base Logger the remote host address and port number must be entered into the fields provided. See the image below for details.


Click the button to check if the remote PC hosting the GSM Base Logger can be reached.

Click the button to establish the connection, the display next to the button will indicate the status of the connection. Leave the connection established to configure the notification users of the interface.

Click the button to check the modem connection at the GSM Base Logger.

7.2.2. Notification Users Configuration

With the network connection established, the configured users in the GSM Base Logger can be downloaded and added to the user notification list. The functions of the buttons are explained below.

Reads all the users that are assigned notification status into the server list.

Adds the selected user in the server list to the assigned user list.


Removes the selected user from the assigned user list.

Clears the assigned user list.

Moves the selected user in the assigned user list up one position.

Moves the selected user in the assigned user list down one position

7.2.3. Predefined Message Configuration

Menu: Tools Edit Predefined Messages

The following topic explains the creation of the predefined text messages that can be used to notify users. The configuration is described below:

Message Configuration Screen


Message Configuration Buttons

Use the left hand panel to enter or edit a message, then add it to or update the message list.

Adds the created message to the predefined message list

Updates the selected message in the list with the text from the edit panel

Transfers the selected message in the list to the edit panel for editing

Moves the selected message in the list up one position

Moves the selected message in the list down one position

Deletes the selected message in the list


8. COMMAND LINE UTILITY

The command line utility is an interface command to the GSM Base Logger that can be called from any scripting language able to run executable files externally. See the descriptions below for more details.

8.1. Command Line Execution

To send an SMS manually, follow the steps below:

➢ Go to Windows Start All Programs Accessories and then open the Command Prompt.

➢ Once displayed, navigate to the directory containing the cmdline utility and enter the command as shown below.

➢ The command line dialogue will pop-up indicating the status of the transfer and then close on completion as shown in the image below.

The syntax of the command is given below with an example on how to execute it with PHP scripting language.

Syntax: cmdline User Code: SMS Message

Example:

<?php$tmp = exec("cmdline lsvz:Test SMS Message", $results);?>


8.2. Connect Configuration

In order to use the cmdline utility, the IP address and notification port number at the GSM Base Logger must be configured. Click Windows Start then Run, browse for the cmdline utility and run it. The screen as shown below will be displayed.

Once the form is displayed click the set-up button to open the IP address configuration dialogue. Enter the IP address of the PC where the GSM Base Logger is installed and the configured notification port number as shown below. Once completed, close the dialogue and the command line screen.


9. IMPORTANT NOTICE (DISCLAIMER/COPYRIGHT)

Herein, “the Company” will mean:

Polygon Technologies CC, its directors, members, employees and agents.

Much effort has been made to ensure the contents of this manual are complete and without errors. Nonetheless, the Company cannot be held liable for any damages indirectly or directly resulting from any errors in this manual.

All Information and images in this manual are proprietary to Polygon Technologies CC. The manual as a whole may be distributed and copied freely, but no partial content may be used/copied or distributed in any way. No part of this product may be copied.

Polygon Technologies CC reserves the right to make changes to contents of this manual, without notice, at any time.


10. MANUFACTURER CONTACT DETAILS

Polygon Technologies may be contacted at:

South African Head Office

Email: [email protected]

Web: www.gsmcommander.com

Telephone: +27(0)21 9817062

Fax: +27(0)86 6823310

Postal Address: PO Box 1125

Kuilsriver

7579

South Africa


http://www.gsmcommander.com/

mailto:[email protected]

gsm base logger manual - vansoft.co.za filegsm base logger manual version 2-2-0-3 before attempting...

Documents