SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12...

49
i SCADA Interface Program Handbook Version 3.12 October 16, 1998 Rev 1, November 27, 2001 AGM Electronics Inc.

Transcript of SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12...

Page 1: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

i

SCADA Interface Program

Handbook

Version 3.12 October 16, 1998

Rev 1, November 27, 2001

AGM Electronics Inc.

Page 2: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

ii

INTRODUCTION .......................................................................................................................................................1

WARNING................................................................................................................................................................1

SYSTEM REQUIREMENTS .....................................................................................................................................2

INSTALLATION.........................................................................................................................................................3

STARTING SCADA....................................................................................................................................................5

INTERACTIVE MODE ...................................................................................................................................................5 BATCH MODE.............................................................................................................................................................6

INTERACTIVE MODE MENU MAP.......................................................................................................................7

INTERACTIVE MODE MENUS ..............................................................................................................................8

DATA HANDLER SELECTION MENU ............................................................................................................................8 MAIN MENU ...............................................................................................................................................................9 PROJECT MENU ........................................................................................................................................................12 COMMUNICATIONS PORT SETUP MENU ....................................................................................................................16 EDIT MODEM CONTROL & RESPONSE STRINGS ........................................................................................................18 EDIT MODEM HANG UP STRINGS..............................................................................................................................19 FUNCTION KEYS WHEN CONFIGURING A DATA HANDLER........................................................................................20 CONVERT FILE MENU...............................................................................................................................................22 DOWNLOAD FILE MENU ...........................................................................................................................................23 PROGRAM SETTINGS MENU ......................................................................................................................................25 SUPER PUK MONITOR SCREEN SETTINGS MENU.......................................................................................................27 SUPER PUK MONITOR VARIABLES LOCATION MENU................................................................................................28 VARIABLE SCREEN POSITION # MENU ......................................................................................................................29 DIGITAL INPUT # OR RELAY # MENU ........................................................................................................................31

USING MULTIPLE DATA HANDLERS WITH SCADA ....................................................................................32

EXAMPLES:...............................................................................................................................................................32

STATUS LINE...........................................................................................................................................................34

UPLOADING A GENIE PUK CONFIGURATION FILE ....................................................................................36

BATCH COMMANDS..............................................................................................................................................38

/#:.........................................................................................................................................................................38 /150......................................................................................................................................................................38 /300......................................................................................................................................................................38 /600......................................................................................................................................................................38 /1200....................................................................................................................................................................38 /2400....................................................................................................................................................................38 /4800....................................................................................................................................................................38 /9600....................................................................................................................................................................38 /19200..................................................................................................................................................................38 /AD: .....................................................................................................................................................................38 /COM1 .................................................................................................................................................................38 /COM2 .................................................................................................................................................................38 /COM3 .................................................................................................................................................................38 /COM4 .................................................................................................................................................................38 /AGM ...................................................................................................................................................................38 /CMD:..................................................................................................................................................................38 /CSV.....................................................................................................................................................................39 /DBF ....................................................................................................................................................................39 /DELAY: ..............................................................................................................................................................39 /IPC......................................................................................................................................................................39

Page 3: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

iii

/SP .......................................................................................................................................................................39 /NAME:................................................................................................................................................................40 /OVERWRITE ......................................................................................................................................................40 /RADIO:...............................................................................................................................................................40 /RETRY:...............................................................................................................................................................41 /RRADIO: ............................................................................................................................................................41 /RS232 .................................................................................................................................................................41 /RS485 .................................................................................................................................................................41 /RS485R ...............................................................................................................................................................42 /TO:......................................................................................................................................................................42 /WAIT: .................................................................................................................................................................42

AUTOMATIC DOWNLOADING ...........................................................................................................................43

/WAIT: & /DELAY: IN MS-DOS, NO SCHEDULING PROGRAM.................................................................................43 /WAIT: & /DELAY: IN WINDOWS, NO SCHEDULING PROGRAM. ..............................................................................43 SCADA IN WINDOWS 95 OR WINDOWS NT, WITH SCHEDULING PROGRAM. .............................................................44 SCADA.LOG...........................................................................................................................................................44

Example 1 ............................................................................................................................................................45 Example 2 ............................................................................................................................................................45 Example 3 ............................................................................................................................................................45 Example 4 ............................................................................................................................................................45

Page 4: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

1

Introduction Welcome to the AGM SCADA System. The SCADA program allows you to collect data and control AGM's various Data Handlers remotely. These Data Handlers may be connected either directly via RS-232 / RS-485 or through dial up phone lines, radio modems, etc. Data may be collected either interactively or automatically through the programs batch mode. For interactive use the SCADA program provides a menu driven interface. For automated downloads the SCADA program accepts commands entered on the command line or though a command file. This will allow a MS-DOS batch file or command file to be written to perform the download automatically. When in batch mode, any errors encountered will be written to the file SCADA.LOG and processing will continue. This will allow multiple sites to be downloaded automatically and without stopping for user intervention. Data collected from the Data Handlers may be written either to a comma separated .CSV or dBase .DBF file. One or both of these data files are supported by all commercial spreadsheet, database, and graphing programs. AGM Electronics Inc., Integrated Control System (ICS), IPC / Data Loggers, Super Puks, and Genie Puks Data Handlers are supported by this SCADA program. Data may be collected from the IPC / Data Loggers and Super Puks. Real time data may be viewed from the ICS, and the ICS and Genie Puk controlled.

WARNING AGM Electronics Inc. can not be held responsible for the use or misuse of this program. Some sections of this program are intended for diagnostics only and will override the internal programming of the ICS. When you use these sections, you will be controlling the I/O of the ICS and not the internal program. The ICS will no longer control I/O controlled by you and this program. You will retain control will be returned to the ICS upon exiting the SCADA program or resetting the ICS. YOU MUST USE THE EXIT THE SCADA PROGRAM USING THE EXIT COMMANDS. If the computer is turned off or the SCADA program exits abnormally, return will not be returned to the ICS. The control of the Super Puk's two relays may be available on some Super Puks. Control of these relays has the same risks as controlling the ICS. The section that controls the ICS is protected by up to 2 passwords. You may define these passwords by using an option within the Program Settings Menu. You may obtain the initial passwords from AGM Electronics Inc. Technical Support.

Page 5: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

2

System Requirements The SCADA program requires the following:

1. IBM PC compatible computer system. 2. MS-DOS 3.0 or above or equivalent. SCADA will also work in an MS-DOS window in Microsoft

Windows 3.1, Windows for Workgroups 3.11, Windows 95, and Windows NT.

NOTE: When using with Microsoft Windows of any version, you must be careful not to have another Windows or MS-DOS program using the same communications port. Windows allows only one program to use the communications ports at a time and if the port is in use, Windows will prevent the second program from using the ports. Outside the normal dial or communications failure errors, there will not be any error messages indicating that this has occurred.

If you are running under Windows and are unable to connect or dial, check to

determine if another program is using the same communications ports. 3. One serial communications port, COM1 through COM4 is supported. COM1 and COM2 must

be the standard communications ports used by IBM PC compatibles. COM3 must be addressed at 3E8H and use IRQ 4. COM4 must be addressed at 2E8H and use IRQ 3.

4. AGM Data Handler. 5. SCADA program and related files.

The following is optional: 1. Hayes AT command set compatible modem. Only required if you will be connecting to a data

handler over the phone lines. Other modems may be used with this program, however the modem commands may require editing.

2. RS-232 to RS-485 converters. You may use either AGM's or other manufactures converters.

The SCADA program supports the RTS control that may be required by the converters. 3. Radio Modem. The SCADA supports some radio modems. It supports the control of the RTS

line required by many half duplex or simplex radio modems. If the modem sets CTS active as an indication that the modem is ready for data, this SCADA program can be set to use CTS. If CTS is not available, the SCADA program can be set for a fixed delay

4. Dedicated Modems either full or half-duplex. Full duplex modems can be used the same as a

direct connection. Half-duplex modems are used the same as radio modems where data will only be transmitted when CTS is active.

Page 6: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

3

Installation To install the SCADA system you only need to copy the files from the distribution disk to a subdirectory on your hard disk or to a working diskette. You may copy all files or just the files you need to support your data handlers. If you do not know how to copy files or create subdirectories see your MS-DOS manual. If you copied the files to a subdirectory on your hard disk and you wish to run the SCADA program from any drive or directory, add the subdirectory to your "PATH" statement in your AUTOEXEC.BAT file. If you do not know how to this, consult your MS-DOS manual. The following is a list of all files of the SCADA system and their function:

SCADA.EXE Main SCADA program. AGM_MON.EXE ICS Monitor program. Required for ICS Data Handler interrogation and

control. This program is called by the main SCADA program it is not a stand-alone program. TO BE USED WITH SCADA.EXE ONLY.

Program must be placed in the same drive and directory as SCADA.EXE. SCADA.HLP On line help for the SCADA program. Required only if you want to access

help from the SCADA program menus by pressing F1. If this file is not found then an error message will be displayed when F1 is pressed for help.

File must be placed in the same drive and directory as SCADA.EXE. *.SET All files with the extension of .SET are settings files used by the SCADA

program. These files contain the various user settings used in the program. These settings include the screen colors, communications port, baud rate, and the default file names.

SCADA.SET Active settings file. This file may not be included on the distribution disk. It will however, be

created when you make any changes to the SCADA programs settings. If available it is automatically read when the SCADA program is loaded. It is

written when any changes occur in the SCADA program settings. This allows your program settings to be maintained between sessions.

The default file will be located in the same drive and directory as

SCADA.EXE. MONO.SET Default settings file for black and white monitors. Rename or copy this file to

SCADA.SET if you have a black and white monitor.

Page 7: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

4

LABELS.LAD FPCTBL.DAT ICS support files used when interrogating or controlling an ICS. When

available they provide the ICS labels and other information to the ICS interrogation program.

These files are optional. If provided, they will normally be located within a

subdirectory on either the distribution disk or on an additional disk provided through AGM Electronics technical support.

