Professional Documents
Culture Documents
MB400 Mapboard Driver User's Guide 1.1
MB400 Mapboard Driver User's Guide 1.1
Mapboard Driver
User Guide
____________________________________________
Document Number: MB-400
support@survalent.com
www.survalent.com
FAX (905) 826-7144
This manual describes the functionality and data entry requirements for the Mapboard
Driver used in the Windows SCADA system.
.
Date Description
January 6, 2005 New manual.
June 15, 2016 Added Mauell protocol
1 Introduction 1-1
3 Mapboards 3-1
4 Macros 4-1
5 Indications 5-1
5.1.1 Point.............................................................................................................................................5-2
5.1.2 Mapboard.....................................................................................................................................5-2
5.1.3 Controller.....................................................................................................................................5-2
5.1.4 Address ........................................................................................................................................5-2
5.1.5 Macro...........................................................................................................................................5-2
6 Numerics 6-1
6.1.1 Point.............................................................................................................................................6-2
6.1.2 Mapboard.....................................................................................................................................6-2
6.1.3 Controller.....................................................................................................................................6-2
6.1.4 Address ........................................................................................................................................6-2
6.1.5 Width ...........................................................................................................................................6-2
6.1.6 Decimal Digits .............................................................................................................................6-2
6.1.7 Macro...........................................................................................................................................6-2
This document describes the functionality and database entry requirements for the Windows SCADA
Mapboard driver.
The Mapboard driver is designed to operate on a Survalent SCADA master station for Windows and to
communicate with one or more mapboard display panels.
Chapters 3 to 6 describe the database entry requirements for the Mapboard driver. They describe how to
use the Survalent STC Explorer to define:
Mapboards
Macros
Indicators
Numerics
The CIS Mapboard display protocol was developed by Computer Inquiry Systems Inc. (now called EL-
CAT Inc.). Other companies, such as SACO Controls Inc., have developed Mapboard displays which also
uses the same CIS protocol.
The Mauell Mapboard display protocol was developed by Bilfinger Mauell Corporation.
The Mapboard driver scans the assigned SCADA database points for changes and sends these changes
to the Mapboard on a periodic basis. You can control the frequency of the scan via the Time Between
Scans field. See section 3.1.6, Time Between Scans.
The Mapboard driver requests the internal status of the mapboard at a frequency that you control via the
Health Check Interval field. See section 3-3, Health Check Interval.
If supported by the protocol, the Mapboard driver sends synchronization messages at a frequency that
you control via the Synchronization Interval field.
This feature may be used to make use of redundant terminal servers and to avoid resorting to failover
when a mapboard port fails.
To illustrate how this feature can be used, consider the Macro in Figure 4-2. If you assign just one
SCADA database point to a lamp address, you get the following:
If the point is in the abnormal state AND has an unacknowledged alarm, the lamp Fast Flashes
If you assign multiple SCADA database points to the same lamp address (and use the same Macro), you
get the following:
If any of the points are in the abnormal state AND has an unacknowledged alarm, the lamp Fast
Flashes
Else, if any of the points are in the abnormal state, the lamp is ON
This chapter describes how to define a Mapboard for the Windows SCADA system. The STC Explorer is
used to create or modify a mapboard’s definition. The dialog box that allows you to do that has several
tabs, each of which contains different data.
NOTE: After creating or changing a Mapboard definition, a Mapboard Macro or editing the display
address or Macro for any points on the Mapboard, remember to come back to this dialog to restart the
Mapboard driver.
3.1.1 Status
This is the status point that will be used by the Mapboard driver to indicate the Up or Down status of the
mapboard. The status point is not optional. It must be specified.
3.1.2 Protocol
This is the name that identifies the protocol to be used to communicate with the mapboard. Select the
CIS protocol for CIS and SACO mapboards. Select Mauell protocol for Bilfinger Mauell mapboards.
Alternatively, you could use the Test page to manually turn off all lamps and then resume normal
operations. See section 3.3,Mapboard Data Field Test
If this value is zero, then a full update will not take place, only changes are sent to the Mapboard. In this
case, the Mapboard driver will only do a full update on startup.
If this value is one second, then on every Time Between Scans interval, the Mapboard driver will update
all assigned lamp and indication addresses.
For any other value, at the specified interval, the Mapboard driver will update all assigned lamp and
indication addresses.
For the CIS protocol, Table 3-1 illustrates the alarms that may be raised against the mapboard status
point for the specified conditions at the mapboard.
For the Mauell protocol, controllers are polled in a round-robin fashion. One controller is polled for each
Health Check Interval. Only controllers defined for indications or numeric displays are polled. Table 3-2
illustrates the alarms that may be raised against the mapboard status point for the error conditions at the
controller.
For the CIS protocol, this parameter is not used, enter zero.
For the Mauell protocol, this command will synchronize all the controllers at once. The synchronization
interval must be a multiple of 2 seconds and must be a factor of 60 seconds. Best practices is to use 10
second intervals.
/LogPath
The LogPath option overrides the default folder that is used when logging communications to a file. If
this option is specified, it must precede the Log option and the folder must exist. If there are any
spaces in the name of the folder, then quotes are required around the name. For example,
/LogPath=”D:\My Logging”.
/Log
The Log option specifies the Mapboard driver is to log communications to a file. The file will be
created in the folder specified when Windows SCADA was installed; the default folder is C:\Program
Files\Quindar\ScadaServer. The file name is comprised of the Mapboard id and the current date. For
example, a file from Mapboard 1 on January 3, 2005 would be MAPBOARD1-2005-01-03.log. If you
wish to change the default folder for logging, see the LogPath option.
Note: If this option is specified, the Mapboard driver will log the communications to a file until the
driver has been stopped. The file can become quite large and may consume the entire disk if left too
long.
The valid values for this option are:
3.2.1 Network
This specifies the type of communication network to be used. Choose COMM for mapboards that will
communicate directly through a serial port on the SCADA host (i.e. a COM port known to Windows).
Choose TCP/IP for all connections that rely on the TCP/IP network, such as serial ports on terminal
servers.
Each port corresponds to a physical or logical connection from the host computer to the communication
medium. The type of Network (see section 3.2.1, Network) determines how these fields are used. For
COMM networks, the port means a serial port attached to the host computer.
Host Name
When Network is set to COMM:
For Mapboard drivers that use a local serial port, this must be the name that identifies the
serial port. It will be of the form COMn where n is a number uniquely identifying the serial
port. This is the same name that Windows uses to identify the port.
For Mapboard drivers that use TCP/IP, this will usually be the name that identifies the other
device that we are communicating with over the network. It may be the mapboard display
itself, or more commonly, a terminal server. It may be a fixed IP address (of the form
nnn.nnn.nnn.nnn), or preferably, a name known to the SCADA host computer (such as may
be specified in the Windows HOSTS file, or by another name-resolution means).
Host Port
When Network is set to TCP/IP:
For a TCP/IP connection, there will be a TCP/IP port number that must be entered here. For
terminal servers, this will correspond with the number of the desired physical serial port.
Consult the terminal server documentation to determine which port numbers to use.
Select from the available choices for baud rate and parity, if your Network uses a local serial
port. Note that the hardware you are using must support the chosen settings as well.
You cannot use these fields for a TCP/IP Network. In the case of a terminal server or similar
device that will provide a serial port, this information must be programmed into that device,
and not here.
Switch
If two ports have been defined, this port switch status point is required. The point is used to show which
port the mapboard is currently communicating on. When the point’s value is 0, the Mapboard driver is
using the first port. When the status point’s value is 1, the Mapboard driver is using the second port.
Whenever it wants to poll, the Mapboard driver first tries the port currently indicated by the port switch
status point. If the poll fails, the Mapboard driver retries. If the After n errors count expires, the Mapboard
driver switches to the other port and sets the port switch status point accordingly.
You can force the Mapboard driver to either port by manually setting the port switch status point.
The port switch status point should be defined as a non-alarm point because you don’t want to be
bothered by alarms on this point when the driver is constantly switching ports.
While the Mapboard driver is using one particular port, it does not check the other port for availability.
Such checks can be made manually by manually setting the port switch point. If you do this, don’t forget
to remove the manual set, or the driver will not be able to switch ports when it needs to. If you define the
port switch point as a control point associated with a dummy scan task, then you don’t have to worry
about manual set. Alternatively, you can automate the forced switching process via a command
sequence.
The Mapboard driver also uses this value (times 2), to establish the number of retries before failing the
Mapboard. If the entered value is zero, the Mapboard driver defaults to 3*2 or 6 for the retry count.
To verify the lamps on the mapboard display, select an Operation (see Table 3-3) and a Station (if
required by the Operation), and click Send. When completed testing, remember to perform the operation
Resume normal mapboard functions. Otherwise, a reminder alarm will be generated every 3 minutes.
Turn ON all the display lights, not just the lights with defined
Turn ON all lights addresses for this Mapboard.
Turn OFF only the display lights that correspond to points on the
Turn OFF all lights for station selected station.
Resume normal mapboard Stop testing, perform a complete refresh of all display lamps and
functions return to normal polling and updating.
This chapter describes how to define a Mapboard Macro for the Windows SCADA system. The STC
Explorer is used to create or modify a Macro’s definition. To access the Macros, click “+” on Mapboards to
expand the tree, then click Macros. The Macro dialog box is illustrated in Figure 4-2.
Each Macro can have up to six cases, which is one case for every possible lamp action. Macros are
evaluated in priority order from case 1 through to case 6. Therefore, you should plan your cases
accordingly. Evaluation continues until the first case that produces a TRUE result, then the resulting lamp
action is performed. If all cases have been evaluated without a TRUE, the default lamp action is OFF.
To prevent unexpected behavior, it is strongly suggested that Macros be defined in such a way that the
last case evaluated always produces a TRUE result. See Figure 4-1. This may be of particular interest
when you do not want the default lamp action to be OFF.
The Macro illustrated in Figure 4-2 contains three cases that will do the following:
Case 1 will set the lamp to Fast Flash, if the point being evaluated is in its abnormal state AND
the point has an unacknowledged alarm
If case 1 did not return TRUE, case 2 will set the lamp to ON if the point being evaluated is in its
abnormal state
If case 2 did not return TRUE, case 3 will always set the lamp to OFF, as <Ignore> produces a
FALSE result, but because NOT is checked the result is changed to a TRUE result
Cases 4, 5 and 6 are never evaluated because case 3 always produces a TRUE result
If only one predicate is required for the case, then for the left predicate make your selection from the
drop-down list, select OR and select <Ignore> for the right predicate. See Figure 4-4. The <Ignore>
predicate will always return a FALSE result, so the left predicate you selected must produce a TRUE
result for the case to be TRUE and the action to be performed.
Predicate results for status points are listed in Table 4-1. For analog points, the predicate results are
listed in Table 4-2, and for stations, they are listed in Table 4-3. A predicate result can be negated by
checking the NOT flag. That is, a FALSE result will become a TRUE result and vice versa.
The possible actions for lamps are listed in Table 4-4. Note, however, that not all mapboards may be
able to perform these actions. Check with your mapboard documentation.
Lamp Action
Off
On
Slow Flash
Fast Flash
Dim
Modulate
This chapter describes how to define indication lamps for the Mapboard driver. The Edit Mapboard
Indication dialog from the STC Explorer is illustrated in Figure 5-1. This editor is used to assign SCADA
database points to lamps on the mapboard. For each database point, you specify the mapboard, the lamp
address and a Mapboard Macro (that you previously defined). The Macro specifies how the database
point values drive the lamps.
Next to this field is a “browse” button, which will call up the point browser as described in DB-400,
Database Editing Overview. You can use the browser window to drag point names into this field.
5.1.2 Mapboard
This field specifies the mapboard to which the SCADA database point name will be assigned. Select the
desired mapboard from the drop-down list.
5.1.3 Controller
This field specifies the mapboard controller to which the SCADA database point is to be assigned.
For the CIS protocol, this field is not used, enter zero.
For the Mauell protocol, this field is required. The controller number is entered in decimal and ranges from
0 to 255.
5.1.4 Address
This field specifies the mapboard lamp address to which the SCADA database point is to be assigned.
For the CIS protocol, the required address is a DMUX address. This number is entered in octal (base 8)
and ranges from 0 to 6777 for 4 digit addresses (most common) and 0 to 37776 for 5 digit addresses.
Leading zeros are not required. Note that address 7777 for 4 digit addresses and 37777 for 5 digit
addresses will address all lamps on the mapboard and therefore should not be used.
For the Mauell protocol, this field is required. The address is entered in decimal and ranges from 0 to 127
for DO128 controllers.
5.1.5 Macro
This field contains the Mapboard Macro (that you previously defined) that specifies how the SCADA
database point value is to drive the lamp. Select the Macro from the drop-down list. See Chapter 4,
Macro, for a discussion on defining Macros.
For the Mauell protocol, when defining Macros for DO128 controllers, the lamp actions that are available
are OFF, ON, Slow Flash and Fast Flash.
This chapter describes how to define numeric indicators for the Mapboard driver. The Edit Mapboard
Numeric dialog from the STC Explorer is illustrated in Figure 6-1. This editor is used to assign SCADA
database points to numeric indicators on the mapboard. For each database point, you specify the
mapboard, the indicator address, the total field width, number of decimal digits and a Mapboard Macro
(that you previously defined). The Macro specifies how the database point values drive the indicators.
Next to this field is a “browse” button, which will call up the point browser as described in DB-400,
Database Editing Overview. You can use the browser window to drag point names into this field.
6.1.2 Mapboard
This field specifies the mapboard to which the SCADA database point name will be assigned. Select the
desired mapboard from the drop-down list.
6.1.3 Controller
This field specifies the mapboard controller to which the SCADA database point is to be assigned.
For the CIS protocol, this field is not used, enter zero.
For the Mauell protocol, this field is required. The controller number is entered in decimal and ranges from
0 to 255.
6.1.4 Address
This field specifies the numeric indicator address on the mapboard to which the SCADA database point is
to be assigned.
For the CIS protocol, the required address is a BCD address. This number is entered in octal (base 8)
with a maximum of 3 digits. Leading zeros are not required.
For the Mauell protocol, this field is required. The address is entered in decimal and ranges from 0 to 8.
6.1.5 Width
This field specifies the total number of digits there are in the numeric indicator at the specified address.
6.1.7 Macro
This field contains the Mapboard Macro (that you previously defined) that will be used to specify how the
SCADA database point values drive the indicators. Select the Macro from the drop-down list. See
Chapter 4, Macro, for a discussion on Macros.
For the CIS protocol, when defining Macros for numeric displays, the lamp actions that are available are
OFF, ON, Slow Flash and possibly Fast Flash.
For the Mauell protocol, when defining Macros for numeric displays, the lamp actions that are available
are OFF, ON, Slow Flash, Fast Flash, Dim and Modulate.