NOTE 1: These files are unique to an ICS program. If you have multiple ICS's with

different programs or different program versions, you may require additional LABELS.LAD and FPCTBL.DAT files.

2: Additional files may be located in the subdirectory or on the disk along with

the above files. The additional files are not required by the SCADA program. 3: These files are only available if you have an ICS Data Handler. They are not

required for other data handlers. *.INI Genie Puk Configuration files. Files with this extension are used to configure

the Genie Puk Data Handler. The SCADA program will upload this file to configure the Genie Puk when requested.

This file may be located on either the distribution disk or on a separate disk

provided by AGM Electronics. You may create or edit this file using an ASCII text editor. To create the

configuration file enter the commands and data you would normally enter after the "ATC" command. This file replaces the keyboard entry that you would normally enter in response to the configuration questions supplied by the Genie Puk.

NOTE 1: This file may be unique to a specific Genie Puk version. If the Genie Puk you

are using requires a program update, you may also need to update the configuration file.

2: This file is only provided if you have a Genie Puk Data Handler. It is not

required for other data handlers. *.DOC *.TXT READ.ME *.* Additional files may be contained on the distribution disk. These files are

typically document files about the data handlers you may be using or support files and programs distributed with the SCADA program. They are not required to use the SCADA program.

Page 8: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

5

Starting SCADA

Interactive Mode The interactive mode of the SCADA system is a menu-based program used for controlling various AGM Data Handlers. All options are selected either through menus or by entering a value at a prompt within the program. The only command line argument that the SCADA program accepts is the name of an alternate setting file. When using the SCADA program for the first time on a system with a black and white display copy or rename MONO.SET to SCADA.SET. The default screen color setting is for a color display. If no settings file is available when the SCADA program is loaded the screen will use color. The settings file MONO.SET has the screen settings for black and white monitors. If the SCADA program is in a subdirectory included in your path statement you only need to enter SCADA on your command line to start the program. The SCADA program will remember the last settings you used via the SCADA.SET file located in the same subdirectory as the SCADA program. If you have only one data handler and only use one set of settings, entering SCADA is all that is required. When the SCADA program is started the first screen may be one of 3 possibilities. the Data Handler Selection menu, Main Menu, or Super Puk Monitor. The default initial screen is the Data Handler Selection Menu. The other two screens are enabled by the configuration settings. If you are using only one type of data handler or you wish to skip to the Main Menu on startup, a setting within the Program Settings menu will allow the initial data handler to be selected automatically. A built in option for monitoring the Super Puk has been added and this option may be displayed immediately, in some cases, bypassing the Data Handler Selection, Main, and Project menus. To use this option you must be directly connected to the Super Puk, set the Data Handler Type to Super Puk in the configuration menu. You must also enable the option in the Super Puk monitor configuration menu.

Page 9: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

6

Batch Mode The batch mode of operation is intended for automatic downloading of data from one or more Super Puks or IPCs. You may also use it, for normal downloading when you don’t want to use the interactive menus. Before using the batch mode, we suggest you connect to the data handler using the interactive mode and save the setting when you exit SCADA. This will set most of the setting required for connecting to a data handler. You may, however, still override these settings from the command line. Setting them before hand, will reduce the number of commands required on the command line. NOTE: You can override most communications options from the command line. These include the

communications port, baud rate, and communications type. Some settings, such as the modem control strings, can not be overwritten from the command line. Should you ever need to change any option that can not be specified on the command line or if you wish to reduce the number of commands required, Save the program settings with unique names, and then specify the settings before any command line options.

The general syntax for the SCADA program to enter batch mode is: SCADA [settings] @command file | batch commands where:

settings Optional name of the setting file. The settings file contains various settings used to control the program. These settings include the communications port, baud rate, communications type, download file type, etc.

If not specified then the default setting file of SCADA.SET will be used. This

file will normally contain the last communications settings used in the interactive mode.

@command file Name of the command file. The command file is an ASCII text file containing

the commands for automatic downloading of the Super Puk or IPC. This file may contain the batch commands for one or more devices. Each command must be separated by a space, with one device per line.

Batch commands This is one or more batch commands used to control the automatic download.

See the complete listing in the following section. NOTE: At least one batch command must be specified either on the command line or

in a command file, otherwise the program will be in the interactive mode.

Page 10: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

7

Interactive Mode Menu MapA

GM

SC

AD

A P

rogr

am M

enu

Map

Ref

er to

the

SCA

DA

Pro

gram

Han

dboo

k fo

r Spe

cific

s on

each

Men

u an

d M

enu

Item

Mai

n

Pro

gram

Setti

ngs

F2 -

SPM

(DH

)F3

- IP

C/IC

SF4

- IP

CF5

- IC

SF6

- G

PM

Sele

ct A

GM

Dev

ice

Han

dler

Typ

eF1

- H

elp

F2 -

Cal

lF3

- Ta

lkF4

- C

onve

rtF5

- P

rogr

amF6

- C

hang

eF1

0 - E

xit

Com

mun

icat

ions

Port

Set

up

Edit

Mod

emF2

- M

odem

Init

F3 -

Mod

em S

ucce

ssF4

- D

ial P

refix

F5 -

Dia

l Suf

fixF6

- C

onne

ct S

tring

F7 -

Con

nect

Del

ayF8

- H

ang

Up

Met

hod

F10

Dia

l

F1 -

Hel

pF2

- BW

Mon

itor

F3 -

Col

or M

onito

rF4

- Pa

ssw

ord

F5 -

Def

ault

Setti

ngF6

- D

own

Load

Tim

e ou

tF7 F8

- Lo

ad S

ettin

gsF9

- Sa

ve S

ettin

gsF1

0

Com

mun

icat

ions

Port

Set

upF2

- C

omm

Por

tF3

- B

aud

F4 -

Com

m T

ype

F5 -

Addr

ess

F10

Mai

n

F1 -

Hel

pF2 F3 F5 F6 F7

- C

hang

e A

ddr

F10

Proj

ect

*

Mai

n

F2 -

Com

m P

ort

F3 -

Bau

dF4

- C

omm

Typ

eF5

- Ad

dres

sF1

0

Cha

nge

Type

Con

fig/T

erm

inal

Up/

Dow

n Lo

adIn

terr

ogat

e

Supe

r Puk

Mon

itor

Varia

bles

Loc

atio

n

Supe

r Puk

Scr

een

Setti

ng

Varia

ble

Scre

enPo

sitio

n x

F1 -

Hel

pF2

- S

tart

Up

Mod

eF3

- S

how

Dat

e/Ti

me

F4 -

Scr

een

Title

F5 -

Upd

ate

Inte

rval

F6 F10

F1 -

Hel

pF2

- S

tart

Up

Mod

eF3

- D

H T

ime

& D

ate

F4 -

Title

F5 -

Upd

ate

Inte

rval

F6 F10

1-9

A-D

F10

Mai

nF1

- H

elp

F2 -

Mod

em In

itF3

- M

odem

Suc

cess

F4 -

Dia

l Pre

fixF5

- D

ial S

uffix

F6 -

Con

nect

Stri

ngF7

- C

onne

ct D

elay

F10

F1 -

Com

m P

ort

F2 -

Baud

F3 -

Com

m T

ype

F10Va

riabl

es

D I/

O

F1 -

Hel

pF2 F5 F6 F1

0

F1 -

Hel

pF2 F3 F4

- C

ontro

lF5 F6 F7

- C

hang

e Ad

drF1

0

F1 -

Hel

pF2 F5 F6 F7

- C

hang

e Ad

drF1

0

F1 -

Hel

p

F3 F4 -

Con

trol

F6 F7 -

Cha

nge

Add

rF1

0

* Pro

ject

Men

u Va

riatio

ns -

SP D

evic

e Sh

own

IPC

/ICS

IPC

ICS

GPM

Con

vert

File

F2 -

Inpu

t Nam

eF3

- O

uput

Nam

eF4

- O

utpu

t Typ

e

F9 F10

Mai

nSt

art

Dow

nloa

d Fi

leF2

- In

put N

ame

F3 -

Oup

ut N

ame

F4 -

Out

put T

ype

F9 F10

Mai

nSt

art

If an

swer

= "N

o" th

en p

rogr

am g

oes

dire

ctly

to D

ial

If an

swer

= "N

o" th

en p

rogr

am g

oes

dire

ctly

to P

roje

ct

Page 11: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

8

Interactive Mode Menus

Data Handler Selection Menu At program start up or in response to the F6 key in either the Main or Project Menus a menu listing all supported device handlers will be displayed. You must press one of the function keys to select one of the data handlers displayed. The availability of some features as well as the help screens displayed depends on the selection you make from this menu. Only the features and help relevant to the selected data handler will be available. You are not locked into you initial data handler selection. You may change the data handler selection from either the Main or Project Menus. Pressing F6 in either of these menus will display the data handler selection menu again. If you forget which data handler you selected or if you wish to verify the data handler in use, the current selection is displayed in the status line at the top of the screen. See the Status Line section for more information. Press one of the following to select the data handler you are using:

F2 Selects the Super Puk. You may download data from or configure a Super Puk with this

selection. Status line will display SP to indicate that this data handler has been selected. F3 Selects the IPC / Data Logger and ICS Data Handlers. Use this selection when connected

to both an IPC and ICS Data Handler. The ICS in this configuration is always connected to the IPC and the computer is connected to the IPC. All communications to the ICS is done through the IPC. You may download data from or configure the IPC or interrogate and control an ICS with this selection.

Status line will display IPC+ to indicate this data handler has been selected. F4 Selects the IPC / Data Logger only. Use this selection when connected to only an IPC or

when you do not wish to access the ICS that may be connected to the IPC. You may download data from or configure an IPC with this selection. You can not interrogate or control an ICS.

F5 Selects the ICS only. Use this selection when you are connected to a stand-alone ICS or

when you wish to interrogate or control the ICS only. You can not download data from or configure the IPC with this selection.

F6 Selects the Genie Puk. Use this selection to communicate with the Genie Puk.

Page 12: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

9

Main Menu If the Data Handler has been predefined the Main Menu will be displayed. The Main Menu is the starting point for all functions performed by this SCADA program. This menu will allow you to make the initial connection to a Data Handler, convert a previously downloaded file, or change the program settings or data handler type. The following sections describe the function of each function key. Unlike some menus the Main Menu is the same for all data handlers.

F1 Displays a context sensitive help screen. When you press F1 this SCADA program will display the relevant section of the help text file

SCADA.HLP. This file contains a brief description of the current menu and, if applicable, a short description of the data handlers commands.

Only relevant functions and help are displayed for each data handler type. Functions that

exist in this SCADA program but are not supported by the selected data handler will not be shown in the menus nor will it be described in the help files. It is important that you select the correct data handler to obtain the correct menus and help screens.

F2 Connects to Data Handler over dial up phone lines. You may use this option when using dial

modems and standard phone lines or smart switches. If using a smart switch, replace the phone numbers and dial commands with the access strings required by the switch.

After selecting this option "Change Communications Parameters?" will be displayed. If you

have already set up the communications ports answer No. If using for the first time or if any communications parameter such as the baud rate or communications port has changed, you must answer Yes. Also answer Yes if you have changed your modem or if you need to change any of the modem settings. If you are unsure answer Yes then check all settings.

See the Communications Port Setup and Modem Control & Response section for more

information on the setting menus displayed. You may answer Yes or No by either entering a "Y" for yes and a "N" for no or by pressing

the left or right arrow keys until the desired selection is surrounded by the double line box. Pressing Enter will select the option that is outlined by the double lined box.

After the Communications Port Setup has been displayed or skipped by answering No, you

will be requested to enter the telephone number. You should only enter the phone number and any additional commands or pauses here. Use the Modem Control & Response Strings menu to add any additional dial prefixes or suffixes that will be used with the phone number.

If using a smart switch enter the port number in place of the phone number. Use the Dial

Prefix in Modem Control & Control Strings to enter the switch boxes access prefix. The entered phone number will be saved from session to session in the SCADA.SET file. If

you have multiple phone numbers you may wish to use multiple settings files with each file containing a different phone number. See the Using Multiple Data Handlers with SCADA section for information on creating and using these setting files.

Only if the connection was completed successfully will this program advance to the Project

Menu. If unable to connect or if the connection sequence is canceled then you will return to the Main Menu.

F3 Connects directly to a Data Handler. Use this option for Data Handlers connected directly to

your computers serial communications ports, dedicated modems and phone lines, RS-485, Radio Modems, or functionally equivalent telemetry equipment. Use this option also when

Page 13: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

10

you have previously connected through a modem but did not disconnect when you returned to the Main Menu.

After selecting this option "Change Communications Parameters?" will be displayed. If you

have already set up the communications ports answer No. If using for the first time or if any communications parameter such as the baud rate or communications port, has changed you must answer Yes. If you are unsure answer Yes then check all settings.

See the Communications Port Setup for more information on the menu displayed. The

communication port settings are the same for both a direct and modem connection. When directly connected settings required by modems will not be displayed.

You may answer Yes or No by either entering a "Y" for yes, "N" for no or by pressing the left

or right arrow keys until the desired selection is surrounded by the double line box. Pressing Enter will select the option that is outlined by the double lined box.

After answering "N" or leaving the Communications Ports Setup menu you will always

advance to the Project Menu. F4 Converts a data file containing raw data from a previous download of a Data Handler. Either

a comma separated .CSV or dBase .DBF may be created from the raw data file. The data files produced by this option will be identical to the files produced when the download was performed with the .CSV or .DBF option enabled.

This option may be used on either the .AGM file produced by this program, the .$$$ file

produced from previous versions of the SCADA program, or on a text file downloaded from a terminal emulator program. If created or edited by any other source than the SCADA program, the file must be in ASCII without any formatting characters included. Editing by some word processors in a document mode will add formatting characters, these formatting characters will prevent the conversion program from working correctly. Use a non-document or ASCII editor only.

Two different routines are required for converting the downloaded data from a Super Puk or

IPC / Data Logger. If the downloaded file was produced by this program it will have the extension of .AGM and include a tag that indicates the device that was selected at the time of download. If the tag is found, the correct conversion routine will be selected automatically regardless of the selected data handler type. If not found and the selected data handler is a Super Puk, IPC / Data Logger and ICS, or IPC / Data Logger Only then the device that produced the file will be assumed to be the same as the selected Data Handler. If the selected data handler is an ICS Only or Genie Puk then a question will be displayed requesting the type of data handler that produced the file. You may enter either a "I" for the IPC / Data Logger or "S" for the Super Puk. You may also use the arrow keys to move the double lined box around the correct data handler, then press enter to select.

After selecting this option the Convert File menu will be displayed where you will enter the

file names and types of file to create. After you leave that menu conversion will start and the file conversion. The progress of the conversion will be displayed. See the Convert File section for more information on the menu displayed.

F5 Sets various program settings. These settings include the screen colors, password required

to control a data handler, initial data handler type, and the time to wait for a message when downloading data.

All settings will be saved when the program exits and loaded when the program starts. You

may also save or load the setting manually with two commands within this menu. See the Program Settings section for more information on the available program settings

and their menu.

Page 14: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

11

F6 Changes the selected AGM Data Handler. Use this option to switch between the various types of AGM Data Handlers. This program supports AGM's Super Puk, IPC / Data Logger, ICS, and Genie Puk. The IPC / Data Logger may be either connected alone or with an ICS. The selected data handler must match the device connected to your computer.

Selecting this option displays the Data Handler Selection Menu. You may use this menu

option to switch between various data handlers without exiting the SCADA program or hanging up a telephone connection. See the Data Handler Selection Menu section for more information about the selection menu.

F10 Exits the SCADA program. Before exiting, if you changed any parameter such as the phone

number; communications port; baud rate; screen colors; or password, you will be prompted to save the setting. If you save these settings they will automatically be loaded next time you run this program.

The settings will be saved in the last setting file specified. If you renamed and saved the

settings file with in the Program Settings menu, the new file name entered at that time will be used. If you entered a settings file name on the command line, and did not change it in the Program Settings menu, the file name entered will be used. If you rename the program then the program name with the extension of .SET will be used. If you did not rename the file at either location or rename the program, SCADA.SET will be used.

Page 15: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

12

Project Menu In the project menu you select the operation that you wish to perform on the data handler. The contents of this menu will vary according to the data handler selected. You will only have the options supported by the data handler you selected. The following describe each menu option. After the function key the data handlers each command supports is listed. If a data handler is not listed then function is not supported. Key: SP = Super Puk, IPC = IPC / Data Logger, ICS = ICS, GP = Genie Puk, All = Add data handlers:

F1 (All) Displays the context sensitive help screen for the selected data handler. F2 (SP, IPC) This option starts the download process for the Super Puk or IPC / Data

Logger. During the download process the data will first be saved to an either a temporary file or a file with a .AGM extension. After all data is retrieved, the data will be, optionally, converted to a comma separated .CSV or dBase .DBF file. Unless you specified that the .AGM file should be produced, the temporary data file will be deleted.

Data downloaded into a raw data file may be later converted by the F4 option

in the Main Menu. When you select this option the Download File menu will be displayed

requesting the file names, types, and amount of data to download. See the Download File section for more information on the Download File menu.

F2 (GP) This option uploads the Genie Puks configuration file. The configuration file is used to set the various voice menus and responses

used within the Genie Puk. When you purchased your Genie Puk you received a file with the extension of .INI. You will need to specify the name of this file when requested.

While uploading, data received form the Genie Puk will be displayed on the

screen. This will allow you to monitor the upload process. The .INI file contains the responses to the configuration questions asked by

the Genie Puk. These responses must be in sequence and synchronized with the Genie Puk. Normally if the file was supplied by AGM Electronics, has not been edited, and is for your version of Genie Puk they will be in sync.

This menu option is the same as the F4 menu option in the terminal emulator

used to configure other sections of the Genie Puk. Pressing F5 then F4 is the same as pressing F2 here.

F3 (ICS) Interrogates an ICS Data Handler in real time. The current I/O and variables

are displayed on various screens. When you select this option you will be requested to supply the drive and

directory where the ICS data files are located. This file is optional. It is only required if you want the identifying labels used to program the ICS available on the screen.

The files requested are unique to each ICS program version and are available

through AGM Electronics technical support.

Page 16: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

13

This option is currently implemented as separate program that is loaded by this SCADA program. The program AGM_MON.EXE must be available in the same drive and subdirectory as the SCADA program before an ICS can be interrogated.

Operation of the screen is slightly different in the interrogation program and

on-line help is not available. Below list the functions of each of the keys while interrogating the ICS:

F1 Next Screen. F2 Last Screen. Both of these options cause the program to scroll through each

I/O and Variable screen. Scrolling is a continuous loop, pressing either F1 or F2 continuously will scroll through all screens then start over again.

F3 Retrieves data from the ICS for the displayed screen only.

There will be a small delay after pressing this key before the data shown on the screen is updated. If unable to obtain the data the program will time out and an error message displayed at the bottom of the screen.

F6 Sends the data on the current screen to the printer. All data of

the selected type will be printed, including all pages of the variables.

F10 Exits AGM_MON.EXE and returns you to the main SCADA

Program. Page Up Page Down Some types of data require more than one screen to display all

data. Pressing either key may display additional I/O or Variables.

F3 (SP) Interrogates a Super Puk Data Handler in real time. The current status of up

to 9 variables and the conditions of the digital inputs and relay outputs can be displayed, either on demand or as a predetermined interval. The date and time from the Super Puk can also be displayed.

Once you press the F3 key, the program will interrogate the Super Puk to

obtain the requested data. Once the data has been obtained it will be placed on the screen.

Only 2 keys are active while in this display. Pressing the Enter key will

interrogate the Super Puk again and update the display. Pressing F10 will exit and return you to the Project or Main Menu.

This feature also has the option of being started immediately when the

program is loaded bypassing the Main and Project Menu. To use this option, the Super Puk must be directly connected and the program must be set to automatically select the Super Puk, rather than asking for the data handler type.

F4 (ICS) Interrogates and controls an ICS Data Handler. Same as F3 above except

you may now modify variables and I/O within the ICS data handler. To modify I/O or Data, you will first select the I/O or variable then press F4 to

change the variable.

Page 17: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

14

Before you will be allowed to interrogate and control an ICS through this option you must successfully enter a password. These passwords are initially available only through AGM Electronics Technical Support. These passwords may be modified to fit your needs and security requirements.

These passwords are there to protect you, your employees, and equipment.

READ ALL WARNINGS AND KEEP THE PASSWORDS A SECRET. The command options that these passwords protect are inherently dangerous.

WARNING

INDISCRIMINATE MODIFICATION OF ANY DATA HANDLERS I/O OR

VARIABLES WILL CAUSE UNPREDICTABLE RESULTS. WHEN YOU MODIFY I/O OR VARIABLES YOU ARE OVERRIDING THE PROGRAM CONTAINED WITHIN THE DATA HANDLER. THIS OPTION SHOULD ONLY BE USED BY AUTHORIZED PERSONNEL AND FOR DIAGNOSTICS ONLY.

AGM Electronics Inc. can not be held responsible for the use or misuse of this

program. This section is intended for diagnostics only and will override the internal programming of the ICS. When you use this section, you will be you controlling the I/O of the ICS and not the internal program. The ICS will no longer control I/O controlled by you. You will retain control of the I/O until you exit this section or reset the ICS.

F5 (SP, IPC) Configure Data Handler starts a simple terminal emulator.

Some Data Handlers such as the Super Puk, IPC / Data Logger, and Genie Puk contain their own prompts and routines for configuration. The configuration steps required by these devices is specific to the device and will vary according to the Data Handlers programming.

When the terminal emulator starts, any character you type except the function

keys, will be sent to the Data Handler. All messages from the Data Handler will be displayed on the screen.

The following 3 function keys are available in this mode regardless of the data

handler type:

F1 Displays the help screen showing descriptions of the function keys and common commands used by the data handler. This help screen is specific to the data handler selected. Only the commands relevant to the selected data handler will be displayed.

F2 Enables or disables the echoing of entered text on the screen. When Echo is On, characters entered on the keyboard will be echoed

on the screen as they are transmitted. When Echo if Off characters typed on the keyboard will not be echoed to the screen by this program.

Some AGM Data Handlers can be set up to echo any received

characters. If you are connected to an AGM Data Handler and it is not echoing, you may wish to turn the Echo On to see the text you are entering.

If you are seeing double characters, the AGM Data Handler is echoing

the received characters. Press F2 to toggle the Echo Off to stop the double echo.

Page 18: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

15

F10 Exit the terminal emulator section and returns to the Project Menu.

F5 (GP) Configure Data Handler starts a simple terminal emulator. Operation is identical to the terminal emulator mode described for the Super

Puk and IPC / Data Logger except for the addition of the following two function keys:

F3 Sends a command that instructs the connected Genie Puk to enter it’s

remote access mod. Once in this mode you may configure the Genie Puk as if you were directly connected to the Genie Puk.

F4 Uploads the configuration file. Pressing F4 is identical to pressing F2

in the Project Menu. See the F2 key description for more information. F6 (All) Changes the type of selected AGM Data Handler. Use this option to switch

between the various AGM Data Handlers. This program supports AGM's Super Puk, IPC / Data Logger, ICS, and Genie Puk. The IPC / Data Logger may be either connected alone or with an ICS. The selected data handler must match the device connected to your computer.

Selecting this option displays the Data Handler Selection Menu. You may

then use this menu to switch between various data handlers without disconnecting from the data handler. See the Data Handler Selection Menu section for more information about the selection menu.

F7 (SP,ICS) Changes the address used to access the AGM Data Handler.

When using an addressable data handler you must supply the address of the data handler. This address will be placed at the beginning of all commands except those you enter via the terminal emulator. This address is required to select the correct device when using multiple data handlers over RS-485 or Radio Modems.

Selecting this option will allow your to switch addresses without returning to

the Communications Port Setup Menu. F10 (All) Returns you the main menu.

If you connected to the Data Handler over a phone line, this SCADA program will ask you if you wish to disconnect.

If you do not disconnect, use the direct connect entry to return to the project

menu. Using the connect over phone line option will disconnect then dial the entered numbers.

Page 19: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

16

Communications Port Setup Menu The Communications Port Setup Menu is displayed when you answer yes to the Change Communications Port Question. You will be able to modify various communications port settings from this menu. On line help via F1 key is not available in this menu, however each menu entry contains a brief explanation of each option. The following describes each of the menu options:

F2 Selects the communications port. Press F2 until the desired communications port is

displayed. COM1, COM2, COM3 and COM4 are supported. COM1 and COM2 must be the standard communications ports used by IBM PC compatibles. COM3 must be addressed at 3E8H and use IRQ 4. COM4 must be addressed at 2E8H and use IRQ 3.

F3 Selects the communications baud rate. Press F3 until the correct baud rate is displayed.

Baud rates 150, 300, 600, 1200, 2400, 4800, 9600, and 19200 are supported by this program and the Super Puk. IPC / Data Loggers support 300, 1200, and 9600. ICS supports 300 or 1200.

F4 Selects the type of communications to use. Press F4 to select the communications type.

The following describe each communications type supported:

RS-232 - Normal Communications. This is the normal RS-232 used for direct connections to a single data handler. Used also for modem connections over the phone line.

RS-485 - RTS Active TX. Used for communicating with Super Puks or Genie Puks over RS-

485. Some RS-232 to RS-485 converters require RTS to be controlled for half-duplex communications. Selecting this option allows the RTS line to be controlled. RTS will only be active (high) when transmitting.

This option may also be used on other devices that require this type control. No

handshaking or delays are available with this option. If a delay is required use the Radio Modem setting.

Reversed RS-485 - RTS Active RX. Used only for RS-232 to RS-485 converters that

control RTS differently than the normal RS-485 converters. With this options RTS will remain active (high) until time to transmit. Otherwise, it functions the same as the normal RS-485 described above.

Radio Modem - RTS Active TX. Wait. Used by radio and other half-duplex modems that

require in addition to RTS control, a delay between RTS and the transmitted data. Like RS-485, RTS is used to control the transmitting. RTS will remain inactive (low) until time to transmit, then it will be switched active (high). The entered delay will time out, or CTS will become active, then the data will be transmitted. If no delay time is entered and CTS does not become active after 5 seconds, then the data will be transmitted without CTS active. When in the terminal section keys entered on the keyboard will be buffered up until a carriage return is entered, the internal buffer fills up, or 15 seconds have elapsed since the last key was entered.

Reversed Radio Modem - RTS Active RX. Wait. This option is the same as the normal

Radio Modem option described above, except, the condition of RTS is reversed. RTS will remain active (high) then switch to inactive (low) when transmitting.

F5 When using an addressable data handler you must enter the address of that data handler

here. This address will be placed at the beginning of all commands except those you enter via the terminal emulator. This address is required to select the correct device when using multiple data handlers over RS-485 or Radio Modems.

Page 20: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

17

To enter or change the address, press F5 then type in the new address. Leave blank if no

addressing is used. F10 Leaves this menu then continues with command selected in the Main Menu. If directly

connected then the Project Menu will be displayed. If connected over a phone line then the Edit Modem Control & Response Strings menu will be displayed.

Page 21: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

18

Edit Modem Control & Response Strings The Edit Modem Control and Response Strings menu is displayed after the Communications Port Setup menu and only when the Call AGM Data Handler by Phone was selected from the Main Menu.. It lists the command strings and expected responses use to control the modem. To change any setting press the function key then enter the new value. If no command or response is required then leave blank. On line help via F1 key is not available in this menu, however each menu entry contains a brief explanation of each option. The following describes each of the menu options:

F2 String used to initialize the modem. The string entered here will be sent to the modem

before any dial commands are sent. F3 String used to detect the success of the initialization string. After sending the above

initialization string this program will wait for the string specified here to be received. If not received by the time specified in F7 below, the dial routine will exit and an error message will be displayed.

Typically for most modems the response will be OK or 0 to signal a successful completion of

a command. F4 Modem Dial Prefix is a text string placed at the beginning of the dial string that you specify

when requested for the Phone Number. F5 Modem Dial Suffix is a text string appended to the end of the Phone Number. F6 Modem Connect String is the response used to indicate a dial was successful and the

modem is now connected. If this string is not received after a dial, then an error message will be displayed and you will be returned to the Main Menu. You must receive the message specified here before advancing to the Project Menu.

F7 Connect Time-out Delay is the number of seconds the program will wait for either the

initialization success or connect string. This delay should be long enough for you modem to not only dial the phone, but receive an answer and connect as well.

You should also set the S7 register on your modem as well. This register is typically used to

set the time in seconds the modem will wait for a carrier from the answering modem. This program does not automatically set this register, the delay time set here is only used internally. You may however set the S7 register as part of the initialization or dial prefix.

F8 Indicates how the modem will be hung up. Most modems may be disconnected by either

switching the DTR line from active (high) to inactive (low) or by receiving an escape string followed by the hang up command.

Toggling the DTR line is often the fastest and surest method of hanging up the modem,

however, modems may be set to ignore the DTR signal typically due to wiring constraints or possibly the options on the modem itself.

To select the hang up method press F8 until the correct method is displayed. F10 Leaves this menu then continues with command selected in the Main Menu. If the Hang Up

method selected by F8 is Toggling DTR the Project Menu will be displayed next. Otherwise, the Edit Modem Hang Up Strings menu will be displayed.

Page 22: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

19

Edit Modem Hang Up Strings The Edit Modem Hang Up Strings menu is displayed after the Edit Modem Commands and Response Strings menu when the Hang Up Method is “Send Message to Hang Up”. It contains the command strings used to hang up the modem. To change any setting press the function key then enter the new value. If not command or response is required then leave blank. On line help via F1 key is not available in this menu, however each menu entry contains a brief explanation of each option. The following describes each of the menu options:

F2 Modem Hang Up Prefix is the escape string required by all modems to exit from the data

mode and return to the command mode. When hanging up the phone the string specified here will be sent 1 second before the actual hang up command specified F3 below. Typically “+++”.

F3 Modem Hang Up Suffix is the command string that actually hangs up the phone. Typically

“ATH”, F10 Leaves this menu then display the Project Menu.

Page 23: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

20

Function Keys When Configuring a Data Handler When you select the Configure Data Handler via Terminal Emulator from the Project Menu you are selecting the terminal emulator section of the SCADA program. While in this section any key, except function keys, will be sent to the data handler. Any messages returned from the data handler will be displayed on the screen. All data handlers, except the ICS, have this option available. The ICS was not designed for direct control by a terminal program. It uses a specialized syntax that relies on the absolute address of the internal registers within the ICS. Use only the interrogate or control options from the project menu to access the ICS. The function keys available while in the terminal emulator are:

F1 Displays the help screen containing definitions of the function keys and typical commands

for the data handler. Only some of the data handlers commands will be displayed. The Super Puk data handlers have their command sets defined when programmed to the

customers specifications. For this reason only the common and stable commands are displayed in the help screens. When you obtained you data handler, you may have received an additional documentation listing all of the available commands.

F2 Enables or disables the echoing of entered text on the screen. When Echo is On, characters entered on the keyboard will be echoed on the screen as they

are transmitted. When Echo if Off characters typed on the keyboard will not be echoed to the screen by this program.

Some AGM Data Handlers can be set up to echo any received characters. If you are

connected to an AGM Data Handler and it is not echoing, you may wish to turn the Echo On to see the text you are entering.

If you are seeing double characters, the AGM Data Handler is echoing the received

characters. Press F2 to toggle the Echo Off to stop the double echo. F3 Sends the remote access command &*agmgp to the Genie Puk. This will allow you to

configure and control the Genie Puk over the phone line. To configure a Genie Puk remotely:

1. Dial up the Genie Puk using your computer, this program and a normal modem. 2. When connected, enter this terminal emulator section and press this F3 key. The

remote access command "&*agmgp" will be sent to the Genie Puk to enable remote configuration.

3. After the Genie Puk is in remote mode you may use the normal AT commands just

as if you were directly connected directly to the Genie Puk. Note: If you have an early version (prior to 2.7) press the shift and F3 key. Versions prior

to 2.7 used "&*agmsm" as the remote access command.

This function key is only available when the data handler selected is a Genie Puk.

Page 24: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

21

F4 Uploads the configuration file. The configuration file is used to set the various voice menus

and responses used within the Genie Puk. When you purchased your Genie Puk you received a file with the extension of .INI. This is the file that will be requested when you select this option. It contains all responses to the questions asked by the Genie Puk after the ATC command is entered.

You may make you own .INI file with the additional software supplied with your Genie Puk.

You may also use an ASCII text editor to create the file. This function key is only available when the data handler selected is a Genie Puk. F10 Exit the terminal emulator section and returns to the Project Menu.

Page 25: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

22

Convert File Menu When you select F4 from the Main Menu to convert a file a menu will be displayed allowing you to enter the various settings required to convert the file. The following section describes each menu options:

F2 Input File Name is the name of the input file that will be converted. Press F2 then enter the

file name. The file name entered must be valid MS-DOS file. You may omit the drive and directory if the file is located in the current MS-DOS drive and directory. You may omit the extension only if the file has the extension of .AGM. If the input file has no extension enter the file name followed by a period.

F3 Output File Name is the name of the output file. Press F3 then enter the file name. The file

name entered must be valid MS-DOS file. You may omit the drive and directory if the file is located in the current MS-DOS drive and directory.

Do not include the extension when entering the file name as it will be automatically added to

the file name.

The extension will be either .CSV for the comma-separated file and DBF for a dBase file. If you do enter an extension and both types of files are produced, only the comma-separated file will have the extension you entered. The dBase file will have a .DBF extension. If only one output file is produced then the extension you use will be the extension of the output file. Using an extension other that the default extension may create problems with some software that uses the extension to determine the type of file loaded.

F4 Selects the output file type. Press F4 until the desired output file combination is displayed.

You may output a file as either a comma separated .CSV file, dBase .DBF file, or both. F9 Starts the conversion process. To successfully convert the input file must exist and contain

data downloaded from a data handler. During this conversion process a progress report will be displayed showing the progress as a percentage of the input file processed. If any errors occur, an error message will be displayed. Also an error message will be displayed if no data is found after reading completely through the input file.

If the file was created by this SCADA program a flag was placed at the start of the raw data

file to indicate the data handler that contained the data. If the file was created by some other program, it will be converted according to the data handler currently selected, or if the selected data handler can not be determined, a question requesting the type of data handler will be displayed.

F10 Exits to the Main Menu without converting the files. Any changes made to the above

parameters will be retained.

Page 26: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

23

Download File Menu When you select F2 from the Project Menu to Download data a menu will be displayed allowing you to enter the various settings required for downloading. The following section describes each menu options:

F2 Selects the amount of data to be downloaded. When using the IPC / Data Logger you can specify the starting date and number of days to

download. You will set the download date and number of days just before the download starts. When using a Super Puk that supports partial downloads you will be asked for the number of hours to download just before the download starts. Super Puks that do not support a partial download will always download all data.

F3 Output File Name is the name of the output files. Press F3 then enter the file name. The file

name entered must be valid MS-DOS file. You may omit the drive and directory if the file is located in the current MS-DOS drive and directory.

Do not include an extension when entering the file name. The extension will be .AGM for the

raw data file, .CSV for the comma separated file, and DBF for a dBase file. If you do enter an extension, the extension will be assigned to the raw data file if requested.

If the raw date file is not requested, the extension will be assigned to the comma separated file. If neither the raw data nor comma separated file is requested then the extension will be assigned to the dBase file.

Using an extension other that the default extension for a comma delimited or dBase file may

create problems with some software that uses the extension to determine the type of file loaded. If you change the extension of the raw data file you must enter the full file name including extension when converting the file with the F4 option from the Main Menu.

F4 Selects the output file types. Press F4 until the desired output file combination is displayed.

You may download and output the data as a raw data file, comma separated .CSV file, dBase .DBF file, or any combination of the three types.

F9 Starts the download and optional conversion process. When F9 is selected the following will

occur:

1. This program will attempt to establish communications to the data handler. This is accomplished by outputting messages to the data handler until it responds with a specific message. For the IPC / Data Logger that message is an asterisks. For the Super Puk that message is the program version number. During this process any messages received will be displayed on the screen. If the expected message is not found after 4 attempts, the program will assume the data handler is not connected and display a error message.

This data handler detection may take a minute or more, if the data handler is slow in

responding.

Page 27: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

24

2. After communications has been established, the download command will be sent. As

the data handler sends data to this program, this program will store the received data either in the raw data or temporary file, search for records, and display the number of records found.

If you are using high baud rates you may see a message indicating the progress

display is unavailable. This message indicates the data is being received too fast for the record search to be performed. Data will however still be saved in the raw data file.

3. The downloading of data is completed when no more data is received from the data

handler within the time specified by the “Set Download Time-out” in the Modify Program Settings Menu. An adjustable time-out is required as some data handlers may require more time to start their download. For example a dump of data on a specific date will take longer than a dump all in the IPC / Data Logger. Should the download end prematurely, increase the download time out value. To minimize the download time, decrease the download time out value.

4. After the download is complete, the number of records received will be checked. If

no records were received, then an error message will be displayed.

5. If a comma separated .CSV, or dBase .DBF file is requested then the raw data will be converted to the requested files. If both files are requested then the comma separate file will be converted first.

6. Unless the raw data file is requested, it will be deleted after conversion.

F10 Exits to the Project Menu without downloading the data. Any changes made to the above

parameters will be retained.

Page 28: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

25

Program Settings Menu The Modify Program Setting menu allows you to change various operating settings of this program. It also allows you to manually load or save the programs settings. The following sections describes each menu option:

F1 Displays help screen for the Program Settings Menu. F2 Sets the screen colors for use with a black / white monitor.

F3 Changes the screen colors for use with Color Monitors. F4 Changes the Password required for remotely controlling an ICS Data Handler. The old

password must provided before a new password may be entered. Up to 2 passwords may be used. Entering password #1 will change only password #1 and entering password #2 will change only password #2.

WARNING

THESE TWO PASSWORDS ARE PROVIDED TO PREVENT INDISCRIMINATE

MODIFICATION OF A DATA HANDLERS I/O OR VARIABLES. INDISCRIMINATE MODIFICATION OF VARIABLES AND I/O WILL CAUSE UNPREDICTABLE RESULTS. WHEN YOU MODIFY I/O OR VARIABLES YOU ARE OVERRIDING THE PROGRAM CONTAINED WITHIN THE DATA HANDLER. DO NOT DEFEAT THE PURPOSE OF THESE PASSWORDS BY ALLOWING UNAUTHORIZED USERS OF THE SCADA PROGRAM ACCESS TO THE PASSWORDS.

F5 Selects the data handler type that will be selected when this program is loaded. You may

select between any of the supported data handlers or "Ask for Data Handler type" to request the data handlers type.

When shipped this setting is set to “Ask for the data handlers type”. If you are primarily

using only one type of data handler, select the data handler here to avoid the start up menu requesting you to enter the data handler type. The data handler type may still be selected via the F6 key in either the Main or Project menus.

F6 Sets the time out period when downloading data from the Super Puk or IPC. This setting is the time the program will wait for a data message from the data handler. If

you are having trouble downloading or uploading data, increase this time delay. F7 Define the screen for the Super Puk Monitor. The monitor allows up to 9 variables and the

condition of the digital inputs and relays to be displayed and monitored. This selection is used to define the options, messages and variables to display.

F8 Loads the program settings from a file that you specify. F9 Saves the program settings to a file that you specify. F10 Exits this settings menu and returns to the Main Menu. Note 1: When using either F7 or F8 you should enter the complete file name including the

drive and directory. The extension is optional and if not entered ".SET" will be used. Note 2: Manually loading or saving the settings file is not required. When this program is

loaded, the default settings file "SCADA.SET" will be loaded. You may specify another settings file by entering the file name on the command line.

Page 29: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

26

When you exit this program you will be asked to save the settings file if any settings have been changed. Unless you have the either F7 or F8 above, or specified a file name on the command line the default settings file "SCADA.SET" will be used.

Page 30: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

27

Super Puk Monitor Screen Settings Menu This menu allows you to define several options for use in the Super Puk Monitor screen. It is reached from the Program Settings Menu. It will allow you to determine the start up mode, title, update time, and if the Super Puk’s date and time will be displayed. The following sections describes each menu option:

F1 Displays help screen for the Program Settings Menu. F2 Sets the start up mode for this program. The SCADA program may be start by displaying

the Data Handler Selection Menu, the Main Menu, or the Super Puk Monitor screen. To start with the Super Puk Monitor screen the Super Puk the following must be done:

1. The Super Puk must be directly connected. No automatic dialing of a Super Puk is provided at this time.

2. The Data Handler Type must be set to “Super Puk” in the Program Settings Menu. 3. This setting must be set to “Super Puk Screen” and not “Standard Menus”.

F3 Indicates if the Super Puk’s Date and Time will be obtained and displayed. If “Yes” the date and time will be obtained then displayed in the lower right of the screen. If “No” then the lower right will be blank.

F4 Sets the title that will be displayed across the top of the Super Puk Monitor screen. Any text

up to 70 characters may be used. F5 Update interval for automatic polling of the Super Puk. Enter one of the following:

1. Time delay in Minutes. 2. 0 for a continuous update (approx. every 15 seconds). 3. -1 to update on demand only. Note: The actual update time does not include the time it takes to obtain the data from the

Super Puk. Normally, this will be from 10 to 15 seconds. F6 This menu selection loads the Super Puk Monitor Variable Location Menu. From this menu

you will be able to select the location on the screen where the variables are to be displayed and other display parameters not covered by this menu.

F10 Returns you to the Modify Program Settings Menu.

Page 31: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

28

Super Puk Monitor Variables Location Menu Pressing F6 from the Super Puk Monitor Screen Settings Menu will bring you to this menu. Here you can select the screen locations for the variables, digital inputs or relay status you wish to define. Pressing 1 through 9 will bring up a menu allowing a Super Puk variable to be defined for display. With that menu you will set the variable number, text for the name, text for the units, multiplier and offset. The number you enter here will determine where on the screen the variables will be displayed. Only the 9 defined positions are available for displaying variables. The location is defined by the number in the upper left of the box. Inside the boxes are the current definitions for that variable. The top line in the format of “Vn*m+o”. Where “n” is the variable numbering (1 - 256), “m” is the multiplier, and “o” is the offset. If “n” is set to 0 then the variable location is not used and will be blank when the Super Puk Monitor screen is displayed. The second line is the text that was entered for the Units. The third line is the text that was entered for the name. Pressing A through D will define the strings used for displaying Digital Input or Relay conditions. These options are in fixed locations and the only control this program provides is setting the text that will be indicate each condition. You will enter a string for both the on and off conditions. If either condition’s indicating text is blank then the box will be blanked. Pressing A or C will allow you to define the text messages for both the on and off condition of Digital Input 1 or 2 respectively. Pressing B or D will allow you to define the text messages for Relay 1 or 2. The box in the lower right indicates where the Super Puk’s date and time will be located if enabled.

Page 32: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

29

Variable Screen Position # Menu Pressing 1 through 9 from the Super Puk Monitor Variable Locations Menu will take you to this menu. From this menu you will define the various operating parameters for the indicated variable display location. This includes defining the variable to display, naming the variable, setting the units, and defining any multipliers or offsets. The following sections describes each menu option:

F1 Displays help screen for this menu. F2 Defines the text that will appear at the bottom of the display box. Typically this is the name

of the variable. However if a name is not required, any text may be displayed. F3 Defines the text that will appear in the center of the display box. Typically this is the Units,

but any text message may be used. F4 This is the number of the Super Puk variable to monitor and display. This should be a

number between 1 and 256. See your Super Puk documentation or contact AGM Electronics for valid numbers to enter here. Each Super Puk may be different depending on its internal program. There may also be differences between revisions of a program. Entering an incorrect number will not effect the operation of this program or the Super Puk, however the values displayed will be meaningless.

Enter 0 if the variable location is not to be used. If 0 the text and box will be blanked. F5 Enter an optional multiplier here. The multiplier will be used to modify the value read from

the Super Puk prior to displaying. If no modification is required this value must be 1. Do not set to 0. Setting to 0 will cause the results to be 0 regardless of the value read from the Super Puk.

F6 Enter an optional offset here. The offset will be added to the results from the multiplications

of the Super Puk value by the Multiplier. The Multiplier and Offset are provided for scaling the Super Puk’s input. The formula used

is: Display Value = (Super Puk Value * Multiplier) + Offset. F7 Indicates the type of variable and the number of decimal points to use in displaying the

variable. To set press F7 until the required variable type and decimal point setting is displayed. The following types and decimal point displays are available:

Integer Value read from Super Puk and displayed as an integer. No decimal point

displayed. Floating Point - No Decimal Point Floating Point - 1 Decimal Point Floating Point - 2 Decimal Points Floating Point - 3 Decimal Points Floating Point - 4 Decimal Points Floating Point - 5 Decimal Points Value read and displayed as a floating point with the indicated number of

decimal point precision. The number will be truncated to fit the display format. Floating Point - Best Fit Value read and displayed as a floating point. Decimal point precision will

depend on the value displayed. The program will display the number in the format that results in the least number of digits.

Page 33: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

30

Integer - No Decimal Point Integer - 1 Decimal Point Integer - 2 Decimal Points Integer - 3 Decimal Points Integer - 4 Decimal Points Integer - 5 Decimal Points Integer - Best Fit Value read as an integer but displayed as a floating-point value with the

specified floating-point precision. Typically used only when the value read has been scaled using the multiplier and offset values. Decimal point precision is the same as for a floating-point number.

NOTE: It is important that the correct variable type is selected. The Super Puk uses

both floating point and integer variables. Displaying a variable with the wrong type will not effect the operation of the Super Puk or this program. It will however, make the results meaningless.

If you get a display that is always 0, extremely large or small, check this

setting. You may have selected the wrong variable type.

F10 Pressing F10 returns you to the Super Puk Monitor Variable Locations Menu.

Page 34: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

31

Digital Input # or Relay # Menu

Pressing A through D from the Super Puk Monitor Variable Locations Menu will take you to this menu. From this menu you will define the two text strings that will be displayed to indicate the condition of the digital input or relay output. The following sections describes each menu option:

F1 Displays help screen for this menu. F2 Sets the text that will be displayed when the digital input or relay is on. Include both the

name and state when entering this text string. It will be displayed as you have entered it here.

If left blank, then the text string and surrounding box will be blanked when the input or output

is on. F3 Sets the text that will be displayed when the digital input or relay is off. Include both the

name and state when entering this text string. It will be displayed as you have entered it here.

If left blank, then the text string and surrounding box will be blanked when the input or output

is off. F10 Pressing F10 returns you to the Super Puk Monitor Variable Locations Menu.

Page 35: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

32

Using Multiple Data Handlers with SCADA If you are using more than one AGM Data Handler or if you require different settings in the SCADA program you can either change the settings each time you use the program or create different settings files for each data handler or configuration. To create the file use the "Save Program Settings" command in the settings menu. To load the file at program startup enter SCADA followed by the name of the saved settings file. If the settings file is not found then SCADA.SET will be used.

Examples: SCADA To use the normal default settings. SCADA MONO To use the settings for a black and white display. MONO.SET

supplied on distribution diskette. SCADA ICS SCADA PUK SCADA IT These three examples are for use with setting files called ICS.SET,

PUK.SET, or IT.SET. Each of the setting files must be created before use. To use the name only the files must be in the same drive and directory as the SCADA program.

SCADA C:\ICS\SCADA This example illustrates how to use the program with a setting file not

contained in the same directory as the SCADA program. It uses the setting file SCADA.SET located in the directory of ICS or drive C.

SCADA SCADA.XXX SCADA SCADA. SCADA SCADA.SET The extension of the setting file is normally optional and is assumed to

be .SET. The setting files can however be saved with a different extension. To use these setting files you must enter the extension.

The first of these three examples loads a settings file with the

extension of .XXX. The second loads a file with no extension. If no extension is used a period must be placed after the file name. The third loads the default setting file, it is identical to specifying SCADA alone.

IT IT SCADA These two examples show how you can use a different name for the

SCADA program. You may accomplish this by either creating a batch file or by renaming the program.

If you use a batch file the default name of the settings file will remain

the same. If IT is the name of a batch file, it is possible that both examples will use the default setting file of SCADA.SET.

Page 36: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

33

The SCADA program uses its own program name for creating the

names of its default settings file and help file. By renaming the SCADA program you will also rename the default settings and help file. If the program was renamed to IT.EXE then the first example will use the settings file IT.SET and the second example will use the settings file SCADA.SET.

NOTE: If you rename the SCADA.EXE program you must also rename the

help file SCADA.HLP, otherwise help will be unavailable within the program.

Page 37: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

34

Status Line Across the top of the screen is a status line showing the current operating conditions of the program. It contains from left to right: the date and time according to your computers real time clock, communications port selected, baud rate selected, connection type, data handler selected, location within the program, and condition of the insert, caps and num lock key. If you are in the Main Menu and no connection has been may be pressing either F2 or F3 the connection entry in the status line will be blank, otherwise it will display on of the following:

Direct For a direct RS-232 connection. Phone When connected via a phone line or smart switch. RS485 When connected via RS-485 or related communications protocol. Radio When connected via a radio modem, half-duplex, modem, or related device. R RS485 When connected via a device similar to RS-485, except it requires the control of the

RTS line to be reversed. R Radio When connected via a device similar to a radio modem except it requires the control

of the RTS line to be reversed. The data handler selected is a 2 to 4 letter word that indicates the data handler type. The following is a list of all data handlers and their types as displayed on the status line:

SP Super Puk selected. IPC+ IPC / Data Logger with ICS selected. IPC IPC / Data Logger Only selected. ICS ICS Only selected. GP Genie Puk selected.

The location within the program is displayed as a list of function keys pressed after making a selection from the main menu. The location will be blank when you are in the Main Menu. When you make a selection and go to an additional menu the function key you pressed will be displayed. If you press another function key that key will be added to the location list on the status line. When you return from a menu the function key will removed from the list. Up to 3 function keys will be displayed the SCADA program is not nested beyond 3 menu or function beyond the Main Menu. The following example shows the location display, as it will be displayed at each function key pressed:

(blank) Location blank you are the Main Menu. May also be at the initial display of the

version screen or Data Handler selection menu. F3 You have selected a direct connection. You may be either in the Project Menu or

The Communications Port Setup if you answered yes to changing the communications ports.

F3 F5 You are configuring a data handler. F3 F5 F1 You needed help to configure the data handler to you pressed F1 to request help.

Page 38: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

35

NOTE: F3 is the direct connect menu option form the Main Menu.

F5 is the Configure Data Handler option from the Project Menu. F1 is the Help menu selection from the terminal emulator used to configure the data

handler. F3 F5 You pressed ESC to exit help and are back to configuring a data handler. F3 You have completed configuring a data handler and are back to the Project Menu. (blank) You exited the Project Menu and are now back at the Main Menu. << F6 F1 When “<<“ is displayed the program has been nested more than 3 levels from the

Main Menu. Currently the only area where you will see this display is in the configuration section the full location is F5 F6 F7 F1.

The three shift lock indicators show the condition of the shift lock for the Num Lock, Caps Lock and Insert keys only. Scroll lock is not used by this program nor is it used by MS-DOS or the keyboard controller to modify the keystrokes so it is not include in the shift key list. Num and Caps lock are not used by this program, but they do modify the value of the key pressed so they are included for your convenience. Insert lock, which is not normally shown on a keyboard, is used by this program to determine if typed in text will overwrite or be inserted into an existing text string. The condition of this key is displayed on the status line so you know the condition of this shift key. If you are using a color screen, the color of the cursor will also indicate the insert mode. To change insert modes, press the Insert key on you keyboard.

Page 39: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

36

Uploading a Genie Puk Configuration File The following is step by step instructions for uploading a configuration file for the Genie Puk. The configuration file is an ASCII text file with the extension of .INI. It contains all the responses required by the ATC command. The contents of this file may differ between various versions of the Genie Puk. The upload procedure described below remains the same for all versions of the Genie Puk.

1. Start the SCADA program by entering SCADA on the command line. Prefix the SCADA command with the drive and directory if required. The drive and directory is not required if either SCADA.EXE is not in the current drive and directory or if the drive and directory containing SCADA.EXE is not listed in your PATH.

2. When the Select AGM Device Handler Type menu appears select F6 for the Genie Puk. If the Main Menu appears, then the SCADA program has been set up to start with a

predetermined Device Handler Type. If "GP" appears on the top line then the SCADA program is already set for communicating with the Genie Puk and you may skip this instruction. Otherwise Press F6 to obtain the Select AGM Device Handler Type Menu.

3. From the Main Menu select either F2 or F3. Select F2 if communicating with Genie Puk over

a phone line. Select F3 if you are directly connected to the Genie Puk. 4. After selecting either F2 or F3 you will be asked if you want to change the communications

parameters. Enter Y if either the baud rate, communications port, communications type or any other communications setting is incorrect or unknown. Otherwise enter N.

These settings are normally saved between sessions. Unless you change or if you fail to

save the settings when you exit the program they will remain set. 5. If you selected F3 from the Main Menu continue to the next step. If you selected F2 from the Main Menu you will be requested for the phone number to dial.

Enter the phone number of the remote Genie Puk here. If the correct phone number is already displayed you only need to press enter to start the dialing sequence.

After entering the phone number the SCADA program will attempt to connect with the

remote Genie Puk. The SCADA program must be connected to the Genie Puk before you may continue with this procedure. The Project Menu will not appear unless the connection is made.

6. If you are directly connected to the Genie Puk press F2 and skip the following 2 steps or

press F5 and skip the following step. If you are connected through the phone line there is one additional step that is required and

you must press F5 to configure the Data Handler via Terminal Emulator.

Page 40: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

37

7. Press F3 to access the Genie Puk remotely. The Genie Puk must be setup for remote access before it will respond to any command via its internal modem port. Pressing F3 will send the commands to the Genie Puk to place it in this remote access mode.

Do not perform this step if you are directly connected to the Genie Puk. 8. Press F4 to start the uploading of the configuration file. 9. After pressing either F2 from the Project Menu or F4 from the Terminal Emulator you will be

requested to enter the file name of the Genie Puk Configuration File. Enter the name of the ASCII file containing the configuration responses.

The file name must be a valid MSDOS file and unless it is in the current directory you must

include the drive and directory. The extension is optional and if omitted an extension of ".INI" will be assumed. If the file has no extension enter "." after the name.

10. Unless an error or other problem occurs the SCADA program will now be uploading the data

file. The program will display all responses from the Genie Puk while uploading. Progress of the upload is displayed on the second line of the screen. It shows the percentage of the file that has been transferred. You may abort the upload at any time by pressing the ESC key.

11. After the file is transferred or aborted the SCADA program will return you either the Project

Menu or Terminal depending on how you started the upload. At this point you have completed the upload and may exit the program.

To exit press F10 until you are asked if you wish to exit then answer Y. If you changed any

settings including the uploaded file name you will also be asked it you wish to save the configuration. Answer either Y or N. Answering Y will save all configuration settings. N will exit without saving the settings.

Page 41: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

38

Batch Commands Batch commands are command strings included either on the command line of the program or in a command file. They are used to automate the downloading of data from the Data Handlers. All batch commands start with the forward slash “/” character and end with either a space, tab, or carriage return. Some commands require additional information to be specified. For these commands do not include spaces between the command and the additional data.

/#: Phone number to dial. Required if you are connecting over a telephone line. If not specified then program assumes you are using a direct connection.

/150 /300 /600 /1200 /2400 /4800 /9600 /19200

Overrides the communications baud rate set in the program setting file. The most common baud rate is 1200 baud (command /1200), however some Super Puks may be set up for different rates. If not specified then the settings file will determine the baud rate.

/AD:

Address of the Super Puk. When a Super Puk is set up for addressing mode, you must enter its specified address after the colon “:”. This setting is optional and if specified will override the program settings if specified. If the settings file has been set up for addressing and you wish to use it with a Super Puk that is not addressed, enter this command without specifying an address. If the address of the Super Puk is unknown, then enter -1 for the address. NOTE: The address of -1 is a universal address available on later versions (1.43 and

later) of the Super Puk. Versions prior to 1.43 required the entry of “RR” to temporally disable the addressing mode.

/COM1 /COM2 /COM3 /COM4

Overrides the communications port specified in the setting file. /AGM

Indicates the raw text file received from the data handler will be retained. The file name will have a “.AGM” extension.

/CMD: Super Puk command string. The specified Super Puk command string will be sent to the Super Puk only on successful completion of the file download. It is intended for use with the memory clear commands, however it may be used with any valid command.

Page 42: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

39

NOTE 1: Not all Super Puks have the memory clear options available. The Super Puk must be programmed with this command before this option will work. The command specified after the colon “:” must the same memory clear command programmed into the Super Puk. Super Puks that require additional entry for verification or only clear memory after going though the configuration can not be cleared with this command.

NOTE 2: Clearing the Super Puk memory is not always necessary. Normally,

Super Puks are set up to collect data on a continuous basis. These Super Puks will continue to store data after the buffer fills up discarding the oldest data to make room for the new data.

Clearing the memory on these Super Puks will reduce the time it takes

to download the data, as well as simplify any external processing done to the downloaded files. For example, you will not need to filter out redundant records when combining the downloaded files from several days.

If the Super Puk is set up to stop after the buffer is full, then you will

need to either have this command specified or use the interactive mode to clear the memory.

/CSV

Indicates a comma-delimited .CSV should be created from the downloaded data. Comma delimited files can be used by many programs for exchanging data. The file created by this command will have the .CSV extension. More than one output file may be specified. This command may be used with either the /AGM or /DBF commands to create 3 different types of output files.

/DBF

Indicates a database file should be created from the downloaded data. Data will be in dBase III format. This format is readable by most of the data base programs in use. The file created by this command will have the .DBF extension.

You may specify this command along with either the /AGM or /CSV commands to create additional data file formats.

/DELAY:

Delay time in minutes to wait before starting the next download. The number of minutes to wait is specified after the colon “:”. This command has two uses. It may be used when downloading multiple downloads to create a dead time between each data handler download, or when a periodic download is required. If a download is required once a day, an alternate downloading method is available. See the /WAIT: command for details.

/IPC IPC / Data Logger download command. Indicates the data handler is an IPC / Data Logger rather than a Super Puk. Must be specified if an IPC / Data Logger is used, otherwise the SCADA program assumes it is connection to a Super Puk.

/SP Super Puk download command. Indicates that a Super Puk is to be downloaded. Optional, unless the IPC / Data Logger has been selected as the default device in the setting file.

Page 43: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

40

/NAME: Optional name template of the output files. The first 2 characters specified after the colon “:” will be used to create the name for the output files. When data is automatically downloaded, the output file name will be created from the first and second two character entered here and the current date. Should the file already exist it will be overwritten. The format for the output file name is:

##YYMMDD where

## Is the name specified by this command. If not specified then only the date will be used.

YY Current year in 2 digit format.

NOTE: On January 1, 2000 this numeric date will roll over to 00. Keep this in mind if you will be sorting the files by their names.

MM Month in 2 digit format. 01 = January. DD Date in 2 digit format.

/OVERWRITE

Overwrite command. Normally the SCADA program will not overwrite any existing data files when downloading. Specifying this command indicates the files should be overwritten if they already exist. Anytime a file already exists, an error message will be written to the log file SCADA.LOG. The entry in this file will indicate if the file was overwritten.

/RADIO: Radio modem communications mode. Overrides the setting of the communications mode in the setting file. Used to indicate that a radio modem is connected to the selected communications port. Radio modem mode differs from the normal RS-232 mode in that it uses RTS to control transmitting.

Page 44: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

41

Syntax for this command is:

/RADIO:#1,#2 where:

#1 Delay between the time RTS is activated and data starts to be transmitted. Units are in seconds, however decimal seconds may be specified. If set to 0, the CTS will be used to determine when to start transmitting.

#2 Delay between the time the data transmission has been completed and the

RTS line is disabled. Units are in seconds and may be specified as a decimal number. If set to 0, RTS will be disabled after transmission is completed.

NOTE 1: If measuring the output from a normal RS-232 connection the RTS lien will be

at a positive voltage when transmitting and a negative voltage when receiving. If the voltage levels are reversed, use the /RRADIO command.

NOTE 2: Not all radio modems require RTS to be controlled, but handle the switching

of the radio transmitter automatically. For these radios use the normal /RS-232 command.

/RETRY:

Optional Retry count. Indicates the number of times the program will attempt to contact the Data Handler and download data unsuccessfully before quitting. Overrides the setting in the programs setting file. Normally you should not need to change the retry count, either in the setting file or on the command line. Control of this option it to accommodate marginal signal conditions where the program may have problems connecting.

/RRADIO: Reversed radio modem communications mode. Same as the /RADIO command except the condition of the RTS line is inverted. With /RRADIO the RTS line is negative when transmitting and positive when receiving. See the /RADIO for syntax and other details.

/RS232 RS-232 mode. Overrides the settings in the setting file to indicate communications is normal RS-232. Use this setting for telephone modem, direct, or any connection where special hardware control is not required.

/RS485 RS-485 mode. Overrides the settings in the settings file to indicate the communications is RS-485. This setting may be required when using some types of RS-232 to RS-485 adapters. If your adapter requires RTS line to be controlled you must either use this command or specify RS-485 communications in the setting file. If using an external RS-485 adapter connected to your computers communications port, RTS will be positive when transmitting and negative when receiving. No delay is implemented between the activation of the RTS line and transmitting of data. The only delay will be the time it takes for your computer to switch the RTS line and send the first character. If your RS-485 adapter requires an on or off delay, use the /RADIO or /RRADIO commands. They will control the RTS too, except they provide adjustable on and off delays.

Page 45: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

42

/RS485R Reversed RS-485 mode. Same as the /RS485 command except the polarity of the RTS line is inverted. It will be negative when transmitting and positive when receiving.

/TO: Download time out. Optional value indicating the time in seconds the program will wait for a response from a data handler before beginning or ending a download. If not specified the value in the program settings will be used. The program uses this time to determine when a data handler has completed its download. The default time in 60 seconds and may be reduced to reduce the connect and download time. Reducing this time to too short of an interval could cause the download to end prematurely.

/WAIT: Wait until command. This command is used when you wish to initiate a download at a specific time of day. When used the program will check the current time against the entered time. When the current time reaches the specified time, the download will begin. If the specified time has already elapsed the download will begin immediately. If the specified time has not been reached then the program will wait.

Syntax for this command is: /WAIT:HH:MM:SS where:

HH is the hour. MM is the minutes.

SS is the optional seconds.

Page 46: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

43

Automatic Downloading The SCADA program is an MS-DOS program, however it will run in an MS-DOS window in the various versions of Microsoft Windows. To use this program for unattended downloading, you will need to first either create a batch file or command file. Your choice depends on if you need to perform additional operations between downloads, the number of commands required and personal preference. Typically you will need to use a batch file when performing additional operations between downloads, for example when you will be appending the newly downloaded file to an existing database. We recommend that you establish connections to all data handlers first then save the setting file when there are changes in many of the connections settings, and use only the command line options only for the parameters such as the file name, /NAME and Phone number /#. You may however, use all of the available commands for modifying the connections. If you have too many commands to specify, you may exceed the command line limit of MS-DOS. You can get around this limit by using a command file. To use the SCADA program to download data at a specific interval you can use either the /WAIT or /DELAY commands, or a third party scheduler program. If running under Windows 95, we suggest you use the System Agent available on Microsoft’s Windows 95 Plus CD-ROM, however any program that allow you to run external programs at a specified time should work.

/WAIT: & /DELAY: in MS-DOS, no scheduling program. Both the /WAIT: and /DELAY: commands require the SCADA program to be running, and the SCADA program is not a TSR (Terminate and Stay Resident). If running MS-DOS only, you may not be able to run other programs.

/WAIT: & /DELAY: in Windows, no scheduling program. If using any version of Microsoft Windows, you can use the SCADA program in an MS-DOS window. If you don’t have a Windows scheduler program, and you wish to download data at a specific time or interval, use the SCADA programs /WAIT: or /DELAY: commands. Set up your Windows PIF (shortcut in Windows 95) file to start a batch file or the SCADA program. Then place the PIF file in the “Startup” group. This will allow the SCADA program to start when Windows starts. Make sure the PIF file is set to run in the background and not in exclusive mode.

NOTE 1: Do not use any other communications programs that use the same communications port as the SCADA program while SCADA is running. Windows will only allow one program to use the communications port at a time. Use of the communications port by other programs may prevent the SCADA program from using the port. The SCADA program may also prevent the other communications program from using the port.

There may not be a warning when this condition occurs. If you find you are having

communications problems, check to determine if another program is using the same communications port.

NOTE 2: When running in the background, you system performance will be degraded.

Page 47: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

44

SCADA in Windows 95 or Windows NT, with scheduling program. On the Windows 95 Plus disk, Microsoft has a program called the “System Agent”. This program is used to schedule programs for execution at specific times. It not only works with Windows programs, but MS-DOS and batch files as well. Windows NT has a built in Scheduler Service that can run Windows, MS-DOS and batch program as specified times. There are also third party program schedulers that run under the various Windows versions. To get the best performance from the SCADA program, for periodic automatic downloading, we suggest you use one of these scheduler programs rather than the /WAIT: or /DELAY: commands. As the SCADA program will only be running when required, the use of these programs will reduce the overhead, and consequently improve the performance when not downloading data. They will also allow the communications port to be used by other programs, provided the other program is not used at the time of download. Setting up any of these programs will depend on the scheduler program. Typically all you need to do is to supply the program or batch file name and the starting times. The scheduler program will take care of starting the batch file.

SCADA.LOG The SCADA program has been written for unattended operation when in the batch mode. In order to allow the program to continue after errors and provide feedback to the download operation the SCADA program will create a log file of the download. This log file will include the name of the downloaded file, and any errors that occur during the download process. This log file will be retained for all batch downloads. When the file already exists, due to a previous download, the new transactions will be appended to the end of the existing file. We suggest you periodically review and then delete this file to avoid running out of disk space on your computer. The log file SCADA.LOG is a ASCII text file that can be read with most editing or word processing programs, such as Windows Notepad, Windows Write, Microsoft Word or MS-DOS Edit.

Page 48: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

45

Example 1 The following example shows the minimum requirements for downloading data via a phone line. Only the phone number is specified. The output file name will be the default of the current date in the form of year, month, date. All other settings are taken from the SCADA settings file SCADA.SET. SCADA /#:722-1162

Example 2 The following example shows the minimum requirements for downloading data via a direct connection. The output file name will be the default of the current date in the form of year, month, date. All other settings are taken from the SCADA settings file SCADA.SET. NOTE: The phone number command /#: is specified without a phone number. This fulfills the

requirement of at least one command and since the phone number is blank, the SCADA program assumes a direct connection.

SCADA /#:

Example 3 The following example shows a typical download command where only the minimum amount of information is contended in the setting file. It will dial the phone number 722-1162 using the modem at communications port COM1: at 1200 BAUD and download a .CSV file. The downloaded file will start with the letter “X” followed by the current date. If the file already exists, it will be overwritten. When the file is downloaded the clear memory command “CM” will be sent to the Super Puk.

SCADA /#:722-1162 /NAME:X /CSV /COM1: /300 /RS232 /SP /OVERWRITE /CMD:CM Example 4

The following examples show the typical contents of a batch file or a command file. This example will show several variations of the command structures. Both examples will first wait until 1:00 AM, then download a file over the phone line. Then 10 minutes later, download a file from a long distance phone number. Finally, it will download 2 local Super Puks connected over via RS-485. Batch File: SCADA /#:722-1162 /NAME:L /CSV /COM1: /300 (enter additional commands here) SCADA /#520722-1162 /NAME:LD /CSV /COM1: /1200 (enter additional commands here) SCADA /NAME:C /AD:1 /CSV /COM2: /1200 /RS485

(enter additional commands here) SCADA /NAME:C /AD:2 /CSV /COM2: /1200 /RS485 (enter additional commands here)

Command File: (To be used with the @name on the command line.) /#:722-1162 /NAME:L /CSV /COM1: /300 /#520722-1162 /NAME:LD /CSV /COM1: /1200 /NAME:C /AD:1 /CSV /COM2: /1200 /RS485

/NAME:C /AD:2 /CSV /COM2: /1200 /RS485 Combination Batch and Command File: SCADA @command.cmd (enter additional commands here)

Page 49: SCADA Interface Program Handbook - …€¦ · SCADA Interface Program Handbook Version 3.12 October 16, ... AGM Electronics Inc., ... Windows 3.1, Windows for ...

46

NOTE: Only a batch file can execute other programs between download sessions. If you need to do additional operations between the downloads, place the commands after the SCADA command that performs the download.

If you only need to perform a operation after all files are downloaded, you may use a combination of a command file for doing the download and a batch file for tying the download and other operations together.