Roclink 800
Roclink 800
Roclink 800
December 2017
This manual may be revised periodically to incorporate new or updated information. The revision date
of each page appears at the bottom of the page opposite the page number. A change in revision date
to any page also changes the date of the manual that appears on the front cover. Listed below is the
revision date of each page (if applicable):
Page Revision
All Pages December-2017
All Pages November-2016
All Pages January-2016
All Pages March 2013
Initial release December 2010
ii Revised December-2017
ROCLINK 800 Configuration Software User Manual (for ROC800-Series)
Contents
Chapter 1 – Introduction 1-1
1.1 ROCLINK 800 Software Basics ..................................................................................................... 1-1
1.2 Computer Requirements ................................................................................................................ 1-2
1.3 Contacting Technical Support ........................................................................................................ 1-2
1.4 Software Installation ....................................................................................................................... 1-2
1.4.1 Installing ROCLINK 800 under Microsoft Windows 10, Windows 8 or
Windows 7........................................................................................................................ 1-3
1.4.2 Un-installing ROCLINK 800 ........................................................................................... 1-26
1.5 Starting ROCLINK 800 Software .................................................................................................. 1-26
1.5.1 Logging On..................................................................................................................... 1-26
1.6 User Interface Basics ................................................................................................................... 1-28
1.6.1 Device Dynamic Interface .............................................................................................. 1-29
1.6.2 Standard Buttons ........................................................................................................... 1-30
1.6.3 Toolbar Buttons .............................................................................................................. 1-31
1.6.4 Configuration Tree Menu ............................................................................................... 1-33
1.6.5 Keystrokes ..................................................................................................................... 1-33
1.6.6 Help System ................................................................................................................... 1-34
1.6.7 Basic Navigation ............................................................................................................ 1-35
1.6.8 Text Boxes ..................................................................................................................... 1-37
Index I-1
Chapter 1 – Introduction
In This Chapter
1. Extract the .zip file to the local hard drive (for example, in the
C:\TEMP\directory) or place the DVD-ROM into the drive.
2. Double-click the setup.exe file if the Installation Wizard does not
automatically launch. The Installation Wizard screen appears
3. Click Next in the ROCLINK 800 Welcome screen. Read the License
Agreement and click Yes to accept it. Enter your Name and
Company name, and click Next.
The program installs the software in the default recommended
directory C:\Program Files\ROCLINK800 or C:\Program Files (x86)
\ROCLINK800. Select an alternative destination folder if you want to
install the software in a folder other than the default.
4. Follow the setup installation instructions.
5. Click Finish in the Wizard Complete screen.
Note: You may need to restart your PC to complete the installation.
5. Click OK to save your changes and close the User Account Control
Settings window.
Note: You must have Administrator rights to make this change.
Click Yes (and enter Administrator password if necessary) if
Windows asks if you want to allow the changes.
6. Reboot the computer for your changes to take effect.
7. Start ROCLINK 800. Refer to Starting ROCLINK 800 Software
(located in this chapter).
Disabling User Account Control (Windows 8)
Note: User Account Control must remain disabled in order to run
ROCLINK 800.
To disable User Account Control:
1. Select Search and type UAC into the Search field.
.
Figure 1-4. Search
4. Click OK to save your changes and close the User Account Control
Settings window.
Note: You must have Administrator rights to make this change. Click
Yes (and enter Administrator password if necessary) if Windows
asks if you want to allow the changes.
7. Click OK to save your changes and close the User Account Control
Settings window.
Note: You must have Administrator rights to make this change. Click
Yes (and enter the Administrator password if necessary) if
Windows asks if you want to allow the changes.
.
8. Reboot the computer to apply the changes.
9. Start ROCLINK 800. Refer to Starting ROCLINK 800 Software
(located in this chapter).
Changing Region Settings (Windows 10)
To avoid potential error when opening configuration files, we recommend
that you change your PC’s location to United States.
To change your PC’s location:
1. Right-click the Start menu and select Search from the pop-up menu.
1. Right-click the Start menu and select Search and from the pop-menu.
Note: You must have Administrator rights to make this change. Click
Yes (and enter the Administrator password if necessary) if
Windows asks if you want to allow the changes.
.
8. Reboot the computer to apply your changes.
9. Start ROCLINK 800. Refer to Starting ROCLINK 800 Software.
1.4.2 Un-installing ROCLINK 800
To remove ROCLINK 800 from your PC:
7. Click the Windows Start button.
8. Select Settings > Control Panel.
9. Double-click the Add/Remove Programs icon.
10. Select ROCLINK 800.
11. Click Add/Remove.
12. Follow the instructions.
1.5.1 Logging On
To log on to ROCLINK 800:
1. Connect the ROC to the Local Operator Interface (LOI – Local Port)
and launch ROCLINK 800.
Typically, your initials are your User ID. If User IDs have not yet been
assigned, try using the default User ID of LOI. You assign User IDs
using the ROC > Security features of ROCLINK 800.
1. Type your assigned 4-digit Password and click OK.
For added security, the software displays an asterisk for each number
that you type. If passwords have not yet been assigned, use the default
password of 1000 (valid with default User ID of LOI).
2. ROCLINK 800 validates the User ID and Password you enter against
a predefined list.
If the log on is not valid, a dialog box appears. Click OK and re-enter
the User ID and Password. You can repeat the procedure as many
times as needed until you successfully enter a valid User ID and
Password. If the log on is valid, ROCLINK 800 displays the Device
Directory screen.
To exit from the log on screen, press Esc or click Cancel. This closes
ROCLINK 800 and returns you to the point where you started ROCLINK
800.
Menu Options
File New, Open, Download, Close, Save Configuration, Print
Configuration, Print, Print Setup, [List of recent files], Exit
View Directory, EFM Report, Calibration Report, History, Alarms,
Events, Weights & Measure Events, Display, I/O Monitor,
Toolbar, Refresh User Program Tree
ROC Direct Connect, Connect, Disconnect, Collect Data, Clock,
Security, Comm Ports, Information, Flags
Note: The Direct Connect menu option is the default; it
directs ROCLINK 800 to connect with any available
valid connection. The Connect menu option becomes
available when you select a connection option (COM1,
COM2, Ethernet, and such.) from the Device Root. By
clicking Connect, you tell ROCLINK 800 to use that
specific communications connection.
Configure I/O, Control, History Segments, History Points, Opcode
Table, MODBUS
Utilities Update Firmware, License Key Administrator, Convert EFM
File, User Program Administrator, ROCLINK 800 Security, AI
Calibration Values, RTD Calibration Values, MVS Calibration
Values, FST Editor, Custom Display Editor, Custom EFM
Report Editor, Read File From Device, Communications
Monitor
User (Located under the Configuration Tree) LiquidCalcs,
Programs Transaction History, Printer, Additives, Batching, Keypad
Display
Tools Options
Window Cascade, Tile, Device Directory, [List of open windows]
Help Help Topics, About ROCLINK 800
Closes a window.
Button Description
Pastes text currently in the Clipboard at the cursor’s current
location.
Note: Currently not available.
Prints the configuration file.
Note: Currently not available.
Connects to a device locally using the (LOI) Local Operator
Interface port.
Button Description
Launches the ROCLINK 800 on-line help system.
With a menu displayed, you can highlight the desired item by using the
Down Arrow () and Up Arrow () keys or the mouse. Once you have
highlighted an item, press Enter to activate the function.
To leave a menu or submenu, press Esc. You can then select another
menu. You can also access another menu using and .
The text scrolling keys are Page Up and Page Down.
To use the keyboard in configuration screens and dialog boxes, press Tab
to move in a predetermined sequence from one parameter field or button
to the next. The selected field or button becomes highlighted. Fields
unavailable for changes are automatically skipped.
When you Tab to the last field or button in the screen or dialog box,
pressing Tab again jumps back to the first field or button. To go back to a
previous field or button, press Shift + Tab.
In an option field, the currently selected option is highlighted. To select
one of the other options, use or to highlight the desired option and
then press Enter.
In a field that requires a text or numerical entry, type in the required
characters or numbers from the keyboard. Use Backspace or Delete to
erase unwanted characters. Use and to move the cursor one
character at a time and Home and End to place the cursor at the
beginning and end of the field, respectively.
Other keys or key combinations include:
▪ F1 – Launches ROCLINK 800 on-line help.
▪ Esc – Cancels the current activity, closes the screen, and returns you
to the last-used place in the menu structure, screen, or other place
from which the dialog box originated. If a menu is active, Esc closes
the last-opened menu, taking you up one level in the menu structure.
If the menu bar is active, Esc de-selects all menu options. Press Alt or
click with the mouse to reactivate the menu bar.
▪ Ctrl + N – Creates a new configuration file.
▪ Ctrl + O – Opens a configuration file.
▪ Ctrl + S – Saves the current configuration file.
1.6.6 Help System
The Help menu provides detailed on-screen information about getting
started with ROCLINK 800 and performing keyboard operations, a list of
the Help topics, and the ROCLINK 800 version.
To display context sensitive help on a field, a parameter, or a button,
press F1 while the field, parameter, or button is highlighted. A help
window appears on the screen.
To view detailed help, select Help > Help Topics from the menu bar.
Table 1-2. Help System
Option Description
Contents Presents a list of Help Topics that display based on task-
oriented situations. Each screen, tab, and field has a help
topic associated with it. For example: the MODBUS Scale
Values tab is located under Modbus > Modbus
Configuration > Scale Values tab.
Index Locates specific Help Topics. The Index lists each field by the
tab or screen in which the field appears.
Search Activates a search function on a specific word.
Back Returns to the last topic that you viewed.
Print Sends the currently displayed topic to the PC’s default
printer.
See Also Displays topics related to the currently selected topic.
<< / >> Navigates forward (>>) or backwards (<<) through the help
system on a per topic basis. The Browse Sequence follows
the order of the topics as displayed in the Contents tab.
TLP Selections In many locations in ROCLINK 800, you can click the TLP Browse
button (a button with three dots) to view the Select TLP dialog. The
Select TLP dialog allows you to assign specific inputs and outputs to
parameters. ROCLINK 800 uses Point Type (T), Logical Number (L),
and Parameter (P) to define point locations.
Display TLP Displays values on the Select TLP screen as either text or numbers. For
example, the TLP for Register 2 of FST 1 could display as either "FST
1,R2" or "96, 0, 3".
Auto Scan Update Select Tools > Options to set the time interval, in seconds, at which the
Interval Auto Scan feature on various screens in ROCLINK 800 polls the ROC.
Clicking Auto Scan causes ROCLINK 800 to poll the device
automatically until you click Stop Scan.
This chapter describes the Device Directory screen and the Device Root,
the graphical representation of all devices, which appears on that screen.
This backup file enables you to restore your settings in case they ever
become corrupted.
You can configure devices on-line communications using the Local
Operator Interface (LOI) Port (also known as the "local port") or a
communication port, such as a modem.
2.2.2 Adding a Group
You can organize devices into groups. Typically, groups contain devices
in the same geographical area or with another common feature. When
you double-click a group icon, ROCLINK 800 displays all devices or
subgroups associated with that group.
To add a new group to the device root directory:
1. Right-click the Device Root icon. A pop-up menu displays.
2. Select Add a Group. ROCLINK 800 adds the new group icon to the
device root graphic.
3. Click Yes to delete the group and all subordinate groups and devices
in that group.
2.2.4 Adding a Device
To add a new device to the device root:
1. Right-click the device root icon. A pop-up menu displays.
2. Select Add a Device. ROCLINK 800 adds a device icon to the
device root.
3. Click Yes. ROCLINK 800 deletes all devices in the device root.
3.1 Communications
Before you attempt to connect to a ROC, you must configure
communication parameters in two places:
▪ ROCLINK 800 Communications
Configure device communications on the Device Directory screen
(Device Directory and Device Root). This sets the PC’s comm ports
to communicate with a specific device.
▪ Communication Ports on the ROC800-Series
Select ROC > Comm Ports to access the Comm Port screen and
configure the device communication ports for incoming or outgoing
communications. Refer to the Communication Ports section.
Field Description
Tag Sets a unique name for the ROC800-Series. Enter
up to 50 alphanumeric characters to identify the
device.
Connect Click to communicate with the PC using the
parameters you configure for this PC’s
communications port.
Device Address Sets the address of the specific ROC800-Series
with which you desire to communicate. If you
connect to a multi-drop series of devices, enter the
Device Address and Device Group of the specific
device.
Note: The default values for the Device Address
and Device Group are both 240. .
Device Group Associates the ROC with a specific group. The
default Device Group is 240.
Note: If you connect a PC running ROCLINK 800
directly to the device’s LOI (Local Port),
ROCLINK 800 makes a request to Device
Group of 240 and Device Address of 240.
The Local Port of a device always responds
to a request for Address 240 and Group
240, no matter what Device Address and
Device Group is configured in the device if
the LOI Security is valid.
Field Description
Host Address Identifies the PC’s host address, which by default is
Address 3. If more than one computer running
ROCLINK 800 communicates with a group of
devices (either by radio or by other multi-drop
communications), you must define unique host
address for each device to avoid multiple
responses. The host address must also be different
from any other host system that may access the
communications link.
Use the following host group and host address
conventions: 0 and 240 are reserved
Host Group Identifies the PC’s host group, which by default is
1. When using ROC Protocol, the group address
must match the address defined at the destination
device in order for communications to properly
transmit.
Use the following host group and host address
convention: 0 and 240 are reserved
Use Sets the type of connection. Valid values are
Comm Port, Modem, or TCP/IP.
Note: If you select TCP/IP, ROCLINK 800 applies
only the Time Out parameter you define on
the Advanced tab. No other parameters
defined on that tab apply.
PC Comm Port Sets the PC comm port ROCLINK 800 uses for this
setup. The ROC can communicate through any of
the PC’s configured comm ports. The default comm
port is 1.
Note: This field is available only if you set the
Comm Port option. Before you select this
parameter, check to see which
communications ports are assigned in the
PC.
PC Baud Rate Sets the baud rate ROCLINK 800 uses to
communicate with the device through a serial port
(COM port). For successful communications, the
baud rate you set here must match the baud rate
on the PC. The default value is 19200. If you have
difficulties communicating to your device, set the
baud rate in both the device and the computer to
the default baud rate.
Note: This field is available only if you select the
Comm Port option.
Modem Indicates the modem ROCLINK 800 uses. Click ▼
to list all available modems. Only the modems
defined in the Windows Control Panel display.
Ensure that the modem you select is properly set
up.
Note: This field is available only if you select the
Modem option.
Field Description
Phone Number Sets the telephone number for the device
ROCLINK 800 dials.
Note: This field is available only if you select the
Modem option.
Override Default Indicates that ROCLINK 800 should use an
TAPI Init String override initialization string configuration. When
you select this option, you must provide an override
initialization string.
Note: This field is available only if you select the
Modem option.
IP Address Indicates the IP address for the TCP/IP connection.
Note: This field is available only if you select the
TCP/IP option.
Port Number Indicates the port for the TCP/IP connection.
Note: This field is available only if you select the
TCP/IP option.
Refresh Comm Port Click to enable ROCLINK 800 to refresh the listing
List of the displayed comm ports for the PC.
Field Description
Number of Retries Sets the number of times (after the initial attempt)
ROCLINK 800 tries to request data from the
specified device before reporting a timeout error.
Valid values are between 0 and 25. The default is
3. Use the Time Out parameter to adjust the
amount of time between retries.
Note: This parameter does not apply to the dial-
up modem, which only tries to establish a
connection once.
Tx Delay Sets, in seconds, the amount of time ROCLINK
800 waits before transmitting data. This delay
enables the request-to-send (RTS) line for the
amount of delay specified before transmitting data.
The default is 0.05.
Typically, this value allows a radio to fully stabilize
before the system applies data for transmission.
▪ For EIA-232 (RS-232) and dial-up modem
communications, set this value (and the value
in the Key Off Delay field) to 0 (zero) or the
default of 0.05 seconds.
▪ For EIA-485 (RS-485) and radio
communications, set this value to 0.1.
Note: These variables may change, based on
your situation. These are general values
that you need to assess for each
circumstance.
Time Out Sets, in seconds, the actual amount of time that
ROCLINK 800 waits to receive a valid message
after it sends a request to a device. The default is
3. Modem users typically accept the default value.
Do not set this field to 0 (zero). This prevents
ROCLINK 800 from timing out, and quickly
exhausts the retries.
Note: If you select TCP/IP as the communications
method on the General tab, ROCLINK 800
applies only the Time Out parameter. No
other parameters defined on that tab apply.
Key Off Delay Sets, in seconds, the amount of time ROCLINK
800 waits after transmitting a message before
turning off the ready to send (RTS) signal. The
default is 0. You can change this value to optimize
communications.
The default value should be sufficient for dial-up
modems and EIA-232 (RS-232) connections. For
radios, a value of 0.01 may be appropriate.
Host CRC Check Indicates whether ROCLINK 800 uses cyclical
redundancy checking. The default value is
Enabled.
Field Description
Comm Ports Sets the specific comm port to be configured. Click
▼ to display all valid selections.
Tag Sets a 10-character name (“tag”) to help identify
the comm port.
Comm Type This read-only field displays the type of
communications port, such as EIA-232 (RS-232)
or Ethernet.
Note: The message “No Module” appears in this
field when no communication module is
present in slots 1, 2, or 3.
Baud Rate Sets, in bits per second, the transmit and receive
data baud rate for the comm port. The default is
19.2K.
Parity Sets whether the communications controller
performs parity checks and, if selected, sets the
parity value (odd or even). The default value is
None.
Data Bits Sets the number of data bits contained in an
asynchronous byte, or character. The default is 8.
Field Description
Stop Bits Sets the number of stop bits contained in an
asynchronous byte, or character. The default is 1.
Key On Delay Sets, in seconds, the amount of time the
ROCLINK 800 waits after turning on the ready to
send (RTS) signal before beginning transmission.
The default is 0. You can change this value to
optimize communications.
The default value should be sufficient for dial-up
modems and EIA-232 (RS-232) connections. For
older radios, you may need to set this value to 0.2
seconds. For newer radios, 0.02 seconds should
be sufficient.
Key Off Delay Sets, in seconds, the amount of time ROCLINK
800 waits after transmitting a message before
turning off the ready to send (RTS) signal. The
default is 0. You can change this value to optimize
communications.
The default value should be sufficient for dial-up
modems and EIA-232 (RS-232) connections. For
radios, a value of 0.01 may be appropriate.
Note: These variables may change, based on
your situation. These are general values
that you need to assess for each
circumstance.
Field Description
Port Owner Sets the communication protocol this port uses
▪ ROC Plus Protocol/Modbus Slave
configures the port to automatically switch
between Modbus and ROC Plus Protocol
messages.
▪ ROC Plus Protocol Only configures the port
to only accept ROC Plus protocol messages
(Modbus Slave is disabled).
▪ Modbus Slave Only configures the port to
allow the ROC to act only as a Modbus slave
device (ROC Plus Protocol is disabled).
Note: Use the "Only" options only if the
messages received use this specific
protocol. Otherwise, select ROC Plus
Protocol/Modbus Slave if this comm
port is going to have both protocols
communicate on it.
▪ Modbus Master configures the port to allow
the ROC800-Series to poll Modbus devices.
▪ DS800 configures the port to download and
debug Development Suite 800 projects only.
You will not be able to connect two ROC units
together with this option. It is exclusively
configured for DS800/PC communications.
Note: Modems are not supported for the
DS800 communication type.
▪ LCD configures the port for communications
with a ROC800-Series Keypad Display.
▪ I/O Module configures this port to use the
communications protocol residing in the I/O
module.
▪ Reserved indicates that this port is reserved
and cannot be used for communications.
▪ User Program configures this port to use the
communications protocol residing in the
loaded user program. The user program
number here matches the user program
number in the Configuration Tree menu and
the User Program Administrator screen.
Field Description
Modem Type Sets the modem type. Valid values are None
(using a serial link to the host), External (using an
external modem), and Internal (using an internal
modem). The default is None.
Connect Time Sets, in seconds, the amount of time that
ROCLINK 800 waits after initiating a call to
receive a connect message from a device
(typically the modem) before it terminates the call.
The default is 60 seconds.
The Connect Time varies from system to system
and can take up to 60 seconds to make and
complete a dial up connection. If a successful
connection is made, the Disconnect Time begins.
Disconnect Time Sets, in seconds, the amount of time that
ROCLINK 800 waits for further activity on the line
before it hangs up. ROCLINK 800 resets this
timer after each valid receive signal.
Inactivity Time Sets, in seconds, how long ROCLINK 800 waits
without receiving a signal before resetting the
modem. ROCLINK 800 must receive a valid
receive counter to remain active. The default is
900.0 seconds.
Config Command Sets the string of characters the device requires
to initialize the modem. For external modems,
refer to the manufacturer’s literature. For an
internal modem, use the default value or the
modem card may not operate correctly. Refer to
your modem’s documentation for default Config
Command characters.
Field Description
Connect Command Sets the Hayes-style connect command the
device requires to contact the host. Typically, this
is the command ATDT followed by the telephone
number (for example, ATDT5155551212). The
unit requires this parameter for dial-out
operations, such as SRBX Alarming.
Disconnect Sets the Hayes-style disconnect command
Command required to disconnect the contact to the host.
Typically, this is the command ATH0.
Modem Status This read-only field shows the modem’s current
status result code. Valid values are:
Result Code Definition
0 = OK Successfully executed
command line
1 = CONNECT Connection established
2 = RING Ring signal detected
3 = NO CARRIER Carrier not detected/lost
4 = ERROR Error in command line
6 = NO DIAL No dial tone detected
TONE
7 = BUSY Busy signal detected
8 = NO ANSWER Line not picked up on the
called end
Field Description
SRBX Mode Sets the SRBX Mode for Spontaneous-Report-by-
Exception alarming on this comm port. The default
is Disabled.
SRBX Host Address Sets the address of the host to which the SRBX
feature communicates. The default value is 1.
SRBX Host Group Sets the group of the host to which the SRBX
feature communicates. The default value is 0.
Delay Sets, in seconds, the time the device waits
between attempts to transmit an SRBX or RBX
message. Each SRBX or RBX Attempts parameter
has an associated delay parameter. The default
for Delay #1 is 20 seconds, the default for Delay
#2 is 30 seconds, and the default for Delay #3 is
45 seconds.
Field Description
SRBX Attempts Sets the number of times the device attempts to
resend a message if it does not obtain a valid
response on the first try. "Attempt" refers to the
initial message plus any retries.
ROCLINK 800 provides three parameters. The
default for all parameters is Fixed Number. The
default value for SRBX Attempt #1 is 1. The
default value for SRBX Attempt #2 is 2. The
default value for SRBX Attempt #3 is 3.
Select Fixed Number to set how many times
ROCLINK 800 retries sending a message after the
first unsuccessful attempt. If you enter 0, no retries
occur. Select Continuous (255) to start
continuous retries that stop only when the host
acknowledges the SRBX alarm.
Fixed Number Sets the number of times
ROCLINK 800 retries sending a
message after the first
unsuccessful attempt. Enter 0 to
prevent retries.
Continuous Starts continuous retries that stop
only when the host acknowledges
the SRBX alarm.
SRBX Alarm Index This read-only field shows the current SRBX
alarm.
SRBX Status This read-only field shows the status of SRBX
messaging. Valid values are Active (SRBX alarm
is processing) or Inactive.
Field Description
Valid Receive Indicates the number of valid ROC Plus protocol
Counters or Modbus protocol messages the ROC800 has
received. Although these are incrementing values,
you can zero them out if necessary.
Successful This read-only field Indicates the time and date of
Message Time the last valid ROC Plus protocol or Modbus
protocol message received.
Transmit Counter Indicates the number of messages sent by the
ROC. This is an incrementing value that you can
zero out if necessary.
Invalid Message Indicates the number of ROC Plus protocol or
Bytes Modbus protocol bytes lost. This is an
incrementing value that you can zero out if
necessary.
Invalid Message This read-only field shows the time and date of
Byte Time the last invalid message.
3.7 Security
You control security in two ways:
▪ ROCLINK 800 Security: – Enables who can access (log on)
ROCLINK 800 software and the Access Level assigned to a user.
▪ Device Security – Enables who has access to the ROC Comm Ports
and the LCD.
Note: Security Access Levels enable you to control which users have
access to specific ROCLINK 800 functions.
4. Click OK to add the user and close the dialog. The Device Security
screen displays, showing the user you have just added.
Deleting a User To delete an operator ID:
1. Select ROC > Security.
2. Click an Operator ID to delete.
3. Click Remove.
4. Click Yes to the confirmation dialog. The Device Security screen
displays, showing that the operator ID has been removed.
Note: If you enable security on any port, at least one user must have the
highest level of security (level 5).
Use the File Menu to print, open, close, and save configuration files.
Configuration files contain all hardware and software settings for your
ROC800-Series.
4. Once you have completed the configuration, click Start. The Save
As dialog box displays.
5. Enter a file name for the configuration file. Configuration files for
ROCLINK 800 use the extension .800.
6. Click Save. ROCLINK 800 saves the new configuration file, and
displays the following dialog.
7. Click No to save the new configuration file and return to the New
Configuration File screen.
Option Description
I/O Lists all available inputs and outputs by type.
Control Displays the FST Registers, PID Loop, Radio Power
Control, Sampler/Odorizer, and DS800 options enabled
on the ROC > Information screen.
System Displays Comm Port, Device Flags, and Opcode Table
information.
Meter Lists all available gas meters and all stations.
History Displays all available History Segments and History
Points.
User Program Displays all user programs.
User Display Accesses custom displays stored in the configuration
file. The file can store a maximum of 246 displays (both
custom user displays and user program displays).
5. Select the appropriate module from the pop-up menu. An Add New
Module dialog displays.
6. Click Start to add the new module TLPs to the configuration file.
7. Click Finish. A dialog displays warning you that all offline and
online connections must be closed to complete the operation.
Any unsaved changes to other configuration files are lost when the
Caution connections are closed.
8. Click OK to close all online and offline connections and add the
new module to the configuration.
4.7 Print
Click Print or select Print from the File menu to print ROCLINK 800-
generated historical, event, and alarm log reports.
4.10 Close
Select File > Close to close the active screen.
Note: Because the graphic display is an active screen, selecting Close
can terminate the online connection.
4.11 Exit
Select File > Exit to exit the ROCLINK 800 program. The following
may occur:
▪ If you are currently editing a configuration file, ROCLINK 800
closes the file.
▪ If you are currently connected to a dial-up ROC, ROCLINK 800
issues the hang-up command to the modem.
▪ If you are currently online with a ROC, the connection automatically
terminates.
Use the View menu options to view the Device Directory; electronic
flow measurement (EFM) reports; calibration logs; history, alarms,
weights and measures, and events logs; create, view, and manage
custom displays, monitor I/O; view the toolbar; and update point tags on
the User Program configuration tree.
5.1 Directory
Select View > Directory to replace the ROC800-Series graphic image
or Configuration Tree with the Device Directory. The Device Directory
displays the root level of all devices and groups configured in
ROCLINK 800.
Note: You can also switch displays between the Device Directory and
the online device using the Windows option on the ROCLINK
800 menu bar.
5. Select a report file and click Open. The View EFM Report screen
displays, indicating the selected report file.
9. Use the options on the menu bar to print the report to a local printer
or convert the report file to another format. Figure 5-6 shows a page
of an example printed report.
Note: Select Utilities > Convert EFM File (from the menu bar) to
convert the report data to the PGAS or Coastal Flow data
format. See Chapter 9, Section 9.3, Converting EFM Report
Files for further information.
ROCLINK 800 provides several option buttons you can use to manage
report data:
Button Description
Plot Graphically displays history data based on criteria you
select. Refer to the Plotting History section for further
information.
Select New Re-displays the Select History Points screen, which you
can use to select new history values.
Note: This option is available only if you are viewing
data from the device.
Save Saves the log as a file on your PC, using one of the
following file name extensions based on the kind of
data.
▪ .MDB – Minute-based history log file.
▪ .PDB – Hourly/Periodic-based history file.
▪ .DAY – Daily-based history log file.
2. Select the points you want to monitor. Click the plus sign next to
each item to expand the selection. Click Select All or Deselect All
to select or deselect all points.
Note: Use the Select New button to redisplay the Select Points to
Monitor screen and select other I/O points to monitor.
5.9 Toolbar
Select View > Toolbar to display or hide the ROCLINK 800 toolbar. A
check mark appears next to the menu option when the toolbar is
available.
Use the ROC menu options to set system information for the ROC.
6.2 Connect/Disconnect
Use this option (which displays as Connect when you are not
connected and Disconnect when you are connected) to connect to the
ROC using a specific port and connection speed. You select the
preferred connection using the Device Directory.
You can also directly connect to the ROC by clicking the Connect icon
on the ROCLINK 800 menu bar.
Use this option to disconnect from the ROC. You can also disconnect by
clicking the Disconnect icon on the ROCLINK 800 menu bar.
Field Description
Collect Data for Selects the meters and/or stations from which data
Selected Meters is to be collected.
and/or Stations
Collect This read-only check box allows the Collect Data
function to save all values for EFM parameters in
an .EFM file.
Collect User Sets if the program collects user program and user
Program and User defined point data from the device to include in the
Defined Point Data report. Valid values are:
Yes The program collects all user program
and user defined point data from
the device to include in the report.
Field Description
Collect History Sets to report on all historical data or only data
collected between dates you specify. Valid values
are:
All Select to report on all historic data
Archived collected.
Data Note: This is the default value..
Specify Select to only collect data between
Start & End the Start Time and End Time dates
Times you specify.
Save Data Sets a file name (other than the default
C:\Program Files\ROCLINK800\Station
Name_address group_yyyy-mm-dd.efm) to which
the ROC saves .EFM information.
1. Select ROC > Collect Data. A Collect Device Data dialog box
displays.
9. Click Close.
Once you create this file, you can generate a report at any time (such
as in the office) and a connection with the device is no longer
necessary. The EFM Reports utility retrieves the data associated
with the requested meter run and time period from the *.EFM file
and formats this report for each meter run covering a specified
period of time.
Note: For the EFM Reports utility to function correctly, you must
configure the historical database in the device so that the
system can retrieve flow values from memory. Refer to
Configuring History Points (located in Chapter 7).
6.4 Clock
The internal real-time clock provides time-stamping and control of the
historical databases, Event Log, and Alarm Log.
Immediately after connecting to a ROC for the first time, set the clock to
Caution ensure proper logging of history.
Note: The user-selectable time stamp in the ROC reflects the time
either at the beginning or at the end of the period. Select
Configure > History Points > Setup tab to adjust this
preference in the History Time Stamp field.
1. Select ROC > Clock or click the Clock icon in the toolbar. The
Clock screen displays.
If the displayed
Device Date and Time
is not correct, use a
If the displayed combination of the
Device Date date, day, and time
and Time is fields to set the value.
correct, click
Today.
Field Description
Group Sets a number that identifies a group of ROCs for
communication purposes. All ROCs defined as an
area in the host must have the same group. Valid
values are 1 to 255.
Note: To avoid communications problems, do not
use 240. With ROC Protocol, the values in
the Address and Group fields must match
the address defined in the destination
device for communications to work.
You can use TCP/IP connections for Modbus RTU
encapsulated in TCP/IP, Modbus TCP/IP, and
ROC Plus Protocol communications. If you change
the default value of the Address or Group
parameters, then all Modbus RTU encapsulated in
TCP/IP, Modbus TCP/IP, or ROC Plus Protocol
over TCP/IP connections close, and you must re-
establish a connection.
Logical Indicates whether the ROC uses 16 or 8 logical
Compatibility Mode points per module. The default for a Series 2
CPU is 8 points.
Double Precision Indicates the value at which the double precision
Accumulators accumulators roll over. The default value is
1,000,000,000,000.0.
Weight & Measures Displays the current status of the system
Parameters regarding the weights & measures parameters. All
parameters (TLPs) in the ROC800-Series device
have an associated access type. For most
parameters, that access type is either Read/Only
or Read/Write. For the ROC800-Series, there is an
additional access type, named Read/Write
Conditional. Parameters of this access type are
considered to be significant, meaning they deal
with the configuration of the measurement
features. When the system is unlocked (as it is by
default), then parameters of this type may be
written to. When the system is locked by the user
(this can only be done by a user with the highest
level of security), then these parameters can no
longer be written to. They essentially become
Read/Only. To lock and unlock the system, see
Utilties > W&M Lock/Unlock.
Measurement Determines where changes to parameters will be
related events are stored. By default, this is the Weights &
logged to Measures Log. Some legacy systems are not
capable of reading the weights & measures event
log, and require events to be placed in the
standard event log. When this is necessary, select
Standard Event Log to record all events in the
standard event log.
Field Description
Modbus or ROC Plus Protocol
IP Port Number Sets the IP Port Number for the Modbus or ROC
Plus Protocol communications. The IP Port
Number identifies the port that the ROC monitors
for Modbus or ROC Plus protocol connections
when communicating over a TCP/IP connection.
The ROC Plus protocol default is 4000. The
Modbus default is 502. Port numbers 1113 and
1131 are reserved.
If you change the IP Port Number, the change
takes effect immediately. If you change the default
value of this parameter, all Modbus or ROC Plus
communications over TCP/IP connections close,
and you have to re-establish a connection.
Inactivity Time Sets the time, in seconds, ROCLINK 800 waits for
a valid Modbus or ROC Plus protocol message
before closing the connection. The default value
is 3600. This timer is in addition to the security
timeout. Set this field to zero (0) to disable the
timer.
Keep Alive Time Keeps a connection “alive” by periodically
transmitting of messages (probes). Indicate, in
seconds, the amount of idle time before the first
probe occurs. If the other side of the connection
fails to respond after ten consecutive probes, the
connection is considered broken and the
connection closes. The default is 0 (no messages
are sent).
After the first probe, ROCLINK 800 sends nine
other probes, 64 seconds apart. The total Keep
Alive Time is 486 seconds (9 x 64) plus the value
you enter in the Keep Alive Time field.
Active Connections This read-only field displays the total number of
active TCP/IP connections.
Note: This field is active only if you enable ARP
Protection. The Ethernet port supports up
to six ROC Plus connections, six Modbus
slave connections, and one Modbus Master
connection all at the same time.
Reset All Click to close all active Modbus or ROC Plus
Connections Protocol over TCP/IP connections. This button
returns to an un-pressed state when connections
are successfully closed.
ARP Protection Enables Address Resolution Protection (ARP)
storm protection, which limits the number of
incoming messages to the value you enter in the
Packet Queue Limit field and ignores the
remainder until the number of messages drops
below the value you enter. The default is
Disabled.
Packet Queue List Indicates a limit of incoming messages.
Note: This field is active only if you enable ARP
Protection.
Field Description
Address to Use Indicates the protocol address to use. Valid values
are Device Address, Slave Address, or Either
Device or Slave Address.
Slave Address Indicates, a specific address if you have chosen
Slave Address in the Address to Use frame.
Gratuitous ARP Enables the Gratuitous ARP functionality. A
Gratuitous ARP is a broadcast to every device on
the network, and enables each device to pre-
update its device listings.
GARP Init Timer Sets, in seconds, the amount of time the ROC
waits after the Gratuitous ARP is activated to
begin ARPing at the user-configured frequency.
Note: This field is active only if you enable
Gratuitous ARP.
Reset Timer Click to reset the GARP Init Timer to the
configured value. No ARPing will occur if you click
this button (or SCADA writes to this parameter as
a part of its normal polling sequence) before the
GARP Init Timer expires.
Note: This field is active only if you enable
Gratuitous ARP.
GARP Frequency Sets, in seconds, the ARP interval. The ROC
repeats at this interval (frequency) until it the
GARP Init Timer field is reset.
Note: This field is active only if you enable
Gratuitous ARP.
Field Description
Last Power Down These read-only fields show the date and time
Time/Last Power Up when the ROC was last connected to power (Last
Time Power Up Time) and when the ROC was last
disconnected from power (Last Power Down
Time).
Field Description
Baud Rate Sets the four baud rates the ROC can use at any
given time. A read-only display on the Comm
Ports General screen indicates which of the four
baud rate generators is currently in use.
Note: Do not change these baud rates unless
directed to do so by Technical Support
personnel.
Field Description
LCD Video Mode Sets the mode for the display. Dark Text on Light
Background is the default. Click Apply to
change the display mode.
LCD Backlight Shuts off the LCD automatically after a defined
Power Saving Mode amount of inactivity. The default is Disabled.
Inactivity Time Indicates, in seconds, how long the LCD backlight
remains on without activity before automatically
shutting off.
Note: This field is active only if you enable the
LCD Backlight Power Saving Mode.
LCD Firmware This read-only field shows the currently installed
Version version of firmware for the Keypad Display.
Auto Logout Period Indicates, in minutes, how long the display waits
inactive before automatically timing out and
logging out the current user.
Logout Scroll Time Indicates, in seconds, how long the display pauses
between parameter displays. For example, if you
configure 10 parameters, the LCD displays
parameters 1 through 5 and then parameters 6
through 10 after the amount of time set in this
field. The default value is 5 seconds.
Field Description
Board Health This read-only field shows the module’s health.
Valid values are:
OK Board is functioning correctly.
Module Not No module is currently
installed installed.
Communications ROC has lost communications
lost with the expanded backplane.
Boot Part Number This read-only field shows the part number of the
main startup (boot) firmware currently installed in
the module.
Boot Revision This read-only field shows the revision number for
the main startup (boot) firmware currently installed
in the module.
Note: This field is not valid for communications
modules.
Boot Build Date This read-only field shows the build date for the
main startup (boot) firmware currently installed in
the module.
Note: This field is not valid for communications
modules.
Data This read-only field shows additional module-
specific information.
Field Description
Over Threshold % This read-only field shows the percentage of
samples that have exceeded the value set in the
Threshold field.
Note: This value will not clear until the Reset
button next to it is pressed.
Reset (Threshold) Click to clear the value in the Over Threshold %
field.
Alarming Enable Place a check mark to enable the system to log an
alarm when the current load sample exceeds the
value in the Threshold field.
6.8 Flags
Use the selections on the Flags screen to perform actions that affect the
overall operation of the ROC. From this screen, you can save a
configuration to Flash memory and, if necessary, re-initialize the ROC.
Be very careful when using system flags. Selecting certain flags can
Caution lose data, change parameter values, and clear configuration memory.
Be sure you understand the function of any flag before changing it.
When you select ROC > Flags, ROCLINK 800 displays the Flags
screen and defaults to the Flags tab (see Figure 6-15).
Button Description
Save Configuration Click to save the current configuration to flash
memory.
When using a ROC800-Series, most configuration
settings (including calibration values and loads)
are stored into flash memory as the new
configuration after a cold start. All user flags are
maintained at their current status during this
process. Clicking Save Configuration temporarily
suspends all incoming communications. A running
FST is temporarily suspended, but restarts where
it was suspended.
Clear Clears flash memory.
Flash Write Status This read-only field shows the status of the
selected activity.
Reset (RST) Switch The ROC’s CPU module provides a Reset (RST) switch that you can
use to restart the ROC from the boot block of flash memory
(essentially a cold start) rather than from RAM (a warm start).
For further information, refer to Central Processing Unit (CPU) in
Chapter 2 of the ROC800-Series Remote Operations Controller
Instruction Manual (Part D301217X012).
Note: Options that are “grayed out” on the menu (such as AO Points)
indicate modules which are not currently installed in the
connected ROC800-Series and therefore not configurable.
Configuring a ROC800-Series is a matter of establishing points and then
configuring various parameters.
Each input and output has a unique point number to identify the input or
output. The point number indicates the location of the point at the slot
number of the I/O module and channel number in the ROC800-Series.
For example, DI 2-1 indicates the point number for a discrete input at
module slot number two, first channel.
The Analog Input screen has four tabs. Use each tab to configure a
component of the input.
▪ Use the General tab to set the basic parameters for the analog input
point.
▪ Use the Advanced tab to configure features, such as filtering, A/D
conversions, and clipping for the selected analog input.
▪ Use the AI Calibration tab to calibrate the AI point while on-line.
▪ Use the Alarms tab to set the alarm parameters for this AI point.
Note: You enable alarming on the Alarms tab. If you enable
alarming, the limit alarms (four levels, Rate, and Deadband)
are configured on the Alarms tab. To conserve Alarm Log
space, alarms should be enabled only when necessary. Even
if you do not plan to use all the alarms, check and adjust the
value of each one so that no false alarms generate.
Save After you configure a point and click Apply, click Flash Memory Save
Configuration Configuration (on the ROC > Flags screen) to save I/O configuration
to permanent memory in case you must perform a cold start.
Field Description
Analog Inputs Selects the analog input to be configured. Click ▼
to display all available analog inputs.
Note: The selection in this field applies to each
tab on this screen.
Tag Provides a 10-alphanumeric character identifier
associated with each point type.
Note: The selection in this field applies to each
tab on this screen.
Point Number The read-only field shows the rack location for
this point.
Value This read-only field shows the value from the
field device. When scanning is disabled, you can
write to the failsafe or download value and then
choose either the User Failsafe or User Download
option in the Off Scan Mode frame on the
Advanced tab.
Units Shows the engineering for the I/O (such as IN
H2O, PSIG, MCF, degrees F, milliamps, or volts).
Scan Period Sets, in seconds, how frequently the system
scans the input to acquire the Value when you
enable scanning. Each AI updates based on its
individual scan period.
Low Reading EU Sets the engineering unit (EU) for the low reading
to zero percent input. For example, if a
temperature transmitter is connected to the
analog input with a range of – 40 to 160 degrees
F, the Low Reading EU would be set to – 40.
Field Description
High Reading EU Sets the engineering unit (EU) for the high
reading to 100 percent input.
For example, if a temperature transmitter is
connected to the analog input with a range of – 40
to 160 degrees F, set this value to 160.
Active Alarms This read-only field shows any alarms that are
active for this point. If you enable alarming, any
active limit alarms (such as Low Alarm and Rate
Alarm) display. Even if you disable alarming, the
Point Fail alarm (hardware reports a malfunction)
and Manual (Scanning Disabled) indicators can
still appear.
Scanning Sets the scanning option for this point. Valid
values are Enabled (automatically process the
field input and display the last analog input scan in
the Value field) or Disabled (permit only manual
updates of the Value field).
Note: If you enable alarming, the ROC generates
a Manual Mode alarm when scanning is
disabled. If you disable scanning, you must
manually enter a value to override the
input.
Field Description
Filter Sets the Filter percent (ENTERED_DATA) as a
weighted sample using a percentage of the last
value plus a percentage of the new value.
Notes:
▪ You can calibrate inputs for up to five points (zero, span, and up to
three mid-points). You must define at least two points (zero and
span) for calibration.
▪ If you leave the ROC idle during calibration, the ROC times out and
resumes normal processing. Calibration values are restored to the
previous values, an event is logged, and you must reconnect to start
calibration from the beginning.
▪ Click Cancel to exit the calibration without saving the changes. The
ROC retains the previous calibration settings and logs an event.
Field Description
Freeze Click to stop the system from updating analog,
MVS, DVS, HART, or temperature (RTD) inputs
during verification or calibration. Once you click
Freeze, the input is frozen at the current Freeze
Value.
Scan Mode This read-only field displays the current input
status. Valid values are:
Manual The system is in manual mode.
Normal Poll The system is functioning
normally
Input Freeze After you click Freeze, input is
frozen and activates Verify and
Calibrate.
Poll Mode Sends an initial communication
to a sensor to gather all the
configuration data stored on that
sensor.
Off Scan The sensor is disabled
Freeze Value This read-only field shows the value received
from the analog input, DVS, HART, MVS, RTD, or
meter inputs when the Update button was last
clicked. The system uses these values in ongoing
processing (such as flow calculations, history
logging, or control) while calibration occurs.
Verify Click to start the verification process.
Calibrate Click to begin calibration and display the Set Zero
dialog.
Update Click to request a value update from the input to
be used as the Freeze Values.
Zero Click to set adjustment factors for the input. The
Shift/Offset/RTD value is sent to the device for:
Bias ▪ Zero Shift – Zeros the static pressure effect
for the differential pressure input (Set Offset).
▪ Offset – Sends the value of the live reading to
set the reading as close to zero as possible for
a static pressure inputs (Measured Pressure
Reading).
▪ RTD Bias – Calibrates the offset (shift) of
temperature throughout the RTD curve
(Temperature Standard Reading).
Verifying an Use this process to verify that the analog input is within operating
Analog Input limits.
2. From the AI Calibration tab, click Freeze to stop the values of the
input from being updated during verification. ROCLINK prompts you
to create a calibration report file.
Note: The Freeze Value field displays the value received from the
input when you clicked Freeze. This is the value the system
uses in ongoing processing (such as flow calculations and
history logging) while performing calibration.
5. Review the value in the Scan Mode field. Valid values are Normal
(point scanning is enabled and is updated each scan period) or
Manual (the point is not in scanning mode).
6. Click Verify. A Verify dialog displays.
Field Description
Action Indicates the current action. Valid values are
Verify or Calibrate.
Actual Displays the value in the Live Reading field.
Expected Displays the value in the Dead Weight/Tester
Value field.
Deviation Displays the amount of deviation between the
actual and expected values.
% Deviation Displays a percentage deviation between the
Actual and Expected values.
9. As the live reading value changes, click Log Verify as many times as
necessary to establish the verification log.
10. Typically you verify the same points you calibrate. Temperature
might be an example (– 100, 200, 50). For each test point, you set
your test equipment to produce the expected value, enter that
expected value in the Tester Value field, wait for live input to
stabilize, and then click Log Verify. You can verify as many points
as you want.
11. Click Done. The AI Calibration screen displays.
12. If your verification is satisfactory, click OK to close the Analog Input
screen. If you need to calibrate the AI, proceed to Calibrating an
Analog Input.
Calibrating an Use this process to calibrate an analog input.
Analog Input
1. Select Configure > I/O > AI Points. The Analog Input screen
displays.
2. From the AI Calibration tab, click Freeze to stop the values of the
input from being updated. ROCLINK prompts you to create a
calibration report file.
Note: The Freeze Value field displays the value received from the
input when you clicked Freeze. This is the value the system
uses in ongoing processing (such as flow calculations and
history logging) while performing calibration.
Note: A calibration requires only two points (zero and span). Your
organization determines whether additional points (midpoints
1, 2, or 3 typically at 25%, 50%, and 75% respectively) are
necessary for a calibration. For this example, we set one
midpoint.
11. Click Set Mid 1.
12. ROCLINK 800 completes the Set Mid 1 entry in the calibration log
and activates the Set Mid 2 button.
13. If you do not wish to configure additional midpoints, click Done. The
AI Calibration screen displays.
When the AI Calibration screen displays, you can calibrate inputs for
another AI by starting again at step 1.
Field Description
Alarming Sets the alarm option for the selected point. Valid
values are Enabled (configures the limit alarms -
four levels, Rate, and Deadband) or Disabled
(does not generate limit alarms).
Note: The Point Fail alarm may appear in the
Active Alarms field, but is not logged in the
Alarms file. If you enable alarming, the
system generates an alarm if you disable
scanning.
RBX Sets the Spontaneous Report-by-Exception
(SRBX or RBX) alarming for this point. Valid
values are On Alarm Set (which generates an
RBX message to the host when the point enters
an alarm condition) and On Alarm Clear (which
generates an RBX message to the host when the
point exits an alarm condition).
Note: RBX alarming requires you to configure the
communications port.
HiHi Alarm Sets, in engineering units, a value to which the
input value must rise to generate a HiHi Alarm.
Note: Typically you set the value for the HiHi
Alarm higher than the value for the High
Alarm.
High Alarm Sets, in engineering units, a value to which the
input value must rise to generate a High Alarm.
Low Alarm Sets, in engineering units, a limit value to which
the input value must fall to generate a Low Alarm.
Field Description
LoLo Alarm Sets, in engineering units, a limit value to which
the input value must fall to generate a LoLo
Alarm.
Note: Typically you set the value for the LoLo
Alarm lower than the value for the Low
Alarm.
Rate Alarm Sets, in engineering units, a value that represents
the maximum amount of change allowed in the
calculated rate between updates before an alarm
generates. If the change is equal to or greater than
this value, an alarm occurs.
Note: To disable this Rate Alarm without
disabling the other alarms, set the value
greater than the scan value of the analog
input.
Alarm Deadband Sets, in engineering units, an inactive zone above
the Low Alarm limits and below the High Alarm
limits. The Alarm Deadband prevents the alarm
from being set and cleared continuously when the
input value is oscillating around the alarm limit.
This prevents the Alarm Log from being over-filled
with data.
The Analog Output screen has three tabs. Use each tab to configure a
component of the output:
▪ Use the General tab to set the basic parameters for the analog
output point.
▪ Use the Advanced tab to configure features, such as on-restart
power settings and RBX alarming.
▪ Use the Alarms tab to set the alarm parameters for the AO point.
Save After you configure a point and click Apply, click Flash Memory Save
Configuration Configuration (on the ROC > Flags screen) to save I/O configuration
to permanent memory in case you must perform a cold start
Field Description
Analog Outputs Selects the analog output to be configured. Click
▼ to display all available analog outputs.
Note: The selection in this field applies to each
tab on this screen.
Tag Provides a 10-alphanumeric characters) identifier
associated with each point.
Note: The selection in this field applies to each
tab on this screen.
Point Number This read-only field shows the rack location for
this point.
Auto Value Reads the value from the field device. When
scanning is disabled, enter a value to override the
output. If scanning is enabled, this field displays
the last analog scan in engineering units.
Units Sets the engineering units for the I/O (such as IN
H2O, PSIG, MCF, degrees F, milliamps, or volts).
Field Description
Low Reading EU Sets the engineering unit (EU) for the low reading
to zero percent output (low end of the EU range).
Based on the EU range determined in part by this
parameter, the EU value is converted to a
corresponding analog signal.
High Reading EU Sets the engineering unit (EU) for the high reading
to 100 percent output (or high end of the EU
range). Based on the EU range determined in part
by this parameter, the EU value is converted to a
corresponding analog signal.
Manual Value When the Scanning Mode is set to Manual, use
Manual Value to enter the value instead of the
Auto Value field.
Physical Value The read-only field shows the current state of the
AO. When the AO is in Manual Mode, this should
reflect the Manual Value. When the AO is in Auto
mode, this should reflect the Auto Value.
Scanning Mode Sets the scanning option for this point. Valid
values are Auto (automatically process the field
input and display the last analog output scan in the
Auto Value field), Disabled (do not permit any
updates of the Auto Value or Manual Value fields),
or Manual (enter the value in the Manual Value
field).
Note: If you enable alarming, the ROC generates
a Manual Mode alarm when Scanning is
Disabled.
Active Alarms This read-only field shows any active alarms for
this point. When you Enable alarming, the limit
alarms (such as Low Alarm and Rate Alarm) that
are active appear. Even if you Disable alarming,
the Point Fail (hardware reports a malfunction)
alarm and Manual (Scanning Disabled) indicators
can still appear.
Note: A read-back error indicates the AO is
driving the output to a set level, but the loop
is not responding. Example: An I/P
converter is connected to the A/O and set
to 25%. If the I/P is not connected or an
open wire occurs, a read-back error would
display.
Field Description
Raw D/A Output This read-only field shows the current counts
written to the digital-to-analog converter. The D/A
value set to the AO is the raw D/A output. The
default value is 0.
Adjusted D/A 0% Sets the count the digital-to-analog converter uses
for zero percent output. This value is also used to
scale the output to engineering units. The default
is 0.
Adjusted D/ A 100 % Sets the count decoded by the digital-to-analog
converter for 100 percent output. This value is also
used to scale the output to engineering units.
Value After Reset or Sets what value the system uses on a power
Power Fail restart or a warm start. Valid values are Retain
Last Value (maintain last output value ) or Use
Failsafe Value (use specified value ). Retain Last
Value is the default.
Note: If you select Use Failsafe Value, you must
also complete the Failsafe Value field.
Failsafe Value If you select Use Failsafe Value, complete this
field to indicate a value the system uses on a power
restart or a warm start.
Field Description
Alarming Sets Alarming to generate alarms on point failure.
When Alarming is Disabled, the Point Fail alarm
appears in the Active Alarms field, but will not be
written to the Alarm Log.
To conserve Alarm Log space, enable alarms only
when necessary. Even if you do not plan to use all
the alarms, check and adjust the value of each
one so that no false alarms generate.
RBX Sets the RBX Alarming option to configure
Spontaneous-Report-By-Exception (SRBX or
RBX) alarming for this point. Valid values are On
Alarm Set (which generates an RBX message to
the host when the point enters an alarm condition)
and On Alarm Clear (which generates an RBX
message to the host when the point exits an
alarm condition).
Note: RBX Alarming requires you to configure the
communications port.
The Discrete Input screen has three tabs. Use each tab to configure a
component of the input.
▪ Use the General tab to set the basic parameters for the DI point.
▪ Use the Advanced tab to configure features, such as filtering, input
inversion, and counter values for the discrete output.
▪ Use the Alarms tab to set the alarm parameters for this DI point.
Save After you configure a point and click Apply, click Flash Memory Save
Configuration Configuration (on the ROC > Flags screen) to save I/O configuration
to permanent memory in case you must perform a cold start
Field Description
Discrete Inputs Selects the discrete input to be configured. Click
▼ to display all available discrete inputs.
Note: The selection in this field applies to each
tab on this screen.
Tag Sets a short (10 alphanumeric characters)
identifier for the point.
Note: The selection in this field applies to each
tab on this screen.
Point Number This read-only field shows the rack location for
this point.
Module Scan Period Sets, in seconds, how frequently the system scans
the input.
Status Sets the state of the discrete input. Valid values
are On (indicates that a contact is closed or input
is on) or Off (indicates that a contact is open or
input is off). Off is the default.
Physical Status This read-only field shows the state of the
hardware. Off normally indicates that a switch is
open; On normally indicates that a switch is
closed. This may be different from the Status if
Inverting or Latching is in effect.
Scanning Sets the scanning option for this point. Valid
values:
Enabled Automatically process the field
input.
Disabled Do not process the imput.
Field Description
DIN Type Sets how the DI functions. Valid values are
Standard (follow the actual field input) and
Latched (maintain the input status). During an
active transition from off to on, Latched mode
enables the DI to remain in the on state until you
clear the Status parameter either manually or
through the software.
Active Alarms This read-only field shows any active alarms for
this point. When you enable alarming, the limit
alarms (such as Low Alarm and Rate Alarm) that
are active appear. Even if you disable alarming,
the Point Fail (hardware reports a malfunction)
alarm and Manual (Scanning Disabled) indicators
can still appear. Refer to User Interface Basics.
Field Description
Input Sets the state of the input. Valid values are
Normal (field input operates normally, so that On
is On) or Inverted (inverts the field input in the
Status field so that On becomes Off and vice-
versa). Normal is the default.
In the Inverted state, an open circuit in the field
would then be indicated as On in the Status field,
and closed contacts would be indicated as Off.
Field Description
Filter Sets, in seconds, the amount of time that the
discrete input must remain in the On (high) state
before the device recognizes it as such. Enter a
value between 0 to 255. The discrete input returns
to the Off state immediately upon detection of the
On to Off transition; there is no filtering for this
transition.
Accumulated Value Counts the number of times the discrete input
goes from Off to On. The accumulator is a 32-bit
number with a maximum count of 4,294,967,295.
You can preset the accumulator by entering the
desired value or clear the accumulator by entering
0.
On Counter Counts the number of 50-millisecond periods
when the Status parameter is in the On state. The
On Counter is a 32-bit number that automatically
rolls over when it reaches its maximum value. You
can preset the On Counter by entering the desired
value or clear the counter by entering 0.
Note: The On Counter does not function if you
disable scanning.
Off Counter Counts the number of 50-millisecond periods
when the Status parameter is in the Off state. The
Off Counter is a 32-bit number that automatically
"rolls over" when it reaches its maximum value.
You can preset the Off Counter by entering the
desired value or clear the counter by entering 0.
Note: The Off Counter does not function if you
disable scanning.
Actual Scan This read-only field shows the actual amount of
time in seconds that passes between scans. This
number should be the same as shown for the
Module Scan Period parameter if the system is not
overloaded.
Field Description
Alarming Sets the alarm option for the selected point. Valid
values are Enabled (generates an alarm when the
point’s status changes) or Disabled (no alarm
generates). The default is Disabled.
When you disable alarming, the Status Change
alarm appears in the Active Alarms field, but is not
written to the Alarms log.
Note: The Point Fail alarm may appear in the
Active Alarms field, but is not logged in the
Alarms file. If you enable alarming, the
system generates an alarm if you disable
scanning.
RBX Alarming Sets the Spontaneous-Report-by-Exception
(SRBX or RBX) alarming for this point. Valid
values are On Alarm Set (which generates an
RBX message to the host when the point enters
an alarm condition) or On Alarm Clear (which
Generates an RBX message to the host when the
point exits an alarm condition):
Note: RBX Alarming also requires you to
configure the communications.
Select Configure > I/O > DO Points. The Discrete Output screen
displays.
Examine the default settings and adjust the parameters to suit your
application on each of the tabs.
▪ Use the General tab to set the basic parameters for the DO point.
▪ Use the Advanced tab to configure accumulated value and state for
reset for the selected DO.
▪ Use the TDO Parameters tab to configure TDO parameters.
▪ Use the Alarms tab set the alarm parameters for this DO point.
Save After you configure a point and click Apply, click Flash Memory Save
Configuration Configuration (on the ROC > Flags screen) to save I/O configuration
to permanent memory in case you must perform a cold start
Field Description
Discrete Outputs Selects the discrete output to be configured. Click
to display all available discrete outputs.
Note: The selection in this field applies to each
tab on this screen.
Tag Provides a 10-alphanumeric character identifier
associated with each point.
Note: The selection in this field applies to each
tab on this screen.
Point Number This read-only field identifies the rack location for
this point.
Time On This read-only field shows, in seconds, the
amount of time for momentary operation. The
default value is 1.0 seconds for a DO. The default
value is 5 milliseconds for an ACIO DO.
Note: In Momentary mode, this is the amount of
time (in seconds) that the momentary
contact is energized. In the Toggle mode,
this is the time (in seconds) between
switching On or Off. In the TDO and TDO
Toggle modes, the TDO configuration
calculates this value.
Auto Output Indicates the state of the discrete output. Valid
vaules are Off (the output is off or a switch is
open) and On (the output is on or a switch is
closed). The default is Off.
Manual Output Indicates the state of the discrete output. Valid
values are Off (the output is off or a switch is
open) and On (the output is On or a switch is
closed). Select On and click Apply to force one
transition of the DO.
Field Description
Momentary This read-only field shows the state of the
discrete output when the DOUT Type is set to
Momentary. Valid values are Off (the output is off
or a switch is open) and On (the output is on or a
switch is closed).
Physical Output This read-only field shows the actual status of the
output channel at the field terminations regardless
of the DOUT Type selected.
DOUT Type Selects the function of this discrete output. Valid
values are:
Latched Changes on an active transition
of the output (from off to on).
The discrete output remains On
until cleared by selecting Off in
the Auto Output field.
Momentary Enables ROCLINK 800 to
activate the discrete output for
the amount of time defined in the
Time On field.
Toggle Enables a square-wave output
for which both the time on and
time off are defined by the value
in the Time On parameter. Time
on and time off are equal. Use
the TDO Parameters tab to
define time-related parameters.
TDO Enables the discrete output to
have a time duration between
On and Off transitions based on
time-related parameters
configured in the TDO
Parameters tab.
TDO Toggle Enables the discrete output to
continuously repeat in a cycle
defined by the value in the
Cycle Time field on the TDO
Parameters tab where the EU
Value controls the on-time
duration.
Field Description
Scanning Mode Sets the scanning type to configure how the DO is
scanned. Valid values are:
Auto Automatically processes the field
output.
Manual Prevents the ROC from updating
the DO value; permits only
manual updates of the output
value. Set Manual Output to On
and click Apply to override the
output.
Disabled Prevents the ROC from updating
the DO value; permits a manual
process of the last output scan.
Set Auto Output to On and click
Apply to override the output.
Note: If you enable alarming, the ROC generates
a Manual Mode alarm when scanning is
disabled.
Active Alarms This read-only field shows any active alarms for
this point. When you Enable alarming, the limit
alarms (such as Low Alarm and Rate Alarm) that
are active appear. Even if you Disable alarming,
the Point Fail (hardware reports a malfunction)
alarm and Manual (Scanning Disabled) indicators
can still appear.
Field Description
Accumulated Value Sets a value for the accumulated number of off-to-
on transitions for the discrete output. The
accumulator is a 32-bit number with a maximum
count of 4,294,967,295. You can preset the
accumulator to a desired value or clear it by
entering zero (0).
Action After Reset Indicates how the ROC handles the discrete
or Power Fail output relay state on power reset or failure. Valid
values are Use Failsafe Mode (discrete output
uses value set in the Failsafe State frame: On or
Off) or Retain Last Status (ROC retains the DO
state, whether off or on).
Failsafe State Indicates whether the failsafe state is active
following a reset due to a power restart or warn
start. Valid values are On or Off.
Note: If you select On, you must also indicate (on
the General tab) whether the Auto Output
or Manual Output is set to On or Off after
a reset of the ROC.
Output Indicates the state of the DO output. Valid values
are Normal (energizes in time on) or Inverted
(energizes in time off). Selecting Inverted inverts
all outputs in any mode.
Note: If Failsafe State is set to On and Inverted is
On, the Failsafe State returns to Off
following a reset.
Notes: To correctly configure time duration DO, ensure that you have
selected TDO in the DOUT Type field and Auto as the
Scanning Mode on the General tab for DO.
Select Configure > I/O > DO Points > TDO Parameters tab. The
TDO Parameters screen displays.
Field Description
Cycle Time Sets, in seconds, the total amount of time the
cycle spends in the on and off positions. The
default is 15 seconds.
The system uses Cycle Time to define the Off time
in the TDO Toggle mode using the formula.
Field Description
Low Reading Time Sets, in seconds, the Low Reading Time (0%
Count) that represents a zero percent output pulse
width. The default is 3 seconds. This is the
minimum amount of time that the TDO can be
energized to move the motor. Set to a value that
allows movement, but also provides good
resolution of control.
High Reading Time Sets, in seconds, the High Reading Time (100%
Count) that represents a 100 percent output pulse
width. The default is 12 seconds. This is the
maximum amount of time that the TDO can be
energized to move the motor. Normally, this is the
amount of time it takes for the actuator to move
the valve from fully open to fully closed.
Low Reading EU Sets the engineering unit (EU) for the low reading
to zero percent output (low end of the EU range).
Based on the EU range determined in part by this
parameter, the EU value is converted to a
corresponding signal.
High Reading EU Sets the engineering unit (EU) for the high reading
to 100 percent output (or high end of the EU
range). Based on the EU range determined in part
by this parameter, the EU value is converted to a
corresponding signal.
EU Value Current value, displayed in engineering units.
In TDO Toggle mode, the EU Value controls the
Time On:
On Time = ((EU Value – Low Reading EU) /
(High Reading EU – Low Reading EU) *
(High Time – Low Time)) + Low Time
Units Sets the engineering units for the discrete output
(such as percentage, IN H2O, PSIG, MCF,
degrees F, milliamps, and volts).
The output pulse from the TDO function must be defined for proper
engineering unit (EU) conversion. The minimum pulse width (Low
Reading Time / 0% Count) and the maximum pulse width (High
Reading Time / 100% Count) define the minimum and maximum On
time of the output pulse. The values entered in the Low Reading Time
and High Reading Time represent the number of seconds the output is
On.
Example:
A TDO is used to emulate a field instrument measuring flow. The TDO
outputs a pulse width of 3 seconds for no flow and a pulse width of 12
seconds for 1000 MCF per day flow.
Low Reading Time (0% Count) = 3 seconds
High Reading Time (100% Count) = 12 seconds
Low Reading EU = 0
High Reading EU = 1000
Field Description
Alarming Sets the alarm option for this point. Valid values
are Enabled (enables alarming) or Disabled
(does not generate limit alarms).
Note: The Point Fail alarm may appear in the
Active Alarms field, but is not logged in the
Alarms file. If you enable alarming, the
system generates an alarm if you disable
scanning.
RBX Sets the Spontaneous-Report-by-Exception
(SRBX or RBX) alarming for this point. Valid
values are On Alarm Set (which generates an
RBX message to the host when the point enters
an alarm condition) and On Alarm Clear (which
generates an RBX message to the host when the
point exits an alarm condition).
Note: RBX Alarming requires you to configure the
communications port.
The Pulse Input screen has three tabs. Use each tab to configure a
component of this input.
▪ Use the General tab to set the basic parameters for the PI point.
▪ Use the Advanced tab to configure features, such as EU Options,
Rate Period, Rollover value, and Conversion for the pulse input.
▪ Use the Alarms tab to set the alarm parameters for this PI point.
Note: If you enable Alarming, configure the limit alarms (four levels,
rate, and deadband) on the Alarms tab. By disabling alarms, you
can prevent alarms from generating for this point. To conserve
alarm log space, enable alarms only when necessary. If you do
not plan to use all the alarms, check and adjust the value of each
one to prevent the generation of false alarms.
Save After you configure a point and click Apply, click Flash Memory Save
Configuration Configuration (on the ROC > Flags screen) to save I/O configuration
to permanent memory in case you must perform a cold start.
Field Description
Pulse Inputs Selects the pulse input to configure. Click ▼ to
display all available pulse inputs.
Note: The selection in this field applies to each
tab on this screen.
Tag Sets a short (10 alphanumeric characters)
identifier for the point.
Note: This selection in this field applies to each
tab on this screen.
Point Number This read-only field shows the rack location
(module slot and channel number) for this point.
EU Value Sets the value for engineering units (EUs).
The EU Value is dependent on how you set the
EU Options on the Advanced tab. If you set up the
PI as a Rate (Max Rollover), then the system
assigns the Current Rate to the EU Value. If you
set up the PI as an accumulator using Today’s
Total (Max Rollover), then the system assigns
Today’s Total to the EU Value.
If you set up the PI as an accumulator using
Running Total (Entered Rollover), then the EU
Value corresponds to the accumulated pulses
times the Conversion. The system compares the
EU Value to the value entered for the Rollover
Value. If the EU Value is greater than or equal to
the entered Rollover Value, the system sets the
EU Value here to zero.
Units Sets the engineering units for the I/O (In H2O,
PSIG, MCF, degrees F, milliamps, or volts).
Field Description
Scan Period Sets, in seconds, the amount of time between
scans of the EU Value. The default value is 1.0
second. The system calculates this rate by
counting the number of pulses during the scan
interval and dividing by the time interval.
To avoid highly fluctuating calculation results,
typically at least 10 pulses should occur between
scans at low flow conditions. For example, if a flow
meter produces one pulse per second at low flow,
then set the Scan Period value to a minimum of 10
seconds.
Note: Once the system reaches the scan period,
it updates the values in the Accum’d
Pulses, Pulses Today, Today’s Total,
Yesterday’s Total, and Current Rate fields.
Accum’d Pulses Sets the number of raw counts stored in the
accumulated value counter in firmware. For each
scan period, the ROC determines the number of
raw counts that have occurred since the last scan
period and adds them to the accumulated value
counter.
The accumulated value rolls over to zero after
reaching 16,000,000.
Pulses For Day This read-only field shows the total number of
pulses that the PI has received for the contract
day. At the end of the contract day, the ROC zeros
this field and starts over, only if being totalized in
History. The Contract Hour is specified on this
screen.
Today's Total Displays the total EU Values accumulated for the
current contract day, calculated by multiplying the
conversion value by the accumulated pulses. The
system resets this value to zero at the contract
hour.
Yesterday's Total This read-only field shows the total EU Value
accumulated the previous contract day, calculated
as the previous day’s Today’s Total value at the
contract hour before being cleared.
Current Rate This read-only field shows the calculated rate as
of the most recent scan expressed in EUs per unit
of time. You select time units using the Rate
Period field on the Advanced tab. The system
calculates the rate at the end of each scan period
by multiplying the number of pulses received by
the conversion value divided by the rate period.
Active Alarms This read-only field shows any active alarms for
this point. When you Enable alarming, the limit
alarms (such as Low Alarm and Rate Alarm) that
are active appear. Even if you Disable alarming,
the Point Fail (hardware reports a malfunction)
alarm and Manual (Scanning Disabled) indicators
can still appear.
Field Description
Contract Hour Sets the beginning of the day for the daily counted
parameters. Click ▼ to display all defined contract
hours.
Conversion Indicates a conversion factor by which the system
multiplies or divides the number of pulses to
determine the EU value.
Note: You specify how the system uses this value
in the Conversion field on the Advance tab.
Frequency This read-only field shows, in pulses/second, the
frequency of incoming pulses.
Scanning Sets the scanning option for this point. Valid
values:
Enabled Automatically process the field
input and display the last analog
input scan in the Value field.
Disabled Permit only manual updates of
the Value field.
Note: If you enable alarming, the ROC generates
a Manual Mode alarm when scanning is disabled.
If you disable scanning, you must manually enter a
value to override the input.
Field Description
EU Options Sets how the system assigns the value of the
engineering units (EU). Valid values are:
Rate (Max Uses the value of the Current
Rollover) Rate parameter (as shown on
the General tab)
Running Total Uses the value of Today’s Total
(Entered parameter (as shown on the
Rollover) General tab)
Today’s Total Uses a value calculated by
(Max Rollover) multiplying the accumulated
pulses (shown on the General
tab) by the Conversion factor. If
the EU Value exceeds the
Rollover value, it is cleared and
starts to accumulate again from
0.
Note: This option does not clear EU values at the
contract hour.
Conversion/K Sets how ROCLINK uses the number in the
Factor Conversion field on the PI General tab.
Rollover Value Sets a value in EUs (not pulses) to indicate when
(EUs) rollover should occur.
Note: This field is available only if you select
Running Total as an EU Options value.
Rate Period Sets how the system calculates rates, if you
selected Rate as an EU Option. Valid values are:
EU/sec Calculation based on EU second totals.
EU/hour Calculation based on EU hourly totals.
EU/min Calculation based on EU minute totals.
EU/day Calculation based on EU daily totals.
Note: If you select EUs/Pulse as a conversion rate
and EU/min as a rate period, the system
calculates Current Rate as (accumulated
pulses x Conversion) (Scan Period x
conversion from seconds to minutes). If you
select Pulses/EU as a conversion rate and
EU/hour as a rate period, the system
calculates Current Rate as (accumulated
pulses Conversion) (Scan Period x
conversion from seconds to minutes).
Conversion Specifies how the number entered in the
Conversion field on the PI General tab is used.
Valid values are:
EUs/Pulse Associates a specific number of
engineering units, typically fractional
parts such as 0.01, with a single pulse.
Pulses/EU Associates a specific number of
pulses, such as 100, with one
engineering unit.
Field Description
Alarming Sets the alarm option for this point. Valid values
are Enabled (configures the limit alarms - four
levels, Rate, and Deadband) or Disabled (does
not generate limit alarms).
Note: The Point Fail alarm may appear in the
Active Alarms field, but is not logged in the
Alarms file. If you Enable alarming, the
system generates an alarm if you disable
scanning.
Field Description
RBX Sets the Spontaneous-Report-by-Exception
(SRBX or RBX) alarming for this point. Valid
values are On Alarm Set (which generates an
RBX message when the point enters an alarm
condition) or On Alarm Clear (which generates an
RBX message when the point exits an alarm
condition).
Note: RBX Alarming requires you to configure the
the communications port.
HiHi Alarm Sets, in engineering units, a value to which the
input value must rise to generate a HiHi alarm.
Note: Typically you set the value for the HiHi
alarm higher than the value for the High
Alarm.
High Alarm Sets, in engineering units, a value to which the
input value must rise to generate a high alarm.
Low Alarm Sets, in engineering units, a limit value to which
the input value must fall to generate a Low Alarm.
LoLo Alarm Sets, in engineering units, a value to which the
input value must fall to generate a LoLo alarm.
Note: Typically you set the value for the LoLo
alarm lower than the value for the Low
Alarm.
Rate Alarm Sets, in engineering units, a value that represents
the maximum amount of change allowed in the
calculated rate between updates before an alarm
generates. If the change is equal to or greater than
this value, an alarm occurs.
Note: To disable the Rate alarm without disabling
the other alarms, set the value greater than
the scan value of the input.
Alarm Deadband Sets, in engineering units, an inactive zone above
the Low Alarm limit and below the High Alarm
limit. The Alarm Deadband prevents the alarm
from being set and cleared continuously when the
input value is oscillating around the alarm limit.
This prevents the Alarm Log from being over-filled
with data.
▪ The Thermocouple Input screen has the following tabs. Use each tab
to configure a component of the input.
▪ Use the General tab to set the basic parameters for the TC Input point.
▪ Use the Advanced tab to configure features, such as filtering and
averaging for the selected TC point.
▪ Use the Alarms tab to set the alarm parameters for this TC point.
Save After you configure a point and click Apply, click Flash Memory Save
Configuration Configuration (on the ROC > Flags screen) to save I/O configuration
to permanent memory in case you must perform a cold start
Field Description
Thermocouple Sets the input to be configured. The inputs are
listed by both number and tag.
Note: This selection in this field applies to each
tab on this screen.
Tag Sets a 10-character string name for identification
of the Point Number.
Note: This selection in this field applies to each
tab on this screen.
Point Number Sets the value to identify the physical location of
the input. The Point Number identifies the module
slot.
Note: This selection in this field applies to each
tab on this screen.
Value If Scanning is set to Disable, enter a Value to
override the input. When Scanning is set to
Enable, Value displays the last TC Input scan in
engineering units.
Units Tag Sets a name to display in configuration screens,
reports and custom displays. This should be the
same unit of measure as was chosen in the Units
Tag field. If this field is blank, configuration
screens, reports, and custom displays show a
blank where the unit of measure should be.
Scan Period Sets the amount of time between updates of the
Filter value. All TC Inputs are updated based on
their individual Scan Periods. The default value is
1 second. The minimum scan period allowed is
100 mSec.
Type Sets the type of thermocouple sensor in use. For
the values, refer to Table 7-1. Thermocouple Input
Type values.
Units Sets in which engineering unit (EU) the ROC
calculates the temperature.
Scanning Sets the Scanning option.
▪ For the input to automatically process the field
input, select Enabled (Automatic Mode).
When Scanning is set to Enabled, Value
displays the last TC Input scan in engineering
units.
▪ When Scanning is set to Disabled (Manual
Mode), the ROC does not update the
engineering unit (EU) Value. If Alarming is
Enabled, an alarm generates when Scanning
is set to Disabled. If Scanning is set to
Disabled, enter a Value to override the input.
Field Description
Active Alarms This read-only field shows the Active Alarms
indicating any alarms that are active for this point.
When Alarming is set to Enabled, the limit alarms
(such as Low Alarm and Rate Alarm) that are
active appear. Even if Alarming is Disabled, the
Point Fail (hardware reports a malfunction) alarm
indicator can still appear. If Alarming is set to
Enabled, an alarm is generated when Scanning is
disabled.
Field Description
Filter Sets a value, which is a weighted sample using a
percentage of the last value, plus a percentage of
the new value. The entered data is the percentage
of the last value used. The filter is calculated every
Scan Period by the formula:
(Last Value Entered %) + [New Value (100 –
Entered %)] = Filtered Value
Actual Scan This read-only field shows the actual amount of
time, in seconds, that passes between scans. This
number should be the same as the Scan Period
parameter if the system is not overloaded.
Field Description
Average Raw Sets how the system averages and calculates the
Values raw readings during the Scan Period and use the
outcome as the Raw A/D Input during EU
calculations. For example: When Enabled, a TC
Input point configured with a Scan Period of 1.5
seconds obtains a new value from the A/D every
100 milliseconds. During the Scan Period, 10
values are obtained from the A/D and summed
together. At EU calculation, the values summed
are divided by the Actual Scan Period display and
are used as the Raw A/D Input. Disable this
function to acquire instantaneous values.
EU Offset Sets a bias the system adds to the EU Value,
allowing you to set a zero shift that is applied to
the entire temperature versus voltage curve.
Field Description
Alarming When Alarming is Enabled, the limit alarms (four
levels, Rate, and Deadband) are configured on the
Alarms tab. When Alarming is Disabled, no limit
alarms generate for this point. The Point Fail alarm
appears in the Active Alarms field, but will not be
logged in the Alarms Log.
To conserve Alarm Log space, alarms should be
enabled only when necessary. Even if you do not
plan to use all the alarms, check and adjust the
value of each one so that no false alarms
generate.
Field Description
RBX If the host computer is configured to receive field-
initiated calls, you can select a Report-by-
Exception (RBX) option to send a Spontaneous-
Report-by-Exception (SRBX) message.
▪ On Alarm Set – When the point enters an
alarm condition, the ROC generates a RBX
message.
▪ On Alarm Clear – When the point leaves an
alarm condition, the ROC generates a RBX
message.
Note: RBX Alarming requires the communications
port to be properly configured.
HiHi Alarm Sets, in engineering units, a value to which the
input value must rise to generate a HiHi Alarm.
Note: The HiHi Alarm value is typically set higher
than the High Alarm.
High Alarm Sets, in engineering units, a value to which the
input value must rise to generate a High Alarm.
Low Alarm Sets, in engineering units, a limit value to which
the input value must fall to generate a Low Alarm.
LoLo Alarm Sets, in engineering units, a limit value to which
the input value must fall to generate a LoLo
Alarm.
Note: The LoLo Alarm value is typically set lower
than the Low Alarm.
Rate Alarm Sets the value, in engineering units, that
represents the maximum amount of change
allowed between updates. If the change is equal
to, or greater than this value, an alarm is
generated. To disable this Rate Alarm without
disabling the other alarms, the Rate Alarm value
must be set greater than the Span (Range) of the
TC Input.
Alarm Deadband Sets the value, in engineering units, is an inactive
zone above the Low Alarm and below the High
Alarm. The purpose of the Alarm Deadband is to
prevent the alarm from being set and cleared
continuously when the input value is oscillating
around the alarm limit. This also prevents the
Alarm Log from being filled with nuisance alarm
trips.
Save After you configure a point and click Apply, click Flash Memory Save
Configuration Configuration (on the ROC > Flags screen) to save I/O configuration
to permanent memory in case you must perform a cold start.
Field Description
RTD Inputs Sets the input to be configured. The inputs are
listed by both number and tag.
Note: This selection applies to each tab on this
screen.
Tag Sets a 10-character string Tag for identification of
the point number. Any alphanumeric characters,
including spaces, may be used.
Note: This selection applies to each tab on this
screen.
Point Number The read-only field identifies the physical location
of the input. The Point Number identifies the
module slot – channel number.
Field Description
Value If Scanning is set to Disabled, enter a Value to
override the RTD Input. When Scanning is set to
Enabled, Value displays the last RTD Input scan
in engineering unit.
Units Tag Sets a name to display in configuration screens,
reports and custom displays. This should be the
same unit of measure as was chosen in the Units
field. If this field is blank, configuration screens,
reports, and custom displays show a blank where
the unit of measure should be.
Scan Period Sets the Scan Period as the amount of time
between updates of the Filter value. All RTD
Inputs are updated based on their individual Scan
Periods. The default value is 1 second. The
minimum scan period allowed is 64 mSec.
ROCLINK 800 will not allow a value less than 64
mSec in this field. The scan occurs in multiples of
64 mSec, such as if you enter 0.20 sec, it will scan
every 0.192 sec.
Low Reading EU Sets the value corresponding to a 0% input.
High Reading EU Sets the value corresponding to a 100% input.
Units Sets the engineering units (EU) in which the ROC
calculates the temperature.
Scanning Sets the Scanning option.
▪ For the input to automatically process the field
input, select Enabled (Automatic Mode).
When Scanning is set to Enabled, Value
displays the last RTD Input scan in
engineering units.
▪ When Scanning is set to Disabled (Manual
Mode), the engineering unit (EU) Value is no
longer updated by the ROC. If Alarming is
Enabled, an alarm generates when Scanning
is set to Disabled. If Scanning is set to
Disabled, enter a Value to override the input.
Active Alarms This read-only field shows the Active Alarms
indicating any alarms that are active for this point.
When Alarming is set to Enabled, the limit alarms
(such as Low Alarm and Rate Alarm) that are
active appear. Even if Alarming is Disabled, the
Point Fail (hardware reports a malfunction) alarm
indicator can still appear. If Alarming is set to
Enabled, an alarm is generated when Scanning is
Disabled.
Field Description
Filter Sets a value, which is a weighted sample using a
percentage of the last value, plus a percentage of
the new value. The entered data is the percentage
of the last value used. The filter is calculated every
scan period by the formula:
(Last Value Entered %) + (New Value (100 –
Entered %)) = Filtered Value
Adjusted A/D 0 % This read-only field shows the calibrated Analog-
to-Digital (A/D) reading corresponding to zero
percent input. In the Calibrate function, this value
is changed to set the zero percent input exactly at
the Low Reading EU value to eliminate transmitter
and system errors.
Adjusted A / D 100 This read-only field shows the calibrated A/D
% reading corresponding to 100 percent input. This
value is used to convert the input to engineering
units. In the Calibrate function, this value is
changed to set the 100 percent input exactly at the
High Reading EU value.
Raw A/D Input This read-only field shows the Raw A/D Input
displaying the current reading directly from the
Analog-to-Digital converter.
Actual Scan This read-only field shows the actual amount of
time in seconds that passes between scans. This
number should be the same as shown for the
Scan Period parameter, if the system is not
overloaded.
Field Description
Average Raw Value Sets the ROC to average and calculate the raw
readings during the Scan Period and use the
outcome as the Raw A/D Input during EU
calculations. For example, when enabled, an RTD
Input point configured with a Scan Period of 1.0
seconds obtains a new value from the A/D every
50 milliseconds. During the Scan Period, 20
values are obtained from the A/D and summed
together. At EU calculation, the values summed
are divided by the Actual Scan Period display and
are used as the Raw A/D Input. Disable this
function to acquire instantaneous values.
RTD Alpha Sets the RTD Alpha of the RTD being used
(0.00385 or 0.00392).
Clipping Sets the ROC to force the Filtered EUs to stay
within the range defined by the cut off limits. Set
the cut off limits by using the LoLo Alarm and HiHi
Alarm parameters.
Zero Shift Sets a value if necessary to compensate for the
zero shift effect on an input.
Field Description
Freeze Values These read-only fields show the value received
from the analog input, DVS, HART, MVS, RTD or
Meter inputs when the Update button was last
clicked. The system uses these values in ongoing
processing (such as flow calculations, history
logging, or control) while calibration occurs.
Verify Click to start the verification process.
Calibrate Click to begin calibration and open the Set Zero
dialog opens.
Zero Click to set adjustment factors for the input. The
Shift/Offset/RTD value is sent to the device for:
Bias
Zero Shift Click to zeros the static pressure
effect for the differential
pressure input (Set Offset).
Offset Click to send the value of the
live reading to set the reading as
close to zero as possible for a
static pressure inputs (Measured
Pressure Reading).
RTD Bias Click to calibrate the offset (shift)
of temperature throughout the
RTD curve (Temperature
Standard Reading).
Auto Scan/Stop Click to automatically request values each second
Scan from the meter. The request continues until you
click Freeze.
Update Click to request a value update from the input to
be used as the Freeze Values.
Verifying an Use this process to verify if an RTD is within the correct operating
RTD Input temperature limits. If the value is incorrect, calibrate the input.
Field Description
Action Indicates the current action. Valid values are
Verify or Calibrate.
Actual Displays the value in the Live Reading field.
Expected Displays the value in the Dead Weight/Tester
Value field.
Deviation Displays the amount of deviation between the
actual and expected values.
% Deviation Displays a percentage deviation between the
Actual and Expected values.
7. As the live reading value changes, click Log Verify as many times as
necessary to establish the verification log.
8. Typically you verify the same points you calibrate. Temperature might
be an example (– 100, 200, 50). For each test point, you set your test
equipment to produce the expected value, enter that expected value in
the Tester Value field, wait for live input to stabilize, and then click
Log Verify. You can verify as many points as you want.
9. Click Done.
10. Calibrate the input.
Note: You can click Cancel to exit the calibration without saving
the changes. The system retains the previous calibration
settings but logs the event in the event log.
7. Set test equipment to produce the expected results.
8. Complete the Dead Weight/Tester Value field. This value represents
the low range (0%) of the instrument’s measurement range.
9. When you enter a value in the Dead Weight/Tester Value field,
ROCLINK immediately begins comparing it once each second to the
value in the Live Reading field (obtained from the static pressure
sensor) and calculating the percentage deviation between the two
values.
10. Click Set Zero when the live reading stabilizes. ROCLINK 800 adds
the first line in the calibration log, renames the screen to Set Span,
and changes the label on the Set Zero button to Set Span.
17. When you enter a value in the Dead Weight/Tester Value field,
ROCLINK immediately begins comparing it once per second to the
value in the Live Reading field (obtained from the static pressure
sensor) and calculating the percentage deviation between the two
values.
18. Click Set Mid 1 when the live value stabilizes. ROCLINK 800 adds
the next line in the calibration log, renames the screen, and changes
the label on the Set Mid 1 button to Set Mid 2.
Field Description
Alarming Sets Alarming, the limit alarms (four levels, Rate,
and Deadband) are configured on the Alarms tab.
When Alarming is Disabled, no limit alarms
generate for this point. The Point Fail alarm
appears in the Active Alarms field, but will not be
logged in the Alarms Log.
To conserve log space, alarms should be enabled
only when necessary. Even if you do not plan to
use all the alarms, check and adjust the value of
each one so that no false alarms generate.
RBX Alarming If you configure the host computer to receive field-
initiated calls, select a Report-by-Exception (RBX)
option to send a Spontaneous-Report-by-
Exception message.
▪ On Alarm Set – When the point enters an
alarm condition, the ROC generates a RBX
message.
▪ On Alarm Clear – When the point leaves an
alarm condition, the ROC generates a RBX
message.
Note: RBX Alarming requires you to properly
configure the communications.
HiHi Alarm Sets, in engineering units, a value to which the
input value must rise to generate a HiHi Alarm.
Note: The HiHi Alarm value is typically set higher
than the High Alarm.
High Alarm Sets, in engineering units, a value to which the
input value must rise to generate a High Alarm.
Low Alarm Sets, in engineering units, a limit value to which
the input value must fall to generate a Low Alarm.
Field Description
LoLo Alarm Sets, in engineering units, a limit value to which
the input value must fall to generate a LoLo
Alarm.
Note: The LoLo Alarm value is typically set lower
than the Low Alarm.
Rate Alarm Sets the value, in engineering units, that
represents the maximum amount of change
allowed between updates. If the change is equal to
or greater than this value, an alarm generates. To
disable this Rate Alarm without disabling the other
alarms, the Rate Alarm value can be set greater
than the Span of the analog input.
Alarm Deadband Sets the value, in engineering units, that is an
inactive zone above the Low Alarm limits and
below the High Alarm limits. The purpose of the
Alarm Deadband is to prevent the alarm from
being set and cleared continuously when the input
value is oscillating around the alarm limit. This
also prevents the Alarm Log from being over-filled
with data.
Save After you configure a point and click Apply, click Flash Memory Save
Configuration Configuration (on the ROC > Flags screen) to save I/O configuration
to permanent memory in case you must perform a cold start.
Field Description
Analog Inputs The ROC800-Series has five system analog
inputs:
▪ System AI #1 = Battery.
▪ System AI #2 = Charge Voltage.
▪ System AI #3 = Module Voltage.
▪ System AI #4 = AI Default.
▪ System AI #5 = Board Temperature.
Note: This selection in this field applies to each
tab on this screen.
Tag Sets a 10-character name for identification of the
point.
Note: This selection in this field applies to each
tab on this screen.
Point Number Because this type of input has no physical
location, the read-only portion of the Point
Number refers to module location 0. The read-
only portion that refers to channel number is 1 to
5 for the input numbers.
Value Sets a value to override the input if Scanning is set
to Disabled. When Scanning is set to Enable,
Value displays the last analog input scan in
engineering units (EU).
Units Sets the Units value. Inputs #1, #2, and #3 are in
Volts. Input #5 is in Degree C.
Scan Period Sets the amount of time between updates of the
Filter value. The default value is 1 second. All
System analog inputs are updated based on their
individual Scan Periods.
Low Reading EU Sets the engineering unit corresponding to zero
percent input.
High Reading EU Sets the engineering unit corresponding to 100
percent input.
Field Description
EU Value Units Set the system AI units to be read and written in
volts, millivolts, degree F, degree C, degree K, or
Degree R.
Scanning Sets the Scanning option.
▪ For the input to automatically process the field
input, select Enabled (Automatic Mode).
When Scanning is set to Enabled, Value
displays the last System AI scan in
engineering units.
▪ When Scanning is set to Disabled (Manual
Mode), the engineering unit (EU) Value is no
longer updated by the ROC If Alarming is
Enabled, an alarm generates when Scanning
is set to Disabled. If Scanning is set to
Disabled, enter a Value to override the input.
Active Alarms This read-only field any alarms that are active for
this point. When Alarming is set to Enabled, the
limit alarms (such as Low Alarm and Rate Alarm)
that are active appear. Even if Alarming is
Disabled, the Point Fail (hardware reports a
malfunction) alarm indicator can still appear. If
Alarming is set to Enabled, an alarm is generated
when Scanning is Disabled.
Field Description
Filter Sets a value, which is a weighted sample using a
percentage of the last value plus a percentage of
the new value. The entered data is the percentage
of the last value used. The Filter is calculated
every Scan Period by the formula:
(Last Value Entered %) + (New Value (100 –
Entered %)) = Filtered Value
Adjusted AD 0 % Sets the calibrated Analog-to-Digital (A/D) reading
corresponding to zero percent input.
Adjusted AD 100 % Sets the calibrated A/D reading corresponding to
100 percent input.
Raw A/D Input This read-only field shows the current reading
directly from the Analog-to-Digital converter.
Actual Scan This read-only field shows the actual amount of
time, in seconds, that passes between scans. This
number should be the same as the Scan Period
parameter if the system is not overloaded.
Average Raw Sets the values to average and calculate the raw
Values readings during the Scan Period and use the
outcome as the Raw A/D Input during EU
calculations. For example, when enabled, an
analog input point configured with a Scan Period
of 5 seconds obtains a new value from the A/D
every second. During the Scan Period, five values
are obtained from the A/D and summed together.
At EU calculation, the values summed are divided
by the number of samples and are used as the
Raw A/D Input. Disable this function to acquire
instantaneous values.
Clipping If enabled, the software forces the Filtered EUs to
stay within the range defined by the cut off limits.
Select the cut off limits by using the LoLo Alarm
and HiHi Alarm parameters.
Field Description
Alarming Sets Alarming for the point. If you Enable
Alarming, the limit alarms (four levels, Rate, and
Deadband) are configured on the Alarms tab. If
you Disable Alarming, no limit alarms generate for
this point. The Point Fail alarm appears in the
Active Alarms field, but will not be logged in the
Alarms Log.
To conserve Alarm Log space, alarms should be
enabled only when necessary. Even if you do not
plan to use all the alarms, check and adjust the
value of each one so that no false alarms
generate.
RBX Alarming If the host computer is configured to receive field-
initiated calls, you can select a Report-by-
Exception (RBX) option to send a Spontaneous-
Report-by-Exception (SRBX) message.
▪ On Alarm Set – When the point enters an
alarm condition, the ROC generates a RBX
message.
▪ On Alarm Clear – When the point leaves an
alarm condition, the ROC generates a RBX
message.
Note: RBX Alarming requires the
communications port to be properly
configured.
HiHi Alarm Sets, in engineering units, a value to which the
input value must rise to generate a HiHi Alarm.
Note: The HiHi Alarm value is typically set higher
than the High Alarm.
High Alarm Sets, in engineering units, a value to which the
input value must rise to generate a High Alarm.
Low Alarm Sets, in engineering units, a limit value to which
the input value must fall to generate a Low Alarm.
Field Description
LoLo Alarm Sets, in engineering units, a limit value to which
the input value must fall to generate a LoLo
Alarm.
Note: The LoLo Alarm value is typically set lower
than the Low Alarm.
Rate Alarm Sets the value, in engineering units, that
represents the maximum amount of change
allowed between updates. If the change is equal to
or greater than this value, an alarm is generated.
To disable this Rate Alarm without disabling the
other alarms, the Rate Alarm value can be set
greater than the Span of the analog input.
Alarm Deadband Sets the value, in engineering units, that is an
inactive zone above the Low Alarm limits and
below the High Alarm limits. The purpose of the
Alarm Deadband is to prevent the alarm from
being set and cleared continuously when the input
value is oscillating around the alarm limit. This
also prevents the Alarm Log from being over-filled
with data.
Select Configure > I/O > Soft Points. The Soft Point screen displays.
Because of the graphical interface, you can use the Configure option on
the ROCLINK 800 menu (Configure > I/O > MVS Sensor), click on
the MVS module graphic, or use the configuration tree.)
Note: If you change a parameter on the MVS screens, click Write to
update the sensor configuration.
Caution If you attempt to write data to a 4088 with the Security Switch in the ON
position, ROCLINK saves the new transmitter information but is unable
to write the new values to the transmitter. If you change the value in the
Address field, communications fail between ROCLINK and the
transmitter. Enter the transmitter address previously used in ROCLINK to
regain communications. Changes made to all other fields revert to the
values stored in the transmitter.
Field Description
MVS Sensor Sets the MVS sensor to configure. Each MVS has
a unique address number to differentiate it from
other MVS units, because MVS sensors can be
multi-dropped.
Tag Sets the ten-character identifier that resides in the
MVS.
Note: This selection in this field applies to each
tab on this screen.
Address Sets the unique address for this device used in the
device communications protocol. The default
address is 1. If the MVS is used in the multi-drop
mode, each MVS must have a unique address.
Use Address 240 to poll the sensor to determine
the address of the connected sensor. This is
similar to polling a using Address and Group 240.
When Address 240 is used, the sensor responds
with its address by updating the Address field.
Voltage This read-only field shows the voltage input to the
sensor.
If the MVS interface version (as shown on the
Advanced tab’s Sensor Interface Version field) is 6
or greater, this field should read approximately 5,
which is the voltage to the microcontroller in the
sensor. If the MVS interface version is less than 6,
this field shows the input voltage to the sensor.
Note: For proper operation, the input voltage to
the sensors with versions less than 6 must
be at least 10.5 volts dc.
Sensor Click Write to update the sensor with the current
Configuration values on the screen or click Read to read the
sensor’s current configuration data and process
variables.
Pressure / These read-only fields show scaled differential
Temperature Values pressure readings from the sensor. The units
and Fault Values display as either InH2O or kPa.
The scaled Differential Pressure (Reverse DP)
reading is from the sensor times a negative "1" for
flow in the reverse direction.
The scaled absolute Pressure (Static Pressure)
reading from the sensor displays in either PSI or
kPa.
The scaled process Temperature reading from
the sensor displays in either degrees Fahrenheit
or degrees Celsius, based on global settings
(ROC > Information).
Enter Fault Values if you desire for the MVS to
return to the values you configure upon on failure
of the sensor, an input point, or communications.
Field Description
Scanning Sets whether the input communicates with the
MVS sensor. Valid values are Enabled (allow
communications to the MVS sensor) or Disabled
(the system does not update information from the
sensor).
Note: The Scanning text field displays scanning
status messages. Additionally, the system
generates an alarm when you Disable
scanning.
Sensor Alarming Sets the alarm conditions of the sensor or any
alarms that are active for this point. Valid values
are Enabled (display any active failed alarms,
such as point fail or sensor fail) or Disabled (do
not display alarms).
Note: When you enable sensor alarms, the
system displays any loss of
communications to the sensors by
displaying an RS-485 Communications
Failure. If you disable scanning, an Off
Scan Mode alarm displays.
Active Alarms These read-only fields indicate any alarms that
are active for this point. If you Enable alarming,
any active limit alarms (such as Low Alarm and
Rate Alarm) appear. Even if you Disable alarming,
the Point Fail (hardware reports a malfunction)
alarm and Manual (Scanning Disabled) indicators
can still appear
Sensor This read-only field displays the type of MVS you are
configuring. Valid values are MVS205, 4088A, 4088B, or
3095.
Note: The value in this field applies to each tab on this
screen
Note: If you change any values, click Write on the General tab to save
the configuration.
Field Description
Sensor Interface This read-only field shows the version of the
Version sensor interface firmware for the sensor.
Units Sets the engineering units for the process
variable. If you change this value, click Write to
update the configuration.
Action on Failure Sets how the sensor retains values on failure of
the sensor, an input point, or communications.
Valid values are Hold Last Value (retains the last
values before the failure) or Set to Fault Value
(returns to the configured fault values).
Note: See the Alarms tab for the Fault Value.
Report Pressure As Sets the location of the static pressure tap in
relation to the orifice and normal flow. Valid values
are Upstream or Downstream. Upstream is the
default. If you select Downstream, the system
subtracts the Diff Pressure (DP) (in PSI) from the
Static Pressure (SP) reading to obtain a
Downstream Pressure measurement for archiving.
For Downstream operation, adjustments to the
calibration procedure may be required when
setting the Span value.
Note: If you change this value, click Write on the
General tab to save the configuration.
Field Description
Reference Sets a reference temperature the sensor uses
Temperature when reporting differential pressure. The default
value is 60 °F (15.6 °C). The system uses this
value only when you change the Units selection or
when you select the Downstream option is
selected in Metric units.
Note: If you change this value, click Write on the
General tab to save the configuration.
Zero Shift Sets a value if necessary to compensate for the
zero shift effect on an input.
Field Description
Freeze Click to stop the system from updating analog,
MVS, DVS, HART, or temperature (RTD) inputs
during verification or calibration. Once you click
Freeze, the input is frozen at the current Freeze
Values.
Scan Mode This read-only field displays the current input
status. Normal Poll indicates the system is
functioning normally. After you click Freeze, the
software changes to Input Freeze for the
verification or calibration process and activates all
buttons in the Freeze Values frame. Poll Mode is
the initial communication to a sensor to gather all
of the configuration data that is stored on the
sensor. Off Scan indicates that the sensor is
disabled.
Diff Pressure, Static These read-only fields show the values for the
Pressure, differential pressure, static pressure, and
Temperature temperature received from the analog, MVS, or
temperature (RTD) input. The system uses these
values in ongoing processing (such as flow
calculations, history logging, or control) while
calibration occurs.
Verify Click to start the verification process.
Calibrate Click to begin calibration and open the Set Zero
dialog opens.
Field Description
Zero Click to set adjustment factors for the input. The
Shift/Offset/RTD value is sent to the device for:
Bias
Zero Shift Click to zeros the static pressure
effect for the differential
pressure input (Set Offset).
Offset Click to send the value of the
live reading to set the reading as
close to zero as possible for a
static pressure inputs (Measured
Pressure Reading).
RTD Bias Click to calibrate the offset (shift)
of temperature throughout the
RTD curve (Temperature
Standard Reading).
Auto Scan/Stop Click to automatically request values each second
Scan from the meter. The request continues until you
click Freeze.
Update Click to request a value update from the input to
be used as the Freeze Values.
Verifying Use this process to verify an MVS is within the operating or contractual
an MVS limits. If the value is incorrect, calibrate the input. You can verify the
differential pressure, static pressure, and the temperature of an MVS
sensor.
1. Select Configure > I/O > MVS Sensor. The Multi-Variable Sensor
screen displays.
2. Select the Calibration tab. The Calibration screen displays.
3. Select an MVS input point to calibrate.
4. Click Update to request one value update from the input.
5. Click Freeze to stop the values of the input from being updated during
verification or calibration.
Note: The Freeze Value field displays the value received from the
MVS input when you last clicked Update and is the value the
system uses in ongoing processing (such as flow calculations
and history logging) while performing calibration.
Review the value in the Scan Mode field. Valid values are Normal
Poll (point scanning is enabled and is updated each scan period),
Off Scan (the point is not in scanning mode), or Input Freeze
(points are frozen).
6. If you are calibrating a temperature input, disconnect the MVS or
DVS sensor and connect a decade box (or comparable equipment) to
the terminals of the ROC.
Field Description
Action Indicates the current action. Valid values are
Verify or Calibrate.
Actual Displays the value in the Live Reading field.
Expected Displays the value in the Dead Weight/Tester
Value field.
Deviation Displays the amount of deviation between the
actual and expected values.
% Deviation Displays a percentage deviation between the
Actual and Expected values.
10. As the live reading value changes, click Log Verify as many times as
necessary to establish the verification log.
11. Typically you verify the same points you calibrate. Temperature
might be an example (– 100, 200, 50). For each test point, you set
your test equipment to produce the expected value, enter that
expected value in the Tester Value field, wait for live input to
stabilize, and then click Log Verify. You can verify as many points
as you want.
12. Click Done.
13. Calibrate the input if required.
Field Description
Point Identifies the point (differential pressure, static
pressure, or temperature) being verified.
Action - Verify Shows the activity being performed as well as
Fields various values:
▪ Actual – Displays the current Live Reading
value from the sensor.
▪ Expected – Displays the expected value as
entered in the Dead Weight/Tester Value
field.
▪ Deviation – Displays the difference between
the expected value and the actual value.
(Deviation = Expected – Actual.)
▪ % Deviation – Displays a percentage
deviation between the Actual and Expected
values.
Note: Click Log Verify to add lines to this screen.
Dead Weight/Tester Sets the expected value against which the system
Value tests and calibrates.
Note: This is the Expected value in the Action
field.
Live Reading with This read-only field shows the current reading
Offset applied from the sensor. If you have configured an offset,
the value appears in the Offset applied field.
Deviation and % This read-only field shows the deviation between
Deviation the Actual and Expected values, such as the
difference between the live pressure or
temperature reading and the measured pressure
or temperature reading.
(%Deviation = Deviation [(Span EU – Zero EU) x
100%]). Use this value to determine the need for
calibration or adjustment.
Log Verify Click to write the displayed data to the Event Log.
Calibrating You can calibrate the differential pressure, static pressure, and
an MVS temperature inputs of an MVS. ROCLINK allows you to perform either
a five-point calibration on an MVS205 or 4088B or a two-point
calibration on a 3095 or 4088A. The five-point calibration consists of
setting the zero point, span, and up to three mid points.
The two-point calibration process consists of setting the zero point and
the span. To calibrate an MVS:
Note:
▪ You cannot calibrate a 4088 if the Transmitter Security switch on
the device is enabled.
▪ The 4088 provides range checking on the input values. The
calibration process fails if the input values deviate more than 10%
from the expected values.
▪ If you have a 4088B and click Cancel at any time during the
calibration process, you must start the calibration process over from
the beginning.
1. Select Configure > I/O > MVS Sensor > Calibration tab. The MVS
Calibration screen displays.
5. If you click Yes, enter a file name and location to save the file, and
click Save. The MVS screen displays with the values frozen, the Scan
Mode field is set to Input Freeze, and the Verify and Calibrate
buttons are activated.
12. If the calibration results indicate that you need to adjust the sensor,
click Zero Shift/Offset/RTD Bias (depending on the point you are
adjusting). The system displays a Set Zero (Offset) screen.
Note: If calibration fails, check the communication wiring, entered
values, and applied pressure.
Field Description
Point Identifies the point (differential pressure, static
pressure, or temperature) being verified.
Calibration Fields Shows the activity being performed as well as
various values:
Action Indicates the current action. Valid values are Set
Zero, Set Span, Set Mid 1, Set Mid2, or Set
Mid3.
As found Shows the sensor’s initial value.
As Left Shows the sensor’s value after calibration
Deviation Shows the difference between the As Found value
and the As Left value.
% Deviation Shows the difference between the As Found and
As Left values as a percentage.
Set Zero Calibrate the zero value (0% of range) for the in
differential pressure (orifice only),
static pressure, or temperature. Set the Dead
Weight/Tester Value (in engineering
units). This should correspond with the Low
Reading EU (0% Count) and is the low
value for the input. This is the input desired for the
test value and is the actual value
expected by the test equipment being calibrated
against. For example: When
calibrating temperature for an RTD input, enter the
degree value associated with the
resistance set up in the decade box or other
equipment.
Set Span Calibrate the span value (100% of range) for
differential pressure (orifice only), static
pressure, or temperature. Set the Dead
Weight/Tester Value (in engineering units).
This should correspond with the High Reading EU
(100% Count) and is the high
value to the input (the top end of the expected
operating range).
For static pressure on an absolute-pressure
device, remember to add in the actual
atmospheric pressure, for example, 300 + 14.73.
Field Description
Set Midpoints If desired, calibrate midpoint 1 (such as 25% of
range) for the differential pressure
(orifice only), static pressure, or temperature,
otherwise click the Done button.
Midpoints allow you to specify the low, middle, and
high calibration point between the
zero and span endpoints. Set the Dead
Weight/Tester Value (in engineering units).
If desired, calibrate Midpoint 2 (such as 50% of
range) for the Differential Pressure
(orifice only), Static Pressure, or Temperature. Set
Midpoint 2 allows you to specify
the middle calibration point between the Zero and
Span endpoints.
If desired, calibrate Midpoint 3 (such as 75% of
range) for the Differential Pressure
(orifice only), Static Pressure, or Temperature. Set
Midpoint 3 allows you to specify a
third point between the Zero and Span endpoints.
Sending the Differential After you have calibrated differential pressure, click Zero Shift to zero
Pressure Zero Shift the static pressure effect for the differential pressure input if required.
(Offset)
5. After you have calibrated static pressure, click Offset to calibrate the
offset (shift) of static pressure if required.
6. Enter a value for the Measured Pressure Reading, which is the
pressure as read from a calibrated pressure sensor.
7. Click Set Offset to send the value to the live reading to get the reading
as close to the measured reading as possible.
8. Click Done to close the dialog.
Field Description
Zero Click to set adjustment factors for the input. The
Shift/Offset/RTD value is sent to the device for:
Bias ▪ Zero Shift – Zeros the static pressure effect
for the differential pressure input (Set Offset).
▪ Offset – Sends the value of the live reading to
set the reading as close to zero as possible for
a static pressure inputs (Measured Pressure
Reading).
▪ RTD Bias – Calibrates the offset (shift) of
temperature throughout the RTD curve
(Temperature Standard Reading).
Measured Pressure Sets the pressure as read from a calibrated
Reading pressure sensor.
Note: This field displays only for static pressure
points.
Pressure Offset This read-only field shows the difference between
the live pressure reading and the measured
pressure reading that ROCLINK 800 applies to the
pressure value.
Note: This field displays only for static pressure
points.
Sending the Temperature Calibrate the offset (shift) of temperature throughout the RTD curve if
RTD Bias required.
1. After you have calibrated the temperature input, click RTD Bias to
calibrate the offset (shift) of temperature throughout the RTD curve if
required.
Note: If you change any values, click Write to save the configuration.
Field Description
Enabled/Disabled Sets whether, for the particular input, alarms are
active. Valid values are Enabled (configure alarms
using the set parameters) or Disabled (do not
generate an alarm, regardless of configuration).
The system logs alarms to the alarm log. To
conserve log space, enable alarms only when
necessary.
Note: If you disable an alarm, the system does
not generate an alarm for this point,
regardless of the alarm configuration.
Alarm statuses display in the read-only
Status field on the General tab.
Low Alarm Sets, in engineering units, a limit value to which
the input value must fall to generate a Low Alarm.
High Alarm Sets, in engineering units, a value to which the
input value must rise to generate a High Alarm.
Alarm Deadband Sets, in engineering units, an inactive zone above
the Low Alarm limits and below the High Alarm
limits. The Alarm Deadband prevents the alarm
from being set and cleared continuously when the
input value is oscillating around the alarm limit.
This prevents the Alarm Log from being over-filled
with data.
Fault Value Sets the point’s value on failure. If a point fails and
you have previously set the value on the
Advanced tab’s Action on Failure field to Set to
Fault Value, the system uses the value entered in
this field as the EU value for that point.
Note: Fault Values are only used in Modify Limits.
Sensor RBX Sets the Spontaneous-Report-by-Exception
Alarming (SRBX or RBX) alarming for this point. Valid
values are:
▪ On Alarm Set – Generates an RBX message
to the host when the point enters an alarm
condition.
▪ On Alarm Clear – Generates an RBX
message to the host when the point leaves an
alarm condition.
2. The HART screen can have as many as eight tabs. Use each tab to
configure a component of the module’s operation.
3. The General and Advanced tabs set parameters for the channel. Each
HART module can support up to four channels.
4. The Calibration tab enables you to calibrate the HART analog input.
5. The Device tabs (1 through 5) set parameters specific to the devices in
that channel. When you configure the module in analog output mode,
each channel can support one device. When you configure the module
in analog input mode, each channel can support up to five devices.
Save After you configure a point and click Apply, click Flash Memory Save
Configuration Configuration (on the ROC > Flags screen) to save I/O configuration
to permanent memory in case you must perform a cold start.
Field Description
Point Number Identifies the channel and its physical location.
The first number indicates the total number of
installed HART points (based on the sum of all
installed HART modules) in the ROC. The last two
numbers indicate the point’s location on a specific
HART module. Click ▼ to display all available
HART points.
For example, 1 – 1-1 indicates the first point
located on the HART module placed in slot #1 in
the ROC chassis. 6 – 2-2 indicates the sixth HART
point, located on the HART module placed in slot
#2 in the ROC chassis.
Note: This selection in this field applies to each
tab on this screen.
Channel Version This read-only field shows the version of firmware
present in the HART module for this channel.
Note: This field displays only if you have a Series
1 HART module installed.
Comm Status This read-only field shows the status of the
communications channel. Scanning indicates the
channel is currently scanning the device(s). Not
Scanning indicates the device is currently off-line
or not communicating. Dual Master indicates that
the channel has another master connected.
Examples of other masters include a Hand-Held
Communicator and a device that is configured to
be in Burst mode. When in Dual Master, the ROC
is not scanning the device, which allows
communications between the other master and the
devices. When the hand-held communicator
finishes communicating with the HART device (or
Burst mode was turned off in the device), normal
HART module scanning automatically resumes.
Note: The HART module does not support Burst
mode. The device should not be configured
in Burst mode when connected to the ROC
If a device is in Burst mode, use a hand-
held communicator to turn off Burst mode.
I/O Type Click ▼ to configure the HART module as an
analog input or analog output.
Note: The Series 1 HART module requires you to
manually change switches on the module
itself. Refer to Chapter 4 in the ROC800-
Series Remote Operations Controller
Instruction Guide (A6175).
Field Description
Communication Sets the communication mode for the point. Valid
Mode values are:
Disabled Stop all HART communication; no
changes occur unless you manually
enter them.
Point to Enables the channel to
Point communication with one HART
device per channel and the analog
signal is still representative of the
measured variable.
Multidrop Enables the channel to
communications with the specified
number of devices (maximum of five)
that you connect to each channel in
parallel. Each HART device in multi-
drop mode requires 4mA and does
not represent any measured variable
value. With all four channels in
multidrop mode, the ROC800 can
support a maximum of twenty HART
devices. The ROC superimposes
digital communications on the analog
signal that you use for powering the
HART devices.
Note: Multidrop is not a valid option
if you select Analog Output
as an I/O Type.
Master Mode Sets sequencing to ensure that two masters can
communicate with one slave device. Primary
indicates that this HART point has priority in
communications; any point set to Secondary must
wait until the Primary communication has
completed.
EU Value Sets the engineering units value of the analog
input or analog output.
Note: This field does not display if you select
Analog Output as the I/O Type.
Low Reading EU Sets the value in engineering units that
corresponds to zero percent input.
High Reading EU Sets the value in engineering units that
corresponds to 100 percent input.
Units Tag Provides a 10-character descriptor for the
engineering units.
Note: This field does not display if you select
Analog Output as the I/O Type.
Analog Scanning Sets analog scanning options. Valid values are
Enabled (automatically process the field input)
and Disabled (stop processing the field input).
Note: This field displays only if you select
Analog Input as the I/O Type.
Field Description
Output Mode Identifies where the system obtains the output
value. Valid values are Auto (system uses the
value in the Auto Value field of the Output Value
frame), Manual (system uses the value in the
Manual Value field of the Output Value frame), or
Disabled (system does not use a value).
Note: This field displays only if you select
Analog Output as the I/O Type.
250 Ohm Indicates whether the software activates a 250
Termination termination resistor for the HART module. Valid
Resistor only for the Series 2 HART module.
Note: This field displays only if you select
Analog Input as the I/O Type.
Output Values Sets the actual output value the system uses,
based on the setting in the Output Mode field. The
system uses the value you enter in the Auto
Value field if you also select Auto in the Output
Mode field. The system uses the value you enter
in the Manual Value field if you also select
Manual in the Output Mode field. The Physical
Value field is a read-only field that displays the
actual value being sent.
Note: This field displays only if you select
Analog Output as the I/O Type.
Alarming Sets alarming on the channel. Select Enabled to
activate alarming or Disabled to prevent alarming.
Disabled is the default.
AI High Alarm Sets the high point for the channel alarm.
AI Low Alarm Sets the low point for the channel alarm.
AI Alarm Deadband Sets a deadband for the channel alarm.
Active Alarm This read-only field shows any active alarms.
Field Description
Adjusted A/D 0% or Sets a value to adjust the calibrated Analog-to-
Adjusted D/A 0% Digital (for AIs) or Digital-to-Analog (for AOs)
reading to zero percent input. In the Calibrate
function, this value is altered to set the zero
percent input exactly at the Low Reading EU value
to eliminate transmitter and system errors.
Note: This is a read-only field for the Series 1
HART module.
Adjusted A/D 100% Sets a value to adjust the calibrated Analog-to-
or Digital (for AIs) or Digital-to-Analog (for AOs)
Adjusted D/A 100% reading corresponding to 100 percent input. This
system uses this value to convert the input to
engineering units. In the Calibrate function, this
value is altered to set the 100 percent input
exactly at the High Reading EU value.
Note: This is a read-only field for the Series 1
HART module.
Raw A/D or D/A This read-only field shows the current reading
Input directly from the Analog-to-Digital (for AIs) or
Digital-to-Analog (for AOs) converter.
Analog Output EU Indicates the value the system uses on reset.
Value on Reset When you select Retain Last Value, use the last
EU value for the channel after a reset or a warm
start. If you select Use Failsafe Value, enter a
value to use after a reset or warm start.
Field Description
Pass Through Sets how communications pass from a host device
through the ROC and on to the HART devices.
The communications must be in ROC Plus
protocol (typically for Opcode 120 requests). Valid
values are Disabled (no pass through occurs),
Enabled – Strip (strip all preamble bytes in HART
protocol) or Enabled – Don’t (leave the entire
message intact).
For the Series 1 HART Module, the Timeout field
enables you to enter, in milliseconds, the amount
of time the system pauses between the end of the
pass through communication and the restarting of
polling of the HART device.
Note: This function requires a HART Pass-
Through license key (part number FS8KY-
6).
Field Description
Freeze Value This read-only field shows the value received
from inputs when the Update button was last
clicked. The system uses these values in ongoing
processing (such as flow calculations, history
logging, or control) while calibration occurs.
Field Description
Calibrate Click to begin calibration and displays the Set Zero
dialog.
Calibrating a Use this process to calibrate an HART that is outside the temperature
HART Input limits.
1. Select a HART Point Number to calibrate.
2. Verify that the Communication Mode on the General tab is set to
Point-to-Point.
3. Click the Device tab and verify that the Poll Mode is set to Skip This
Device.
4. Click the Calibration tab.
Note: You can click Cancel to exit the calibration without saving the
changes. The system retains the previous calibration settings but
logs the event in the event log.
6. Complete the Dead Weight/Tester Value field. This value represents
the low range (0%) of the instrument’s measurement range.
When you enter a value in the Dead Weight/Tester Value field,
ROCLINK immediately begins comparing it once each second to
the value in the Live Reading field (obtained from the static
pressure sensor) and calculating the percentage deviation between
the two values.
7. Click Set Zero when the live reading stabilizes. ROCLINK 800 adds
the first line in the calibration log, renames the screen to Set Span,
and changes the label on the Set Zero button to Set Span.
Field Description
Poll Mode Sets the polling behavior for this device. Valid
values are:
Skip this Removes this device from the polling
Device sequence
PV Only Poll only the Primary Variable value.
Dynamic Poll values for all of the Dynamic
Variables Variables (primary, secondary, tertiary,
and fourth).
Slot Poll only the values for the three Slot
Variables Variables.
Update Poll for a full update of all values
Dynamic Variables Sets the values to use after a failure, if you have
on Failure set the value in the In Use Selection frame to Live
Value. Valid values are:
Retain Last Use the last dynamic values for
Value the dynamic variables.
Use Failsafe Use the value entered as the
Value Failsafe Value.
Use Use the value entered in the
Download PV Download PV field in the Extended
Parameters frame; the other
dynamic values use their failsafe
values.
Actual Scan Period This read-only field shows the actual amount of
time in seconds that passes between scans.
Field Description
Current (mA) This read-only field shows the current, in
milliamps, reported by the device.
% of Range This read-only field shows the percentage of the
range currently being reported by the device.
Status This read-only field shows the state of the device.
This field displays either No Device or
Communicating.
Response Code This read-only field shows the response status of
the device. Refer to the documentation from the
transmitter manufacturer for more information.
ID Number This read-only field shows a 3-byte globally
unique address of the device.
Active Alarms This read-only field shows any alarms that are
being sent from the device. These are not entered
in the Alarm Log.
Descriptor Provides up to 16 alphanumeric characters of
information (in addition to the device Tag) to more
specifically describe the device.
Message Defines a message (up to 32 alphanumeric
characters in length) sent to and stored in the
device.
PV This read-only field shows the value of the
Primary Dynamic Variable.
PV Fail Safe Sets the value to use as the Primary Variable,
after a failuret if you select Use Failsafe Value in
the Dynamic Variables on Failure frame.
SV This read-only field shows the value of the
Secondary Dynamic Variable.
SV Fail Safe Sets the value to use as the Secondary Variable
after a failure if you select Use Failsafe Value in
the Dynamic Variables on Failure frame.
TV This read-only field shows the value of the third
dynamic variable.
TV Fail Safe Sets the value to use as the Third Variable after a
failure if you select Use Failsafe Value in the
Dynamic Variables on Failure frame.
FV This read-only field shows the value of the fourth
dynamic variable.
FV Fail Safe Sets the value to use as the fourth variable after a
failure if you select Use Failsafe Value in the
Dynamic Variables on Failure frame. .
Tag Sets the name for the HART device to identify it
throughout the configuration. The tag should be 10
characters or less. When in Multidrop mode, the
tag must be unique for every device.
Poll Address This read-only field shows the address used for
this HART device. In Point to Point mode, the Poll
Address is 0. In Multidrop mode, the system uses
addresses between 1 and 5.
Field Description
Device ID This read-only field shows the coded ID that
reflects the manufacturer of the device, the device
type, and the device ID.
PV Sensor Serial This read-only field shows the serial number of
Number the sensor.
PV Upper Sensor This read-only field shows the upper limit on the
Limit sensor.
PV Lower Sensor This read-only field shows the lower limit on the
Limit sensor.
Sensor Units This read-only field shows the units of measure
for the upper and lower sensor limits.
Slot Assignment Sets the value (0, 1, 2, or 3) to determine which
(0 through 3) variable in that slot to request.
Slot Value These read-only fields show the value (0, 1, 2 or
(0 through 3) 3) of the variable requested from that slot. The
read-only units defined in the device displays to
the right of this field.
PV Damping Value This read-only field shows the damping value
reported by the device for the Primary Variable.
PV Range Units This read-only field shows the units of measure
for the analog output minimum span and upper
and lower range limits.
PV Upper Range This read-only field shows the maximum value in
Limit the analog output range.
PV Lower Range This read-only field shows the minimum value in
Limit the analog output range.
PV Minimum Span This read-only field shows the minimum sensor
span.
Alarming Activates alarms for this device. Valid values are
Enabled (active alarms) or Disabled (prevent
alarms for this device). The default is Disabled.
High Alarm Sets a high value limit for alarms for this device.
Low Alarm Sets a low value limit for alarms for this device.
Alarm Deadband Sets a deadband
Active Alarm This read-only field shows any current alarms for
this device.
In Use Selection Indicates the value the system uses for the
primary value while in operation. Valid values are:
Live Value Use the value from the device. If
device fails, use value specified in
PV Fail Safe field.
Failsafe Sets PV value to the value entered
Value in the PV Fail Safe field.
Download Sets PV value to the value entered
Value in the Download PV field.
Download PV Sets a specific value the system uses if you select
Use Download PV in the Dynamic Variables on
Failure frame.
Field Description
Live PV This read-only field shows the live primary
variable for the device.
In Use Status This read-only field shows the current In-use
settings.
Switch Trips application is notified of this condition to signify that the pulse
accumulations are invalid.
Master Meter Provers APM supports master meter provers in that the APM can accept a
software detector switch simulation to start and stop pulse counting.
APM accumulates whole pulses between the software detector switch
triggers for both the meter being proved and the master meter.
Note: While pulse interpolation is not required for the master meter
proving, interpolated pulses are always provided.
Detector Switches APM support two detector switches that gate the accumulation of pulses
during a prove. APM recognizes a detector switch trigger at any change
in state of a detector switch. APM starts the accumulation of whole
pulses between detector switches at the first detector switch transition
and stops the accumulation at the second detector switch transition.
APM implements a detector switch filter time so as to not misinterpret
"noise" after a detector switch transition as another transition. The APM
displays the pulse counts and the interpolated pulse counts.
Examples of APM configurations include:
Ch 1 Ch 2 Ch 3 Ch 4 Detector 1 & 2
Config 1 PI PI PI PI Always Present
Config 2 PI PI PI PO Always Present
Config 3 PI PI Densitometer Input PI Always Present
Config 4 PI PI Densitometer Input PO Always Present
Config 5 PI PI API Pair 2 – –
– Ch 1 and Ch 2 Ch 3 Ch 4 Detector 1 & 2
Config 6 API Pair 1 PI PI Always Present
Config 7 API Pair 1 Densitometer Input PI Always Present
Config 8 API Pair 1 Densitometer Input PO Always Present
– Ch 1 and Ch 2 Ch 3 and Ch 4 Detector 1 & 2
Config 9 API Pair 1 API Pair 2 Always Present
APM Switches The Advanced Pulse Module has several switches you can set for
specific actions.
S4 S2
S3
S1
S5
Left/Right Switch
Switch Number Channel Channel
Side 1 Position 1
S1 – 1 = Standard PI – Up
S1 – 1 = Densitometer – Down
S2 Left 1 = In 2 1 = Out 3 Up
S2 Right 2 = In 2 = Out Up
S3 4 Left 3 = In 3 = Out Up
S3 Right 4 = In 4 = Out Up
S4 Left Detector switch 2 = In Detector switch 2 = Out Up
S4 Right Detector switch 1 = In Detector switch 1 = Out Up
S5 Left 4 = Pulse Output – Up
S5 5 Right – – –
1
Descriptors (up/down/right/left) assume that module terminal blocks face upward and daughter board is
visible.
2
In = Pull-up resistor is in the circuit.
3
Out = Pull-up resistor is not in the circuit.
4
If S1 is down, this switch is non-functional.
5
Right side of switch 5 currently not used.
You can configure the module as a two point pulse input for two pulse
pairs. The pulse inputs are read-only, non-resettable pulse accumulation
counters.
APM supports a Micro Motion (formerly Solartron) densitometer on
channel 3 that provides a frequency in the range of 0 to 10 KHz as a
pulse input.
The four pulse input channels have a number of applications. When
used with dual pulse turbine meters, then you can use the APM to create
two API 5.5, level B, C, D, and E compliant pairs, while Level (Pair)
also supports API Level A. Both levels support marker pulses.
Channel 3 can provide the hardware filtering to support the frequency
input from a Micro Motion (formerly Solartron) 7835/7845
densitometer. This hardware filtering is switched into channel 3 by a
hardware switch located on the module.
Channel 4 can be designated as either a pulse input or a pulse output.
The pulse input can support up to 5-kilohertz inputs. When connected as
pulse inputs, the APM module processes the PI signals from pulse-
generating devices and provides a calculated rate and an accumulated
pulse total. The PI is most commonly used to interface to relays or open
collector/open drain type solid-state devices.
The pulse input can interface to either self-powered or ROC-powered
devices with signals up to 5 kilohertz. With the pull-up resistor "in," the
PI supports externally powered open collector and open drain devices as
well as externally powered contact closure devices. If the pull-up
resistor is "out," then pulse inputs supports 0 to 3 volts dc through 0 to
12 Volts dc sourced square wave input signals. Refer to Table 7-2. APM
Hardware Switches.
Note: This screen displays various fields based on the options you
select. Consequently, it is not possible for one screen image to
display all options.
Field Description
Point Number Sets the Advanced Pulse Module Point Number to
configure.
Note: This selection applies to each tab on this
screen.
Tag Sets a 10-character alphanumeric identifier for
each point.
Note: This selection applies to each tab on this
screen.
Pulse Info (Pulse Input 1 through Pulse Input 4)
Tag Sets a 20-character identifier for the pulse input
being configured.
Raw Pulse Count This read-only field shows the raw number of
pulses.
Frequency This read-only field shows, in hertz, the frequency
of incoming pulses.
Scan Period Sets the time period, in seconds, in which the
system evaluations the parameters associated
with the pulse input.
Configuration This read-only field shows the configuration
(Pulse Input or Pulse Output) of the terminal for
channel 4.
Note: For the APM to function as a pulse output
on channel 4, you must manually set the
S3 switch. Refer to Table 7-2. APM
Hardware Switches.
Field Description
Pulse Security The APM supports different field devices based on
Level (Pair 1 and 2) various hardware switch settings. You can “pair”
pulse inputs for use with API 5.5 compliant Pulsed
Data Fidelity and Integrity algorithms. Pulse Input
1 and Pulse Input 2 share the Pulse Fidelity Level
(Pair 1) configuration. Likewise, Pulse Input 3 and
Pulse Input 4 share the Pulse Fidelity Level (Pair
2) configuration.
Options for pulse fidelity checking (integrity
security) are Level A through Level E for Level
(Pair 1) and Level B through Level E for Level
(Pair 2). API standards are in accordance with the
American Petroleum Institute Manual of Petroleum
Measurement Standards Chapter 5.5, August
1987. Both levels also support Marker Pulse
options for Pulse Fidelity.
Level A This level of fidelity checking requires a dual pulse
train and two Pulse Inputs. Level A performs
continuous monitoring, detection, and corrections
of errors as it compares one pulse train against
the other. Continuous comparison of the pulse
trains for missing pulses as well as simultaneous
pulses occurs. In the event of missing pulses, the
system simulates the missing pulses and adds
them to the pulse accumulations. The system
detects simultaneous interfering pulses but does
not include them toward the total pulse count. If
you enable alarming, the same channel alarm
count increments in the event of missing pulses,
the phase alarm count increments in the event of
simultaneous pulses, and the total alarm count
increments in both cases. You can use the alarm
threshold to set a lower frequency limit below
which alarms based on these bad pulses do not
generate.
Level B This level of fidelity checking requires a dual pulse
train. Two pulse inputs enable Level B to perform
continuous monitoring, detecting, and warning of
errors (alarming), as it compares one pulse train
against the other. Continuous comparison of the
pulse trains for the number, frequency, phase, and
sequence occur. Level B security provides
warning of transients and other spurious
influences and protection against functional errors
and failures. Simultaneous interfering pulses are
detected and indicated. If the pulses delivered are
lost or gained on either channel (PI1/PI2 or
PI3/PI4), a differential counter API warning occurs.
Refer to the discussion of the Alarms tab. If the
frequency of the pulses falls below 101 Hz, the
APM defaults to a simulated Level C until the
frequency increases above 111 Hz.
Field Description
Level C This level of fidelity checking requires a dual pulse
train. Two pulse inputs enable Level C to
automatically detect and warn when errors occur,
as it compares one pulse train against the other at
approximately one-second intervals. Comparison
of the pulse trains occurs automatically but not
continuously. Level C security provides protection
against functional errors and failures. If the pulses
delivered become numerically out of step, a
differential counter API warning occurs. Refer to
the discussion of the Alarms tab.
Level D This level of fidelity checking uses only a single
pulse train and requires only one pulse input.
Level D allows manual detection of errors, as the
results of the pulse train calculations are
compared by an operator against a mechanical
readout (user supplied) at specified intervals. The
manual error monitoring is at specified intervals by
methods of comparison and provides amplification
and frequency limiting, pulse shaping, and
common mode inference rejection. The readout is
visually checked against an independent totalizing
system. Level D security provides protection
against functional errors and failures.
Level E This level of fidelity checking uses only a single
pulse train and individual pulses using one pulse
input. Level E is a straightforward totalizer system.
The pulses are counted, but the system does not
perform error detection; integrity depends solely
on the quality of the equipment. Level E provides
amplification and frequency limiting, pulse
shaping, and common mode inference rejection.
The system does not provide built-in provisions for
error monitoring.
Field Description
Marker Pulse This level of fidelity checking adds an option to the
level checking for each pair, Check Pulse
Verification. When set, the first pulse input of the
pair is the standard pulse input and the second
input of the pair is the check pulse input. You
configure the check pulse as a configurable
number of standard pulses, on a repeating basis.
There are two additional accumulators, the first is
an accumulation of standard pulses that updates
at the time the system receives the check pulse.
For example, if the system receives the check
pulse every 500 pulses, this accumulator updates
to 500, 1000, 1500, and so forth. The second
accumulator is the difference between the
expected standard pulses at the check pulse and
the actual number. For example, if the system
receives the check pulse every 500 pulses and the
system receives the check pulse at 499, this
accumulator would read –1. If the system receives
the next pulse at 1002, it would then read 2.
An alarm bit is available and set when the
difference between the expected and actual
standard pulses exceeds a user configured
deadband. You can also trigger a reset, resetting
the two accumulators and restarting the check
pulse verification upon the first check pulse the
system receives.
Pulse Fidelity The Level options you select define which of the
following fields display.
Total Accum Pair This read-only field shows the accumulated
(1 and 2) number of pulses (forward and backward) through
the API level checks for pulse pair 1 and 2.
Note: This field displays only when you select
Level A, B, or C for pair 1 or 2.
Frequency Pair This read-only field shows, in pulses/second, the
(1 and 2) frequency of incoming pulses on Pair 1 or Pair 2.
These values assume the API level is set the
same for both pairs under the Pulse Security
frame.
Pulse 2-Pulse 4-Pulse
Security Inputs Inputs
Level A 2000 Hz N/A
Level B 4000 Hz 2000 Hz
Level C 8000 Hz 4500 Hz
Level D/E 9000 Hz 5500 Hz
Note: This field displays only when you select
Level A, B, or C for pair 1 or 2.
Forward Accum This read-only field shows the accumulated
Pair (1 and 2) number of forward pulses through the API level
checks for pulse pair 1 and 2.
Note: This field displays only when you select
Level B or C for pair 1 or 2.
Field Description
Reverse Accum This read-only field shows the accumulated
Pair (1 and 2) number of reverse pulses through the API level
checks for pulse pair 1 and 2.
Note: This field displays only when you select
Level B or C for pair 1 or 2.
Bad Pulse Counter This read-only field shows the number of bad
pulse pairs the system receives before setting the
API Pair 1 alarm status when using API Level A.
Note: This field displays only when you select
Level A for pair 1.
Alarm Threshold Sets the number of bad pulse pairs the system
can receive before setting the API Pair 1 alarm
status when using API Level A.
Note: This field displays only when you select
Level A for pair 1.
Reset Threshold Sets the number of good pulse pairs the system
can receive before clearing the API Pair 1 alarm
status.
Note: This field displays only when you select
Level A for pair 1.
Alarm Inhibit Sets a frequency below which the pair 1 alarm
Frequency status no longer sets. Existing alarms clear either
if you select Reset Alarm Count in the Action
Below Alarm Inhibit Frequency frame or if the
number of good pulse pairs the system receives
falls below the good pulse threshold for Pair 1.
Note: This field displays only when you select
Level A.
Action Below Alarm Indicates whether the number of bad pulse pairs
Inhibit Frequency contributing towards the Pair 1 bad pulse
threshold and the existing alarm bits clear when
the frequency falls below the low frequency cutoff
for pair 1. Valid values are Retain Alarm Count
(does not clear the alarm) and Reset Alarm
Count (clears the alarms).
Note: This field displays only when you select
Level A.
Flow Pulses per Sets the number of flow pulses to expect between
Marker Pulse each marker pulse. The default is 1000.
(Pair 1 and 2) Note: This field displays only when you select
Marker Pulse for pair 1 or 2.
Alarm Pulse Sets the deviation of flow pulses from expected
Deadband pulses at a marker pulse that must occur before
the system triggers the Marker Pulse alarm. The
default is 5.
Note: This field displays only when you select
Marker Pulse for pair 1 or 2.
Flow Pulse Accum This read-only field shows the accumulation of
at Marker Pulse flow pulses, updated whenever the system
receives a marker pulse.
Note: This field displays only when you select
Marker Pulse for pair 1 or 2.
Field Description
Flow Pulses Drift This read-only field shows the drift from expected
from Expected flow pulse value, updated whenever the system
receives a marker pulse.
Note: This field displays only when you select
Marker Pulse for pair 1 or 2.
Reset Marker Pulse Click to reset the flow pulse accumulation and flow
Values pulse drift for pair 1 or pair 2. Applies only when
using Marker Pulse level checking.
Note: This button displays only when you select
Marker Pulse for pair 1 or 2.
Flow Direction (Pair This read-only field shows the direction of flow.
1 and 2) Direction of flow is based on 180 degrees out of
phase for the first and second pair of pulses.
Forward indicates less than 180 degrees; Reverse
indicates more than 180 degrees. The Forward
and Reverse designators assume 90 degrees out-
of-phase.
Note: This field displays only if you select Level B
for pair 1 or 2.
Field Description
PI-4 Configuration This read-only field shows the configuration of the
PI-4/PO terminal of the APM. A hardware switch
configures this value.
Note: For the module to support a pulse output
on channel 4, you must manually set the
left S5 switch in the up position. Refer to
Table 7-2. APM Hardware Switches.
PO Scan Period Sets, in seconds, how often the firmware
evaluates the inputs to determine how many
pulses to send out. All other output pulses are at a
50% duty cycle.
PO Input TLP Sets the value of the input TLP. The value is
depends on you configure the PO Input mode (as
a rate or an accumulation). Click the TLP button to
set the input to be used in calculating the output
pulses.
PO Input Mode Sets the interpretation of the Input TLP. Valid
values are Rate (calculates the integrated rate by
multiplying the time and rate to determine the
quantity, and then by subtracting the new
accumulated value from the old accumulated
value to determine the pulse output value) or
Accumulation (sets a constant accumulation
value against which you can define a PO Scaling
Value for adjustments, so that the old value minus
the new value represents the accumulated change
value or the pulse output value).
Field Description
PO Accumulator This read-only field shows the accumulated
number of pulses sent out.
PO Scaling Value Sets the value the system applies to the
accumulated pulse value based on the value in the
PO Input Mode field.
PO Max Frequency Sets the maximum number of pulses per second
that can be output by the pulse output (in Hz). If
the calculated number of pulses exceeds this
value, those pulses are placed in the buffer. For
example, if you set the PO Max Frequency to 20,
no more than 20 pulses are sent out within the
Scan Period time.
During a meter proving operation, detector inputs start and stop the
accumulated pulse counts, a positive-to-negative transition on either
detector input generates a time-stamped interrupt with the 30-megahertz
on-board processor. This interrupt is used in the pulse accumulation
between the detectors as well as the pulse interpolation calculations for
use with small volume provers.
When a displacement prover is used, the installed prover device uses the
detector switch pulse count to acquire the whole (full) meter count
pulses and interpolated pulses. Pulse interpolation determines if a trip
occurred before or after a trip per the American Petroleum Institute's
Manual of Petroleum Measurement Standards Chapter 4 - Proving
Systems, Section 6 - Pulse Interpolation.
Field Description
APM DET and SW Indicates, using light-emitting diodes (LEDs) on
LEDs the APM module, the current status for each
channel of the module. The DET and SW LEDs
indicate the status of the detector switches:
▪ Both LEDs blink simultaneously – APM has
no firmware resident in the module. Refer to
Update Firmware.
▪ LEDs toggle blink – APM is in the process of
programming the flash memory. Do not
remove the module or power down the ROC.
▪ Both LEDs are solid – APM is in the process
of erasing the flash memory. Do not remove
the module or power down the ROC.
▪ LEDs blink independently – APM is
transmitting or receiving pulses on the
detector switches.
Meter Input Sets the pulse input to use for the Meter Prove.
Hardware detector switches are used for
displacement provers. This is the pulse to view at
the meter gate to acquire the count.
Master Meter Input Sets the pulse input to use for the Master Meter
Prove. Select this option when you are using
another meter to provide the pulse counts and not
an actual displacement prover.
Software detector switches are used for master
meters, so the Master Meter Input is only valid if
the S/W Det. Switch Enabled field is set to Enable.
S/W Det Switch Sets the proving for use with a Master Meter or
Enabled tank prover. APM supports two detector switches
which gate the accumulation of pulses.
Detector Switch This read-only field shows the current physical
Status open or closed contact status of the detector
switch. Options include Contact Open or Contact
Closed.
Detector Switch This read-only field shows the current state of the
State detector switch indicating what the trip is doing:
▪ Reset has been received and the APM is
expecting a detector switch transition.
▪ Counting indicates a detector switch
transition has occurred and the APM is
currently counting whole pulses.
▪ Complete indicates another detector switch
transition has occurred and the Prove Run is
complete. All values will be stored until the
next reset. The values in the Proving Pulse
Counts frame are valid to use in calculations.
▪ Invalid Data indicates the accumulator does
not contain valid values. This can be either at
a power up or if you lost communication during
a prove and the accumulators have been reset
to zero.
Field Description
Detector Switch Sets, in milliseconds, the time allotted after a
Filter Time detector switch triggers but before the next trigger
occurs. This is a de-bounce filter for the detector
switches to ensure that any "noise" is filtered out
and is not read as another detector switch trigger.
This is the maximum filter time for how long the
trip waits before the pulses are read again.
S/W Detector Switch Sets to start and stop the software detection
switch from counting pulses for a Master Meter or
tank prove. Once the APM receives a trigger, the
APM automatically resets to idle. Click Reset
before starting a Master Meter prove.
Note: Use only if the S/W Detector Switch is
Enabled.
Reset Button Notifies the APM to clear values in the Proving
Pulse Counts frame and prepare to read the trip
counter pulses. All accumulated pulse values and
alarms are cleared. Accumulation of whole pulses
starts at the first detector switch transition and
stops at the second detector switch transition.
Meter Whole Pulse This read-only field shows the actual number of
Counts whole pulses accumulated between detector
switches for a Meter Input. Click Reset to clear
this value.
Meter Interpolated This read-only field shows the actual number of
Pulse Counts interpolated pulses accumulated between detector
switches for a given pulse input. Click Reset to
clear this value.
Master Meter Whole This read-only field shows the actual number of
Pulse Counts whole pulses accumulated between detector
switches for a Master Meter Input. Click Reset to
clear this value.
Master Meter This read-only field shows the actual number of
Interpolated Pulse interpolated pulses accumulated between detector
Counts switches for a given pulse input. Click Reset to
clear this value.
Field Description
PI Alarming Sets Alarming for this point. If Alarming is set to
Enabled, alarms are written to the Alarm Log.
These are the API pulse fidelity alarms when
performing dual pulse integrity checking on a pair
of pulses. Specifically sequenced out of order,
phase discrepancy, pulse synchronization,
frequency discrepancy, and pulse failure alarms.
These alarms are all dependent on what level of
security is being used.
Field Description
PI SRBX Sets the SRBX Alarming option to configure
Spontaneous-Report-By-Exception (SRBX)
alarming for this point.
▪ On Set – The point enters an alarm condition,
the ROC generates a Spontaneous-Report-by-
Exception message to the host.
▪ On Clear – The point leaves an alarm
condition, the ROC generates a Spontaneous-
Report-by-Exception message to the host.
Note: SRBX Alarming requires the
communications port to be configured.
API Alarm Status API Level Alarm Status indicating the failure error
for the alarm.
Note: These are updated in real time
API Phase Alarm This read-only field shows the total number of
Count phase alarms.
API Same Channel This read-only field shows the total number of the
Count same channel alarms.
Pulse Output PO alarms safeguard against the loss of too many
Alarms pulse counts. Certain devices cannot read the
pulse counts as fast as they are produced; thus,
loosing pulse counts. The APM module buffers
and tracks pulse counts to ensure the pulse count
values read are the same as the actual pulse
counts that are output. The buffer fields enable
you to determine how many lost pulses can occur
before an alarm is triggered.
When enabled, enter a value in the Buffer
Warning Set Point field. This is the maximum
buffered pulses allowed before the buffer warning
alarm is triggered. The value in the Maximum
Buffered Pulses field is the maximum buffered
pulses allowed. If the number of pulses requested
to send out exceeds the Maximum Number of
Buffered Pulses an alarm occurs and you
essentially lose any pulses greater than the value
set in this field.
PO Alarming Sets Alarming for this point. If Alarming is set to
Enabled, alarms are written to the Alarm Log.
These alarms are for the pulse output of the APM
and are used when the PO begins to buffer
pulses. There are two alarms, a buffer warning
and a buffer overflow. When the warning alarm is
present, it indicates that the buffer is being filled
and it has passed a user specified set point. If the
overflow has occurred, indicates that the buffer is
filled up and pulses are being lost.
Field Description
PO SRBX Sets the SRBX Alarming option to configure
Spontaneous-Report-By-Exception (SRBX)
alarming for this point.
▪ On Set – The point enters an alarm condition,
the ROC generates a Spontaneous-Report-by-
Exception message to the host.
▪ On Clear – The point leaves an alarm
condition, the ROC generates a Spontaneous-
Report-by-Exception message to the host.
Note: SRBX Alarming requires the
communications port to be configured.
PO Alarm Status This read-only field shows the type of alarm for a
pulse output.
Buffer Warning Set Sets the maximum buffered pulses allowed before
Point the buffer warning alarm is triggered. This must be
less than the Maximum Buffered Pulses allowed.
Maximum Buffer Sets the maximum buffered pulses allowed. If
Pulses the number of pulses requested to send out
exceeds the Maximum Number of Buffered Pulses
an alarm occurs and you essentially lose any
pulses greater than the value set in this field.
APM Module Sets Alarming for this point. If Alarming is set to
Alarming Enabled, alarms are written to the Alarm Log.
These are module only alarms. In other words,
alarms which are related to the module as a
whole. Currently only one alarm is available, which
is a point fail alarm. If there is a malfunction with
the APM, specifically a loss of communication
between the module and the device, then this
alarm will be set.
Module SRBX Sets the SRBX Alarming option to configure
Spontaneous-Report-By-Exception (SRBX)
alarming for this point.
▪ On Set – The point enters an alarm condition,
the ROC generates a Spontaneous-Report-by-
Exception message to the host.
▪ On Clear – The point leaves an alarm
condition, the ROC generates a Spontaneous-
Report-by-Exception message to the host.
Note: SRBX Alarming requires the
communications port to be configured.
PO Alarm Status This read-only field displays the type of alarm for
a pulse output.
Field Description
Contract Hour Sets the channel on the ACIO module that you
desire to configure.
Note: This selection in this field applies to each
tab on this screen.
Rate Period Sets how the system calculates rates. Valid values
are:
EU/Sec Calculation based on EU second totals.
EU/Min Calculates based on EU minute totals.
EU/Hour Calculation based on EU hourly totals.
EU/Day Calculation based on EU day totals.
Note: The system calculates Current Rate as
(accumulated pulses ÷ conversion) ÷ (scan
period x conversion to correct time).
Pulse Input 1-4 Sets a short (20-alphanumeric characters)
identifier for the engineering units used for each
pulse input.
Pulses Today This read-only field displays the total number of
pulses that the PI has received for the contract
day. At the end of the contract day, it zeros and
starts over, only if being totalized in History. The
Contract Hour is specified on this screen.
EU Today Displays the total EU Values accumulated for the
current contract day, calculated by multiplying the
conversion value by the accumulated pulses. The
system resets this value to zero at the contract
hour.
Field Description
EU Yesterday This read-only field shows the total EU Value
accumulated the previous contract day, calculated
as the previous day’s Today’s Total value at the
contract hour before being cleared.
EU Calc Rate This read-only field shows the calculated rate as of
the most recent scan expressed in EUs per unit of
time. You select time units using the Rate Period
field on the Advanced tab. The system calculates
the rate at the end of each scan period by dividing
the number of pulses received by the conversion
value divided by the rate period.
EU Conv Value Sets a conversion factor that the system divides
the number of pulses by to determine the rate.
Field Description
Discrete Outputs Selects the discrete output to be configured. The
outputs are listed by both Point Number and Tag.
Note: This selection in this field applies to each
tab on this screen.
Time On Sets, in seconds, the amount of time for
momentary operation. The default value is 1
second for a DO. The default value is 5
milliseconds for an ACIO DO.
Note: In Momentary mode, this is the amount of
time (in seconds) that the momentary
contact is energized. In the Toggle mode,
this is the time (in seconds) between
switching On or Off. In the TDO and TDO
Toggle modes, the TDO configuration
calculates this value.
Field Description
Auto Output Indicates the state of the discrete output. Off
indicates that the output is Off or that a switch is
open; On indicates that the output is On or that a
switch is closed.
Manual Output This field indicates the state of the discrete output.
Off indicates that the output is Off or that a switch
is open; On indicates that the output is On or that
a switch is closed. Select On and click Apply to
force one transition of the DO.
Momentary This read-only field shows the state of the
discrete output when the DOUT Type is set to
Momentary. Off indicates that the output is Off or
that a switch is open; On indicates that the output
is On or that a switch is closed.
Physical Output This read-only field shows the actual status of the
output channel at the field terminations regardless
of the DOUT Type selected.
DOUT Type Selects the function of this discrete output. Valid
values are:
Latched Changes on an active transition
of the output (from off to on).
The discrete output remains On
until cleared by selecting Off in
the Auto Output field.
TDO or Time Enables the discrete output to
Duration have a time duration between
On and Off transitions based on
time-related parameters
configured in the TDO
Parameters Tab.
Momentary Enables ROCLINK 800 to
activate the discrete output for
the amount of time defined in the
Time On field.
Toggle Enables a square-wave output
for which both the time on and
time off are defined by the value
in the Time On parameter. Time
on and time off are equal. Use
the TDO Parameters Tab to
define time-related parameters.
TDO Toggle Enables the discrete output to
continuously repeat in a cycle
defined by the value in the
Cycle Time field on the TDO
Parameters Tab where the EU
Value controls the on-time
duration.
Field Description
Scanning or Sets the scanning type to configure how the DO is
Scanning Mode scanned. Valid values are or Auto (automatically
process the last output scan) or Disabled (permit
only manual updates of the output). Manual
(manually permit a process of the last output
scan).
Note: If you enable alarming, the ROC generates
a Manual Mode alarm when scanning is
disabled.
▪ For the output to automatically process the
field output, select Auto.
▪ When Scanning Mode is set to Disabled or
Manual, the DO is no longer updated by the
ROC
▪ When the Scanning Mode is set to Manual,
set Manual Output to On and click Apply to
override the output.
▪ When Scanning Mode is set to Disabled, set
Auto Output to On and click Apply to
override the output.
Active Alarms This read-only field shows any active alarms for
this point. When you Enable alarming, the limit
alarms (such as Low Alarm and Rate Alarm) that
are active appear. Even if you Disable alarming,
the Point Fail (hardware reports a malfunction)
alarm and Manual (Scanning Disabled) indicators
can still appear.
Field Description
Output Set to Inverted or Normal to define the action of
the discrete output value. Normal output energizes
in Time On and Inverted output energizes in off
time.
Note: Selecting Inverted inverts all outputs in any
mode. If you set both Failsafe State and
Inverted to On, the Failsafe State returns to
Off on a reset.
Action After Reset Sets the Action After Reset or Power Fail
or Power Fail parameter to determine the value for the output
after a reset or power failure. The DO can retain
the last values before the reset or power failure.
If Use Failsafe State is selected, you must specify
whether the Auto Output or Manual Output is set
to On or Off after a reset of the ROC, such as a
power restart or a warm start.
Failsafe State Sets the Action After Reset or Power Fail
parameter to determine the value for the output
after a reset or power failure. The DO can retain
the last values before the reset or power failure.
If use Failsafe State is selected, you must specify
whether the Auto Output or Manual Output is set
to On or Off after a reset of the ROC, such as a
power restart or a warm start.
Accumulated Value Sets a value for the accumulated number of off-to-
on transitions for the discrete output. The
accumulator is a 32-bit number with a maximum
count of 4,294,967,295. You can preset the
accumulator to a desire value or clear it by enter
zero (0).
Field Description
Holding Current This read-only field shows the current
approximate load value of the output in milliamps.
Module Inrush Time Sets devices you connect to the ACIO module to
draw more than 1.5A(rms) for the number of
seconds you specify. This parameter assumes
60hz AC.
Module AC Sets the frequency of the AC input to ensure the
Frequency correct functionality of fault detection.
Relay Status This read-only field shows the current status of
the output:
▪ Normal – The relay is healthy.
▪ Fault – A fault condition has occurred on this
channel, the channel has been shut down and
may not be re-enabled without first resetting
this parameter
▪ Failure – A relay failure has been detected.
This is a physical failure. This module must be
repaired by the factory.
Fault Reset Click to reset the output after a fault.
Field Description
Cycle Time Sets, in seconds, the total amount of time the
cycle spends in the on and off positions. The
default is 15 seconds.
The Cycle Time entry is used to define the OFF
time in the TDO Toggle mode. The OFF time is
calculated by the formula:
Field Description
Alarming Sets the alarm option for this point. Valid values
are Enabled (enables alarming) or Disabled
(does not generate limit alarms).
Note: The Point Fail alarm may appear in the
Active Alarms field, but is not logged in the
Alarms file. If you enable alarming, the
system generates an alarm if you disable
scanning.
RBX Alarming Sets the Spontaneous-Report-by-Exception
(SRBX or RBX) alarming for this point. Valid
values are:
▪ On Alarm Set - Generates an RBX message
to the host when the point enters an alarm
condition.
▪ On Alarm Clear - Generates an RBX
message to the host when the point leaves an
alarm condition.
Note: SRBX Alarming requires the
communications port to be configured.
Failure Action Sets the action to perform upon alarm detection:
▪ Shut Down Channel, Log Alarm – Shuts
down the DO and logs an alarm event.
▪ Log Alarm Only – Leaves the DO in alarm
state and logs an alarm event.
▪ No Action – No action performed upon alarm
detection.
Field Description
Point Number This read-only field identifies the rack location for
this point.
Scan Period Sets, in seconds, how frequently the system scans
the input.
Status Sets the state of the discrete input. Valid values
are On (indicates that a contact is closed or input
is on) or Off (indicates that a contact is open or
input is off).
Physical Status This read-only field shows the state of the
hardware. Off normally indicates that a switch is
open; On normally indicates that a switch is
closed. This may be different from the Status if
Inverting or Latching is in effect.
Field Description
Scanning Sets the scanning option for this point. Valid
values:
Enabled Automatically process the field
input.
Disabled Do not process the input.
DIN Type Sets how the DI functions. Valid values are:
Standard Follow the actual field input.
Latched Maintains the input status. For
example, in an active transition
from off to on, the DI remains in
the on state until you clear the
Status parameter either
manually or through the
software.
Active Alarms This read-only field shows any active alarms for
this point. When you Enable alarming, the limit
alarms (such as Low Alarm and Rate Alarm) that
are active appear. Even if you Disable alarming,
the Point Fail (hardware reports a malfunction)
alarm and Manual (Scanning Disabled) indicators
can still appear. Refer to User Interface Basics.
Field Description
Input Sets the state of the input. Valid values are
Normal (field input operates normally, so that On
is On) or Inverted (inverts the field input in the
Status field so that On becomes Off and vice-
versa).
In the Inverted state, an open circuit in the field
would then be indicated as On in the Status field,
and closed contacts would be indicated as Off.
Filter Sets, in conjunction with the Filter Intervals field,
the amount of time that the discrete input must
remain in the On (high) state before the device
recognizes it as such. Enter the Filter value as a
valid between 0 to 255. The discrete input returns
to the Off state immediately upon detection of the
On to Off transition; there is no filtering for this
transition.
Accumulated Value Counts the number of times the discrete input
goes from Off to On. The accumulator is a 32-bit
number with a maximum count of 4,294,967,295.
You can preset the accumulator by entering the
desired value or clear the accumulator by entering
0.
On Counter Counts the number of 50-millisecond periods
when the Status parameter is in the On state. The
On Counter is a 32-bit number that automatically
"rolls over" when it reaches its maximum value.
You can preset the On Counter by entering the
desired value or clear the counter by entering 0.
Note: The On Counter does not function if you
disable scanning.
Off Counter Counts the number of 50-millisecond periods
when the Status parameter is in the Off state. The
Off Counter is a 32-bit number that automatically
"rolls over" when it reaches its maximum value.
You can preset the Off Counter by entering the
desired value or clear the counter by entering 0.
Note: The Off Counter does not function if you
disable scanning.
Actual Scan This read-only field shows the actual amount of
time in seconds that passes between scans. This
number should be the same as shown for the
Scan Period parameter if the system is not
overloaded.
Field Description
Alarming Generate alarms on point status change. When
Alarming is Disabled, the Status Change alarm
appears in the Active Alarms field but is not written
to the Alarm Log.
Note: The Point Fail alarm may appear in the
Active Alarms field, but is not logged in the
Alarms file. If you Enable alarming, the
system generates an alarm if you disable
scanning.
RBX Alarming Sets the Spontaneous-Report-by-Exception
(SRBX or RBX) alarming for this point. Valid
values are:
▪ On Alarm Set – Generates an RBX message
to the host when the point enters an alarm
condition.
▪ On Alarm Clear – Generates an RBX
message to the host when the point leaves an
alarm condition.
Note: RBX Alarming also requires the
communications port to be properly
configured for RBX Alarming.
Save After you configure a point and click Apply, click Flash Memory Save
Configuration Configuration (on the ROC > Flags screen) to save I/O configuration
to permanent memory in case you must perform a cold start.
Field Description
Discrete Outputs Selects the discrete output to be configured. The
outputs are listed by both Point Number and Tag.
Note: This selection applies to each tab on this
screen.
Tag Sets a short (10 alphanumeric characters)
identifier for the point.
Note: This selection applies to each tab on this
screen.
Point Number This read-only field shows the rack location for
this point.
Time On Sets, in seconds, the amount of time for
momentary operation. The default value is 1
second for a DO. The default value is 5
milliseconds for an ACIO DO.
Note: In Momentary mode, this is the amount of
time (in seconds) that the momentary
contact is energized. In the Toggle mode,
this is the time (in seconds) between
switching On or Off. In the TDO and TDO
Toggle modes, the TDO configuration
calculates this value.
Auto Output Indicates the state of the discrete output. Off
indicates that the output is Off or that a switch is
open; On indicates that the output is On or that a
switch is closed.
Momentary This read-only field indicates the state of the
discrete output when the DOUT Type is set to
Momentary. Off indicates that the output is Off or
that a switch is open; On indicates that the output
is On or that a switch is closed.
Field Description
Manual Output This field indicates the state of the discrete output.
Off indicates that the output is Off or that a switch
is open; On indicates that the output is On or that
a switch is closed. Select On and click Apply to
force one transition of the DO.
Physical Output This read-only field indicates the actual status of
the output channel at the field terminations
regardless of the DOUT Type selected.
DOUT Type Selects the function of this discrete output. Valid
values are:
Latched Changes on an active transition
of the output (from off to on).
The discrete output remains On
until cleared by selecting Off in
the Auto Output field.
TDO or Time Enables the discrete output to
Duration have a time duration between
On and Off transitions based on
time-related parameters
configured in the TDO
Parameters Tab.
Momentary Enables ROCLINK 800 to
activate the discrete output for
the amount of time defined in the
Time On field.
Toggle Enables a square-wave output
for which both the time on and
time off are defined by the value
in the Time On parameter. Time
on and time off are equal. Use
the TDO Parameters Tab to
define time-related parameters.
TDO Toggle Enables the discrete output to
continuously repeat in a cycle
defined by the value in the
Cycle Time field on the TDO
Parameters Tab where the EU
Value controls the on-time
duration.
Field Description
Scanning or Sets the scanning type to configure how the DO is
Scanning Mode scanned. Valid values are or Auto (automatically
process the last output scan) or Disabled (permit
only manual updates of the output). Manual
(manually permit a process of the last output
scan).
Note: If you enable alarming, the ROC generates
a Manual Mode alarm when scanning is
disabled.
▪ For the output to automatically process the
field output, select Auto.
▪ When Scanning Mode is set to Disabled or
Manual, the DO is no longer updated by the
ROC
▪ When the Scanning Mode is set to Manual,
set Manual Output to On and click Apply to
override the output.
▪ When Scanning Mode is set to Disabled, set
Auto Output to On and click Apply to
override the output.
Alarming Sets the alarm option for this point. Valid values
are Enabled (enables alarming) or Disabled
(does not generate limit alarms).
Note: The Point Fail alarm may appear in the
Active Alarms field, but is not logged in the
Alarms file. If you enable alarming, the
system generates an alarm if you disable
scanning.
Active Alarms This read-only field shows any active alarms for
this point. When you Enable alarming, the limit
alarms (such as Low Alarm and Rate Alarm) that
are active appear. Even if you Disable alarming,
the Point Fail (hardware reports a malfunction)
alarm and Manual (Scanning Disabled) indicators
can still appear.
Field Description
Accumulated Value Sets a value for the accumulated number of off-to-
on transitions for the discrete output. The
accumulator is a 32-bit number with a maximum
count of 4,294,967,295. You can preset the
accumulator to a desire value or clear it by enter
zero (0).
Action After Reset Indicates how the ROC handles the discrete
or Power Fail output station on resets or power failures. Valid
values are Retain Last State (ROC retains the
DO state, whether on or off) or Use Failsafe State
(ROC uses the value you specify in the Failsafe
State field). The default is Retain Last State.
Failsafe State Specifies, if you select the Use Failsafe State
option, whether the system sets the virtual directo
output on or off following a reset or power failure.
The default is On. is selected, specify whether the
Auto Output or Manual Output is set to On or Off
after a reset of the ROC, such as a power restart
or a warm start.
Output Indicates whether the virtual DO output is Normal
(that is, on is on) or Inverted (that is, on is off).
The default is Normal.
Field Description
Cycle Time Sets, in seconds, the total amount of time the cycle
spends in the on and off positions. The default is
15 seconds.
The Cycle Time entry is used to define the OFF
time in the TDO Toggle mode. The OFF time is
calculated by the formula:
Field Description
High Reading Time Sets the High Reading Time (100% Count) in
seconds that represents a 100 percent output
pulse width. The default is 12 seconds. This is the
maximum amount of time that the TDO can be
energized to move the motor. Normally, this is the
amount of time it takes for the actuator to move the
valve from fully open to fully closed.
Low Reading EU Sets the engineering unit (EU) for the low reading
to zero percent output (low end of the EU range).
Based on the EU range determined in part by this
parameter, the EU value is converted to a
corresponding signal.
High Reading EU Sets the engineering unit (EU) for the high reading
to 100 percent output (or high end of the EU
range). Based on the EU range determined in part
by this parameter, the EU value is converted to a
corresponding signal.
EU Value Current value, displayed in engineering units.
In TDO Toggle mode, the EU Value controls the
Time On:
On Time = ((EU Value – Low Reading EU) /
(High Reading EU – Low Reading EU) * (High
Time – Low Time)) + Low Time
Units Sets the engineering units for the discrete output
(such as percentage, IN H2O, PSIG, MCF,
degrees F, milliamps, and volts).
TDO Time On The TDO Parameters tab allows configuration of
TDO parameters when one of the DOUT Types
TDO (Timed Duration) or TDO Toggle is selected
in the discrete outputs screen.
The Time On field is located on the general
discrete outputs tab. The Time On field is
calculated from the entered EU Value and the
previous definitions of Low Reading Time, High
Reading Time, Low Reading EU, and High
Reading EU entered in the TDO Parameters
screen. The calculation formulas are:
EU Span = High Reading EU Value – Low Reading EU
Count Span = High Reading Time (100% Count) – Low Reading Time (0% Count)
On Time = (Entered EU Value Count Span) + Low Reading Time (0% Count)
EU Span
Field Description
Alarming Sets the alarm option for this point. Valid values
are Enabled (enables alarming) or Disabled
(does not generate limit alarms).
Note: The Point Fail alarm may appear in the
Active Alarms field, but is not logged in the
Alarms file. If you enable alarming, the
system generates an alarm if you disable
scanning.
RBX Alarming Sets the Spontaneous-Report-by-Exception
(SRBX or RBX) alarming for this point. Valid
values are:
▪ On Alarm Set - Generates an RBX message
to the host when the point enters an alarm
condition.
▪ On Alarm Clear - Generates an RBX
message to the host when the point leaves an
alarm condition.
Note: SRBX Alarming requires the
communications port to be configured.
Select Configure > I/O > IEC62591 Module. The IEC62591 Module
screen displays. Examine the default settings and adjust the parameters
to suit your application on each of the tabs.
▪ The Module tab provides read-only statistical information about the
IEC62591 module, such as serial number and part numbers.
▪ The Network tab identifies the Join Key and Network ID for the
network. These values must correspond to the Network ID and Join
Key in the devices.
▪ The Commission tab auto-detects available uncommissioned
devices and enables you to add them to the defined network.
▪ The Transmitter tab enables you to access both read-only statistics
and modifiable parameters for a specific device associated with the
network.
▪ The Statistics tab provides read-only statistics the Field Link has
accumulated for the network. Click Reset Statistics to reset these
values at any time.
▪ The Diagnostics tab describes how to use the module’s USB port to
generate log information for resolving issues.
Save After you configure a point and click Apply, click Flash Memory Save
Configuration Configuration (on the ROC > Flags screen) to save I/O configuration
to permanent memory in case you must perform a cold start.
Note: To select more than one device, press the Ctrl key and left-click
each additional device.
Click Commission. After a few minutes, the device moves from the
Uncommissioned to the Commissioned list:
Field Description
Transmitter Displays the 8-character alphanumeric tag
associated with the transmitter. The system adds
the logical position (here, 1 - ) to the tag. Click to
display all devices currently defined for this
network.
Tag Defines an 8-character alphanumeric identifier for
the transmitter (such as Tnk2Lvl or Pmp1Tmp).
Message Provides an optional 40-character message
associated with the transmitter. Use this field for
explanatory or warning messages (such as Not to
exceed 300 psi).
Descriptor Provides an optional 13-character describing the
transmitter (such as Casing press).
Transmitter This section displays read-only information on the
Information transmitter, including serial number, manufacturer
ID, type of device, battery life, and other data.
Burst Rate Indicates, in seconds, how often the transmitter
sends out data. The default is 4 seconds.
Response Code Indicates whether the transmitter is responding. For
any value other than 0, the field turns red.
Note: Response codes are manufacturer-defined.
Refer to the documentation provided with the
transmitter or to the manufacturer’s website for a
complete list of response codes, their meanings,
and their resolutions.
Commission Status Indicates the current status of the device in the
commissioning process. Valid values are:
0 = Logical Not Used
1 = Configuring Burst Command
2 = Configuring Burst Variables
3 = Configuring Burst Rate
4 = Enabling Bursting
5 = Bursting (field highlighted in green)
6 = Data Stale (field highlighted in yellow)
7 = Communication Failure (field highlighted in red)
8 = Disabling Bursting
Poll Mode Indicates the mode the transmitter uses to acquire
information. The default is Normal, based on the
value in the Burst Rate field. Select Update and
click Apply to immediately perform an on-demand
polling and refresh all fields on this screen. The
mode reverts to Normal at the next Burst Rate
interval.
Dynamic Variables Displays the values for the primary (PV), secondary
(SV), tertiary (TV), and quaternary (FV) dynamic
variables.
Field Description
Slot Variables Defines the slot assignment and associated value
for up to four slot-based variables.
Each wireless transmitter contains up to 250 slots
able to store variable information (such as
temperature, pressure, scaling factors, altitude,
flow, and so on). Each transmitter manufacturer
defines which slots contain what information. Refer
to the documentation provided with the transmitter
or to the manufacturer’s website for a complete list
of slot assignments.
Note: WirelessHART conventions require that all
manufacturers reserve slots 246 through 249
for the dynamic variables PV, SV, TV, and
FV, respectively. Slot 250 is also reserved as
permanently unassigned, and does not
accumulate values.
Click Apply to save any changes you may make to the values on this
screen.
Note: You can also double-click a commissioned device on the
Commission screen to immediately access the Transmitter
screen for that device.
Note: After you configure a point and click Apply, click Flash
Memory Save Configuration (on the ROC > Flags screen) to
save I/O configuration to permanent memory in case you must
perform a cold start.
Field Description
FST Sets the FST sensor to configure. Click ▼ to
display all available FSTs.
Note: The selection in this field applies to each
tab on this screen.
Field Description
Tag Sets the ten-character identifier for the FST.
Note: The selection in this field applies to each
tab on this screen.
Version This read-only field shows the version (if
assigned) of the FST on download.
Description This read-only field shows the description (if
assigned) of the FST on download.
Status Sets the current state and enables you to start or
stop the FST. Valid values are Enabled (FST is
active) or Disabled (FST is not active).
Note: If you change the value in this field, click
Apply.
Registers #1 to #10 Provides up to 10 storage points for FST floating
point values.
Use FST registers to store calculated or manually-
entered values. You can also those values from
one FST to another. For example, an FST can
write values to the registers and also read the
values stored in the FST Register storage points.
Registers may be read from, or written to, any FST
configured for the ROC
Field Description
Timer #1 through #4 Sets up to four countdown timers that signal
certain periods or times have elapsed. You set the
time, and the FST updates the time. These four
timers, when set to values greater than 0,
decrement by 1 every cycle time. The scan period
determines the cycle times. Cycle time equals:
Misc #1 to #4 Sets up to four unsigned 8-bit integers (with valid
values from 0 to 255) the FST can use for global
storage.
Mesg #1 and Mesg Provides two 30-character fields for storing
#2 messages that display in the FST Message area.
Msg Data #1 and Displays any values associated with the
Msg Data #2 messages.
Execution Delay Sets a period, in seconds, between the execution
of successive FST command steps. The default is
0 seconds. The minimum delay is 0.1.
Results Register Sets a special-purpose register that stores the
floating point result from the most currently
executed command. The Result Register (RR)
may also be known as the Signal Value Analog
(SVA).
Compare Flag Sets a special-purpose 8-bit register that stores an
integer representing the numbers 0 through 255.
The logic commands manipulate the Compare
Flag. The Compare Flag may also be known as
the Signal Value Discrete (SVD).
FST Steps/Task Sets the number of tasks (steps) that you desire
Cycle the FST to complete in the amount of time set in
the FST Cycle Time (in seconds) field, which is
configured in the FST Editor Monitor Display.
FST Cycle Time This read-only field shows, in seconds, the
amount of time in which an FST will cycle as set in
the FST Editor Monitor Display.
EVT Command - Set in which log the FST Event (EVT) command
Log Events creates a file. Select in Standard Event Log to
record the event in the main Events Log. Select in
Weights & Measures Event Log to record the
event in the Weights & Measures Event Log if the
register is related to a weight or measurement
event.
Code Size Bytes This read-only field shows the number of bytes
the FST uses.
Code Pointer Byte This read-only field shows the pointer byte for the
FST.
Note: Use FST Monitor within the FST Editor to
monitor these operations.
PID Overview
Select Configure > Control > PID Loop. In a given PID point, two
separate PID loops are available: Primary and Override. In Primary
Only mode, the Override Control loop is disabled, leaving only the
Primary Control loop active.
The PID control loop can use either one analog output or two discrete
outputs to control the regulating device. If discrete output control is to
be used, one DO will provide open/forward control and the other DO
provides close/reverse control.
Each active PID loop acquires the Process Variable input and calculates
the change in output required to maintain its Setpoint. If Override
Control is enabled, the calculation result that is applied to the output
depends upon whether the High or Low Override Type Select is chosen.
If the output type is analog, the selected change in output is added to the
current value of the output. If the output type is discrete, the change in
output is sent to one of the two discrete outputs. The magnitude of the
correction determines the amount of time that an output is energized. If
the correction is positive, it is routed to the open/forward DO. If the
correction is negative, it is sent to the close/reverse DO.
One application of Override PID control allows pressure control to
Override flow control when the pressure exceeds a Setpoint value. For
example: The output of the Primary flow control loop would be selected
until the pressure input approaches the Override Setpoint of 700 PSIG.
As the pressure input approaches its Setpoint, the pressure loop tries to
close the valve and take over control at the point when the output
calculated by the pressure loop is less than the output calculated by the
flow loop. Control returns to the Primary flow control loop, when the
change in output required to maintain the Override Setpoint no longer
outweighs the flow loop's attempts to maintain its Setpoint.
Through the use of an FST, you may implement a switchover algorithm.
When the input exceeds a predetermined switchover value, the FST can
switch the mode to Override only. When the FST determines that the
input value is no longer in a critical range, the PID mode can be
switched back to Primary only.
Field Description
Tag Sets the ten-character identifier for the PID.
Note: This selection applies to each tab on this
screen.
PID Selects the PID point to configure. Click ▼ to
display all available PIDs.
Note: This selection applies to each tab on this
screen.
Field Description
Control Type Sets the control type for PID loop. Valid values
are:
▪ Primary Only – Sets the Primary loop as the
only active loop. The system uses the output
the Primary loop calculates to adjust the
control output.
▪ Override Only – Sets the Override loop as the
only active loop. The system uses the output
the Override loop calculates to adjust the
control output.
Note: This control type is used mainly for tuning
the Override loop or when loop selection is
controlled by an FST or other logic external
to the PID algorithm.
▪ Override Control – Sets both the Primary and
Override loops as active. The system
compares the outputs from the two loops and
uses either the lesser or greater of the two
outputs (based on the selection in the
Override Type Select field) to adjust the
control output.
Output Type Sets the output type for the PID loop. Valid values
are Analog (the system writes the PID output to
the assigned analog output point EU value) or
Discrete (the system writes the PID output to the
assigned DO Open Point EU value if the change in
output is positive or writes to the assigned DO
Close Point EU value if the change in output is
negative). Any discrete outputs must be
configured as Timed Duration Outputs (TDO).
Digital Valve (the system writes the PID output to
the assigned ACIO or DO point EU value).
Mode Sets the Mode for the PID Loop:
▪ Disabled – No loops are active and the PID
output parameter is not written to the assigned
control output.
▪ Manual – No loops are active and the system
writes the PID output parameter to the
assigned control output, allowing you to adjust
the output as required.
▪ Auto – PID loops are active as configured
under Control Type; you enter the setpoint of
the loops and the system automatically sends
any change in the calculated output to the
configured output point.
▪ Remote SP – PID loops are active as
configured under Control Type. The Setpoint
of the loops are read from the Setpoint I/O
Definition.
Loop Status Indicates which loop (Primary or Override) is
currently selected or disabled.
Field Description
Loop Period Sets, in seconds, the period of time between
executions of the PID algorithm. This is the
amount of time between executions from the
beginning of one execution to the beginning of the
next.
Note: If you select Override Control, both loops
executed in this time period.
Actual Period This read-only field shows the actual amount of
time (in seconds) from the beginning of the last
execution of the loop to the beginning of the
current execution of the loop.
Primary Setpoint Set an input using the TLP Browse button or enter
a Value for controlling the Primary PID loop's
Process Variable.
Note: This field does not display if you select
Override Only as a Control Type.
Primary Process Click the TLP Browse button to select a process
Variable variable for the Primary PID Loop or enter a value
to use for comparison to the Primary Setpoint.
Override Setpoint Set an input using the TLP Browse button or enter
a Value for controlling the Override PID loop's
Process Variable.
Note: This field does not display if you select
Primary Only as a Control Type.
Override Process Click the TLP Browse button to select a process
Variable variable for the Override PID Loop or enter a value
to use for comparison to the Primary Setpoint.
Output Point Click the TLP Browse button to select an analog
output point for the loop.
Note: This field displays only if you select
Analog as an Output Type on the General
tab.
DO Open Point Click the TLP Browse button to select a discrete
output open point for the loop. The DO Open Point
and DO Close Point values, respectively, open or
close the valve or other device. You must
configure these values as TDO (Time Duration
Output) discrete output mode.
Note: This fields display only if you select
Discrete as an Output Type on the
General tab.
DO Close Point Click the TLP Browse button to select a discrete
output close point for the loop. The DO Open Point
and DO Close Point values, respectively, open or
close the valve or other device. You must
configure these values as TDO (Time Duration
Output) discrete output mode.
Note: This field display only if you select
Discrete as an Output Type on the General
tab.
Field Description
Output Low Limit Sets the low limit for the analog or discrete output.
If a change in output causes the current value to
drop below this value, the system sets the output
to this value.
Output High Limit Sets the high limit for the analog or discrete
output. If a change in output causes the current
value to rise above this value, the system sets the
output to this value.
Show Trend / Hide Click Show Trend to display a graphical
Trend representation of the PID output and process
variable in reference to the set point over time.
Use the graph to assist in tuning the control loop.
When you hover over the trend line, the number
on the left updates indicating the SP, PV, and
Output at the point in time. Click Pause to stop the
update and Continue to restart the scanning.
Field Description
Gain Sets proportional gain as the ratio of the change in
output to the change in the error.
Override Type Sets the control output for the Override Type.
Select Valid values are High (system selects as the
control output the higher of the Primary Output
Change value or the Override Output Change
value) or Low (system selects as the control
output the lesser of the Primary Output Change
value or the Override Output Change value).
Reset Sets integral gain or reset as the ratio of the
change in output to the change in the integral of
the error with respect to time. This value is in
terms of repeats per minute.
Typically calculated as either (Primary Process
Variable – Primary Setpoint) or (Override Process
Variable – Override Setpoint).
Field Description
Rate Sets the derivative gain or rate as the ratio of the
change in output to the change in the error with
respect to time. This value is in terms of minutes.
Typically calculated as (Primary Process Variable
Primary Setpoint) or (Override Process Variable
Override Setpoint).
Scale Factor Sets values representing the ratio of the output
span to input (Process Variable) span. The sign of
the number specifies the action of the loop output:
negative for reverse action or positive for direct
action.
Primary Control Sets a "window" around the setpoint for the
Deadband Primary PID. When the process variable is within
this window, the system does not recalculate a
change in output. If you enter 5, the deadband is a
region of 5 units above and 5 units below the
setpoint in which the process variable can move
without affecting the output.
Override Control Sets a "window" around the setpoint for the
Deadband Override PID. When the process variable is within
this window, the system does not recalculate a
change in output. If you enter 5, the deadband is a
region of 5 units above and 5 units below the
setpoint in which the process variable can move
without affecting the output.
Primary SP Ramp Sets the maximum rate at which the Primary PID
Rate setpoint can ramp to a new value. Maximum rate
is in EU per minute where engineering units are
the units of the process variable.
Override SP Ramp Sets the maximum rate at which the Override PID
Rate setpoint can ramp to a new value. Maximum rate
is in EU per minute where engineering units are
the units of the process variable.
SP Low Limit Sets the SP Low Limit as the lowest allowed
value for the Setpoint.
SP High Limit Sets the SP High Limit as the highest allowed
value for the Setpoint.
Change in Output or This read-only field shows the calculated change
in output from the associated loop. You define
these values on the Inputs/Outputs tab.
Note: If you select Primary Only as a Control
Type, the Override Output Change field
does not display. If you select Override
Only as a Control Type, the Primary Output
Change field does not display.
Field Description
Threshold Sets the threshold to prevent premature selection
of the Override loop. If the Override process
variable is outside of this threshold on the safe
side of the Override setpoint, the system always
selects the Primary loop. However, if the Override
process variable is within the threshold of the
Override setpoint or is on the unsafe side of that
setpoint, the system can select the Override loop.
Note: If you set the override Threshold to 0.0, the
system uses the high/low value of the Override
Type Select field (defined on the General tab) to
select the appropriate change, regardless of the
error in the Override loop.
Manual Tracking Sets how the system tracks setpoint and process
variable values in moving between Auto and
Manual Modes (defined on the General tab). Valid
values are Enabled (sets the Primary loop’s
setpoint equal to the process variable when the
PID point is in Manual mode) or Disabled (does
not equalize these values). This is typically used to
eliminate a value "bump" when transferring from
Manual to Auto mode.
Halt PID on Reset Sets the status of the PID control loop following a
power restart or a warm start. Valid values are
Enabled (activate the PID loop) or Disabled (do
not activate the PID loop).
Enabled Do not activate the PID loop.
Disabled Activate the PID loop.
Override Type Sets the control output for the Override Type.
Select Valid values are High (system selects as the
control output the higher of the Primary Output
Change value or the Override Output Change
value) or Low (system selects as the control
output the lesser of the Primary Output Change
value or the Override Output Change value).
Field Description
Output Low Limit This read-only field shows, when a PID loop is
Status enabled, whether the output of the Primary PID
loop has been clipped by the low output limit. Valid
values are Limited or Not Limited.
Output High Limit This read-only field shows, when a PID loop is
Status enabled, whether the output of the Primary PID
loop has been clipped by the high output limit.
Valid values are Limited or Not Limited.
Primary PV Status This read-only field shows, when a PID loop has
been enabled, the status of the Primary loop's
Process Variable data. Valid values are OK,
Questionable Data, or Invalid TLP.
Primary SP Low This read-only field shows whether the setpoint of
Limit Status the Primary PID loop has been clipped by the low
Setpoint limit. Valid values are Limited or Not
Limited.
Primary SP High This read-only field shows whether the setpoint of
Limit Status the Primary PID loop has been clipped by the high
Setpoint limit. Valid values are Limited or Not
Limited.
Primary SP Rate This read-only field shows whether the setpoint of
Limited Status the Primary PID loop is currently being limited by
the maximum Setpoint change rate (as defined by
the SP Ramp Rate on the Tuning tab).
Field Description
Override PV Status This read-only field indicates the status of the
Override loop's Process Variable data. Valid
values are OK, Questionable Data, and Invalid
TLP.
Override SP Low This read-only field shows whether the setpoint of
Limit Status the Override PID loop has been clipped by the low
Setpoint limit. Valid values are Limited or Not
Limited.
Override SP High This read-only field shows whether the setpoint of
Limit Status the Override PID loop has been clipped by the
high Setpoint limit. Valid values are Limited or
Not Limited.
Override SP Rate This read-only field shows whether the setpoint of
Limited the Override PID loop is currently being limited by
the maximum Setpoint change rate (as defined by
the SP Ramp Rate on the Tuning tab).
Change in Output This read-only field shows the algorithm the
Algorithm system uses for the PID. Valid values are
Standard (Change in Output = SF x PG x (errCng
+ (IG x ALP x err) + (DG x RPC)) or Digital
(Change in Output = SF x IG x err), where:
Example PID The following example describes how to configure a PID point and
Configuration associated inputs and outputs to implement flow control with pressure
override to protect against over-pressuring the line.
In this example, the Primary process variable (Primary PV) is the
volumetric flow rate per day obtained from an orifice meter run point.
The system obtains the Override process variable (Override PV) from
the static pressure value from an MVS or analog input. Both the Primary
and Override loops require you to define a setpoint (the value at which
you wish to control the loop). The example describes the process for
setting up either discrete or analog control for the control output.
If a 4 to 20 mA signal to an I/O converter controls the control valve:
▪ Configure an analog output with the appropriate Low and High
Reading EU (engineering units). The units can either be in terms of
the valve position (0 to 100%) or in terms of flow capacity (0 to
1000 MCF/Day).
▪ Set the Output Type on the PID screen to Analog.
▪ On the Inputs/Outputs tab, define an output point TLP using as an
analog input, the desired Logical Number, and EU Value parameter.
Revised December-2017 Configure Menu 7-165
ROCLINK 800 Configuration Software User Manual (for ROC800-Series)
Both loops have scale factors, which permit the control action to close
the valve when the process variable is above the setpoint. With the scale
factor set according to the above formula, the initial settings for gain,
reset, and rate produce stable control (under most circumstances). Gain
controls the magnitude of the initial change in output for a given change
in the process variable (or setpoint). Reset controls the magnitude of the
change in output based on the continuing difference between the process
variable and the setpoint over time. You can then adjust these values to
produce the desired control actions.
Field Description
Hold Time Sets the time that the output remains ON after
detection of communications activity in Seconds or
Minutes depending on the Time Units mode. This
value applies to all Zones. When communications
occur during the On Time, the On Time is
extended by the Hold Time. The DTR signal and
discrete output remain in the ON state.
If a Spontaneous-Report-by-Exception (SRBX)
message needs to be sent to the host computer,
the radio power will be turned on for the Hold Time
allowing the SRBX message to be transmitted.
The Hold Time should be configured for a length
of time long enough to allow the ROC to receive a
response back from the host.
Low Battery Shutoff Sets a value that specifies the voltage at which
Power Control is automatically disabled. The
voltage being sensed is the System AI Battery
Input voltage (0 to 1). The Low Battery Shutoff
parameter allows power cycling to be
automatically disabled whenever the input voltage
to the ROC falls below the specified threshold.
The default value is 11 volts.
Radio Power Control is automatically enabled
again when the input voltage rises up to this value.
Low Battery Sets the value to add to the Low Battery Shutoff to
Deadband determine when the Radio Power Control function
is enabled again and allows the DO to turn on
when needed.
Power Timer This read-only field shows the amount of time (On
Time, Off Time, or Hold Time) that the Radio
Control is currently using. The value is the number
of seconds or minutes remaining.
Discrete Output Sets which DO point to use to power the radio.
On Counter Sets the value to indicate the cumulative time that
the Power Control has been in the ON state in
seconds or minutes.
Off Counter Sets the value to indicate the cumulative time that
the Power Control has been in the OFF state in
seconds or minutes.
7.2.4 Sampler/Odorizer
Use the Sampler/Odorizer to set up a discrete output (DO) channel of
the ROC800-Series to send and control the timing and duration of a
pulse output to another device, such as an odorizer (odor injector).
Note You can also control a gas sampler. Enable the Sampler points on
the ROC > Information screen.
Field Description
Sampler/Odorizer Sets the specific number of the Sampler or
Odorizer (Sampler/Odorizer) to configure.
Mode Sets how the DO to sends a signal when the
specified flow conditions are met.
Input Rate Point Sets the input point from which to acquire the rate.
Click the TLP Browse button to display a Select
TLP dialog you use to define the point.
Input Rate Value This read-only field shows the value of the current
Input Rate Point selected. The unit of measure for
the Input Rate Value and Unit Accumulation will be
the same as the unit of the input point selected for
Input Rate Point.
Time Basis Sets the time base for which the Input Rate Point
is integrated: every second, minute, hour, or day.
Unit Accumulation Sets when an output pulse generates. The Input
Rate Value is integrated over the Time Basis.
When the total matches the Unit Accumulation
value, a pulse is generated for the duration
specified in the duration field.
Duration Sets, in seconds, how long the output pulse will be
on. This is how long the DO stays ON. The DO is
turned on for the amount of time set in the
Duration field every time the Unit Accumulation
value is exceeded.
Output Point Sets the DO point to be used. Click the TLP
Browse button to display a Select TLP dialog you
use to define the point.
Field Description
Mode Enables the execution of all DS800 resources
loaded into the ROC.
RSI Task Sets whether you are communicating via serial
communications for downloading and debugging
DS800 applications. Distributed applications
(multiple resource projects) are not supported over
serial links.
TCP/IP Task Sets whether you are communicating via Ethernet.
IXD Task Enables the download of resources to a ROC.
This would only be Disabled to save processor
time, if there were no bindings between resources
using the HSD network.
Field Description
Clear Resources Click to remove all downloaded resources from the
ROC800-Series's permanent storage. This does
not affect or stop a currently executing resource,
because this resource was copied to RAM before
it is started. The resources reside in RAM until you
perform a restart, until a Warm Start occurs at the
ROC800-Series, or you set the Mode on the
DS800 screen to Off. When you set the Mode to
On or restart the ROC800-Series, only the
resources downloaded to the ROC after you
pressed Clear Resources attempt to start.
Field Description
Name Provides a description of the resource.
Field Description
Status Shows the resource’s current state. Valid values
are:
▪ Fatal Error.
▪ No resource running.
▪ Stored resource available (Resource loaded
in the ROC, but not running).
▪ Resource is running in normal mode of
operation.
▪ Resource is running in a cycle by cycle debug
mode that allows a single execution of the
resource.
▪ Resource is running in a debug mode and is
currently stopped at a breakpoint.
Set Cycle Time Shows the frequency, in milliseconds, that the
resource has been defined to run. This is the
beginning of one execution to the beginning of the
next execution.
Current Cycle Time Shows the actual execution time, in milliseconds,
of the resource. This is from the beginning to the
end of one execution.
Field Description
Number of Points Sets the number of history points required for
segments 1 through 10 for a ROC800-Series
Series1 or 1 through 13 for a ROC800-Series
Series 2.
For a ROC800-Series Series 1 device, the
maximum number of 200 points is based on 60
minute values, 840 periodic values logged hourly
(35 days x 24 hours per day) and 35 daily values
for a total of 187,000 history values. Each
Segment also has storage allotted for the time
stamp values with a default of 935 time stamps
per Segment (60 minute times stamps + 840
periodic time stamps + 35 daily time stamps) x 11
Segments for a total of 10,285 time stamp values.
The 197,285 Available Space shown on the
ROCLINK 800 History Segment Configuration
screen indicates the total of history and time
stamp values.
Space Allocated = (Number of Points + 1)
x (Minute Entries + Periodic Entries +
Daily Entries)
For a ROC800-Series Series 2 device, the
maximum number of 240 points is based on 60
minute values, 840 periodic values logged hourly
(35 days x 24 hours per day) and 35 daily values
for a total of 187,000 history values. Each
Segment also has storage allotted for the time
stamp values with a default of 935 time stamps
per Segment (60 minute times stamps + 840
periodic time stamps + 35 daily time stamps) x 14
Segments for a total of 13,090 time stamp values.
The 197,285 Available Space shown on the
ROCLINK 800 History Segment Configuration
screen indicates the total of history and time
stamp values.
Space Allocated = (Number of Points + 1)
x (Minute Entries + Periodic Entries +
Daily Entries)
Minute Entries This read-only field displays the number of entries
in the minute log for this segment.
Periodic Entries Sets the desired number of points in the Periodic
(hourly) log. The Number of Entries (in the
Periodic log) multiplied by the Periodic Sample
Rate (minutes) will give the number of minutes
before the periodic log begins to write over itself.
Daily Entries Sets the desired number of Daily Entries in the
Daily log.
Space Allocated This read-only field displays how many history
and time stamp entries are currently allocated by
this segment.
Field Description
Periodic Sample Setss the Periodic Sample Rate (minutes). This
Rate indicates how often a time-stamped value will be
written to the Periodic Log. If this Segment is tied
to a meter Station, an entry will also be written
whenever a configuration change is made to a
Station or meter that is part of that Station. All
options for Periodic Sample Rates are evenly
distributed into 60, and logging will be
synchronized with the top of the hour.
Contract Hour Sets the time when the daily values are logged. If
this segment is tied to a meter station, this will also
be the Contract Hour for the station and will be
the time that daily and monthly (if it is the first of
the month) accumulations will be reset. Additional
entries will be made if Force End of Day is
exercised for this segment.
Logging Sets to enable or disable logging for all history
points in the segment. Select User to indicate that
the segment if for user program history.
User Flow Weight Sets the input point from which to acquire the
weight by which history points of the appropriate
archive type within this segment will be averaged.
This is typically a dynamic value, such as an
accumulator or flowrate.
Notes:
▪ This field applies only to liquid meters.
Typical gas meter run history configurations
do not make use of this feature.
▪ When using the Liquid Meter history configuration
wizard for the ROC800L, this field will be
automatically populated.
▪ Only history points with an Archive Type of Avg -
User Weighted are averaged using this value. If no
history points are configured or planned to be
configured with this archive type, the User Flow
Weight selection should be left undefined.
Force End of Day Sets each segment to force logging of entries in
the daily log for all history points in the segment.
Available Space This read-only field shows the total number of
history and time stamp entries possible. Factory
default is 197,285.
Total Space This read-only field shows the number of history
Allocated and time stamp entries allocated to all the
segments.
Available Space to This read-only field shows the number of entries
Allocate unallocated. This number is the Available Space
minus the Space Allocated.
Field Description
sample by a flow value (square root of the
differential pressure measured during the
sample period) and then calculates a linear
average by dividing the sum of the flow-
weighted sample by the sum of the flow values.
This results in minute and hourly values that are
more reflective of short periods of high flow.
▪ Avg – Flow Weighted Formulaic – Combines
the flow-weighting action with the formulaic
averaging technique, both of which were
described previously.
▪ Avg – User Weighted – Other flow weighted
averaging archive types will weigh values
against the gas flow from the associated gas
meter run.Ave – User Weighted allows for the
creation of flow weighted averages using any
arbitrary user selected input point as the
weighting factor. This technique multiplies a
one-second sample of the configured User Flow
Weight TLP (Configure>History Segments) by a
one-second sample of the value and then
divides the answer by the total accumulation
over the time period (minute, hour or
day).History points using this method will have a
value of zero if no flow is accumulated during
the time period, and therefore no weight.
Note: This archive type is used only with liquid
meters.Typical gas meter run history
configurations do not make use of this
feature.
▪ Avg – Linear – Averages one-second samples
to compute minute, periodic, and daily values.
▪ Accumulate/Second – Sums one-second
samples of a per second rate value over the
logging interval to compute the archived value.
Select this archive type when the History Point
being archived is a rate in EUs/second.
▪ Accumulate/Minute – Converts the one-second
samples of a per minute rate value to a per
second rate and sums them over the logging
interval to compute the archived value. Select
this archive type when the History Point being
archived is a rate in EUs/minute.
▪ Accumulate/Hour – Converts the one-second
samples of a per hour rate value to a per second
rate and sums them over the logging interval to
compute the archived value. Select this archive
type when the History Point being archived is a
rate in EUs/hour.
▪ Accumulate/Day – Converts the one-second
samples of a per day rate value to a per second
rate and sums them over the logging interval to
compute the archived value. Select this archive
type when the History Point being archived is a
rate in EUs/day.
Field Description
▪ Current Value – Logs a snapshot of the current
sampled value.
▪ Totalize – Logs the difference between the
current value at the end of the period and the
current value at the last logging interval.
▪ Minimum Value – Archive the minimum value
read.
▪ Maximum Value – Archive the maximum value
read.
▪ FST Time - Minute – Allocates space for the
FST to write time-stamps to the periodic archive
using the WTM command.
Note: The number of periodic entries in the
segment determines the number of time-
stamps that can be written. The value
takes the format MM: DD: HH:MM. The
FST determines which index in the
periodic archive to write to independently
of the current index for the segment.
▪ FST Time - Second – Allocates space for the
FST to write time-stamps to the periodic archive
using the WTM command.
Note: The number of periodic entries in the
segment determines the number of time-
stamps that can be written. The value
takes the format DD: HH:MM:SS. The
FST determines which index in the
periodic archive to write to independently
of the current index for the segment.
▪ FST Data – Allocates space for the FST to write
values to the periodic archive using the WDB
command.
Note: The number of periodic entries in the
segment determines the number of
values that can be written. The FST
determines which index in the periodic
archive to write to independently of the
segment’s current index.
▪ User Program Time – This Archive Type should
only be used as instructed in the respective user
program documentation.
▪ User Program Data – This Archive Type should
only be used as instructed in the respective user
program documentation.
Field Description
Archive Point Sets the point to enter in history. Click the TLP
Browse button to display a Select TLP dialog you
use to define the point type, logical number, and
parameter to be archived.
Point Tag This read-only field displays the name of the Tag
associated with the Archive Point you selected.
User Description Sets a description of the history point that you are
storing. For example, you may enter Units or
Engineering Units.
Current Value This read-only field shows the last historical value
recorded.
Last Daily Value This read-only field shows the last daily historical
value recorded.
7.4.1 History
The Configure > History Points option allows you to setup the History
Points for any numeric parameter in the ROC to archive and to select
which archiving method to use for each parameter.
The historical database can be configured to log only the values that you
require to be logged. The values are logged in the standard (minute-
hourly-periodic-daily) time base of the ROC, unless FST control is
used. By using the FST Editor utility, the period at which the data is
logged can be placed under FST program control. Periodic history can
be configured for 1 to 6 minutes, 10 minutes, 15 minutes, 30 minutes, or
in 60-minute frequencies.
The ROC maintains the following types of historical databases:
▪ Minimum/Maximum (Min/Max) Database.
▪ Minute Database.
▪ Periodic (Hourly) Database.
▪ Hourly Database.
▪ Daily Database.
Field Description
Archive Type Sets the Archive Type to specify how the logged
value is calculated; included are some special
purpose types for FST control.
▪ Disabled/ Undefined – Point not configured.
▪ Avg – Flow Dependant Linear – Discards
samples when there is no measurable flow
and performs a straightforward (linear)
average of the remaining samples to compute
the minute and hour values. This is the default
method for calculating the average for the flow
input and is the simplest and most commonly
used method.
Field Description
second samples of a per minute rate value to
a per second rate and sums them over the
logging interval to compute the archived value.
Select this archive type when the History Point
being archived is a rate in EUs/minute.
▪ Accumulate/Hour – Converts the one-second
samples of a per hour rate value to a per
second rate and sums them over the logging
interval to compute the archived value. Select
this archive type when the History Point being
archived is a rate in EUs/hour.
▪ Accumulate/Day – Converts the one-second
samples of a per day rate value to a per
second rate and sums them over the logging
interval to compute the archived value. Select
this archive type when the History Point being
archived is a rate in EUs/day.
▪ Current Value – Logs a snapshot of the
current sampled value.
▪ Totalize – Logs the difference between the
current value at the end of the period and the
current value at the last logging interval.
▪ Minimum Value – Archive the minimum value
read.
▪ Maximum Value – Archive the maximum
value read.
▪ FST Time - Minute – Allocates space for the
FST to write time-stamps to the periodic
archive using the WTM command. Note: The
number of periodic entries in the segment
determines the number of time-stamps that
can be written. The value takes the format
MM: DD: HH:MM. The FST determines which
index in the periodic archive to write to
independently of the current index for the
segment.
▪ FST Time - Second – Allocates space for the
FST to write time-stamps to the periodic
archive using the WTM command.
Note: The number of periodic entries in
the segment determines the number of
time-stamps that can be written. The value
takes the format DD: HH:MM:SS. The FST
determines which index in the periodic
archive to write to independently of the
current index for the segment.
▪ FST Data – Allocates space for the FST to
write values to the periodic archive using the
WDB command.
Note: The number of periodic entries in
the segment determines the number of
values that can be written. The FST
determines which index in the periodic
archive to write to independently of the
segment’s current index.
▪ User Program Time – This Archive Type
Field Description
should only be used as instructed in the
respective user program documentation.
▪ User Program Data – This Archive Type
should only be used as instructed in the
respective user program documentation.
5. Click Yes and the associated Archive Points display in the History
Wizard screen.
6. Click Close.
Field Description
Table No. Selects an Opcode table.
Version No. Associates a version number with the Opcode
table. By default, the version number (a floating
point number) is one less than the number of the
Opcode table.
Note: If you change the configuration of data
points, update the version number of the
table.
Data Assigns a value to each Opcode data point. Click
the TLP Browse button to display a Select TLP
dialog. Use the dialog to map values into the
Opcode table data point. If a host computer asks
for a specific Opcode data point, the ROC returns
the value that is referred by the mapped TLP.
▪ Use the Master Table tab to map Modbus registers to specific TLP
numbers.
▪ Use the Master Modem tab to configure the ROC to communicate
to multiple Slave devices through modems and phone lines.
▪ Use the Registers tab to map Modbus registers to specific TLP
numbers.
▪ Use the History Table tab to configure the Periodic and Daily
history values, Event records, and Alarm records for retrieval
through Modbus Protocol, using Function Code 03.
Note: After you configure a point and click Apply, click Flash
Memory Save Configuration (on the ROC > Flags screen) to
save the configuration to permanent memory in case you must
perform a cold start.
Field Description
Comm Port Selects a comm port to configure. Click ▼ to
display all defined comm ports.
Note: This screen’s Master Mode frame does not
display if you select either Local Port or
LCD Port as a comm port option.
Field Description
Comm Mode and Sets the communications mode for the selected
Modbus Type comm port. The Modbus protocol supports two
modes of transmission, ASCII and RTU. RTU is
the default.
Note: You must configure all devices in the same
communications network with the same
mode of transmission. Additionally, In either
ASCII or RTU mode, the transmitting
device places the Modbus message into a
frame that has a known beginning and
ending point.
▪ ASCII – American Standard Code for
Information Interchange mode represents
each 8-bit byte of data as two ASCII
characters that are the hexadecimal
representation of the value. This allows the
messages to be read with the use of a dumb
terminal, but uses twice as many characters
as the RTU mode. Each character sent is
composed of a start bit, 7 or 8 data bits, and
one or two stop bits with Even, Odd, or No
parity. ASCII mode uses Longitudinal
Redundancy Checking (LRC) error checking.
▪ RTU – Remote Terminal Unit mode allows for
greater character density and better data
throughput than ASCII for the same baud rate.
Each message is transmitted in a continuous
stream. Data is sent in 8-bit binary characters.
RTU mode uses Cyclic Redundancy Check
(CRC) error checking. By default, RTU is
enabled.
In either mode, ASCII or RTU, a Modbus message
is placed by the transmitting device into a frame
that has a known beginning and ending point.
Field Description
Exception Status This read-only field shows the error message for
the last Modbus message received.
Note: This field applies only in Slave mode.
Event Logging Sets whether the system writes to the Event log all
parameter changes made via Modbus. Valid
values are Enabled (logs all events) or Disabled
(does not log events). Enabled is the default.
Start Polling Controls whether the system begins a Modbus
Master polling sequence. The default is off. The
system clears this field when the polling sequence
completes.
Note: You must have previously selected
Modbus Master as the port owner on the
Comm Port screen (ROC > Comm Ports).
The ROC begins polling at the value
defined in the Starting Request field and
proceeds through the entries in the table.
Starting Request Sets a beginning value from which the Modbus
Master polling sequence begins. This number
corresponds to a line number on the Modbus
Master Table associated with this comm port.
Number of Sets the total number of requests the Modbus
Requests Master makes for this polling sequence. This value
specifies the total number of lines in the Master
tables on which to execute the polls. The default
value 0 prevents the polling from occurring.
Note: You can define up to three Modbus Master
tables for this comm port. The tables are
contiguous. If you indicate more requests
that are on a single table, the system
accesses the second or third table to
complete the request.
Timeout Sets the amount of time, in seconds, that the
Master (Host) waits to receive a valid message
after the ROC or sends a request to a device.
Note: Do not enter 0 (zero) in this field.
Retries Sets the number of times (after the initial try) that
the Master ROC attempts to establish
communications with the specified device before
reporting a timeout error. Valid values are between
0 and 25; the default is 2.
Modbus Continuous Indicates whether the system continually executes
Polling the Modbus Master polling sequence. Valid values
are Enabled (polling occurs continually) or
Disabled (polling occurs only as requested).
Note: Use the Request Delay field to schedule
the continual polling.
Request Delay Sets a delay time, in seconds, between polling
request sequences. This field is valid only when
you enable Continuous Polling.
Note: The system considers each line in a
Modbus Master Table as a request.
Field Description
Integer Scale - Low Sets values the system uses to scale analog I/O to
and High Values integer values with an implied decimal point. The
Low Value determines the low integer scaling that
represents the data and the High Value
represents the highest integer value used to scale
the data.
The High Value and Low Value fields are signed
integers and can range from – 32768 to 32767.
Float Scale # Scales data in conjunction with the Low and High
Integer Scale values. Provide high and low values
for each float scale #.
For host systems that do not accept floating-point
numbers, you can specify eight sets of floating-
point ranges for values. This allows the host to
read and set floating-point values (such as PID
setpoints, softpoint values, and flow values) as
integer values.
The system converts floating-point values to
integers by configuring a register or range of
registers with the Conversion field set in the
Modbus Registers definition configuration to a
Convert Code from 1 to 8.
The system uses the following equations to convert floating point values
to integers:
▪ Float Range = High Value Float Scale – Low Value
▪ Float Scale (for example, 100.0 = 120.0 – 20.0)
▪ Integer Range = High Value Integer Scale – Low Value Integer Scale
(for example, 6000 = 7000 – 1000)
▪ Adjusted Reading = Float Reading – Low Value Float Scale (for
example, 50.0 = 70.0 – 20.0)
▪ Integer = [(Integer Range x Adjusted Reading) Float Range] + Low
Integer Scale (for example, 3500 = [(6000 x 50.0) 100.0] + 1000)
The system uses the following equations to convert integers to floating
point values:
▪ Float Range = High Value Float Scale – Low Value
▪ Float Scale (for example, 100.0 = 120.0 – 20.0)
▪ Integer Range = High Value Integer Scale – Low Value Integer Scale
(for example, 6000 = 7000 – 1000)
▪ Adjusted Integer = Integer Sent – Low Value Integer
▪ Scale (for example, 3000 = 4000 – 1000)
▪ Float Value = [(Adjusted Integer x Float Range) Integer Range] + Low
Float Scale (for example, 70.0 = [(3000 x 100) 6000] + 20)
Field Description
Logical Point Sets the logical point of the communication port.
Note: You can configure the Modbus Master
functionality on the EIA-232 (RS-232), EIA-
485 (RS-485), and modem communications
ports (COMM1 to COMM5). The LOI (Local
Port) port does not support Modbus Master
communications.
Tag Sets a 10-character alphanumeric identifier for the
master table.
Modbus Format Sets the format of Modbus messages sent from
this device. Possible options are:
Note: This field displays only if you select the
Ethernet port in the Comm Port drop-down
list.
TCP Adds a 6 byte header to Modbus
messages, and then encapsulates
it for transmission over TCP/IP.
This is the default. The header
consists of the following:
▪ A 2 byte transaction ID that
increments for each packet
sent.
▪ A 2 byte protocol ID. The
protocol ID for Modbus is 0.
▪ A 2 byte indicator of the packet
length.
Standard Encapsulates Modbus messages
Wrapped for transmission over TCP/IP.
Note: Use this option only with
legacy devices that do not
support the additional
header added with the TCP
format.
Server IP Address Specifies the IP address of the device to be polled.
Note: This field displays only if you select the
Ethernet port in the Comm Port drop-down
list.
Server Port Number Specifies the IP port number of the device to be
polled.
Note: This field displays only if you select the
Ethernet port in the Comm Port drop-down
list.
RTU Address Sets the RTU address for the slave device to be
queried.
Function Code Sets the Modbus function code to be sent to the
slave device. Select the field and click ▼ to
display all valid function codes.
Slave Registers Sets the starting register number from which data
is drawn from the slave device.
Master Registers Sets the starting register number into which data is
stored on the master device.
Field Description
Number of Sets the total number of registers to poll.
Registers
Comm Status This read-only field shows the status of the query.
Refer to Table 7-3.
Status Description
0 Inactive or Start of Transmission
1 Receive Timeout Error
2 Received Address Check
3 Received Function Number Check
4 Number of expected bytes Check
5 Receiving Slave Response
6 CRC or LRC Check
7 CRC or LRC Check
8 Valid Slave Response
128 Write Device Data Error
129 Access Device Data Error
130 Host Function Table Error
131 Transmit Timeout Error
144 Transmit or Receive Buffer Overflow
145 Invalid Function Number in Request
Field Description
Tag Sets a 10-character identifier for the master
modem.
Corresponding Sets the communications port with which to
Comm Port associate the master modem port.
RTU Address Sets the RTU Address of the slave device to be
associated with the Connect Command. Up to six
different Modbus slave devices can be dialed up
through one communications port.
Connect Command Sets the Connect Command (telephone number)
to be sent to the slave device.
Only COMM2 to COMM5 support Modbus Master functionality; the
LOI (Local Port) and COMM1 (Ethernet) port do not.
This communications point associates a Modbus Slave RTU Address to
their respective phone numbers (Connect Command). Up to six different
Modbus slaves can be dialed up through one communications port. The
ROC retries three times to establish a connection with a slave.
Configuring a To configure a Modbus host:
Modbus Host
Note: The steps outlined below assume that you are connecting to the
module using a serial connection. If you are using an Ethernet
connection, you may skip Steps 1 to 5 and proceed directly to
Step 6.
1. Select ROC > Comm Ports. The Comm Port General tab screen
displays.
2. Select the appropriate communications port from the drop down list at
the top of the screen.
3. Configure the appropriate parameters (Baud Rate, Parity, Data Bits,
Stop Bit and Key On/Off Delay) for the port.
4. Select Modbus Master in the Port Owner section.
5. Click Apply to save the settings and click OK to close the screen.
6. Select Configure > MODBUS. The Modbus Configuration screen
displays.
7. Select the appropriate communications port from the drop down list
at the top of the screen.
8. Select the Registers tab and define the Modbus Registers within the
host by mapping them to TLPs. These Modbus Registers will “hold”
the information that the host will transmit and receive. The selection
of Register numbers in the host is arbitrary and is user-defined.
9. When you complete the mapping, click Apply to save the settings
and click OK to close the screen.
10. On the Modbus Configuration Screen, select the Master Table tab.
Select the appropriate comm port from the drop down list at the top of
the screen.
11. Define the polling sequence, Modbus devices (RTU addresses), slave
registers, and Master Registers (Host). In the case of an Ethernet
connection, enter the IP address and port number of the slave device
for each set of registers.
12. When configuration is complete, click Apply to save the changes.
13. Still on the Modbus Configuration screen, select the General tab.
Select the appropriate comm port from the drop down list at the top of
the screen.
14. Match the configuration of the Modbus protocol settings (Byte order
and Comm Mode) with the Modbus device(s) to be polled.
15. If the selected comm port provides Modbus master functionality, a
Master Mode section will be visible. Within this section, configure
appropriate values for the starting request, number of requests,
timeout, retries, and request delay. Apply the changes.
16. When ready to initiate polling, tick the Start Polling check box and
select the Enabled option under the Continuous Polling section.
17. Click Apply to save the changes and click OK to close the screen.
Field Description
Table Selects a table to which you map registers.
Each table entry can define multiple registers by
using either Point Indexing or Parameter Indexing.
By making the registers continuous (when the
Start Register address of a new line is one greater
than the End Register address of the previous
line) you can create a continuous data table for
Modbus Function Codes 3, 4, or 16 up to the limit
of 240 bytes per request. This type of data table
allows access to all its data with one request.
Map Periodic (Hourly) or Daily History Index
registers to the TLP for the Periodic Index (Point
Type 124, Parameter 5) or Daily Index (Point Type
124, Parameter 6)..
Tag Sets a 10-character alphanumeric identifier for this
table.
Modbus Function Sets a Modbus function. Valid values (and
Codes meanings) are:
Code Meaning Action
01 Read Logic Coil Obtain current status (ON/OFF) of a group of
Status logic coils (outputs).
02 Read Discrete Obtain current status (ON/OFF) of a group of
Input Status discrete inputs.
Field Description
03 Read Output Obtain current binary value in one or more
Registers holding registers.
(Holding)
04 Read Input Obtain current binary value in one or more input
Registers registers.
05 Force Single Force logic coil to a state of ON or OFF.
Logic Coil Acknowledge Alarm or Event request.
06 Preset Single Place a specific binary value into a holding
Holding Register register.
15 Force Multiple Force a series of consecutive logic output coils to
Logic Coils defined ON or OFF states.
16 Preset Multiple Place specific binary values into a series of
Holding consecutive holding registers.
Registers
Start Register Sets the first data register in the address span.
Any number from 0 to 65535 is valid. You can
duplicate register numbers as long as you assign
them to separate communication ports. Number
the tables from smallest to largest.
In certain Modbus Host devices, the register
40101 is actually transmitted as "100". The value
"100" should be placed in this field as the ROC
uses the actual number sent by the Host.
For example, the Host device requests the
Starting Register 500 through Ending Register
700. The Starting Register is 400 and the Ending
Register is 700. All register numbers requested by
the Host (500 through 700) are valid and would be
responded to because the requested register
numbers match or fall in between the Starting
Register and Ending Register numbers (400
through 700).
End Register Sets the last register in the address span.
Compute the value for this field by adding the total
number of registers used to the Start Register
number and subtracting 1.
Device Parameter Defines the parameter of the point types to set or
to acquire. Be aware of the different data types
(Character, Integer, Long, Float) and the size of
the data types. Use the Select TLP button to
select parameters.
This field indicates the type of data associated
with an address (defined by the Start Register
through the End Register). When the host
requests a valid range of register numbers, the
function code tells the slave what to do and
between which registers (Start Register through
End Register).
Field Description
Indexing Sets a block of register values as successive
Logical Point Numbers or Parameters without
having to define each separately. Valid values are
Point Indexing or Parameter Indexing.
Point Indexing maps the Start Register to the
selected Device Parameter. Subsequent registers,
through the End Register, are mapped to the
same Point Type and Parameter and increment
the point Logical Number.
Parameter Indexing maps the Start Register to
the selected Device Parameter. Subsequent
registers, through the End Register, are mapped
to the same Point Type and point Logical Number,
and increment the Parameter Number.
Conversion Sets the type of conversion performed (if any) on
data before it is either sent to the Host or written
to the ROC The conversions are used to allow for
differences in data types between the Master and
Slave devices.
Conversion Codes affect Function Codes 3, 4, 6,
8, and 16.
Comm Port Sets the comm port affected by the register.
Register numbers should be unique for any given
communications port. Registers may be
duplicated, as long as they are assigned to
separate ports. If a register number is duplicated
within the port, the first occurrence is used.
The Modbus History Table allows the Periodic and Daily history values,
Event records, and Alarm records to be configured for retrieval through
Modbus Protocol, using Function Code 03. Three registers are defined
to retrieve the current date in the ROC, the current time in the ROC, and
the Event/Alarm records. The Modbus History Table also allows the
Periodic and Daily registers to be defined for up to twenty groups of
History Points.
Note: Before you configure the Modbus History, configure the
Configure > History Segments and Configure > History
Points.
The Event Registers and Alarm Registers are Modbus Register
Numbers used to acquire the Current Date value, Current Time value,
and Event Log and Alarm Log. Enter registers or use the defaults.
Using the defaults is highly recommended. The Current Date and
Current Time values identify the current date and time from the ROC
and may be most useful when you desire the date and time as floating
point numbers in the format of DDMMYY and HHMM. For more
information on the Modbus retrieval of the Event Log and Alarm Log,
refer to Section 7.6.4, Modbus Events & Alarms.
Field Definition
History Index Mode Sets the History Index Mode. Internally, the
History Index is stored as the location in the
historical database where the next record will be
written, accounting for rollover based on the total
number of records configured. It is a zero-based
index. For example, if there are 35 daily entries
configured, valid indexes are 0 to 34. The History
Index Mode allows you to modify the History Index
value and history record returned as follows:
▪ EFM Extensions Mode – History Index will be
returned as one less than the internal History
Index, accounting for rollover (the index to the
most recent data record written). History data
will be returned for the index requested. For
example, if there are 35 daily entries, valid
indexes are 0 to 34. If the internal index is 5, 5
represents the index where the next record will
be written. A request for the current index will
return 4 (one less) and a request for data at
index 4 will return the last record written at
index 4.
▪ Override Mode 1 – History Index will be
returned as stored internally in the historical
database (index to the next record to be
written) and history data values will be
returned for the index requested. For example,
if there are 35 daily entries, valid indexes are 0
to 34. If the internal index is 5, 5 represents
the index where the next record will be written.
A request for the current index will return 5
and the host must request data at index 4 to
get the most recent record.
▪ Override Mode 2 – History Index will be
returned as stored internally in the historical
database (index to the next record to be
written), but the history values returned will be
for one less than the index requested,
accounting for rollover. For example, if there
are 35 daily entries, valid indexes are 0 to 34.
If the internal index is 5, 5 represents the
index where the next record will be written. A
request for the current index will return 5, but a
request for history values at index 5 will
actually return values at index 4. In addition,
this mode will return history values at the last
valid index if an index of greater than or equal
to the number of records is requested. For
example, if there are 35 daily entries, valid
indexes are 0 to 34. A request for history
values at index 35, 36, 37, and so on will
return history values at index 34.
1. The Hourly (periodic) Index, Daily Index, Event, and Alarm Log data fields are used to address a history index
number.
2. The Event and Alarm Log record consists of the bytes shown in Table 7-9. Modbus Events and Alarms Log
Contents. A breakdown of the bit map in Byte 1-2 is given in Table 7-10. Event & Alarm Change Bit Map
Contents.
Field Description
Group Sets a contiguous group of history points from a
single segment. You can access the values
through a Modbus function code 03 request for a
user-defined Modbus register. Twenty groups are
available.
Periodic and Daily Sets the Modbus Register Number to acquire the
History Registers group of history points defined in the Start History
Point and End History Point fields. One Register
(commonly Register 704) can retrieve periodic
data and another Register (commonly Register
703) can retrieve daily data for the Group of
History Points. The time Period for the Periodic
history is set on the Configuration > History
Segment configuration screen (if the Period is set
as 60, this will be Hourly history).
History Segment Sets a segment from which the ROC acquires the
history. Make sure you configure this segment
through the Configure > History Segments
screen. The General Segment displays on this
table as 0.
Field Description
Starting History Sets the starting history point (first retrieved
Point history point) for a group of points, you define in
the Register Number field. You must complete
both this field and the Ending History Points field.
The value in the Ending History Points field must
be different and larger than this value.
Ending History Sets the ending history point (last retrieved history
Point point) for a group of points, as defined in the
Register Number field. You must complete both
this field and the Starting History Points field, and
the value in the Starting History Points field must
be different and smaller than this value.
Conversion Sets the type of data conversion (if any) before the
data returns to the host or is written to the ROC
Conversions allow the unit's floating point values
to transmit or receive as integer values. Table 7-
10. Event & Alarm Change Bit Map Contents lists
the Convert Codes.
Convert Slave
Description Definition
Code Function
0 No Conversion N/A N/A
Convert Slave
Description Definition
Code Function
1 Float to Signed 3,4 The Float to Signed Integer conversion changes the ROC floating
Integer, Float Scale point data to a two-byte signed integer for transmission. The
1 number of the Conversion Code specifies which floating point
2 Float to Signed 3,4 scaling value is to be used for the conversion.
Integer, Float Scale
2
3 Float to Signed 3,4
Integer, Float Scale
3
4 Float to Signed 3,4
Integer, Float Scale
4
5 Float to Signed 3,4
Integer, Float Scale
5
6 Float to Signed 3,4
Integer, Float Scale
6
7 Float to Signed 3,4
Integer, Float Scale
7
8 Float to Signed 3,4
Integer, Float Scale
8
Conversion codes 1 through 8, Float to Signed Integer are calculated as:
Integer = [(Integer Range x Adj Reading)]/Float Range] + Low Integer Scale
Where:
Float Range = High Float Scale — Low Flow Scale
Integer Range = High Integer Scale — Low Integer Scale
Adj Reading = Float Reading — Low Flow Scale
Convert Slave
Description Definition
Code Function
9 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 10.0 and converted to a
Long with 1 Implied signed 32 bit integer. (A value of – 1.234567 would be sent as –
Decimal Place 12).
10 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 100.0 and converted to a
Long with 2 Implied signed 32 bit integer. (A value of – 1.234567 would be sent as –
Decimal Places 123).
11 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 1000.0 and converted to a
Long with 3 Implied signed 32 bit integer. (A value of – 1.234567 would be sent as –
Decimal Places 1234).
12 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 10000.0 and converted to a
Long with 4 Implied signed 32 bit integer. (A value of – 1.234567 would be sent as –
Decimal Places 12345).
13 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 100000.0 and converted to a
Long with 5 Implied signed 32 bit integer. (A value of – 1.234567 would be sent as –
Decimal Places 123456).
Convert Slave
Description Definition
Code Function
14 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 1000000.0 and converted to a
Long with 6 Implied signed 32 bit integer. (A value of – 1.234567 would be sent as –
Decimal Places 1234567).
15 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 10000000.0 and converted to
Long with 7 Implied a signed 32 bit integer. (A value of – 1.234567 would be sent as
Decimal Places – 12345670).
16 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 100000000.0 and converted to
Long with 8 Implied a signed 32 bit integer. (A value of – 1.234567 would be sent as
Decimal Places – 123456700).
17 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 10.0 and converted to a
Long with 1 Implied signed 32 bit integer. (A value of 1.234567 would be sent as 12).
Decimal Place
18 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 100.0 and converted to a
Long with 2 Implied signed 32 bit integer. (A value of 1.234567 would be sent as
Decimal Places 123).
19 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 1000.0 and converted to a
Long with 3 Implied signed 32 bit integer. (A value of 1.234567 would be sent as
Decimal Places 1234).
20 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 10000.0 and converted to a
Long with 4 Implied signed 32 bit integer. (A value of 1.234567 would be sent as
Decimal Places 12345).
21 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 100000.0 and converted to a
Long with 5 Implied signed 32 bit integer. (A value of 1.234567 would be sent as
Decimal Places 123456).
22 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 1000000.0 and converted to a
Long with 6 Implied signed 32 bit integer. (A value of 1.234567 would be sent as
Decimal Places 1234567).
23 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 10000000.0 and converted to
Long with 7 Implied a signed 32 bit integer. (A value of 1.234567 would be sent as
Decimal Places 12345670).
24 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 100000000.0 and converted to
Long with 8 Implied a signed 32 bit integer. (A value of 1.234567 would be sent as
Decimal Places 123456700).
25 Any Type to Float, 3,4,6,16 Changes any ROC data type (except an ASCII tag) to a four-
No Scaling byte floating point without scaling. The conversion is typically
performed using a type cast. This is for both transmitting and
receiving.
26 Any Type to Signed 3,4,6,16 Changes any ROC data type (except an ASCII tag) to a two-byte
Short Integer signed short integer. This is for both transmitting and receiving.
27 Any Type to Signed 3,4,6,16 Changes any ROC data type (except an ASCII tag) to a four-
Long Integer byte signed long integer. This is for both transmitting and
receiving
28 Any Type to 3,4,6,16 Changes any ROC data type (except an ASCII tag) to a two-byte
Unsigned Short unsigned signed short integer. This is for both transmitting and
Integer receiving.
29 Any Type to 3,4,6,16 Changes any ROC data type (except an ASCII tag) to a four-
Unsigned Long byte unsigned long integer. This is for both transmitting and
Integer receiving.
Convert Slave
Description Definition
Code Function
30 Convert Anything to 3,4,6,16 The Anything to Unsigned Character (UNIT8) changes any ROC
an Unsigned Byte data type (except an ASCII tag) to an unsigned character. This
is for both transmitting and receiving. Note: This Conversion
Code works with packed bits from the Function Code 2 response
when in Master Mode to any data type parameter.
31 to 36 No Conversion N/A N/A
37 Unsigned Byte to 3,4,6,16 Response is identical that for a function 1 or 2 request. All
Packed Bit registers in the range requested must be unsigned integer 8
values and have a conversion code of 37
38 to 40 No Conversion N/A N/A
41 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 10.0 and converted to a
Short Implied 1 signed 16 bit integer. (A value of – 0.12345 would be sent as –
1).
42 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 100.0 and converted to a
Short Implied 2 signed 16 bit integer. (A value of – 0.12345 would be sent as –
12).
43 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 1000.0 and converted to a
Short Implied 3 signed 16 bit integer. (A value of – 0.12345 would be sent as –
123).
44 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 10000.0 and converted to a
Short Implied 4 signed 16 bit integer. (A value of – 0.12345 would be sent as –
1234).
45 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 100000.0 and converted to a
Short Implied 5 signed 16 bit integer. (A value of – 0.12345 would be sent as –
12345).
46 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 1000000.0 and converted to a
Short Implied 6 signed 16 bit integer. (A value of – 0.01234567 would be sent as
– 12345).
47 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 100000.0 and converted to a
Short Implied 7 signed 16 bit integer. (A value of – 0.0012345 would be sent as
– 12345).
48 Any Type to Signed 3,4,6,16 Value within ROC is multiplied by 1000000.0 and converted to a
Short Implied 8 signed 16 bit integer. (A value of – 0.0001234567 would be sent
as – 12345).
49 Any Type to 3,4,6,16 Value within ROC is multiplied by 10.0 and converted to an
Unsigned Short unsigned 16 bit integer. (A value of 0.1234567 would be sent as
Implied 1 1).
50 Any Type to 3,4,6,16 Value within ROC is multiplied by 100.0 and converted to an
Unsigned Short unsigned 16 bit integer. (A value of 0.1234567 would be sent as
Implied 2 12).
51 Any Type to 3,4,6,16 Value within ROC is multiplied by 1000.0 and converted to an
Unsigned Short unsigned 16 bit integer. (A value of 0.1234567 would be sent as
Implied 3 123).
52 Any Type to 3,4,6,16 Value within ROC is multiplied by 10000.0 and converted to an
Unsigned Short unsigned 16 bit integer. (A value of 0.1234567 would be sent as
Implied 4 1234).
53 Any Type to 3,4,6,16 Value within ROC is multiplied by 100000.0 and converted to an
Unsigned Short unsigned 16 bit integer. (A value of 0.1234567 would be sent as
Implied 5 12345).
Convert Slave
Description Definition
Code Function
54 Any Type to 3,4,6,16 Value within ROC is multiplied by 1000000.0 and converted to
Unsigned Short an unsigned 16 bit integer. (A value of 0.01234567 would be
Implied 6 sent as 12345).
55 Any Type to 3,4,6,16 Value within ROC is multiplied by 10000000.0 and converted to
Unsigned Short an unsigned 16 bit integer. (A value of 0.001234567 would be
Implied 7 sent as 12345).
56 Any Type to 3,4,6,16 Value within ROC is multiplied by 100000000.0 and converted to
Unsigned Short an unsigned 16 bit integer. (A value of 0.0001234567 would be
Implied 8 sent as 12345).
57 Any Type to Signed 3,4,6,16 Response is similar to dual register floating point conversions.
Long 0, 1, 2, 3 Dual register: byte order 0-1-2-3.
Note: 0 = Byte MSB and Byte 3 = LSB
58 Any Type to Signed 3,4,6,16 Response is similar to dual register floating point conversions.
Long 1, 0, 3, 2 Dual register: byte order 1-0-3-2.
Note: 0 = Byte MSB and Byte 3 = LSB
59 Any Type to Signed 3,4,6,16 Response is similar to dual register floating point conversions.
Long 2, 3, 0, 1 Dual register: byte order 2-3-0-1.
Note: 0 = Byte MSB and Byte 3 = LSB
60 Any Type to Signed 3,4,6,16 Response is similar to dual register floating point conversions.
Long 3, 2, 1, 0 Dual register: byte order 3-2-1-0.
Note: 0 = Byte MSB and Byte 3 = LSB
61 Any Type to 3,4,6,16 Response is similar to dual register floating point conversions.
Unsigned Long 0, Dual register: byte order 0-1-2-3.
1, 2, 3 Note: 0 = Byte MSB and Byte 3 = LSB
62 Any Type to 3,4,6,16 Response is similar to dual register floating point conversions.
Unsigned Long 1, Dual register: byte order 1-0-3-2.
0, 3, 2 Note: 0 = Byte MSB and Byte 3 = LSB
63 Any Type to 3,4,6,16 Response is similar to dual register floating point conversions.
Unsigned Long 2, Dual register: byte order 2-3-0-1.
3, 0, 1 Note: 0 = Byte MSB and Byte 3 = LSB
64 Any Type to 3,4,6,16 Response is similar to dual register floating point conversions.
Unsigned Long 3, Dual register: byte order 3-2-1-0.
2, 1, 0 Note: 0 = Byte MSB and Byte 3 = LSB
65 to 72 IEEE Floating Point 3,4,16 Conversion Codes 65 to 72 allow a four-byte IEEE 754
Number formatted floating point number to be sent or received in two
Modbus registers with the byte orders configurable. Since these
conversions require two registers. A check is made to ensure
that an even number of registers is requested, that the starting
register number does not begin in the middle of a register pair,
and that the number of registers does not exceed the number of
registers configured.
Byte 0 Byte 1 Byte 2 Byte 3
seee emmm mmmm mmmm
eeee mmmm mmmm mmmm
Where s = sign bit, e = exponent bit, m = mantissa bit
Note: Each conversion code is listed individually below.
65 IEEE Floating Point 3,4,16 Places byte 0 and byte 1 in register XXXXXX and places byte 2
Number and byte 3 in register XXXXXX + 1.
Convert Slave
Description Definition
Code Function
Register XXXXXX byte 0, byte 1
Register XXXXXX + 1 byte 2, byte 3
66 IEEE Floating Point 3,4,16 Places byte 0 and byte 1 in register XXXXXX and places byte 2
Number and byte 3 in register XXXXXX + 1. Same as conversion code
65 regardless of MSB 1st flag.
Register XXXXXX byte 0, byte 1
Register XXXXXX + 1 byte 2, byte 3
67 IEEE Floating Point 3,4,16 Places byte 0 and byte 1 in register XXXXXX and places byte 2
Number and byte 3 in register XXXXXX + 1.
Register XXXXXX byte 0, byte 1
Register XXXXXX + 1 byte 2, byte 3
68 IEEE Floating Point 3,4,16 Places byte 0 and byte 1 in register XXXXXX and places byte 2
Number and byte 3 in register XXXXXX + 1. Same as conversion code
67 regardless of MSB 1st flag.
Register XXXXXX byte 1, byte 0
Register XXXXXX + 1 byte 3, byte 2
69 IEEE Floating Point 3,4,16 Places byte 2 and byte 3 in register XXXXXX and places byte 0
Number and byte 1 in register XXXXXX + 1.
Register XXXXXX byte 2, byte 3
v Register XXXXXX + 1 byte 0, byte 1
70 IEEE Floating Point 3,4,16 Places byte 2 and byte 3 in register XXXXXX and places byte 0
Number and byte 1 in register XXXXXX + 1. Same as conversion code
69 regardless of MSB 1st flag.
Register XXXXXX byte 2, byte 3
Register XXXXXX + 1 byte 0, byte 1
71 IEEE Floating Point 3,4,16 Places byte 3 and byte 2 in register XXXXXX and places byte 1
Number and byte 0 in register XXXXXX + 1.
Register XXXXXX byte 3, byte 2
Register XXXXXX + 1 byte 1, byte 0
72 IEEE Floating Point 3,4,16 Places byte 3 and byte 2 in register XXXXXX and places byte 1
Number and byte 0 in register XXXXXX + 1. Same as conversion code
71 regardless of MSB 1st flag.
Register XXXXXX byte 3, byte 2
Register XXXXXX + 1 byte 1, byte 0
73 Double 01, 23, 45, 3,4,6,16 Places byte 0 and byte 1 in register XXXXXX, places byte 2 and
67, Disregard MSB byte 3 in register XXXXXX + 1, places byte 4 and byte 5 in
flag register XXXXXX + 2, and places byte 6 and byte 7 in register
XXXXXX + 3. This places an 8-byte double value into four 2-
byte registers to allow double values to be transmitted. Ignores
the Byte Order field in the Modbus Configuration screen.
Register XXXXXX byte 0, byte 1
Register XXXXXX + 1 byte 2, byte 3
Register XXXXXX + 2 byte 4, byte 5
Register XXXXXX + 3 byte 6, byte 7
Convert Slave
Description Definition
Code Function
74 Double 23, 01, 67, 3,4,6,16 Places an 8-byte double value into four 2-byte registers to allow
45, Disregard MSB double values to be transmitted. Ignores the Byte Order field in
flag the Modbus Configuration screen.
Register XXXXXX byte 2, byte 3
Register XXXXXX + 1 byte 0, byte 1
Register XXXXXX + 2 byte 6, byte 7
Register XXXXXX + 3 byte 4, byte 5
75 Double 45, 67, 04, 3,4,6,16 Places an 8-byte double value into four 2-byte registers to allow
23, Disregard MSB double values to be transmitted. Ignores the Byte Order field in
flag the Modbus Configuration screen.
Register XXXXXX byte 4, byte 5
Register XXXXXX + 1 byte 6, byte 7
Register XXXXXX + 2 byte 0, byte 1
Register XXXXXX + 3 byte 2, byte 3
76 Double 67, 45, 23, 3,4,6,16 Places an 8-byte double value into four 2-byte registers to allow
04, Disregard MSB double values to be transmitted. Ignores the Byte Order field in
flag the Modbus Configuration screen.
Register XXXXXX byte 6, byte 7
Register XXXXXX + 1 byte 4, byte 5
Register XXXXXX + 2 byte 2, byte 3
Register XXXXXX + 3 byte 0, byte 1
77 Double 10, 32, 54, 3,4,6,16 Places an 8-byte double value into four 2-byte registers to allow
76, Disregard MSB double values to be transmitted. Ignores the Byte Order field in
flag the Modbus Configuration screen.
Register XXXXXX byte 1, byte 0
Register XXXXXX + 1 byte 3, byte 2
Register XXXXXX + 2 byte 7, byte 6
Register XXXXXX + 3 byte 5, byte 4
78 Double 35, 10, 76, 3,4,6,16 Places an 8-byte double value into four 2-byte registers to allow
54, Disregard MSB double values to be transmitted. Ignores the Byte Order field in
flag the Modbus Configuration screen.
Register XXXXXX byte 3, byte 2
Register XXXXXX + 1 byte 1, byte 0
Register XXXXXX + 2 byte 7, byte 6
Register XXXXXX + 3 byte 5, byte 4
79 Double 54, 76, 10, 3,4,6,16 Places byte 0 and byte 1 in register XXXXXX, places byte 2 and
32, Disregard MSB byte 3 in register XXXXXX + 1, places byte 4 and byte 5 in
flag register XXXXXX + 2, and places byte 6 and byte 7 in register
XXXXXX + 3. This places an 8-byte double value into four 2-
byte registers to allow double values to be transmitted. Ignores
the Byte Order field in the Modbus Configuration screen.
Register XXXXXX byte 5, byte 4
Register XXXXXX + 1 byte 7, byte 6
Register XXXXXX + 2 byte 1, byte 0
Register XXXXXX + 3 byte 3, byte 2
Convert Slave
Description Definition
Code Function
80 Double 76, 54, 32, 3,4,6,16 Places an 8-byte double value into four 2-byte registers to allow
10, Disregard MSB double values to be transmitted. Ignores the Byte Order field in
flag the Modbus Configuration screen.
Register XXXXXX byte 7, byte 6
Register XXXXXX + 1 byte 5, byte 4
Register XXXXXX + 2 byte 3, byte 2
Register XXXXXX + 3 byte 1, byte 0
81 ASCII 3,4,6,16 Breaks an ASCII string parameter into multiple 2-byte registers.
Number of registers id dependent upon the size of the string.
Supports strings of 3, 7, 10, 12, 20, 30, and 40 bytes. Odd sized
strings are padded with a space character.
82 to 255 No conversion N/A N/A
Bit Map Register Time as float Date as float Old Value as float New Value as float
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
System Text Events When you set the System Command Change Bit (bit 7) in the Operator
Change Bit Map of the Event, it sets the Register number for all System
Command Change events will be set to the Event/Alarm Register
7-218 Configure Menu Revised December-2017
ROCLINK 800 Configuration Software User Manual (for ROC800-Series)
ROCLINK 800 uses this format for the following event codes:
▪ 144 Initialization Sequence
▪ 146 Initialize From Defaults
▪ 147 ROM CRC Error
▪ 148 Database Initialization
▪ 150 Program Flash
▪ 248 Text Message
▪ 249 Download Configuration
▪ 250 Upload Configuration
▪ 251 Calibration Timeout
▪ 252 Calibration Cancel
▪ 253 Calibration Success
FST Events For FST events, the code is the FST number (1 to 6). Unused will be set
to zero.
Bit Map Register Time as float Date as float Code Unused Value as float
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
Time-related The time is the number of seconds since January 1, 1970. Unused will
System Events be set to zero.
Bit map Register Time as float Date as float Code Unused Time as time_t
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
Unmapped Parameter If the alarming point is not mapped to a Modbus Register, identifying
Alarms the point using the following table. The TLP will be the source TLP of
the alarm. The type will be set to 1
Bit Map Register Time as float Date as float Value as float TLP Type
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
FST Alarms If the Alarm is an FST Alarm, ROCLINK 800 uses the following
format. The FST Number is the source FST Number that generated the
alarm. Unused is set to zero and the type is set to 2.
Bit Map Register Time as float Date as float Value as float FST# Unused Type
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
User Text Alarms A User Text alarm uses the following format. Text is filled in with
seven bytes of User Text and the Type will be set to 3.
User Value Alarms If the alarm is a User Value Alarm, the following format will be used.
Unused will be set to zero and the Type will be set to 4.
Bit Map Register Time as float Date as float Value as float Unused Type
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
Reading Events and The Modbus request to read the Event Log and Alarm Log uses the
Alarms Register standard read Function Codes 03 or 04 and the Register Number defined
in the History Access configuration. In this request, the number of
Registers is included to maintain format compatibility, but is ignored by
the receiving ROC.
Twenty bytes are returned for each event and alarm in the response. Up
to 12 events and alarms can be returned in a single response. If no
events and alarms have occurred since the last collection, the response
contains 0 data bytes.
For the date stamp in the events and alarms returned, the year (YY) is
really the number of years since 1980. For example, if the current year
is 2007, the year (YY) for the date stamp would be 27.
Following is an example of a request for events and alarms with the
history access event/alarm register defined as 32 (0x0020 hex).
TX Order Integers — MS LS LS MS
Floats — Selectable
Acknowledging After the host has correctly received event and alarm data, it transmits
Events and Alarms an acknowledgement message to the ROC to clear these events and
alarms from the Modbus buffer.
Until it receives that acknowledgement message, the ROC continues to
send the same event and alarm records to the host. The Modbus
acknowledgement (to clear the Event Log and Alarm Log buffer) uses
Function Code 05 and the Register Number defined in the History
Access configuration. In this request, the data value is always one (1).
9 to 12 Date Stamp (MMDDYY; 32-bit floating point) Date Stamp (MMDDYY; 32-bit floating point)
13 to 16 Previous value of variable (32-bit floating Current (alarmed) value of variable (32-bit floating
point) point)
17 to 20 Current (New) value of variable (32-bit Unused at the current time (zero filled when
floating point) transmitted to the Master)
Use the Meter menu to define, configure, and calibrate meter runs;
review meter runs; and perform plate changes for orifice and linear
(turbine, PD, ultrasonic, Coriolis) meters.
8.1 Setup
Use Meter Setup to configure meter runs and stations. The Meter
configuration screens contain the functions directly associated with
measuring and logging flow, including setup of American Gas
Association (AGA), American Petroleum Institute (API), or
International Standards Organization (ISO) calculation configuration
parameters, and calibrating the meter depending on the device that you
are configuring.
The ROC800-Series organizes meter runs into stations. The 12 meter
runs can be grouped among the 12 stations in any combination. Meter
are assigned to stations in the Meter > Setup > Orifice Meter or
Linear Meter screens. Meter runs belong in the same station when they
have the same gas data, calculation methods, and base/contract
conditions.
Refer to for the defaults in Metric and US engineering units.
▪ Use the Gas Quality tab to set the gas information parameters. The
Gas Quality tab defines the mole percentages of twenty-one gas
components, as well as the Heating Value Basis, the Heating Value,
and the Specific Gravity.
▪ Use the Advanced tab to configure a number of additional
parameters that affect the flow calculation.
▪ Use the Alarms tab to configure alarming parameters for station
flow rates.
Notes:
▪ After configuring a station and clicking Apply, use Flash Memory
Save Configuration in the ROC > Flags screen to save station
configuration to permanent memory in case you must perform a cold
start.
▪ If other stations have similar characteristics, use the copy and paste
buttons to simplify configurations.
Field Description
Station Sets the station to configure. This lists all active
stations.
Note: The selection in this field applies to each tab
on this screen.
Tag Sets a (10 alphanumeric character) identifier for the
point.
Note: The selection in this field applies to each tab
on this screen.
History Segment Sets the history segment in the historical database
that you use to configure history points for the
meters in this station.
Note: Assign only one station per history segment.
Contract Hour Sets the time when the daily values are logged. If
this segment is tied to a meter station, this will also
be the contract hour for the station and will be the
time that daily and monthly (if it is the first of the
month) accumulations will be reset. Additional
entries will be made if Force End of Day is
exercised for this segment.
Note: The contract hour for the station may also
be set in the Configure > History Segment
screen.
Calculation Sets the set of calculation standards that are to be
Standard used for orifice, gas linear meters, and mass linear
meters in this station. There is only one edition of
AGA and ISO flow calculations. Calculation
standards include:
Gas, AGA3- American Gas Association (AGA)
92/AGA7- standard for gas flow through an
96/AGA11-2003 orifice, a linear meter, and a mass
(Coriolis) meter.
Select Gas, AGA3-92/AGA7-
1996/AGA11-2003 for the station
when you want AGA 3
calculations for all orifice meters
in the station and AGA 7
calculations for all turbine meters
and all mass (Coriolis) meters in
a station.
Field Description
Gas, ISO5167- International Standard
98/ISO9951- Organization (ISO) standard for
93/ISO10790- gas flow through an orifice, a
2003 linear meter, and a mass
(Coriolis) meter.
Select Gas, ISO5167-
98/ISO9951-93/ISO10790-2003
for all orifice meters in the station
and ISO9951 calculations for all
turbine meters and all mass
(Coriolis) meters in a station.
Note: ISO9951 calculations are
identical to AGA 7
calculations.
Liquid, ISO and API (American
ISO5167- Petroleum Institute) standards for
98/API 12- liquid flow through an orifice, a
95/ISO10790- linear meter, and a mass
1999 (Coriolis) meter.
Select Liquid, ISO5167-98/API
12-95/ISO10790-1999 for all
orifice meters with an expansion
factor set to 1.0. Linear volumetric
meters will calculate a corrected
volume using user-
entered/calculated pressure and
temperature correction factors.
Mass (Coriolis) meters calculate a
corrected volume form the Mass
Flow Rate and the Base Density.
Gas, ISO5167- International Standard
2003/ISO9951- Organization (ISO) standard for
93/ISO10790- gas flow through an orifice, a
2003 linear meter, and a mass
(Coriolis) meter in circular cross-
section conduits running full.
Select Gas, ISO5167-
2003/ISO9951-93/ISO10790-
2003 for all orifice meters in the
station and ISO9951 calculations
for all turbine meters and all mass
(Coriolis) meters in a station with
circular cross-section conduits
running full.
Note: ISO9951 calculations are
identical to AGA 7
calculations.
Field Description
Note: For linear volumetric meters using API 12,
the user-entered/calculated pressure and
temperature correction factors, as well as
the base density and flowing density values,
need to be supplied by a FST, User C
program, a host computer, a DS800
program, or manually entered from a custom
display. The FPV Method parameter (see
Section 8.1.1.3, Station Setup Advanced
tab) must be set to User so the density
values can be entered.
Flow Rate This read-only field shows the volume flow rate at
base condition in MCF/day or km3/day.
Energy Rate This read-only field shows the energy rate at base
conditions in mmBtu/day or GJ/day.
Mass Rate This read-only field shows the mass rate
conditions in Mlb/day or tonnes/day.
Flow Today This read-only field shows the total accumulation
of flow for the current contract day in MCF or km3.
Energy Today This read-only field shows the total accumulation
of energy for the current contract day in mmBtu or
GJ.
Mass Today This read-only field shows the total mass for the
day in Mlb or Tonnes.
Zs This read-only field shows the represents the
compressibility at standard conditions.
Zb This read-only field shows the represents the
compressibility at base conditions.
Base Density This read-only field shows the represents the
density of the measured fluid at base conditions in
lbm/ft3 or kg/m3.
Flow Yesterday This read-only field shows the total accumulation
of flow for the previous contract day in MMCF or
km3.
Energy Yesterday This read-only field shows the total accumulation
of energy for the previous contract day in MMBtu or
GJ.
Mass Yesterday This read-only field shows the total accumulation
of mass for the previous contract day in Mlb or
tonnes.
Active Alarms This read-only field shows the active alarms
displaying the current alarm conditions at the
station.
Field Description
Heavy Gas Option Sets the option to separate the heavy gas
percentage (C6+) into individual components in the
mole percentages for n-Hexane, n-Heptane, n-
Octane, n-Nonane, and n-Decane. To enter heavy
gases, select the Heavy Gas Option and enter the
percentage of heavy gases under Hexane+. In the
Advanced tab, enter the amount of each heavy gas.
The mole percentages in the Heavy Gas
Distribution fields on the Advanced tab must equal
100%. If the total percentage of the distribution
among the five heavier components is less than
100%, Hexane is increased to make the total add
up to 100%. If the total percentage of the
distribution is greater than 100%, reduction occurs
in the following order: Decane > Nonane > Octane
> Heptane > Hexane until the total is equal to
100%.
Gas Quality Indicates the source for determining gas quality
readings. Valid values are Live (readings come
from a gas chromatograph or are periodically
downloaded from a host) or Constant (manually
enter the gas composition and changes are entered
in the Event Log).
Normalization Type Sets what action is taken if the total of the gas mole
percentages do not add up to 100%. Valid values
are Methane Adjust (automatically adjust the
Methane component up or down to compensate for
the difference if the total does not equal 100%) or
Full Normalization (adjust each component if the
total does not equal 100%).
Heating Value Basis Indicates the basis for determining the entered
heating value. Valid values are Dry (no water vapor
present in the gas), Wet (saturated water vapor
present in the gas), or As Delivered (may contain
some water vapor) for the Heating Value Basis.
This field does not affect the flow or energy
calculations, and is for accounting purposes only.
Heating Value Sets the gross volumetric heating value of the
measured fluid at base conditions. For gas, this
value represents the real heating value, rather than
the ideal heating value.
Specific Gravity Indicates the value the system uses to calculate
specific gravity, which is the ratio of the density of
the flowing gas to the density of the reference gas.
You must enter this value if it is not provided by a
gas chromatograph.
Field Description
User Requires the base compressibility,
standard compressibility, flowing
compressibility, base density, and
flowing density values to be entered.
These values become Read/Write
enabled and may be obtained from a
non-calculated source. The values may
come from a User C program, FST, host
computer, DS800 program, or a custom
display. If none of these sources provide
values, the last value will be held.
Notes:
▪ If either Gross Method is chosen, manually
enter the Specific Gravity and Heating Value in
the Gas Quality screen. For Gross Method I,
the Heating Value is required only for
calculating the gas energy flow.
▪ The Detailed method provides the highest
accuracy in a broader range of measurement
conditions; however, one of the Gross methods
can be used when:
o Temperature is between 0 and 54C (32
and 130F).
o Pressure is between 0 and 8274 kPa (0
and 1200 psia).
o Gas composition is within the normal range
as defined in the 1992 AGA8 report.
Use Gross methods for applications with a
more specific range of measurement
conditions.
Units Sets either US (English), Metric (kPa), or Metric
(bar) units for calculations. The difference between
Metric (kPa) and Metric (bar) is the pressure units
used in calculations. If you select Metric (kPa), the
calculation expects all pressure inputs to be in kPa
(such as kPa for the static pressure input). If you
select Metric (bar), the calculation expects all
pressure inputs to be in bar (such as bar for the
static pressure input and millibar for the differential
pressure input).
Note: If you change this selection, remember that
any existing entered values do not automatically
convert to the newly selected pressure units.
Atmospheric Sets the value of the atmospheric pressure
Pressure (absolute) at the metering location. Valid values are
Calculate (the value is calculated based on the
Elevation) or Enter (type a value for the pressure).
The units of measurement are in PSIA (US) or kPa
(Metric). If entered, the value must be greater than
zero.
Field Description
Local Gravitational Sets the gravitational acceleration at the metering
Acceleration location. Valid values are Calculate (the value is
calculated from the Elevation and Latitude) or
Enter (type a value for the acceleration). The units
of measurement are in ft/sec2 or M/sec2. If entered,
the value must be greater than zero.
Base Pressure Sets the flow measurement base pressure
specified in the gas contract. The pressure units
are in PSIA, or kPa for Metric.
Base Temperature Sets the flow measurement base temperature
specified in the gas contract. The temperature units
are in degrees Fahrenheit or degrees Celsius.
Elevation Sets the elevation or altitude of the metering
location. The units are in feet or meters.
Latitude Sets the geographic latitude of the metering
location. The units are in degrees and minutes,
separated by a decimal point. For example: 46.15.
Heavy Gas Set the mole percentages of heavy gas distribution
Distribution (hydrocarbons Hexane and heavier) if the Heavy
Gas Option was enabled on the Gas Quality tab.
The mole percentages in the Heavy Gas
Distribution fields must equal 100%. If the Total %
of the distribution among the five heavier
components is less than 100%, Hexane is
increased to make the Total % add up to 100%. If
the Total % of the distribution is greater than
100%, reduction occurs in the following order:
Decane > Nonane > Octane > Heptane > Hexane
until the total is equal to 100%.
Field Description
Alarm Deadband Sets the value, in engineering units that the flow
value must be above the Low Alarm limit and below
the High Alarm limit before the alarm clears. The
purpose of the Alarm Deadband is to prevent the
alarm from being set and cleared continuously
when the input value is oscillating around the alarm
limit.
RBX Sets the RBX Alarming option to configure
Spontaneous-Report-by-Exception (SRBX)
alarming for this point. Valid values are On Alarm
Set (The point enters an alarm condition, the ROC
generates a Spontaneous-Report-by-Exception
message to the host) or On Alarm Clear (The point
leaves an alarm condition, the ROC generates a
Spontaneous-Report-by-Exception message to the
host).
Note: SRBX Alarming requires the
communications port to be properly
configured.
Figure 8-6. Meter Setup (Orifice) – General tab Figure 8-7. Meter Setup (Linear) – General tab
Field Description
Meter Description Sets a unique description, up to 30 alphanumeric
characters in length that further identifies or
provides information about this meter.
Station Sets the station in which this meter belongs.
Pipe Diameter Sets the inside diameter for the pipe near the orifice
plate in this meter run. The units are inches or
millimeters.
Note: This field displays only for an orifice meter.
Orifice Diameter Sets the diameter of the orifice plate in this meter
run. The units are inches or millimeters.
Note: This field displays only for an orifice meter.
Low Flow Cutoff Sets the low flow cutoff point. When the differential
pressure value of the metering device is less than
this value, the system sets the calculated flow rate
to zero and, if alarming is enabled, records a No
Flow alarm in the Alarm Log.
For the AGA3-92 or ISO5167-2003 standard, this
value is in terms of inches of water column or kPa.
For the AGA7-96 standard, this value is in terms of
MCF/Day.
Meter Type Sets the meter type that you are configuring.
Select Flange Tapped Orifice or User Defined
Device, for a ROC800-Series with an orifice meter
type.
Valid values are Volume (volume metering device)
or Mass (Micro Motion Coriolis Mass Meter or
similar mass meter).
Process or Active This read-only field shows the active Process or
Alarms Active Alarms. For example, Low indicates that the
calculated flow is below the Low Alarm limit. Other
alarms can include High, No Flow, and Manual
Mode.
AGA3/ISO5167 This read-only field shows the AGA3/ISO5167
Alarms Alarms indicating any current alarms. For example,
Low indicates that the flow is below the Low Alarm
limit. Other alarms can include High, No Flow, and
Manual Mode.
Browse Button
Figure 8-8. Meter Setup (Orifice) – Inputs tab Figure 8-9. Meter Setup (Linear) – Inputs tab
Field Description
Static Pressure Sets the input that senses static pressure. Click the
Browse button to display a Select TLP dialog box
you use to assign the input. The system assumes
the units for the input to be PSIG/PSIA or
kPaG/kPaA.
If Manual appears, use the Values field to enter a
engineering units value for the static pressure input.
Otherwise, the Values field indicates the current
input value.
Temperature Sets the input that senses the temperature of the
flowing gas. Click the Browse button to display a
Select TLP dialog box you use to assign the input.
The system assumes units for the input to be
degrees Fahrenheit or degrees Celsius.
If Manual appears, use the Values field to enter an
engineering units value for the temperature input.
Otherwise, the Values field indicates the current
input value.
Stacked DP Enables the use of standard differential pressure
transmitters for low and high pressure ranges. Valid
values are Enabled (use stacked DP transmitters)
or Disabled (do not allow use of stacked DP
transmitters).
Note: This field displays only for an orifice meter.
Low DP Input Sets the input for monitoring low differential
pressure. Click the Browse button to display a Set
TLP dialog box you use to assign the input.
You must Enable the Stacked DP parameter to use
this input or you can leave this input in Manual
Mode when you Disable Stacked DP.
Note: This field displays only for an orifice meter.
Low DP Setpoint Sets the differential pressure point at which the
system switches over to the low differential
pressure input.
When the High DP input is active and the High DP
reading drops below this value, the Low DP input
becomes the active input. The system assumes the
units for this input to be inches of water column (In
H2O) or kPa.
Note: This field displays only for an orifice meter.
High DP Setpoint Sets the differential pressure point at which the
system switches over to the high differential
pressure input.
When the Low DP input is active and the Low DP
reading rises above this setpoint, the High DP input
becomes the active input. The system assumes the
units for this input to be inches of water column (In
H2O) or kPa.
Note: This field displays only for an orifice meter.
Figure 8-10. Meter Setup (Orifice) – Advanced Figure 8-11. Meter Setup (Linear) – Advanced
tab tab
2. Review the following fields for your organization’s values.
Field Description
Pressure Tap Indicates the pressure tap type and location for this
meter run. Valid values are:
Gauge or Indicates the type of pressure tap.
Absolute This choice must match the static
pressure type as actually measured
by the sensor. Order the MVS
sensor, DVS sensor, or other
pressure transmitter to provide
absolute or gauge measurements.
Upstream or Indicates the location of the static
Downstream pressure tap in relation to the orifice
and normal flow. Upstream is the
default.
Note: This field displays only for
an ISO5167 or AGA3
calculations.
Field Description
Static Pressure Sets Absolute or Gauge for calculations used in
Units this meter run. This choice must match the static
pressure type is actually measured by the sensor.
The MVS sensor, DVS sensor, or other pressure
transmitter can be ordered to provide either absolute
or gauge measurements.
Note: This field displays only for an orifice meter.
Orifice Material Indicates the material from which the orifice is made.
Nearly all natural gas applications use stainless
steel orifice plates.
You must also complete the Ref Temperature field.
This indicates the reference temperature at which
the bore diameter of the orifice plate was measured,
expressed in degrees Fahrenheit or degrees
Celsius.
Note: This field displays only for ISO5167 or AGA3
calculations.
Pipe Material Indicates the material from which the orifice meter
tube material is made. Nearly all natural gas
applications use carbon steel meter tube.
You must also complete the Ref Temperature field.
This indicates the reference temperature at which
the internal diameter of the pipe was measured,
expressed in degrees Fahrenheit or degrees
Celsius.
Note: This field displays only for ISO5167 or AGA3
calculations.
Viscosity Sets the dynamic viscosity of the flowing gas. Units
of measure either Lbm/Ft-Sec (US Units) or cP
(Metric Units).
Sp Heat Ratio Sets the specific heat ratio of the gas (defined as the
specific heat of the gas at constant pressure divided
by the specific heat of the gas at constant volume).
Accepted practice for natural gas applications is to
use a value of 1.3, which was used to develop the
expansion factor tables in the AGA 3 Report – Part
3. If entered, the value must be greater than zero.
Static K Factor Sets the Static K Factor for the turbine linear meter
constant in counts/pulses per unit volume or mass,
such as 4 pulses per cubic foot or 235 pulses/ft3.
The volume units are in pulses ft3 or pulses m3. The
mass units are pulses lb or pulses kg. The Static K-
factor cannot be less than zero.
No Flow Time Sets the No Flow Time. This is the amount of time
without a pulse after which the ROC declares a No
Flow condition. The flow cutoff is the analog signal
lower limit; below this limit a no flow condition exists.
Field Description
Low Flow Cutoff Sets the low flow cutoff value. When the value of the
uncorrected volume input is less than or equal to the
low flow cutoff value, the calculated flow is set equal
to zero. A No Flow alarm is recorded in the Alarm
Log if Alarming is Enabled. The units are MCF/Day
(1000 cubic feet per day) and the metric units are
km3/day (1000 cubic meters per day). This
parameter is only used if the uncorrected volume
input selected is not a pulse input point type.
Speed of Sound Sets the status of the speed of sound calculation. If
Enabled, the system calculates AGA10 feet per
second or meter per second based on the Pressure,
Temperature, and Gas Composition. AGA8 Detail
Method must be selected and a full Gas
Composition entered to calculate the Speed of
Sound.
For diagnostic purposes, Speed of Sound measures
may be read through a serial connection to an
ultrasonic flow meter and stored under the
Measured Speed of Sound to be compared to the
Calculated value.
Variable K Factor Sets the K Factor values at multiple input
frequencies, if the Variable K Factor is enabled. If
the Variable K Factor is disabled, a static factor will
be used.
The K factor is used in the flow calculations to
convert raw pulses to either Volume or Mass. This
conversion may vary with flow rate and Variable K
Factors allow you to specify flow rates as indicated
by Frequency. The K Factor values cannot be less
than zero. Up to twelve K Factor and Frequency
values can be entered.
Temperature Tap Indicates the location of the temperature tap for this
meter run. Valid values are:
Upstream (the default) and Downstream. If you
select Downstream, the system displays the
Calculate Upstream Temperature option. Leave that
option blank to indicate that you do not require a
calculation, or click the option to display the Joule-
Thompson Coefficient field and specify how the
system calculates upstream temperature.
Note: This field displays only if you select ISO5167-
2003 as a Calculation Standard on the
General tab.
Field Description
Joule-Thomson Sets how the system obtains the value for the Joule-
Coefficient Thompson coefficient used in upstream temperature
calculations. Valid values are Calculate (the default)
or Enter (use a specific value). If you click Enter, the
system enables the coefficient value field. The
specific coefficient value must be greater than zero.
Note: This field displays only if you select ISO5167-
2003 as a Calculation Standard on the
General tab and check the Calculate
Upstream Temperature field in the
Temperature Tap frame.
3. Click Apply if you change any parameters on this screen.
4. Proceed to Meter Setup Alarms Tab.
Figure 8-12. Meter Setup (Orifice) – Alarms tab Figure 8-13. Meter Setup (Linear) – Alarms tab
Figure 8-14. Meter Setup (Orifice) – Calibration Figure 8-15. Meter Setup (Linear) – Calibration
Factors tab Factors tab
Field Description
Deadweight Sets whether any corrections occur for local
Gravitational gravity’s effects on dead weight calibrations to
Calibration: Static static pressure. The system multiplies the factor
Pressure Fpwl by the base volume flow equation. The
system uses the factor Fpwl to correct for the effect
of local gravity on the weights of a dead weight
calibrator, which are usually sized for use at a
standard gravitational force or at some specified
gravitational force. A correction factor must then be
applied to correct the calibrations to the local
gravitational force.
Note: When a dead weight calibrator is used for
the differential pressure and the static
pressure, both must be corrected for local
gravity. This involves using Fpwl twice.
Deadweight Sets whether any corrections occur for local
Gravitational gravity’s effects on dead weight calibrations to
Calibration: Diff differential pressure.
Pressure Note: This field displays only for an orifice meter.
For each selection, the system multiplies the factor
Fpwl by the base volume flow equation once for
each selection.
The system uses the factor Fpwl to correct for the
effect of local gravity on the weights of a dead
weight calibrator, which are usually sized for use at
a standard gravitational force or at some specified
gravitational force. A correction factor must then be
applied to correct the calibrations to the local
gravitational force. When a dead weight calibrator
is used for the differential pressure and the static
pressure, both must be corrected for local gravity.
This involves using Fpwl twice.
Calibrated Grav. Sets a gravitational acceleration value if the tester
Accel. value differs from the indicated value. The system
assumes the units to be Ft/Sec 2 or m/Sec 2.
User Correction Sets a factor the system multiplies by the base
Factor volume flow equation to make a desired adjustment
to the flow.
Note: If you use the default value of 1, the system
does not apply any correction.
1. Select the Mass Meter Press Effect tab. The Mass Meter Press
Effect screen displays.
Figure 8-16. Meter Setup (Linear) – Mass Meter Press Effect tab
Figure 8-17. Meter Calibration (Orifice) Figure 8-18. Meter Calibration (Linear)
Notes:
▪ ROCLINK 800 removes input categories from the Freeze Values
frame of this screen depending on the selected meter. For orifice
meters, you can calibrate differential pressure, static pressure, and
temperature inputs. For a turbine meter, you can calibrate static
pressure and temperature inputs. When calibrating stacked
differential pressure, you can calibrate either high differential
pressure (Diff Pressure) input or low differential pressure (Low DP)
input.
Field Description
Meter Selects the meter for verification or calibration.
Click ▼ to display all defined meter runs.
Meter Tag This read-only field shows the short description
associated with the selected meter.
Freeze Button Click to stop the system from updating meter data,
analog, DVS, MVS, or temperature (RTD) inputs
during verification or calibration.
Freeze Values These read-only fields show the value received
from the analog input, DVS, HART, MVS, RTD or
Meter inputs when the Update button was last
clicked. The system uses these values in ongoing
processing (such as flow calculations, history
logging, or control) while calibration occurs.
Verify Click to start the verification process.
Calibrate Click to begin calibration. When this button is
pressed, the Set Zero dialog box opens.
Zero Click to set adjustment factors for the input. The
Shift/Offset/RTD value is sent to the device for:
Bias
Zero Shift Zeros the static pressure effect for
the differential pressure input (Set
Offset).
Offset Sends the value of the live reading
to set the reading as close to zero
as possible for a static pressure
inputs (Measured Pressure
Reading).
RTD Bias Calibrates the offset (shift) of
temperature throughout the RTD
curve (Temperature Standard
Reading).
Auto Scan/Stop Click to automatically request values each second
Scan from the meter. The request continues until you
click Freeze.
Update Button Click to request a value update from the input to be
used as the Freeze Values.
Field Description
Point This read-only field shows the point (differential
pressure, static pressure, or temperature) being
verified.
Action Indicates the current action. Valid values are Verify
or Calibrate.
Actual Displays the value in the Live Reading field.
Field Description
Expected Displays the value in the Dead Weight/Tester
Value field.
Deviation Displays the amount of deviation between the
actual and expected values.
% Deviation Displays a percentage deviation between the
Actual and Expected values.
Dead Weight/Tester Sets the expected value against which the system
Value tests and calibrates.
Note: This is the Expected value in the Action
field.
Live Reading with This read-only field shows the current reading
Offset applied from the sensor. If you have configured an offset,
the value appears in the Offset applied field.
Deviation and % This read-only field shows the deviation between
Deviation the Actual and Expected values, such as the
difference between the live pressure or
temperature reading and the measured pressure or
temperature reading.
(%Deviation = Deviation [(Span EU – Zero EU) x
100%]). Use this value to determine the need for
calibration or adjustment.
Log Verify Click to write the displayed data to the Event Log.
8. As the live reading value changes, click Log Verify as many times
as necessary to establish the verification log.
Typically you verify the same points you calibrate (zero, span, and
mids). Temperature might be an example (– 100, 200, 50). For each test
point, you set your test equipment to produce the expected value, enter
that expected value in the Tester Value field, wait for live input to
stabilize, and then click Log Verify. You can verify as many points as
you want.
Note: If you have chosen to save the verification log, ROCLINK 800
saves it in the location you specified in step 4.
9. Review the verification log and determine whether the results are
within contractual limits. If they are not, you may need to calibrate
the temperature probe. See Section 8.2.2, Calibrating an Input
Example.
10. Click Done. The Meter Calibration screen displays.
If you are calibrating a pressure input, isolate the sensor from the
Caution process. Set up the pressure calibrator and make the necessary
connections to the sensor.
If you are calibrating a temperature input, disconnect the RTD sensor
and connect a decade box (or compatible equipment) to the device’s
RTD terminal.
Note: You can exit a calibration without saving the changes. The
system retains the previous calibration settings but logs the event
in the event log.
To calibrate an input (in this example, the static pressure input):
1. Select Meter > Calibration > Orifice Meter or Linear Meter. The
Meter Calibration screen displays.
Note: You can click Cancel to exit the calibration without saving the
changes. The system retains the previous calibration settings but
logs the event in the event log.
Field Description
Point This read-only field identifies the point (differential
pressure, static pressure, or temperature) being
verified.
Action Shows the activity being performed. Valid values
are Set Zero, Set Span, Set Mid 1, Set Mid 2, and
Set Mid 3
Field Description
As Found Shows the sensor’s initial value.
As Left Shows the sensor’s value after calibration.
Deviation Shows the difference between the As Found value
and the As Left value.
% Deviation Shows the difference between the As Found and
As Left values as a percentage.
Set Zero Calibrate the zero value (0% of range) for the in
differential pressure (orifice only), static pressure,
or temperature. This should correspond with the
Low Reading EU (0% Count) and is the low value
for the input. Set the Dead Weight/Tester Value
(in engineering units). This is the input desired for
the test value and is the actual value expected by
the test equipment being calibrated against. For
example: When calibrating temperature for an RTD
input, enter the degree value associated with the
resistance set up in the decade box or other
equipment.
Set Span Calibrate the span value (100% of range) for
differential pressure (orifice only), static pressure,
or temperature. Set the Dead Weight/Tester Value
(in engineering units). This should correspond with
the High Reading EU (100% Count) and is the high
value to the input (the top end of the expected
operating range).
For static pressure on an absolute-pressure
device, remember to add in the actual atmospheric
pressure, for example, 300 + 14.73.
Set Midpoints If desired, calibrate midpoint 1 (such as 25% of
range) for the differential pressure (orifice only),
static pressure, or temperature, otherwise click the
Done button. Midpoints allow you to specify the
low, middle, and high calibration point between the
zero and span endpoints. Set the Dead
Weight/Tester Value (in engineering units).
If desired, calibrate Midpoint 2 (such as 50% of
range) for the Differential Pressure (orifice only),
Static Pressure, or Temperature. Set Midpoint 2
allows you to specify the middle calibration point
between the Zero and Span endpoints.
If desired, calibrate Midpoint 3 (such as 75% of
range) for the Differential Pressure (orifice only),
Static Pressure, or Temperature. Set Midpoint 3
allows you to specify a third point between the Zero
and Span endpoints.
Note: You can calibrate Midpoints in any order
from low to high or high to low.
Note: You can click Done at this point to complete the calibration
or continue the calibration and define up to three calibration
midpoints.
12. Set test equipment to produce the expected results.
13. Complete the Dead Weight/Tester Value field with the first
midpoint calibration value (which in this example represents 50% of
the instrument’s range).
Note: ROCLINK 800 provides the previous midpoint value as a
default value. Edit this default as necessary.
Field Description
Zero Shift Click to zero the static pressure effect for the
differential pressure input (Set Offset).
Offset Click to send the value of the live reading to set the
reading as close to zero as possible for a static
pressure inputs (Measured Pressure Reading).
RTD Bias Click to calibrate the offset (shift) of temperature
throughout the RTD curve (Temperature Standard
Reading).
Measured Pressure Sets the pressure as read from a calibrated
Reading pressure sensor.
Note: This field displays only for static pressure
points.
Pressure Offset This read-only field shows the difference between
the live pressure reading and the measured
pressure reading that ROCLINK 800 applies to the
pressure value.
Note: This field displays only for static pressure
points.
Field Description
Temperature Sets the temperature as read from a calibrated
Standard Reading temperature probe.
Note: This field displays only for temperature
points.
Live Reading This read-only field shows the live temperature
reading.
With Offset Applied This read-only field shows the live temperature
reading with the calibrated offset applied.
Temperature Bias This read-only field shows the difference between
the live temperature reading and the entered
standard temperature reading that ROCLINK 800
applies to the temperature value.
Note: This field displays only for temperature
points.
Figure 8-34. Meter Values (Orifice) – Values tab Figure 8-35. Meter Values (Linear) – Values tab
Field Description
Temperature This read-only field shows the temperature value
for the selected meter run.
Current Flow Rates These read-only fields display the current Flow
Rate, Energy Rate, and Mass Rate.
Accumulation The read-only field shows the accumulated flow,
energy, flowing minute, and mass values.
Figure 8-36. Meter Values (Orifice) – Factors tab Figure 8-37. Meter Values (Linear) – Factors tab
3. Review the screen’s contents. You can click Update to refresh the
display on demand or Auto Scan to start updating the display once
per second.
Field Description
Orifice Diameter Sets, in inches or millimeters, the exact size of the
orifice diameter of the new plate.
3. Click ▼ to select the correct Meter Number for the meter run you
are changing.
4. Select Yes if the plate change occurs during flowing conditions. You
will be allowed to freeze the inputs for the duration of the plate
change process. Click No for non-flowing conditions.
5. Click Freeze if you are performing the plate change under flowing
conditions, the dialog box shows you the freeze value of each meter
input (for the purpose of calculating gas flow) while the change
occurs. All I/O values are held in manual mode at the current value.
The values are returned to an active state after clicking OK in the
plate change dialog box.
6. Set the exact size of the Orifice Diameter (inches or millimeters) of
the new plate.
7. Click Apply if you change any parameters on this screen.
8. Click OK when you complete the plate change. If you have frozen
values, this returns system values to flowing conditions.
Note: For information on the FST Editor and writing FSTs, refer to the
Function Sequence Table (FST) User Manual (part
D301058X012).
Note: The upgrade file may have either a .dli or a .ddi file type. This is
normal.
The AGA licenses are on the second license key. To move an AGA
license to key #1:
2. Select the license to move. The Move and Split buttons activate.
Note that the Quantity field indicates there are two AGA licenses.
3. Click Split. The AGA license splits into two individual licenses.
4. Select one of the AGA licenses. The Move and Merge buttons
activate, indicating available actions.
5. Click Move. The selected AGA license moves to key #1.
6. You can now remove the second license key or leave it in place, as
your organization requires.
The PGAS system does not support stations. All gas quality data is part
of the station point in the ROC. All .ANA files duplicate for each meter
run in the station, the only difference being the METER_IDs.
PGAS All alarms in the alarm log (.ARM) that are related in any way to a
Alarm Files meter run are included in the PGAS .ARM file. These alarms include
High, Low, and No Flow alarms for meter run and station flows; and
Low, Low Low, High, High High, Rate, Manual Mode, and Point Fail
alarms for points configured as inputs to meter points, including
communication alarms for an MVS points configured as inputs to a
meter point. Station alarms duplicate for each meter included in the
station.
PGAS Meter Meter related events include changes to meter and points, parameters,
Event-related Files and calibration verification events for points configured as inputs to
meter points; changes to the number of active stations, orifice, or
turbine points; changes to the clock; system events; and parameter
change events for history points when the old or new point being
archived is a meter or station point.
Events such as warm starts, cold starts, system initializations, and clock
changes duplicate for every meter run in the unit. Station parameter
change events duplicate for every meter run in that station. Events used
by the PGAS system to recalculate meter values are indicated by
including a METER_CALC_COLUMN_NAME in the PGAS event
record. The point types and parameters map to PGAS METER_CALC
events.
Data
Description METER_CALC_COLUMN_NAME Point Types Parameters
Type
Orifice Diameter ORIFICE_SIZE Float Orifice Config (113) 15
Pipe Diameter TUBE_DIAMETER Float Orifice Config (113) 12
Base TEMP_BASE Float Station (112) 14
Data
Description METER_CALC_COLUMN_NAME Point Types Parameters
Type
Temperature
Base Pressure CONTRACT_PRES_BASE Float Station (112) 13
Atm Pressure SITE_ATMOS_PRES Float Station (112) 16
Orifice Material PLATE_MATERIAL U8 Orifice Config (113) 17
Pipe Material TUBE_MATERIAL U8 Orifice Config (113) 14
Tap Location STAT_TAP_LOCA U8 Orifice Config (113) 3
Diff Press Span1 DIFF_HI_RANGE Float Orifice Config (113) 25
Static Press STATIC_HI_RANGE Float Orifice Config (113) or 27 or 15
Span2 Turbine Config (115)
Temp 0% EU3 TEMP_LO_RANGE Float Orifice Config (113) or 29 or 17
Turbine Config (115)
Temp Span3 TEMP_HI_RANGE Float Orifice Config (113) or 29 or 17
Turbine Config (115)
1 The ROC Point Type and Parameter listed for this entry contains a 3-byte value that is the Point Type, Point Number,
and Parameter to use for the differential pressure value. If the Point Type of the differential pressure input is MVS (108) or
analog input (103), the differential pressure span will be the same Point Type and Point Number as the differential
pressure value and (coincidentally) the Parameter will be 17 for both of these Point Types. If the Point Type is any other
type, a span will not be available.
2 The ROC Point Type and Parameter listed for this entry contains a 3-byte value that is the Point Type, Point Number,
and Parameter to use for the static pressure value. If the Point Type of the static pressure input is MVS (108), the static
pressure span will be the same Point Type and Point Number as the static pressure value and the Parameter will be 33. If
the Point Type of the static pressure input is analog input (103), the static pressure span will be the same Point Type and
Point Number as the static pressure value and the Parameter will be 17. If the Point Type is any other type, a span will not
be available.
3 The ROC Point Type and Parameter listed for this entry contains a 3-byte value that is the Point Type, Point Number,
and Parameter to use for the temperature value. If the Point Type of the temperature input is MVS (108), analog input
(103), or RTD (106), the temperature zero and span will be the same Point Type and Point Number as the temperature
value and the Parameters will be as follows:
Zero Span
Point Type Parameter Parameter
MVS (108) 44 48
AIN (103) 13 17
RTD (106) 9 13
PGAS Volume Files The PGAS .VOL file contains the hourly volume data related to a meter
run including the meter fun ID, report information, general meter flow
parameters, and calculated factors. The Archive Type and TLP of the
history points expected for the hourly volume report also display.
PGAS Volume The PGAS .VOL file contains the hourly volume data related to a meter
Files Format run including the meter run ID, report information, general meter flow
parameters, and calculated factors.
The Archive Type and TLP of the history points expected for the hourly
volume report also display.
Note: For additional information on the PGAS and the .EVT, .ANA,
.ARM, and .VOL file formats, refer to the documentation
provided with your PGAS or the web site www.pgas.com.
PGAS Volume The PGAS .VOL file contains the hourly volume data related to a meter
Files For Orifice Meter fun including the meter run ID, report information, general meter flow
parameters, and calculated factors.
The Archive Type and TLP of the history points expected for the hourly
volume report also display.
Averaging / Rate
Description Archive Type Point Type Parameter
Type
Flowing Totalize (134) None (0) Orifice Values (114) Minutes Accumulated (28)
Minutes
Differential Average (128) Flow Dependent Orifice Configuration DP (26)
Pressure Linear (1) (113)
Average (128) Flow Dependent Orifice Configuration DP (26)
Formulaic (2) (113)
Average (128) Flow Weighted Linear Orifice Configuration DP (26)
(3) (113)
Average (128) Flow Weighted Orifice Configuration DP (26)
Formulaic (4) (113)
Static Average (128) Flow Dependent Orifice Configuration SP (28)
Pressure Linear (1) (113)
Average (128) Flow Dependent Orifice Configuration SP (28)
Formulaic (2) (113)
Average (128) Flow Weighted Linear Orifice Configuration SP (28)
(3) (113)
Average (128) Flow Weighted Orifice Configuration SP (28)
Formulaic (4) (113)
Temperature Average (128) Flow Dependent Orifice Configuration TMP (30)
Linear (1) (113)
Average (128) Flow Dependent Orifice Configuration TMP (30)
Formulaic (2) (113)
Average (128) Flow Weighted Linear Orifice Configuration TMP (30)
(3) (113)
Average (128) Flow Weighted Orifice Configuration TMP (30)
Formulaic (4) (113)
Pressure Average (128) Flow Dependent Orifice Values (114) Pressure Extension (4)
Extension Linear (1)
Average (128) Flow Dependent Orifice Values (114) Pressure Extension (4)
Formulaic (2)
Average (128) Flow Weighted Linear Orifice Values (114) Pressure Extension (4)
(3)
Average (128) Flow Weighted Orifice Values (114) Pressure Extension (4)
Formulaic (4)
C Prime Average (128) Flow Dependent Orifice Values (114) Multiplier Value (12)
Linear (1)
Average (128) Flow Dependent Orifice Values (114) Multiplier Value (12)
Formulaic (2)
Averaging / Rate
Description Archive Type Point Type Parameter
Type
Average (128) Flow Weighted Linear Orifice Values (114) Multiplier Value (12)
(3)
Average (128) Flow Weighted Orifice Values (114) Multiplier Value (12)
Formulaic (4)
Volume Totalize (134) None (0) Orifice Values (114) Flow Accumulated (23)
Accumulate Per Day (13) Orifice Values (114) Flow Rate Per Day (0)
(129)
Accumulate Per Hour (12) Orifice Values (114) Flow Rate Per Hour (2)
(129)
Energy Totalize (134) None (0) Orifice Values (114) Energy Accumulated (33)
Accumulate Per Day (13) Orifice Values (114) Energy Rate Per Day (1)
(129)
Accumulate Per Hour (12) Orifice Values (114) Energy Rate Per Hour (3)
(129)
PGAS Volume The PGAS .VOL file contains the hourly volume data related to a meter
Files For Turbine Meter fun including the meter fun ID, report information, general meter flow
parameters, and calculated factors.
The Archive Type and TLP of the history points expected for the hourly
volume report also display.
Averaging / Rate
Description Archive Type Point Type Parameter
Type
Flowing Totalize (134) None (0) Turbine Values Minutes Accumulated (21)
Minutes (116)
Raw Pulses Totalize (134) None (0) Turbine Values Pulses Accumulated (9)
(116)
Static Average (128) Flow Dependent Turbine SP (16)
Pressure Linear (1) Configuration (113)
Average (128) Flow Dependent Turbine SP (16)
Formulaic (2) Configuration (113)
Average (128) Flow Weighted Linear Turbine SP (16)
(3) Configuration (113)
Average (128) Flow Weighted Turbine SP (16)
Formulaic (4) Configuration (113)
Temperature Average (128) Flow Dependent Turbine TMP (18)
Linear (1) Configuration (113)
Average (128) Flow Dependent Turbine TMP (18)
Formulaic (2) Configuration (113)
Average (128) Flow Weighted Linear Turbine TMP (18)
(3) Configuration (113)
Average (128) Flow Weighted Turbine TMP (18)
Formulaic (4) Configuration (113)
C Prime Average (128) Flow Dependent Turbine Values Multiplier Value (12)
Linear (1) (114)
Average (128) Flow Dependent Turbine Values Multiplier Value (12)
Averaging / Rate
Description Archive Type Point Type Parameter
Type
Formulaic (2) (114)
Average (128) Flow Weighted Linear Turbine Values Multiplier Value (12)
(3) (114)
Average (128) Flow Weighted Turbine Values Multiplier Value (12)
Formulaic (4) (114)
Uncorrected Totalize (134) None (0) Turbine Values Uncorrected Accumulated
Volume (114) (31)
Accumulate Per Hour (12) Turbine Uncorrected Flow Rate
(129) Configuration (113) (14)
Volume Totalize (134) None (0) Turbine Values Flow Accumulated (16)
(114)
Accumulate Per Day (13) Turbine Values Flow Rate Per Day (0)
(129) (114)
Accumulate Per Hour (12) Turbine Values Flow Rate Per Hour (2)
(129) (114)
Energy Totalize (134) None (0) Turbine Values Energy Accumulated (26)
(114)
Accumulate Per Day (13) Turbine Values Energy Rate Per Day (1)
(129) (114)
Accumulate Per Hour (12) Turbine Values Energy Rate Per Hour (3)
(129) (114)
Field Description
Device User These read-only fields show the amount of used
Program and available memory. The user program that you
Environment intend to load must be able to access the memory
location.
User Programs Displays any currently installed user programs.
Installed in Device
If you select a currently installed program, the
system completes the User Programs Installed in
Device frame with information detailing specific
information about that user program.
Clear Click to delete the selected user program from
memory.
Start Click to start the selected user program.
Stop Click to stop the selected user program from
running.
All - Option Select to perform the same action (Clear, Start, or
Stop) on every user program.
Status This read-only field indicates the status of the
selected program. Valid values are:
Empty No program installed.
Loaded Program loaded but not running.
Running Program loaded and active.
License Program requires a license to
Not Found operate.
Reset Counter Click to clear the value that indicates how many
times the user program has been restarted.
Field Description
Download User Identifies the program file to be downloaded to the
Program File ROC. Click Browse to locate the file you desire to
download.
When you select a user program file, the system
completes the lower portion of the screen with
configuration information detailing for the user
program.
Download & Start Click to download and start the user program
running.
Download Click Download to download but not start the
user program.
Note: If you download several programs, they
may need to be started in a particular
order. Use this button to download without
starting the programs.
Update Click to update values on the screen.
Close Click to close the screen.
The settings you define in Utilities > ROCLINK 800 Security must match
Caution the settings you define in ROC > Security (Device Security) in order for
users to log onto ROCLINK 800.
2. Enter three alphanumeric characters for the Operator ID, which are
typically the initials of the person who operates the device. Each
Operator ID must be unique and is case-sensitive (that is, ABC
is different from Abc).
3. Enter four numeric characters (between 0000 and 9999) to define the
operator Password. More than one user can have the same
password.
Note: If you precede a password value with zeroes (such as 0006),
ROCLINK 800 saves that password as 6.
4. Enter the desired Access Level for the user. 0 is the lowest (least
inclusive) access level and allows access to the fewest number of
screens. 5 is the highest (most inclusive) access level and allows
access to all screens. Each access level permits access to screens at
that level and any inherited from lower access levels. For example,
an operator ID with Access Level 3 can access screens with levels 0,
1, 2, and 3. Refer to Table 9-1, Security Access Levels.
Note: Click User Access Levels to display a User Access Levels
dialog that shows all menu options and their access levels.
5. Click Save.
Security Table 9-1 lists the system screens and their system-assigned security
Access Levels access levels. The Menu Options focus on the activity while you use
the Access Levels to increase or decrease responsibility levels within
Field Description
Point Click ▼ to select an RTD point.
Raw Value (1 - 5) These read-only fields show the calibrated raw
values, where Raw Value 1 is the lowest
calibrated raw A/D input and Raw Value 5 is the
highest calibrated raw A/D input.
Field Description
RTD Bias This read-only field shows the Press Effect is the
Zero Shift or RTD Bias adjustment value (applies
only to points configured as the Differential
Pressure input to a Meter Run) or temperature
input.
Set EU Value This read-only field shows the Tester Value
specified for the last calibration value that was set.
Manual EU This read-only field shows the Manual EU Live
Reading for the last calibration value that was set.
EU Value (1 - 5) These read-only fields show the five calibration
settings in engineering unit values, converted from
the raw values, based on the Low Reading EU
and High Reading EU defined for the point. EU
Value 1 is the Zero value and EU Value 5 is the
Span value. The rest are midpoint values.
Timer This read-only field shows, in seconds, the last
inactivity count-down (typically starting from 3600
seconds) that occurred during the last calibration
session. Had the countdown reached 0, time-out
would have taken place, automatically ending the
calibration mode.
Mode Indicates the calibration mode. Valid values are:
0 = Use Current Calibration
1 = Start Calibration
2 = Calibrate
3 = Restore Previous Calibration
4 = Stop Calibration
Type Indicates the calibration value currently being set.
Valid values are:
0 = Inactive (no value)
1 = Zero
2 = Span
3 = Midpoint 1
4 = Midpoint 2
5 = Midpoint 3
6 = Unused
Field Description
Point Click ▼ to select an AI point.
Raw Value (1 - 5) These read-only fields show the calibrated raw
A/D input, where Value 1 is the lowest calibrated
input and Value 5 is the highest calibrated input.
Offset This read-only field shows the zero shift
adjustment value for a differential pressure input.
This value is an offset to the calibrated EU Values,
and compensates for the effect of working static
pressure on a DP transmitter that was calibrated
at atmospheric pressure.
Set EU Value This read-only field shows the Tester Value
specified for the last calibration.
Manual EU This read-only field shows the Live Reading for
the last calibration.
EU Value (1 - 5) These read-only fields show the five calibration
settings in Engineering Unit values, converted
from the raw values, based on the low reading EU
and the high reading EU defined for the point.
Value #1 is the zero value, value #5 is the span
value, and values 2, 3, and 4 are midpoint values.
Timer This read-only field shows the last inactivity
count-down in seconds (typically starting from
3600 seconds) that occurred during the last
calibration session. Had the countdown reached 0,
time-out would have taken place, automatically
ending the calibration mode.
Field Description
Mode This read-only field shows the status of the
calibration. Valid values are:
0 = Use Current Calibration
1 = Start Calibration
2 = Calibrate
3 = Restore Previous Calibration
4 = Stop Calibration
Type This read-only field shows the currently set
calibration value. Valid values are:
0 = Inactive (no value)
1 = Zero
2 = Span
3 = Midpoint 1
4 = Midpoint 2
5 = Midpoint 3
6 = Zero Shift
Field Description
MVS Sensor Click ▼ to select an MVS sensor.
Sensor Tag This read-only field shows the label associated
with the selected MVS sensor.
Field Description
Differential Pressure
Manual Value This read-only field shows the value of the input
at the last meter Freeze.
Cal Value (1 – 5) These read-only fields show the differential
pressure calibration values the selected MVS
sensor currently uses.
Pressure Effect This read-only field shows the adjustment factor
for pressure.
Static Pressure
Manual Value This read-only field shows the value of the input
at the last meter Freeze.
Cal Value (1 – 5) These read-only fields show the static pressure
calibration values the selected MVS sensor uses.
Pressure Offset This read-only field shows the adjustment factor
for pressure.
Temperature
Manual Value This read-only field shows the value of the input
at the time of the last meter “Freeze.”
Cal Value (1 – 5) these read-only fields show the temperature
calibration values the selected MVS sensor
currently uses.
Set To Factory Click to return the MVS calibration values to their
Defaults original values and reset the MVS.
Note: You must answer Yes to a verification
dialog before the reset occurs. When the
reset completes, a verification dialog box
displays. This resets the MVS address to
the default value of 1 and the Sensor Tag
to MV Sensor.
The Keypad Display allows interaction with TLPs in the ROC database.
An understanding of TLPs is crucial to configuring a keypad display
file. TLP refers to Point Type, Logical number (Instance), and
Parameter. For example, the TLP DIN 4-2, ACC is the Accumulated
Value parameter of channel 2 of the discrete Input module in slot 4.
This TLP can also be expressed numerically as 101, 4-2, 6.
Once you add the required number of menus and screens, it is good
practice to save the file to the PC. Use the Save As button in the right
pane of the editor. ROCLINK 800 saves keypad display files using the
extension DCFG. You can also save a display file in a configuration file
(*.800) using either the Download button (when on-line) or the Save
button (when off-line).
Creating the display file is only the first step. You must now edit the
display file to select TLPs and assign security. Refer to the steps in the
Editing a Keypad Display File. Once you complete the edit process, you
must again save the file. Then you can download it to the ROC.
Field Description
Hierarchy Menu The Hierarchy Menu determines the navigation
for the display. Each level in the Hierarchy Menu
represents a screen with menu choices. Add
menus and screens to each level in the Hierarchy
Menu to suit your application.
Title Sets the Title for this configuration file. Use of all
capital letters is recommended.
On Open TLP and When the ROC Keypad Display is in use (logged
On Close TLP on), the system writes the value indicated in the
Value field to the TLP specified in the On Open
TLP field.
When the ROC Keypad Display is no longer in use
(logged off), the system writes the value indicated
in the Value field to the TLP specified in the On
Close TLP field.
Point Types Enables you to scroll through the logical instances
of the point types assigned in the Point Types
field.
Field Description
Line Entries You can add, delete, and move Line Entries.
Each line represents one line on the display. Each
field of the entry is configured separately.
However, a command to Add Entry, Move Up,
Move Down, or Delete Entry causes the entry to
add, move or delete the entire line.
Note: Once you create a line entry, use the
parameters in the Field frame to control the
values for that line entry.
Add Entry Click to add a line entry field.
Delete Entry Click to delete the highlighted line entry field.
Move Up Click to move the selected line entry field up one
position.
Move Down Click to move the selected line entry field down
one position.
Value If the field highlighted in the Line Entry frame is to
have manually entered text or numbers, select a
Value of Manual Value.
If the field is to have a parameter name in full,
select Parameter Name.
If the field is to have an abbreviation of the
Parameter name, select Parameter Abbreviation.
If the field is to have the value of the parameter,
select Parameter Value.
Text If the Value selected was Manual Value, set the
text or number in the Text field.
TLP Indicates the TLP for the field’s value.
Note: This field displays only if you selected
Parameter Name, Parameter Abbreviation,
or Parameter Value in the Value field.
Justify and Length Controls the positioning of the value in the
selected field. Valid values are Left (the default)
Center, or Right.
Length determines the maximum length of the
text or numbers in the entry field.
Length Indicates the maximum number of characters (text
or digits) in the selected line
Read Only Select Read Only (R/O) if the TLP selected is to
be a display only on the ROC Keypad Display. If
not selected, the TLP will be Read Write (R/W) if
the keypad user has Read-write privileges to TLPs
in that access group. Note that only one field in an
entry line can be R/W.
Leading Text and In some circumstances, when you select
Trailing Text Parameter Value, you can type text to go before
or after the value. Leading and Trailing Text
allows units of measurement or some other text to
appear on the screen.
Field Description
Data Format In some circumstances, when you select the
Parameter Value and the Use Default Format
checkbox, set whether the Data Format will be the
default that has a Precision of two characters or
another manually entered precision.
Open File Click to open a .DCFG file residing on your PC.
Read Device Click to read a .DCFG file residing on your ROC.
Save As Click to save the current .DCFG file wit the name
you indicate.
Download Click to download the current .DCFG file to the
connected ROC.
Note: Before you download a file, ensure that you
have assigned the ROC comm port to LCD
(Comm Port Owner field on ROC > Comm
Ports).
Cancel Click to close the Keypad Display Editor without
saving any changes.
Keypad The ROC Keypad Display utility provides security to help you control
Display Security user access to information. You can place users in "groups" that have a
predefined access level. Within each group, individuals can be assigned
an additional level of access that overrides the group access level. The
panels on the right side of the Keypad Display Editor provide this
functionality.
You can define customer display screens that allow users to view and
edit parameters, view parameters only, or have no display access based
on their group or individual access level. Typically, you assign group or
individual access based on job function. Each user within a group
assumes that group’s access level. However, you can grant or deny to an
individual user’s access to a specific display based on that user’s
individual access level.
For example, John, Joe, and Pat are members of a "Technicians" group
that is allowed to view and edit the PID display. You can prevent Joe
from changing the set point of a PID loop if you define individual
access that restricts him to viewing (R/O) only. The rest of the group’s
members are unaffected by Joe’s individual restriction.
If you assign a user to more than one group, each of which has different
access levels, the user assumes the access level of the highest group for
all of their assigned groups.
For example, John is in the Technicians group, which has access to edit
and view. You also assign him to the Meter Setup group, which only has
view access. John automatically has edit access in the Meter Setup
group because of his membership in the Technicians group. However,
you can individually restrict him to read only access in the Meter Setup
group.
Note: The User Access and Group Access lists for a ROC800-Series
unit are established on the ROC > Security screen. For more
information on security in the ROC, refer to Device Security.
Field Description
Group Access Sets the Group Access to determine the type of
access (Read/Write or Read/Only) allowed by the
groups of users to a given display.
User Access Sets the User Access to determine the type of
access (Read/Write or Read/Only) allowed by the
individual users to a given display.
Updating Keypad You can update the firmware in the keypad display while connected by
Display Firmware a serial or TCP/IP (Ethernet) communications connection.
1. The updated firmware files are typically supplied on in a .zip file. It
is recommended that you create a backup copy of the firmware
update file after you unzip the file.
2. Read the README text file included with the firmware update.
3. Select Utilities > Update Firmware and select the Keypad Display
tab.
4. Click Browse and navigate to the new firmware file on the PC.
5. Once the file is found, click Start. The update may take a while; do
not interrupt the update while it is in progress.
6. Click OK when the Firmware Update Completed dialog box
appears.
Select Utilities > Custom EFM Report Editor. A blank Custom EFM
Report Editor screen displays:
Summarized
information
Detailed
hour or daily
history
6. Select the report options (Meter Run, Start Date, End Date, and
Report Sections) and click Print Preview. An on-screen version of
the report displays.
7. Use the print (or export) options on this screen to produce the report.
The system shows bytes sent in black and bytes received in red. Data
received since the last good response (and before a request) are shown
in aqua.
Right-click on the display to display a menu that enables you to Copy
highlighted data, Clear All data, Unselect, or Export the data to several
formats.
10.1 Options
ROCLINK 800 enables you to display TLP selections either as text or
numbers.
When the Browse button (shown on left) is associated with a TLP, click
the Browse button to display the Select TLP dialog (see Figure 10-2).
Use the Select TLP dialog to assign specific inputs and outputs to
parameters. ROCLINK 800 uses Point Type (T), Logical Number (L),
and Parameter (P) to define point locations.
To select how TLP values display, select Tools > Options. The Options
dialog displays.
Field Description
Display TLP Displays values on the Select TLP screen as
either text or numbers. For example, the TLP for
Register 2 of FST 1 could display as either
FST 1, R2 or 96, 0, 3.
Auto Scan Interval Sets, in seconds, the time interval at which the
Auto Scan feature (present on numerous
ROCLINK 800 screens) polls a ROC.
TLP Selection Select to display all TLP options if the TLP does
not pertain to the option you are configuring.
TLP ToolTip Popup Select to display a context-sensitive TLP source
data detailing the selection when you hover over it.
Use the Windows menu to configure how your screens display and to
sets the ROCLINK screen you desire to view.
11.1 Cascade
Select Window > Cascade to view all open ROCLINK 800 windows in
a Cascade view.
Button Description
Minimizes the size of the window and places it at the
bottom of the screen.
Maximizes the size of the window to fill the screen
area.
Restores the original size of the window.
Closes a window.
11.2 Tile
Select Window > Tile to view all open ROCLINK 800 windows in a
Tile view.
Inactive
window
Active
window
Note the difference in color intensity of the title bars: the system
highlights the title bar for the currently active window.
Use the Help menu to access the on-line help system and view the
About ROCLINK 800 screen.
Topic
Menu
Topic
.
Content.
A table of contents for all help topics appears on the left of the help
topic contents. The Help Topics consist of parameter names and menu
options. Note that some topic names have been abbreviated. For
example: analog input functions appear with "AI" in front of the name,
such as in AI Alarms, AI Scanning, or AI-analog inputs.
Appendix A – Glossary
Note: This is a generalized glossary of terms. Not all the terms may
necessarily correspond to the particular device or software
described in this manual. For that reason, the term “ROC” is
used to identify all varieties of Remote Operations Controllers.
A
A/D Analog to Digital signal conversion.
ABS Acrylonitrile Butadiene Styrene.
ADC Analog to Digital Converter. Used to convert analog inputs (AI) to a format the flow
computer can use.
Additive A liquid that is injected into a primary liquid component in relatively small quantities,
usually less than four percent of the delivered volume total. Additives are injected into
the primary liquid component by an injector mechanism which places a known, fixed
volume of the additive into the primary liquid component stream for each injector pulse
received from the DL8000 Preset.
AGA American Gas Association. A professional organization that oversees the AGA3
(orifice), AGA5 (heating value), AGA7 (turbine), AGA8 (compressibility), AGA9
(Ultrasonic), and AGA11 (Coriolis) gas flow calculation standards. See http://
www.aga.org.
AWG American Wire Gauge.
AI Analog Input.
AO Analog Output.
Analog Analog data is represented by a continuous variable, such as an electrical current
signal.
Annubar A device that uses Pitot tubes to measure the gas flow rate within a pipeline. The gas
volume is calculated from the difference between the flowing pressure and the static
pressure of the gas.
AP Absolute Pressure.
API American Petroleum Institute. See http://www.api.org.
Area A user-defined grouping of database entities.
Arm A movable pipe or hose assembly used at a tanker truck loading island (also: swing
arm, loading arm). The arm can be designed for either top loading or bottom loading to
the tanker compartments. A swing arm can be positioned to load at either side of the
loading island or the parked state.
ASCII American (National) Standard Code for Information Interchange.
Attribute A parameter that provides information about an aspect of a database point. For
example, the alarm attribute is an attribute that uniquely identifies the configured value
of an alarm.
B
Batch A preset, quantity-based product delivery or blended component delivery of a single
recipe.
Blend Stream A product stream blended of both gasoline and ethanol.
Blending The process of mixing two or more liquid components to form a composite delivered
stream. The DL8000 controls blending based on a predetermined recipe by either the
sequential (automatic or manual) or the inline (proportional or non-proportional)
method. The quantity of each component in a blend is typically greater than two to four
percent of the blended product. Injection of very small quantities of liquids, less than
four percent of the blended product, is usually controlled by the additive injection
process.
BMV Base Multiplier Value, used in AGA7 (turbine) calculations.
BPS Bits Per Second, associated with baud rate.
BTU British Thermal Unit, a measure of heat energy.
Built-in I/O I/O channels that are fabricated into the ROC and do not require a separate option.
Also called “on-board” I/O.
C
CID2 Class I, Division 2 hazardous area
CF Compare Flag; stores the Signal Value Discrete (SVD).
CMOS Complementary Metal Oxide Semiconductor, a type of microprocessor used in a ROC.
Coil Digital output, a bit to be cleared or set.
COL Ethernet Packet Collision.
COM Communications port on a personal computer (PC).
COMM Communications port on a ROC used for host communications.
Comm Module Module that plugs into a ROC to provide a channel for communications via a specified
communications protocol, such as EIA-422 (RS-422) or HART.
Component Any liquid metered and controlled by the DL8000. Liquid hydrocarbons refined from
crude oil and LPGs (such as propane) are usually referred to as products. Components
are base products or tank products stored at a distribution terminal. The component is
measured before being blended with other components. Additives may be injected
before (upstream of) or after (downstream of) the component meter.
Configuration Refers either to the process of setting up the software for a given system or the result
of performing this process. The configuration activity includes editing the database,
building schematic displays and reports, and defining user calculations. Typically, the
software set up of a device that can often be defined and changed. Can also mean the
hardware assembly scheme.
Configuration In ROCLINK 800, the graphical display that appears when a configuration file opens
Tree (also Directory Tree). It is a hierarchical branching (“tree-style”) method for navigating
within the configuration screens.
CPU Central Processing Unit.
CRC Cyclical Redundancy Check error checking.
Crosstalk The amount of signal that crosses over between the receive and transmit pairs, and
signal attenuation, which is the amount of signal loss encountered on the Ethernet
segment.
CSA Canadian Standards Association. See http://www.csa.ca.
CSMA/CD Carrier Sense Multiple Access with Collision Detection.
CTS Clear to Send modem communications signal.
D
D/A Digital to Analog signal conversion.
DB Database.
dB Decibel. A unit for expressing the ratio of the magnitudes of two electric signals on a
logarithmic scale.
DCD Data Carrier Detect modem communications signal. In addition, Discrete Control
Device – A discrete control device energizes a set of discrete outputs for a given
setpoint and matches the desired result against a set of discrete inputs (DI).
DCE Data Communication Equipment.
Deadband A value that is an inactive zone above the low limits and below the high limits. The
purpose of the deadband is to prevent a value (such as an alarm) from being set and
cleared continuously when the input value is oscillating around the specified limit. This
also prevents the logs or data storage location from being over-filled with data.
Device In ROCLINK 800, the graphical display that allows navigation through the PC Comm
Directory Ports and ROC Comm Ports set up screen.
DI Discrete Input.
Discrete Input or output that is non-continuous, typically representing two levels (such as on/off).
DMM Digital multimeter.
DO Discrete Output.
Download The process of sending data, a file, or a program from a PC to a ROC.
DP Differential Pressure.
DSR Data Set Ready modem communications signal.
DTE Data Terminal Equipment.
DTR Data Terminal Ready modem communications signal.
Duty Cycle Proportion of time during a cycle that a device is activated. A short duty cycle
conserves power for I/O channels, radios, and so on.
DVM Digital voltmeter.
DVS Dual-Variable Sensor. A device that provides static and differential pressure inputs to a
ROC.
E
EDS Electronic Static Discharge.
EEPROM Electrically Erasable Programmable Read-Only Memory, a form of permanent memory
on a ROC.
EFM Electronic Flow Metering or Measurement.
EIA-232 Serial Communications Protocol using three or more signal lines, intended for short
(RS-232) distances. Concerning RS232D and RS232C, the letters C or D refer to the physical
connector type. D specifies the RJ-11 connector where a C specifies a DB25 type
connector.
EIA-422 Serial Communications Protocol using four signal lines.
(RS-422)
EIA-485 Serial Communications Protocol requiring only two signal lines. Can allow up to 32
(RS-485) devices to be connected together in a daisy-chained fashion.
EMF Electro-Motive Force.
EMI Electro-Magnetic Interference.
ESD Electro-Static Discharge.
EU Engineering Units. Units of measure, such as MCF/DAY.
F
FCC Federal Communications Commission. See http://www.fcc.gov.
Firmware Internal software that is factory-loaded into a form of ROM. In a ROC, the firmware
supplies the software used for gathering input data, converting raw input data values,
storing values, and providing control signals.
FlashPAC ROM and RAM module for a ROC300-Series unit that contains the operating system,
module applications firmware, and communications protocol.
Flash ROM A type of read-only memory that can be electrically re-programmed. It is a form of
permanent memory (requires no backup power). Also called Flash memory.
FloBoss A microprocess-based device that provides flow calculations, remote monitoring, and
remote control. A FloBoss is a type of ROC.
FM Factory Mutual.
Force Write an ON/OFF, True/False, or 1/0 value to a coil.
FPV Compressibility Factor.
FSK Frequency Shift Keypad.
FST Function Sequence Table, a type of user-written program in a high-level language
designed by Emerson Process Management’s Remote Automation Solutions Division.
Ft Foot or feet.
G
GFA Ground Fault Analysis.
GND Electrical ground, such as used by the ROC unit’s power supply.
GP Gauge Pressure.
Gross Quantity The indicated quantity times the meter factor derived from a meter proving of the flow
meter at a specific flow rate. Calculation: gross quantity = indicated quantity times
meter factor.
H
HART® Highway Addressable Remote Transducer.
Holding Analog output number value to be read.
Register
Hw Differential pressure.
Hz Hertz.
I, J
IC Integrated Circuit. Also, Industry Canada (more recently known as Measurement
Canada), an organization that grants custody transfer approvals on certain ROC units.
ID Identification.
IEC Industrial Electrical Code or International Electrotechnical Commission. See
http://www.iec.ch.
IEEE Institute of Electrical and Electronic Engineers. A professional organization that, in
conjunction with the International Standards Organization (ISO), establishes and
maintains the Open System Interconnection (OSI) reference model and an international
standard for the organization of local area networks (LANs). Refer to
http://www.ieee.org.
IMV Integral Multiplier Value, used in AGA3 (orifice) calculations.
Indicated The change in the flow meter reading that occurs during a product flow measurement
Quantity operation. (Not displayed by the device calculation: indicated quantity = end reading
minus start reading.)
Input Digital input, a bit to be read.
K
KB Kilobytes.
KHz KiloHertz.
K-factor The pulses per unit quantity generated by a pulse output type flow meter (also system
factor). The nominal value is determined by flow meter design and factory water flow
calibration. The “average” K-factors for the flow meters are usually indicated on the
flow meter nameplates.
L
LCD Liquid Crystal Display.
LDP Local Display Panel, a display-only device that plugs into ROC300 (via a parallel
interface cable) used to access information stored in the ROC.
LED Light-Emitting Diode.
Load For sequential blending: In multi-component blending, a load is the completed
delivery of one component of a batch. The completion of loading all components in the
batch completes the batch delivery. If the recipe only loads one component, a load
corresponds to a batch delivery.
For inline blending: Each component of the blend is loaded simultaneously.
Depending on the blend ratio, the low-proportion components are loaded completely
during the time that the high proportion component(s) are being loaded. After loading of
the highest proportion component has been terminated, all component loads and the
batch delivery are complete.
Loading Island Also loading rack; an installation of one or more loading arms or risers used to deliver
liquid components to a tanker vehicle located on one or both sides of the island,
depending on the design of the island.
Loading Riser The related instruments and devices, located in a meter stream, that provide the liquid
component loading capability to a mobile tanker vehicle.
Note: The flow meter piping can also be installed horizontally, if desired.)
Load Spot Also bay or lane; one side of a loading island, a position where a tanker vehicle parks
for a loading operation. One load spot can have one or more loading arms.
Local Port Also LOI; the serial EIA-232 (RS-232) port on the ROC through which local
communications are established, typically for configuration software running on a PC.
Logical Number The point number the ROC and ROC Plus protocols use for I/O point types are based
on a physical input or output with a terminal location; the point numbers for all other
point types are “logical” and are simply numbered in sequence.
LNK Ethernet has linked.
LOI Local Operator Interface (or Local Port). Refers to the serial EIA-232 (RS-232) port on
the ROC through which local communications are established, typically for
configuration software running on a PC.
LPM Lightning Protection Module; a device that provides lightning and power surge
protection for ROCs.
LRC Longitudinal Redundancy Checking error checking.
M
m Meter.
mA Milliamp(s); one thousandth of an ampere.
MAC Address Media Access Control Address; a hardware address that uniquely identifies each node
of a network.
Manual mode For a ROC, indicates that the I/O scanning has been disabled.
MAU Medium Attachment Unit.
MCU Master Controller Unit.
Meter Factor A number obtained by dividing the actual volume of liquid passed through a flow meter
during a meter proving operation by the volume registered by the flow meter. The
meter factor is used in flow calculations to correct the indicated volume (end flow meter
registration minus start flow meter registration) to the observed gross volume (actual
flow meter throughput at operating conditions).
Meter factor = (Meter prover volume corrected to standard conditions) (Flow meter
indicated volume corrected to std conditions)
Meter Proving A procedure used to determine the meter factor for a flow meter. The K-factor (exact
number of pulses per a volume unit that a flow meter generates) is determined at the
factory. The K-factor is used to derive a mathematical factor, known as meter factor,
which is used to adjust results of the internal flow calculations the DL8000 performs.
Note: The flow meter is not re-calibrated; determining the meter factor allows the
operator to manually re-calibrate the DL8000 so that the flow meter’s
nonadjustable calibration characteristic [pulses per volume unit (K-factor)] are
incorporated into the flow calculations.
Modbus A popular device communications protocol developed by Gould-Modicon.
MPU Micro-Processor Unit.
mm Millimeter.
MMBTU Million British Thermal Units.
msec Millisecond, or 0.001 second.
MVS Multi-Variable Sensor. A device that provides differential pressure, static pressure, and
temperature inputs to a ROC for orifice flow calculations.
mV Millivolts, or 0.001 volt.
mW Milliwatts, or 0.001 watt.
N
NEC National Electrical Code.
NEMA National Electrical Manufacturer’s Association. See http://www.nema.org.
O
OH Off-Hook modem communications signal.
Off-line Accomplished while the target device is not connected (by a communications link). For
example, “off-line configuration” refers to configuring an electronic file that is later
loaded into a ROC.
P, Q
Parameter A property of a point that typically can be configured or set. For example, the Point Tag
ID is a parameter of an Analog Input point. Parameters are normally edited by using
configuration software running on a PC.
PC Personal Computer.
Permissive A discrete signal from a device that is input to a discrete input in the DL8000. The
DL8000 uses this signal to allow a product delivery to be initiated or allow a product
delivery to continue. Permissive contacts are CLOSED in the normal or safe state and
OPEN in the abnormal or unsafe state.
Pf Flowing pressure.
P/DP Pressure/Differential Pressure.
PI Pulse Input.
PID Proportional, Integral, and Derivative control feedback action.
PIT Periodic Timer Interrupt.
PLC Programmable Logic Controller.
Point Software-oriented term for an I/O channel or some other function, such as a flow
calculation. Points are defined by a collection of parameters.
Point Number The physical location of an I/O point (module slot and channel) as installed in the ROC.
Point Type Defines the database point to be a specific type of point available to the system. The
point type determines the basic functions of a point.
Preset Number value previously determined for a register.
Also:
A generic term that describes the functional instrument group to which the DL8000
belongs. The term originated from mechanical and electrical preset counters. The
DL8000 provides much more versatility and capability compared to a simple
mechanical or electrical preset counter.
PRI Primary PID control loop.
Primary Blend A blended product measured by a primary blend stream meter.
Stream
Component
Primary Blend A meter measuring the gasoline-ethanol blend.
Stream Meter
Protocol A set of standards that enables communication or file transfers between two
computers. Protocol parameters include baud rate, parity, data bits, stop bit, and the
type of duplex.
R
Rack A row of slots on a ROC into which I/O modules can be plugged. Racks are given a
letter to physically identify the location of an I/O channel (such as “A” for the first rack).
Built-in I/O channels are assigned a rack identifier of “A” while diagnostic I/O channels
are considered to be in “E” rack.
RAM Random Access Memory. RAM is used to store history, data, most user programs, and
additional configuration data.
RBX Report-by-exception. RBX always refers to Spontaneous RBX in which the ROC
contacts the host to report an alarm condition.
RR Results Register; stores the Signal Value Analog (SVA).
Recipe A pre-entered delivery/blending/control description that allows the DL8000 to
automatically control the product quantity or total quantity based on percentages of
multiple components during a batch delivery operation. The DL8000 supports up to
thirty recipes.
RFI Radio Frequency Interference.
RI Ring Indicator modem communications signal.
ROC Remote Operations Controller microprocessor-based unit that provides remote
monitoring and control.
ROCLINK 800 Microsoft® Windows®-based software used to configure functionality in ROC units.
ROM Read-only memory. Typically used to store firmware. Flash memory.
Rotary Meter A positive displacement meter used to measure flow rate, also known as a Roots
meter.
RTC Real-Time Clock.
RTD Resistance Temperature Device.
RTS Ready to Send modem communications signal.
RTU Remote Terminal Unit.
RTV Room Temperature Vulcanizing, typically a sealant or caulk such as silicon rubber.
RS-232 Serial Communications Protocol using three or more signal lines, intended for short
distances. Also referred to as the EIA-232 standard.
RS-422 Serial Communications Protocol using four signal lines. Also referred to as the EIA-422
standard.
RS-485 Serial Communications Protocol requiring only two signal lines. Can allow up to 32
devices to be connected together in a daisy-chained fashion. Also referred to as the
EIA-485 standard.
RX or RXD Received Data communications signal.
S
SAMA Scientific Apparatus Maker’s Association.
Script An uncompiled text file (such as keystrokes for a macro) that a program interprets in
order to perform certain functions. Typically, the end user can easily create or edit
scripts to customize the software.
Side Stream The controlled stream, often called the ethanol product. The side stream is metered
and can be controlled and measured.
Side Stream A mix component measured by both a side stream meter and a primary blend stream
Component meter. Ethanol is often referred as a side stream component.
Side Stream A meter that measures the side component (ethanol).
Meter
Smart module A module, typically for the ROC800-Series or FloBoss 107 devices, having an on-
board processor which can execute a program.
Soft Points A type of ROC point with generic parameters that can be configured to hold data as
desired by the user.
SP Setpoint, or Static Pressure.
SPI Slow Pulse Input.
SPK Speaker.
SRAM Static Random Access Memory. Stores data as long as power is applied; typically
backed up by a lithium battery or supercapacitor.
SRBX Spontaneous Report-By-Exception. SRBX always refers to Spontaneous RBX in which
the ROC contacts the host to report an alarm condition.
Standard The gross quantity corrected to standard temperature and/or pressure. This is a
Quantity quantity measurement. Calculation: standard quantity = gross quantity times CTLM
(correction factor for the effect of temperature on the liquid in the meter) times CPLM
(correction factor for the effect of pressure on the liquid in the meter)
SVA Signal Value Analog. Stored in the Results Register, it is the analog value that is
passed between functions in an FST.
SVD Signal Value Discrete. Stored in the Compare Flag, it is the discrete value that is
passed down the sequence of functions in an FST.
System Configured parameters that describe the ROC; set using ROCLINK software.
Variables
T
T/C Thermocouple Input.
TCP/IP Transmission Control Protocol/Internet Protocol.
TDI Time Duration Input.
TDO Time Duration Output.
Tf Flowing temperature.
TLP Type (of point), Logical (or point) number, and Parameter number.
Transaction Group of one or more consecutive batch deliveries for accounting purposes. The
batches that comprise a transaction always use one recipe, one additive selection, and
one loading side. An example of a transaction is the delivery of multiple batches to
different compartments in a single tanker vehicle.
Turbine meter A device used to measure flow rate and other parameters.
TX or TXD Transmitted Data communications signal.
U
Upload Send data, a file, or a program from the ROC to a PC or other host.
V-Z
V Volts.
Volume The actual space occupied by the product measured, indicated in one of the following
actual units: cubic meters, liters, barrels, gallons.
Wild Stream Wild stream is the uncontrolled stream, often referring to the gasoline product. This is
because the gasoline product cannot be exclusively metered, controlled, or measured.
Wild Stream A product component measured as part of (Primary Blend Stream Component – Side
Component Stream Component) a primary blend stream component by a primary blend stream
meter is called a wild stream component. Gasoline is referred as wild stream
component.
You can add fields to monitor flow, I/O points, and other TLPs. Select
View > Display > New. A blank Display Editor screen displays.
Display
Editor
toolbar
By adding objects (tabs, fields, labels, text, etc.) to the display, you can
incorporate “live” data as well as images and other information you
wish to convey. One use of custom displays is to graphically represent
the application that a ROC monitors and controls. Another use is to
monitor the ROC, giving you to opportunity to change commonly used
parameters from a single screen.
Each custom display has parameters specific to the entire display that
you are creating. By default, the system places the Display object
properties box at the upper right of the screen in a pop-up window. A
similar object properties box displays for each object you add to the
display.
You can avoid this issue by creating a custom display with a single
iteration that includes the fields for all logicals on a single screen. By
manually assigning the TLP values for each field, the system writes all
values to the correct logicals.
Drag and drop the object buttons from the toolbar to the Display Editor
screen and set the associated parameters. Each option has parameters
associated with it depending on the type of option you have selected and
you can customize the parameters in the object properties box.
Note: Custom displays developed with ROCLINK for Windows are
not compatible with ROCLINK 800 Configuration software.
Sections B.1 and B.2 discuss the process of creating a new custom
display and of adding and arranging objects on that display.
Note: You can also click the New Display button (at the extreme
left of the Display Editor toolbar) to create a new display.
Field Description
Point Type(s) Sets, if you enable the Logical Point List option, the
point type(s) whose logicals track the iteration of the
display. Click … (which appears when you click the
field) to display the Select Point Type(s) screen. Use
that screen to associate one or more point types
with this Logical Point List.
Picture Identifies a graphic used for the background of the
display. Click … (which appears when you click the
field) to display a Select Picture File screen. Use
that screen to associate an image with the display.
Menu Location Allows you to hide, replace, or rename a menu
selection in the ROCLINK 800 menu. This option
applies only to displays physically residing in the
ROC.
Hide Hides a menu selection in the Meter,
View, or ROC menu. Requires the
syntax H:menuname.submenuname
(as in H:Meter.Plate Change).
Replace Replaces a screen in the Meter menu
with the current custom display.
Requires the syntax
R:menuname.submenuname (as in
R:Meter.Setup).
Rename Replaces a menu in the Meter, View, or
ROC menu with the current display
using the indicated name. Requires the
syntax N:menuname.submenuname:
newsubmenuname (as in
N:Meter.Calibration:Coriolis Cal).
Note: Use a comma to hide, replace, or rename
multiple features, as in
N:Meter.Calibration:Coriolis
Cal,N:Meter,Calibration:Central Cal.
Tree Location Currently unavailable.
Update Mode Sets when the system updates data on this screen.
Valid values are Normal (system does not update
the screen content) or AutoScan (system updates
the screen content based on the interval you specify
in the Auto Scan Update Interval field on the
Options screen (Tools > Options). The default
value is Normal.
Note: If you include dynamic content on your
custom display, you may want the system to
refresh that content for the most current
values.
3. Add display content to the custom display. You can either drag an
object from the toolbar and place it on the custom display or place
the cursor on the display where you want the object, right-click, and
select from the pop-up menu. Refer to Section B.2, Adding Custom
Display Objects, for a description of each object and its properties.
▪ Add as many objects to the screen as you need. You can place
objects anywhere on the Display Editor screen. Use a frame with
a label to logically group certain options (such as option buttons
or check boxes) to ensure that others know the use context for
the options.
▪ For each object you enter, complete that object’s Properties box.
Each object’s Properties box has different items, and you can
edit those properties at any time.
▪ Move and re-shape objects within the display as necessary. To
modify an object’s placement or shape:
o Click and drag on the control squares to change the size of
the object.
o Press Shift + arrow keys to change an object’s size. Press
Shift +Alt + arrow keys for smaller changes.
o Press Ctrl + arrow keys to move an object to the desired
position. Press Ctrl + Alt + arrow keys for smaller moves.
o Select the Align Lefts icon to align all selected objects to the
furthest left point in the group.
o Select the Size to Widest icon to change the width of all
selected objects to the width of the widest element.
o Select the Make Vertical Spacing Equal icon to evenly
adjust the vertical spacing between all the selected objects.
o Select the Make Horizontal Spacing Equal icon to evenly
adjust the horizontal spacing between all the selected objects.
o Remove objects by selecting the object and pressing Delete.
4. Click the Test icon to verify that the completed custom display
works correctly.
5. Click the Save Display to File icon to save the completed and tested
custom display. ROCLINK 800 displays use the suffix .DSP (as in
TestScreen.dsp).
Tab Control Adds an eight-tab image, which you can size appropriately and edit to
fewer tabs. You can then drag and drop objects onto each tab.
This object has the following properties:
Property Description
Tabs Sets the number of tabs (up to 8) on the screen.
Click (which displays when you click in the field) to
specify the number of tabs.
Caption 1 through 8 Sets a label or caption for each tab. The size of the
tab increases to accommodate the text.
Allow Data Entry Sets whether the user can edit the object. Click
(which displays when you click in the field) to display
the valid values:
Yes Allows editing. This is the default.
No Does not allow editing.
Expression Editing is permitted based on a Visual
Basic expression. This option opens
an Expression Builder window which
you use to determine the conditions
under which the data entry is allowed.
Refer to Section B.4, Adding an
Expression to an Object.
Visible Indicates whether the object appears in the final
version of the display. Click (which displays when
you click in the field) to display the valid values:
Yes Object is always visible. This is the
default.
No Object is not visible.
Expression Visibility is based on a Visual Basic
expression. This option opens an
Expression Builder window which you
use to determine the conditions under
which the object is visible. Refer to
Section B.4, Adding an Expression to
an Object.
Tab Order Sets the object-to-object order the cursor follows on
the custom display when you press the Tab key.
Note: For greatest efficiency, use the Set Tab-Key
Order option (accessed through the Other
Tools button on the toolbar) to set this
sequence when you have finished defining all
the objects on the custom display.
Frame Adds an organizing frame, which you use to group similar user
selections. Once a frame is in place, drag and drop objects onto the
frame.
This object has the following properties:
Property Description
Caption Sets a label or caption for the object. The default is
Frame(1); the system uniquely names each object
until you rename it.
Allow Data Entry Sets whether the user can edit the object. Click
(which displays when you click in the field) to display
the valid values:
Yes Allows editing. This is the default.
No Does not allow editing.
Expression Editing is allowed based on a Visual
Basic expression. This option opens
an Expression Builder window which
you use to determine the conditions
under which the data entry is allowed.
Refer to Section B.4, Adding an
Expression to an Object.
Visible Indicates whether the object appears in the final
version of the display. Click (which displays when
you click in the field) to display the valid values:
Yes Object is always visible. This is the
default.
No Object is not visible.
Expression Visibility is based on a Visual Basic
expression. This option opens an
Expression Builder window which you
use to determine the conditions under
which the object is visible. Refer to
Section B.4, Adding an Expression to
an Object.
Property Description
Tab Order Sets the object-to-object order the cursor follows on
the custom display when you press the Tab key.
Note: For greatest efficiency, use the Set Tab-Key
Order option (accessed through the Other
Tools button on the toolbar) to set this
sequence when you have finished defining all
the objects on the custom display.
Label Adds labels to identify objects. This object has the following properties:
Property Description
Caption Sets a label or caption for the object. The default is
Label(1); the system uniquely names each object
until you rename it.
Alignment Indicates where the label text displays. Click
(which displays when you click in the field) to display
the valid values: Left (text is flush left), Right (text is
flush right), or Center (text is centered).
Property Description
TLP Associates the object with a TLP. Click … (which
displays when you click in the field) to display a
Select TLP screen you use to define the associated
TLP.
Expression Associates the object with a Visual Basic expression.
Click … (which displays when you click in the field) to
display an Expression Builder window which you use
to define the expression. Refer to Section B.4,
Adding an Expression to an Object.
Property Description
Visible Indicates whether the object appears in the final
version of the display. Click (which displays when
you click in the field) to display the valid values:
Yes Object is always visible. This is the
default.
No Object is not visible.
Expression Visibility is based on a Visual Basic
expression. This option opens an
Expression Builder window which you
use to determine the conditions under
which the object is visible. Refer to
Section B.4, Adding an Expression to
an Object.
Tab Order Sets the object-to-object order the cursor follows on
the custom display when you press the Tab key.
Note: For greatest efficiency, use the Set Tab-Key
Order option (accessed through the Other
Tools button on the toolbar) to set this
sequence when you have finished defining all
the objects on the custom display.
Text Box Adds a data entry field. This object has the following properties:
Property Description
Text Sets text that appears in the object. You can enter as
many characters as necessary. Use the control
squares to change the size of the text box. The
default is TextBox(1); the system uniquely names
each object until you rename it.
Property Description
TLP Associates the object with a TLP. Click … (which
displays when you click in the field) to display a
Select TLP screen you use to define the associated
TLP.
Property Description
Allow Data Entry Sets whether the user can edit the object. Click
(which displays when you click in the field) to display
the valid values:
Yes Allows editing. This is the default.
No Does not allow editing.
Expression Allows editing based on a Visual
Basic expression. This option opens
an Expression Builder window which
you use to determine the conditions
under which the data entry is allowed.
Refer to Section B.4, Adding an
Expression to an Object.
Visible Indicates whether the object appears in the final
version of the display. Click (which displays when
you click in the field) to display the valid values:
Yes Object is always visible. This is the
default.
No Object is not visible.
Expression Visibility is based on a Visual Basic
expression. This option opens an
Expression Builder window which you
use to determine the conditions under
which the object is visible. Refer to
Section B.4, Adding an Expression to
an Object.
Tab Order Sets the object-to-object order the cursor follows on
the custom display when you press the Tab key.
Note: For greatest efficiency, use the Set Tab-Key
Order option (accessed through the Other
Tools button on the toolbar) to set this
sequence when you have finished defining all
the objects on the custom display.
Option Button Adds a radio button to limit input to a single selection. This object has
the following properties:
Property Description
Caption Sets a label or caption for each object. The default is
OptionButton(1); the system uniquely names each
object until you rename it.
TLP Associates the object with a TLP. Click … (which
displays when you click in the field) to display a
Select TLP screen you use to define the associated
TLP.
Mask Value Identifies individual bits of an 8-bit integer ROCLINK
uses when calculating the value to be compared to
the value specified in the Selected When or
Checked When fields. ROCLINK performs a
mathematical AND comparing this masked value and
the value in the Selected When or Checked When
field and activates the button or box if the values are
equal. The default value is 255.
Selected When = Specifies the value at which the option button
activates. Works in conjunction with the value in the
Mask Value field.
Allow Data Entry Sets whether the user can edit the object. Click
(which displays when you click in the field) to display
the valid values:
Yes Allows editing. This is the default.
No Does not allow editing.
Expression Allows editing based on a Visual
Basic expression. This option opens
an Expression Builder window which
you use to determine the conditions
under which the data entry is allowed.
Refer to Section B.4, Adding an
Expression to an Object.
Visible Indicates whether the object appears in the final
version of the display. Click (which displays when
you click in the field) to display the valid values:
Yes Object is always visible. This is the
default.
No Object is not visible.
Expression Visibility is based on a Visual Basic
expression. This option opens an
Expression Builder window which you
use to determine the conditions under
which the object is visible. Refer to
Section B.4, Adding an Expression to
an Object.
Tab Order Sets the object-to-object order the cursor follows on
the custom display when you press the Tab key.
Note: For greatest efficiency, use the Set Tab-Key
Order option (accessed through the Other
Tools button on the toolbar) to set this
sequence when you have finished defining all
the objects on the custom display.
Check Box Adds a check box for multiple selections. This object has the following
properties:
Property Description
Caption Sets a label or caption for the object. The default is
CheckBox(1); the system uniquely names each
object until you rename it.
TLP Associates the object with a TLP. Click … (which
displays when you click in the field) to display a
Select TLP screen you use to define the associated
TLP.
Mask Value Identifies individual bits of an 8-bit integer ROCLINK
uses when calculating the value to be compared to
the value specified in the Selected When or
Checked When fields. ROCLINK performs a
mathematical AND comparing this masked value and
the value in the Selected When or Checked When
field and activates the button or box if the values are
equal. The default value is 255.
Checked When = Specifies the value at which the checkbox activates.
Works in conjunction with the value in the Mask
Value field.
Allow Data Entry Sets whether the user can edit the object. Click
(which displays when you click in the field) to display
the valid values:
Yes Allows editing. This is the default.
No Does not allow editing.
Expression Allows editing based on a Visual
Basic expression. This option opens
an Expression Builder window which
you use to determine the conditions
under which the data entry is allowed.
Refer to Section B.4, Adding an
Expression to an Object.
Property Description
Visible Indicates whether the object appears in the final
version of the display. Click (which displays when
you click in the field) to display the valid values:
Yes Object is always visible. This is the
default.
No Object is not visible.
Expression Visibility is based on a Visual Basic
expression. This option opens an
Expression Builder window which you
use to determine the conditions under
which the object is visible. Refer to
Section B.4, Adding an Expression to
an Object.
Tab Order Sets the object-to-object order the cursor follows on
the custom display when you press the Tab key.
Note: For greatest efficiency, use the Set Tab-Key
Order option (accessed through the Other
Tools button on the toolbar) to set this
sequence when you have finished defining all
the objects on the custom display.
Combo Box Adds a list of options that opens when you click . This object has the
following properties:
Property Description
TLP Associates the object with a TLP. Click … (which
displays when you click in the field) to display a
Select TLP screen you use to select the associated
TLP.
Property Description
Item List Enables you to build a drop-down list of up to 30
selectable items. Click … (which displays when you
click in the field) to display an Item List screen:
Property Description
Tab Order Sets the object-to-object order the cursor follows on
the custom display when you press the Tab key.
Note: For greatest efficiency, use the Set Tab-Key
Order option (accessed through the Other
Tools button on the toolbar) to set this
sequence when you have finished defining all
the objects on the custom display.
Line Adds a line to mark borders between objects. This object has the
following properties:
Property Description
Line Width Sets the thickness of the line. The default is 1.
Color Sets the color of the object. Enter a hexadecimal
color value or click in the field to display a Color
screen, which you use to assign a color to the object.
Visible Indicates whether the object appears in the final
version of the display. Click (which displays when
you click in the field) to display the valid values:
Yes Object is always visible. This is the
default.
No Object is not visible.
Expression Visibility is based on a Visual Basic
expression. This option opens an
Expression Builder window which you
use to determine the conditions under
which the object is visible. Refer to
Section B.4, Adding an Expression to
an Object.
Rectangle Adds a rectangle to mark borders between objects. This option has the
following properties:
Property Description
Color Sets the color of the object. Enter a hexadecimal
color value or click in the field to display a Color
screen, which you use to assign a color to the object.
Visible Indicates whether the object appears in the final
version of the display. Click (which displays when
you click in the field) to display the valid values:
Yes Object is always visible. This is the
default.
No Object is not visible.
Expression Visibility is based on a Visual Basic
expression. This option opens an
Expression Builder window which you
use to determine the conditions under
which the object is visible. Refer to
Section B.4, Adding an Expression to
an Object
Oval Adds an oval to mark borders between objects. This object has the
following properties:
Property Description
Color Sets the color of the object. Enter a hexadecimal
color value or click in the field to display a Color
screen, which you use to assign a color to the object.
Property Description
Visible Indicates whether the object appears in the final
version of the display. Click (which displays when
you click in the field) to display the valid values:
Yes Object is always visible. This is the
default.
No Object is not visible.
Expression Visibility is based on a Visual Basic
expression. This option opens an
Expression Builder window which you
use to determine the conditions under
which the object is visible. Refer to
Section B.4, Adding an Expression to
an Object.
Image Adds an image (.JPG, .BMP, .PNG, .GIF, or other graphic formats)
from a file. This object has the following properties:
Property Description
Picture Sets an image (.JPG, .BMP, .GIF, or other graphic
formats) to display with the object. Click in the field to
display a Select Picture File screen which you use to
indicate the appropriate image. The default is None.
Visible Indicates whether the object appears in the final
version of the display. Click (which displays when
you click in the field) to display the valid values:
Yes Object is always visible. This is the
default.
No Object is not visible.
Expression Visibility is based on a Visual Basic
expression. This option opens an
Expression Builder window which you
use to determine the conditions under
which the object is visible. Refer to
Section B.4, Adding an Expression to
an Object.
Property Description
Header Sets a title for the object.
TLP 1 through 4 Associates up to four TLPs with the chart. Click …
(which displays when you click in the field) to display
a Select TLP screen you use to define the TLPs.
Button Adds a button to the screen. This object has the following properties:
Property Description
Caption Sets a label or caption for the object. The default is
Button(1); the system uniquely names each object
until you rename it.
Action Associates an activity with the button. Write Value is
the only action currently associated with this control.
The system writes the value identified in the Value
property
TLP Associates the object with a TLP. Click … (which
displays when you click in the field) to display a
Select TLP screen you use to define the TLP.
Property Description
Value Opens an Expression Builder window which you use
to determine the conditions under which the object is
visible. Refer to Section 5.6.4, Adding an Expression
to an Object.
Enabled Indicates whether the button is active. Valid values
are:
Yes Object is always active. This is the
default.
No Object is not active.
Expression Selection is based on a Visual Basic
expression. This option opens an
Expression Builder window which you
use to determine the conditions under
which the object is visible. Refer to
Section B.4, Adding an Expression to
an Object.
Visible Indicates whether the object appears in the final
version of the display. Click (which displays when
you click in the field) to display the valid values:
Yes Object is always visible. This is the
default.
No Object is not visible.
Expression Visibility is based on a Visual Basic
expression. This option opens an
Expression Builder window which you
use to determine the conditions under
which the object is visible. Refer to
Section B.4, Adding an Expression to
an Object.
Tab Order Sets the object-to-object order the cursor follows on
the custom display when you press the Tab key.
Note: For greatest efficiency, use the Set Tab-Key
Order option (accessed through the Other
Tools button on the toolbar) to set this
sequence when you have finished defining all
the objects on the custom display.
Open Display File Opens an existing custom display file. Click this button to display an
Open screen that shows all available .DSP files in the default
ROCLINK 800 directory. If you store .DSP files elsewhere, use this
screen to navigate to that location and select a file.
Save Display to File Saves the current display. Click this button to display a Save As screen
that shows the .DSP files in the default ROCLINK 800 directory. If you
store .DSP files elsewhere, use this screen to navigate to that location
and save the display file.
Test Closes edit mode for the custom display and shows the custom display
as defined. If any errors exist, the system displays appropriate error
messages.
Align Lefts Aligns selected objects to the left. Click to display a drop-down
menu that provides more specific alignment options:
Size to Widest Adjusts the size of the selected objects to the width of the widest object.
Click to display a drop-down menu that provides more specific sizing
options:
Make Vertical Spacing Equalizes the vertical spacing between the selected objects. Click to
Equal display a drop-down menu that provides more specific spacing options:
Make Horizontal Equalizes the horizontal spacing between the selected objects. Click
Spacing Equal to display a drop-down menu that provides more specific spacing
options:
Option Description
Set Tab-Key Order Allows you to specify the object-to-object sequence
for the cursor on the custom display when you press
Tab. When you click this option, the system displays
a message:
Option Description
Import Display Allows you to import another custom display into the
Objects current custom display. Use this to quickly duplicate
custom displays or build similar custom displays.
When you click this option, the system displays an
Import screen that you use to select the .DSP file to
import.
Export Display Allows you to save the current custom display.
Objects When you click this option, the system displays a
Save As screen. Use it to save the .DSP file to the
default (or other) ROCLINK 800 directory.
Lock Controls Restricts the movement of objects on the custom display. This control is
helpful when you want to make minor changes to the custom display
without accidentally modifying the location of objects.
To add an expression:
1. Click an object’s property that includes Expression as an option.
2. Click and select Expression.
3. Click … (which displays as part of the Expression option). The
Expression Builder screen displays:
Uncheck the Read-only Attributes box and click Apply. You can now
edit the .DSP file.
Index
FSTs ............................................................. 6-14
Numerical Group .............................................................. 2-5
History Points ............................................... 6-14
800 .................................................................... 4-13
History, Alarm, and Event Logs ...................... 5-8
Meter Runs ................................................... 6-14
A Meter Runs and AGAs .................................. 6-15
About ROCLINK 800 ........................................ 12-2 Operator ID ................................................... 3-26
Access Levels PID Loops ..................................................... 6-14
Security......................................................... 3-27 ROCLINK 800 Communications ..................... 3-2
Table. Security Access Levels ............ 3-22, 9-27 Samplers....................................................... 6-14
Accumulated Pulses ......................................... 7-37 Security ......................................................... 3-21
Accumulated Value 7-25, 7-30, 7-122, 7-128, 7-134 Stations ......................................................... 6-14
Accumulation .................................................... 8-46 Users ............................................................ 3-26
ACIO Adding Custom Displays ................................... 5-16
AC Frequency............................................. 7-123 Address
Action After Reset or Power Fail ................ 7-122 Address to Use ............................................. 6-14
Alternating Current I/O ............................... 7-118 Comm Ports Store & Forward Tab ............... 3-16
Channel Mode ............................................ 7-118 HART ............................................................ 7-98
Channel Number ............................. 7-117, 7-118 Host Address ................................................ 3-14
Failsafe State.............................................. 7-122 Host Group ................................................... 3-14
Failure Action.............................................. 7-125 IP for ROCLINK 800 Communications ........... 3-5
Fault Reset ................................................. 7-123 Modbus Master Modem .............................. 7-196
Holding Current .......................................... 7-123 MVS Sensor ................................................. 7-69
Inrush Time................................................. 7-123 ROC Information General ............................. 6-10
Output ......................................................... 7-122 ROCLINK 800 Communications ..................... 3-3
Power In ..................................................... 7-118 ROCLINK 800 Communications Host ............ 3-4
Relay Status ............................................... 7-123 ROCLINK 800 Communications ROC ............ 3-3
Tag ............................................................. 7-118 Adjusted A/D 0% ..................... 7-6, 7-51, 7-64, 7-92
Acknowledging Events & Alarms .................... 7-219 Adjusted A/D 100% ................. 7-6, 7-51, 7-64, 7-92
Action After Reset or Power Fail ........... 7-31, 7-122 Adjusted D/A 0% ............................................... 7-20
Active Alarms Adjusted D/A 100% ........................................... 7-20
ACIO ............................7-24, 7-121, 7-127, 7-133 Advanced Pulse Module ................................... 7-99
AI ........................................................... 7-5, 7-70 AGA
AO ................................................................ 7-19 Adding.................................................. 6-14, 6-15
APM ................................................. 7-114, 7-116 Enabling ........................................................ 6-15
DI ....................................................... 7-24, 7-127 History Points ............................................. 7-175
DO .......................................... 7-30, 7-121, 7-133 Meter Setup .................................................... 8-1
HART ............................................................ 7-97 Alarm Logs
I/O .......................................................... 7-5, 7-70 Collect Data .................................................... 6-2
MVS ....................................................... 7-5, 7-70 Viewing ......................................... 5-10, 5-11, 6-2
PI .................................................................. 7-38 Alarm, Event, Weights & Measurements
RTD .............................................................. 7-50 Events Reports ................................................ 5-14
Station ............................................................ 8-6 Alarming
System AI ..................................................... 7-63 PI .................................................................. 7-41
TC ................................................................. 7-44 Alarms
Viewing ........................................................... 6-2 ACIO ........................... 7-24, 7-121, 7-127, 7-133
Active View ....................................................... 11-3 ACIO Alarming . 7-26, 7-125, 7-129, 7-133, 7-138
Actual Scan ............................................ 7-25, 7-128 Active 7-5, 7-24, 7-30, 7-70, 7-121, 7-127, 7-133,
Adding 8-6
AGAs ............................................................ 6-14 AI .................................................. 7-5, 7-15, 7-70
Comm Ports for the ROC ............................... 3-7 AI Alarming ................................................... 7-16
Custom Display ............................................ 5-15 AI HiHi Alarms .............................................. 7-16
Device ............................................................. 2-5 AI LoLo Alarms ............................................. 7-17
EFM Report File ............................................. 5-2 Alarm Log Reports ........................................ 5-14
Expression to a Object ................................. B-22 Alarm Log Viewing .......................................... 5-8
Collect Data ........................................... 5-15, 6-2 1-27. User Account Control Settings ............ 1-25
Viewing ......................................... 5-10, 5-11, 6-2 1-28. Logon .................................................. 1-27
Examples 1-29. ROCLINK 800 Menu ........................... 1-28
APM ............................................................ 7-100 1-30. Device User Interface .......................... 1-30
Calibrating an Input ...................................... 8-32 1-31. ROCLINK 800 Toolbar ........................ 1-31
Execution Delay .............................................. 7-152 1-32. Configuration Tree Menu .................... 1-33
Exit .................................................................... 4-16 1-33. Select TLP ........................................... 1-36
Expand Button .................................................. 1-30 2-1. Device Directory and Device Root .......... 2-1
Expanded I/O Tab 2-2. Configuration Tree .................................. 2-2
Backplane ..................................................... 6-20 2-3. Device Pop-up Menu ............................... 2-3
Board Status ................................................. 6-20 2-4. Communications Parameters .................. 2-3
Boot Version ................................................. 6-16 2-5. Device Root ............................................. 2-4
Firmware Image ........................................... 6-20 2-6. Delete Group ........................................... 2-5
System Mode ............................................... 6-20 2-7. Delete Device .......................................... 2-6
Export File Types .............................................. 4-13 2-8. Delete All Devices ................................... 2-6
Expression ........................................................ B-22 3-1. ROCLINK 800 Communication
Extensions Parameters, General tab .............................. 3-3
.DSP ............................................................. 9-40 3-2. ROCLINK 800 Communication
.RPT ............................................................. 9-41 Parameters, Advanced tab ........................... 3-5
3-3. Comm Port, General tab ....................... 3-10
F 3-4. Comm Port, Modem tab ........................ 3-12
3-5. Comm Port, SRBX tab .......................... 3-14
Factors .............................................................. 8-46
3-6. Comm Port - Store & Forward tab......... 3-15
Fault Reset ..................................................... 7-123
3-7. Comm Port - Diagnostics tab ............... 3-16
Fault Value ........................................................ 7-86
3-8. Successful Logon .................................. 3-19
Figures 3-9. ROCLINK 800 Security ......................... 3-21
B-1. Display Editor .......................................... B-1 3-10. Device Security ................................... 3-26
B-2. Display Editor (blank).............................. B-3
3-11. Device Security – User Table.............. 3-27
B-3. Custom Display Objects ......................... B-6
3-12. Device Security – Groups tab ............. 3-29
B-4. Object Management Tools ................... B-19
3-13. Device Security – Comm Ports tab ..... 3-30
B-5. Expression Builder ................................ B-23
3-14. Device Security – User/Group
B-6. Properties ............................................. B-24 Summary tab .............................................. 3-31
1-1. Pop-Up Menu ...........................................1-4 4-1. File Menu................................................. 4-2
1-2. Search ......................................................1-5
4-2. New File Configuration ............................ 4-4
1-3. User Account Control Settings
4-3. New File Configuration (completed) ........ 4-5
(Windows 10) ...............................................1-6
4-4. Open File Configuration .......................... 4-7
1-4. Search ......................................................1-7
4-5. Configuration Tree Menu ........................ 4-7
1-5. Settings – Results for “uac .......................1-7 4-6. Modifying Configuration File .................... 4-9
1-6. User Account Control Settings .................1-8 4-7. Add New Module ................................... 4-10
1-7. System Configuration ...............................1-9
4-8. Add New Module Success .................... 4-10
1-8. Change UAC Settings ........................... 1-10
4-9. Connection Must Be Closed .................. 4-11
1-9. User Account Control Settings .............. 1-10
4-10. New Module Added ............................. 4-11
1-10. Pop-Up Menu ...................................... 1-12 4-11. Download Configuration-Base
1-11, Search ................................................. 1-13 Firmware Tab ............................................. 4-12
1-12. Home Location .................................... 1-14
4-12. Download Configuration-User Defined
1-13. Search ................................................. 1-15
Points ......................................................... 4-12
1-14. Search Results .................................... 1-15
4-13. Print Configuration .............................. 4-14
1-15. Home Location .................................... 1-16
4-14. Print Preview-Certified Print ................ 4-15
1-16. Control Panel ...................................... 1-17 4-15. Recent Files ........................................ 4-16
1-17. Clock, Language, and Region ............. 1-17 5-1. View Menu Options ................................. 5-1
1-18. Region and Language ......................... 1-18
5-2. View EFM Report .................................... 5-3
1-19. Pop-Up Menu ...................................... 1-19
5-3. Select Custom Report ............................. 5-3
1-20. Search ................................................. 1-20
5-4. Selected Custom Report File .................. 5-4
1-21. User Account Control Settings ............ 1-21
5-5. Preview of EFM Report ........................... 5-5
1-22. Search ................................................. 1-22 5-6. Sample EFM Report ................................ 5-6
1-23. Setting, Results for “uac” .................... 1-22 5-7. View Calibration Report .......................... 5-7
1-24. User Account Control Settings ............ 1-23
5-8. Calibration Report Print Preview ............. 5-8
1-25. System Configuration .......................... 1-24
5-9. Log View.................................................. 5-9
1-26. Change UAC Settings ......................... 1-25
5-10. Select History to View ......................... 5-10 7-27. Thermocouple – Advanced tab ........... 7-45
5-11. History (from device) ........................... 5-11 7-28. Thermocouple – Alarms tab ................ 7-46
5-12. History (from file) ................................. 5-12 7-29. RTD – General tab .............................. 7-48
5-13. Plotting History .................................... 5-13 7-30. RTD – Advanced tab ........................... 7-50
5-14. Alarm Log ............................................ 5-14 7-31. RTD – RTD Calibration tab ................. 7-52
5-15. Events Log .......................................... 5-15 7-32. RTD Input Calibration .......................... 7-53
5-16. Display Administrator .......................... 5-17 7-33. Verify ................................................... 7-54
5-17. Select Points to Monitor ...................... 5-18 7-34. RTD Input Calibration .......................... 7-55
5-18. I/O Monitor........................................... 5-19 7-35. Set Zero ............................................... 7-56
5-19. Toolbar Selected ................................. 5-20 7-36. Set Span .............................................. 7-57
6-1. ROC Menu .............................................. 6-1 7-37. Set Midpoint 1 ..................................... 7-58
6-2. Collect Device Data ................................. 6-3 7-38. Set Midpoint 2 ..................................... 7-59
6-3. Collective Device Data (initial) ................ 6-5 7-39. RTD – Alarms tab ................................ 7-60
6-4. Collective Device Data (complete) .......... 6-6 7-40. System AI – General tab ..................... 7-62
6-5. Clock; ...................................................... 6-7 7-41. System AI – Advanced tab .................. 7-63
6-6. Daylight Savings Time tab ...................... 6-8 7-42. System AI – Alarms tab ....................... 7-65
6-7. Device Information – General tab ......... 6-10 7-43. Soft Points ........................................... 7-67
6-8. Device Information – Internet tab .......... 6-12 7-44. MVS Sensor – General tab ................. 7-68
6-9. Device Information – Points tab ............ 6-15 7-45. MVS Sensor – Advanced tab .............. 7-71
6-10. Device Information – Points tab .......... 6-16 7-46. MVS Sensor – Calibration tab ............. 7-73
6-11. Device Information – System 7-47. Verify ................................................... 7-75
Configuration tab ........................................ 6-17 7-48. Input Freeze ........................................ 7-78
6-12. Device Information – Keypad 7-49. Set Zero Calibration ............................ 7-79
Display tab .................................................. 6-18 7-50. Set Span Calibration ........................... 7-80
6-13. Device Information – Expanded 7-51. Set Mid Points ..................................... 7-80
I/O tab ......................................................... 6-20 7-52. Set Zero Shift (Offset) ......................... 7-82
6-14. Device Information – Module 7-53. Set Zero Shift (Offset) ......................... 7-83
Information tab ........................................... 6-21 7-54. Temperature RTD Bias ....................... 7-84
6-15. Device Information – MPU Loading 7-55. MSV Sensor – Alarms tab ................... 7-85
tab .............................................................. 6-23 7-56. HART AI – General tab ....................... 7-88
6-16. Flags – Flags tabs ............................... 6-24 7-57. HART AO – General tab ..................... 7-88
6-17. Flags – Advanced tabs........................ 6-27 7-58. HART – Advanced tab......................... 7-91
7-1. Configure Menu ....................................... 7-1 7-59. HART – Calibration tab ....................... 7-93
7-2. AI – General tab ...................................... 7-4 7-60. HART Input Calibration ....................... 7-94
7-3. AI – Advanced tab ................................... 7-5 7-61. Set Zero ............................................... 7-94
7-4. AI – Calibration tab Menu ........................ 7-7 7-62. Set Span .............................................. 7-95
7-5. AI – AI Calibration tab ............................. 7-9 7-63. HART – Device tab.............................. 7-96
7-6. Verify ..................................................... 7-10 7-64. APM Switches ................................... 7-101
7-7. Verify – Log Entry .................................. 7-11 7-65. APM – Pulse Input tab....................... 7-103
7-8. Set Zero................................................. 7-12 7-66. APM – Pulse Output tab .................... 7-109
7-9. Set Zero (Log) ....................................... 7-13 7-67. APM – Prover Data tab ..................... 7-111
7-10. Set Span (Log) .................................... 7-14 7-68. APM – Alarms tab ............................. 7-114
7-11. Set Midpoint 1 ..................................... 7-15 7-69. APM – EU Data tab ........................... 7-117
7-12. AI – Alarms tab .................................... 7-16 7-70. ACIO (Discrete Output) – General
7-13. AO – General tab ................................ 7-18 tab ............................................................. 7-119
7-14. AO – Advanced tab ............................. 7-20 7-71. ACIO (Discrete Output) – Advanced
7-15. AO – Alarms tab .................................. 7-21 tab ............................................................. 7-122
7-16. DI – General tab .................................. 7-23 7-72. ACIO (Discrete Output) – TDO
7-17. DI – Advanced tab ............................... 7-24 Parameters tab ......................................... 7-123
7-18. DI –Alarms tab .................................... 7-26 7-73. ACIO (Discrete Output) – DO Alarms
7-19. DO – General tab ................................ 7-28 tab ............................................................. 7-125
7-20. DO – Advanced tab ............................. 7-30 7-74. ACIO (Discrete Input) – DI General
7-21. DO- TDO Parameters tab ................... 7-31 tab ............................................................. 7-126
7-22. DO – Alarms tab .................................. 7-34 7-75. ACIO (Discrete Input) – DI Advanced
7-23. PI –General tab ................................... 7-36 tab ............................................................. 7-127
7-24. PI – Advanced tab ............................... 7-39 7-76. ACIO (Discete Input) – DI Alarms
7-25. PI – Alarms tab .................................... 7-41 tab ............................................................. 7-129
7-26. Thermocouple – General tab .............. 7-43 7-77. Virtual DO – General tab ................... 7-131
7-78. Virtual DO – Advanced tab ............... 7-134 8-10. Meter Setup (Orifice) – Advanced tab . 8-18
7-79. Virtual DO – TDO Parameters tab .... 7-135 8-11. Meter Setup (Linear) – Advance tab ... 8-18
7-80. Virtual DO – Alarms tab .................... 7-138 8-12. Meter Setup (Orifice) – Alarms tab ..... 8-21
7-81. Module tab ........................................ 7-140 8-13. Meter Setup (Linear) – Alarms tab ...... 8-21
7-82. Network tab ....................................... 7-141 8-14. Meter Setup (Orifice) – Calibration
7-83. Commission tab ................................ 7-142 Factors tab ................................................. 8-23
7-84. Active Commission button ................ 7-143 8-15. Meter Setup (Linear) – Calibration
7-85. Commissioned Device ...................... 7-144 Factors tab ................................................. 8-23
7-86. Device Replacement Verification 8-16. Meter Setup (Linear) – Mass Meter
Dialog ....................................................... 7-145 Press Effect tab .......................................... 8-25
7-87. Transmitter tab .................................. 7-145 8-17. Meter Calibration (Orifice) ................... 8-26
7-88. Statistics screen ................................ 7-148 8-18. Meter Calibration (Linear) ................... 8-26
7-89. Diagnostics tab.................................. 7-149 8-19. Linear Meter Calibration ...................... 8-28
7-90. FST Registers – General tab ............ 7-150 8-20. Calibration Report File ........................ 8-28
7-91. FST Registers – Advanced tab ......... 7-151 8-21. Linear Meter Calibration – Frozen
7-92. PID – General tab ............................. 7-155 Values ........................................................ 8-29
7-93. PID Loop – Show Trend/Hide 8-22. Verify ................................................... 8-29
Trend ........................................................ 7-158 8-23. Dead Weight/Tester Value .................. 8-30
7-94. PID Loop – Tuning tab ...................... 7-159 8-24. Verify Log Entry ................................... 8-31
7-95. PID Loop – Status tab ....................... 7-162 8-25. Verify Log Entry ................................... 8-32
7-96. Radio Power Control ......................... 7-165 8-26. Linear Meter Calibration ...................... 8-33
7-97. Sampler/Odorizer .............................. 7-168 8-27. Calibration Report File ........................ 8-33
7-98. DS800 – General tab ........................ 7-169 8-28. BLM Report Required Information ...... 8-34
7-99. DS800 – Advanced tab ..................... 7-170 8-29. Calibration – Frozen Values ................ 8-35
7-100. History Segments ............................ 7-171 8-30. Set Zero............................................... 8-35
7-101. History Segment Point 8-31. Dead Weight/Tester Value .................. 8-37
Configuration – General tab ..................... 7-178 8-32. Set Span.............................................. 8-37
7-102. History Point Configuration ............. 7-183 8-33. Set Span.............................................. 8-38
7-103. Gas Meter History Wizard- Create 8-34. Set Span.............................................. 8-39
History Completed .................................... 7-184 8-35. Set Midpoint 1 ..................................... 8-39
7-104. Opcode Table Settings ................... 7-185 8-36. Set Midpoint 2 ..................................... 8-40
7-105. Modbus Configuration – General 8-36. Set Zero Shift ...................................... 8-41
tab ............................................................ 7-188 8-37. Set Zero Shift ...................................... 8-42
7-106. Modbus Configuration – Scales 8-38. AI Calibration Values ........................... 8-42
Values tab ................................................ 7-191 8-39. Set Zero Shift ...................................... 8-43
7-107. Modbus Configuration - Master 8-40. Set Zero Shift ...................................... 8-43
Table tab .................................................. 7-193 8-41 Set RTD Bias........................................ 8-44
7-108. Modbus Configuration – Master 8-42. Meter Values (Orifice ) – Values tab ... 8-45
Modem tab ............................................... 7-196 8-43. Meter Values (Linear ) – Values tab ... 8-45
7-109. Comm Port, General tab ................. 7-197 8-44. Meter Values (Orifice ) – Factors tab .. 8-46
7-110. Modbus Configuration, Registers 8-45. Meter Values (Linear ) – Factors tab .. 8-46
tab ............................................................ 7-198 8-46. Plate Change....................................... 8-47
7-111. Modbus Configuration, Master Table tab 9-1. Utilities Menu ........................................... 9-1
................................................................. 7-199 9-2. Update Firmware ..................................... 9-2
7-112. Modbus Configuration, General tab 7-200 9-3. Update Firmware – CPU Firmware tab ... 9-4
7-113. Modbus Configuration – Register tab ....7- 9-4. Update Firmware Example...................... 9-6
202 9-5. License Key Administrator ...................... 9-7
7-114. Modbus Configuration – History Table tab 9-6. License Key Administrator ...................... 9-8
................................................................. 7-205 9-7. Split Licenses .......................................... 9-8
8-1. Meter Menu ..............................................8-1 9-8. Moved License ........................................ 9-9
8-2. Station Setup – General tab .....................8-3 9-9. Convert EFM File .................................. 9-10
8-3. Station Setup – Gas Quality tab ...............8-7 9-10. Select EFM File ................................... 9-11
8-4. Station Setup – Advanced tab .................8-9 9-11. User Program Administration .............. 9-22
8-5. Station Setup – Alarms tab ................... 8-12 9-12. MPU Loading....................................... 9-24
8-6. Meter Setup (Orifice) – General tab ...... 8-14 9-13. ROCLINK 800 Security ....................... 9-25
8-7. Meter Setup (Linear) – General tab ...... 8-14 9-14. ROCLINK 800 Security ....................... 9-26
8-8. Meter Setup (Orifice) – Inputs tab ......... 8-16 9-15. RTD Input Calibration Values .............. 9-29
8-9. Meter Setup (Linear) – Inputs tab ......... 8-16 9-16. ROCLINK 800 Security ....................... 9-31
9-17. MVS Calibration Values ...................... 9-32 Flags Tab ...................................................... 6-24
9-18. Keypad Display Editor (Blank) ............ 9-34 Flash Write Status ........................................ 6-26
9-19. Keypad Display Editor ......................... 9-37 General Tab .................................................. 6-24
9-20. Custom EFM Report Editor ................. 9-41 Resetting the ROC ....................................... 6-26
9-21. Custom EFM Report (Completed) ...... 9-42 Save Configuration to Flash Memory ........... 6-26
9-22. View EFM Report ................................ 9-43 Warm Start.................................................... 6-25
9-23. View EFM Report ................................ 9-44 Flash
9-24. Custom EFM Report ........................... 9-45 Flash Build Date ........................................... 6-21
9-25. Read File From Device ....................... 9-46 Flash Clear Memory ..................................... 6-26
9-26. Communications Monitor .................... 9-47 Flash Part Number ....................................... 6-21
10-1. Tools Menu ......................................... 10-1 Flash Revision .............................................. 6-21
10-2. Textual TLP Display ............................ 10-1 Flash Write Status ........................................ 6-26
10-3. Numeric TLP Display .......................... 10-2 Save to Memory ........................................... 6-26
10-4. Options ................................................ 10-2 Force End of Day ............................................ 7-174
11-1. Windows Menu .................................... 11-1 FPV Method ........................................................ 8-9
11-2. Cascade .............................................. 11-1 Freeze ............................ 7-8, 7-73, 7-93, 8-27, 8-47
11-3. Tile ....................................................... 11-2 Freeze Values ................................................... 7-52
11-4. Active View .......................................... 11-3 Frequency ............................................ 7-103, 7-106
12-1. Help Menu ........................................... 12-1 PI .................................................................. 7-38
12-2. ROCLINK 800 Software Help.............. 12-1 From Device
12-3. About ROCLINK .................................. 12-2 Viewing Logs ................................................ 5-10
File Menu ............................................................ 4-1 From File
File Type Display .......................................................... B-24
.800 ........................................................ 4-11, 9-3 Viewing Displays .......................................... 5-16
.ANA .................................................... 9-10, 9-12 Viewing Logs ................................................ 5-11
.ARM .................................................... 9-10, 9-14 FST
.CFM .................................................... 9-10, 9-12 Advanced Tab ............................................ 7-151
.DCFG .......................................................... 9-33 Clear ............................................................. 6-25
.ddi .................................................................. 9-6 Cycle Time .................................................. 7-152
.dli ............................................................ 9-3, 9-6 Description .................................................. 7-151
.DSP ............................................................. 9-40 General Tab ................................................ 7-150
.EFM ............................................................... 9-9 Misc #1 to #4 .............................................. 7-152
.EVT ............................................ 9-10, 9-12, 9-14 Msg Data #1 and Msg Data #2 ................... 7-152
.RPT ............................................................. 9-41 Registers.......................................... 7-150, 7-151
.VOL .................................................... 9-10, 9-16 Status.......................................................... 7-151
Filter Steps/Task Cycle ........................................ 7-152
AI Filter ........................................................... 7-6 Tag.............................................................. 7-151
DI Filter .............................................. 7-25, 7-128 Timer #1 through #4 ................................... 7-152
RTD Filter ..................................................... 7-51 Function Codes
System AI Filter ............................................ 7-64 Modbus ....................................................... 7-202
TC Filter ........................................................ 7-46
Firmware G
Firmware Image............................................ 6-20
Firmware Image to Download ........................ 9-3 Gain for PID Tuning ........................................ 7-159
Gas Component .................................................. 8-7
Firmware Version ......................................... 6-19
Gas meter history
Update ............................................................ 9-2
Configuring ........................................ 7-77, 7-175
Update Keypad Display ................................ 9-40
Gas Quality ......................................... 8-7, 8-8, 9-12
Flags
Advanced Tab .............................................. 6-26 Gateway Address .............................................. 6-12
Clear Flash Memory ..................................... 6-26 Glossary .............................................................. A-1
Groups
Clear History Configuration & Data .............. 6-25
Adding............................................................. 2-5
Cold Start...................................................... 6-25
Comm Ports Store & Forward Tab ............... 3-16
Cold Start & Clear Alarms ............................ 6-25
Deleting........................................................... 2-5
Cold Start & Clear All ................................... 6-25
Cold Start & Clear Events ............................ 6-25 Device Security Groups Tab......................... 3-28
Cold Start & Clear FST ................................. 6-25 Device Security Users and Group
Summary Tab ............................................. 3-31
Cold Start & Clear History ............................ 6-25
Group Access ............................................... 9-40
Configuring System Flags ............................ 6-24
Group Name ................................................. 3-28
Group Name for Security.............................. 3-28 High Reading Time ..................... 7-32, 7-124, 7-136
Host Address ................................................ 3-14 HiHi Alarm
Host Group ................................................... 3-14 PI .................................................................. 7-41
Member of Group(s) for Security .................. 3-27 HiHi Alarms ....................................................... 7-16
Modbus History .......................................... 7-208 History
Renaming ........................................................2-7 Clear ............................................................. 6-25
ROC.............................................................. 6-10 Clear History Configuration & Data .............. 6-25
ROCLINK 800 Communications .....................3-3 Collect ROC Data ........................................... 6-2
ROCLINK 800 Communications Host .............3-4 Configuring ................................................. 7-175
Daily, Minute, and Hourly (Periodic) ............... 5-8
H History Index Mode..................................... 7-207
History Table .............................................. 7-205
Halt PID on Reset ........................................... 7-161
Last Daily Value............................... 7-178, 7-182
HART Inputs
Logs ......................................................... 5-8, 6-2
% of Range ................................................... 7-97 Modbus Table ............................................. 7-205
Actual Scan Period ....................................... 7-97 Plot ................................................................. 5-9
Calibration .................................................... 7-93
Plot Report .................................................... 5-12
Channel Version ........................................... 7-89
Print Preview Report....................................... 5-9
Descriptor ..................................................... 7-97
Reports ........................................................... 5-8
Device ID ...................................................... 7-98 Save Report .................................................... 5-9
Devices Tab ................................................. 7-96 Select New ..................................................... 5-9
FV ................................................................. 7-97
Viewing Log ......................................... 5-10, 5-11
FV Fail Safe .................................................. 7-98
History Logs
I/O Type ........................................................ 7-89
Viewing ........................................................... 6-2
ID Number .................................................... 7-97
History Points .................................................. 7-178
Inputs ............................................................ 7-86 Undefining .................................................. 7-184
Low Reading EU .......................................... 7-90 History Segments
Message ....................................................... 7-97
History Basics ............................................. 7-178
Output Values ............................................... 7-91
History Segment Point Configuration
Pass Through ............................................... 7-92
Screen ...................................................... 7-171
Point Number ............................................... 7-89
Minute Entries ............................................. 7-173
Poll Mode ..................................................... 7-96 Number of Points ........................................ 7-173
Response Code ............................................ 7-97 Periodic Entries .......................................... 7-173
Slot Assignment ........................................... 7-98
Periodic Sample Rate ................................. 7-174
Slot Value ..................................................... 7-98
Space Allocated.......................................... 7-173
SV ................................................................. 7-97
Tag ............................................................. 7-172
SV Fail Safe ................................................. 7-97
Total Space Allocated ................................ 7-174
Tag ............................................................... 7-98 Hold Time........................................................ 7-167
TV ................................................................. 7-97 Holding Current ............................................... 7-123
TV Fail Safe .................................................. 7-97
Host Address for ROCLINK 800
Heating Value
Communications ............................................... 3-4
Heating Value Basis ........................................8-8
Host Group for ROCLINK 800
Station .............................................................8-8 Communications ............................................... 3-4
Help Menu ........................................................ 12-1 Hourly History ..................................................... 5-8
Help Topics ....................................................... 12-1
HTML ................................................................ 4-13
Hide Button ....................................................... 1-30
Hierarchy Menu Tree ........................ 1-33, 4-7, 9-37
I
High Alarm
PI .................................................................. 7-41 I/O
High Alarms ACIO ........................................................... 7-118
AI ......................................................... 7-16, 7-86 AI .................................................................... 7-2
MVS .............................................................. 7-86 AO................................................................. 7-17
RTD .............................................................. 7-60 APM .............................................................. 7-99
Station .......................................................... 8-12 Automatic Mode.............................................. 7-5
System AI ..................................................... 7-65 Configuration .................................................. 7-2
TC ................................................................. 7-47 DI .................................................................. 7-21
High DP Setpoint .............................................. 8-17 DO ................................................................ 7-26
High Reading EU ............................. 7-5, 7-19, 7-32, Enabling Scanning................................. 6-27, 7-5
7-49, 7-62, 7-90, 7-124, 7-136 HART Inputs ................................................. 7-86
APM Alarm Tab ............................... 7-114, 7-116 Host Address ....................................... 3-14, 7-16
Conversion ................................................... 7-39 Host Group ................................................... 3-14
K-factor ......................................................... 7-39 Meter ............................................................ 8-22
PI – Pulse Input Configuration ..................... 7-35 Mode .................................................... 3-14, 7-16
PI-4 Configuration ...................................... 7-109 MVS .............................................................. 7-86
SRBX .......................................................... 7-115 PI .................................................................. 7-41
Pulse Outputs RBX Alarm Index .......................................... 3-15
APM ............................................................ 7-108 RBX Status ................................................... 3-15
APM Alarms Tab ............................. 7-114, 7-116 RTD .............................................................. 7-60
PO Alarming ............................................... 7-115 Station .......................................................... 8-13
PO Input TLP .............................................. 7-109 System AI ..................................................... 7-65
PO Scan Period .......................................... 7-109 TC ................................................................. 7-47
PO SRBX ................................................... 7-116 Read File from Device ...................................... 9-45
Pulse Security Level (Pair 1 and 2) ................ 7-104 Recent Files ...................................................... 4-16
Pulses for Day Registers
PI .................................................................. 7-37 Daily and Periodic....................................... 7-208
PV Reading Events and Alarms Register ........ 7-218
Primary Dynamic Variable ............................ 7-97 Registers R1 to R10 ................................... 7-151
PV Damping Value ....................................... 7-98 Relay Status.................................................... 7-123
PV Fail Safe ................................................. 7-97 Remove Programs ............................................ 1-26
PV Lower Range Limit.................................. 7-98 Renaming
PV Lower Sensor Limit ................................. 7-98 Group or Device ............................................. 2-7
PV Minimum Span ........................................ 7-98 Replacing a device ......................................... 7-144
PV Range Units ............................................ 7-98 Reports
PV Sensor Serial Number ............................ 7-98 Alarm Log ..................................................... 5-14
PV Upper Range Limit.................................. 7-98 Calibration ...................................................... 5-7
PV Upper Sensor Limit ................................. 7-98 Creating EFM File........................................... 5-2
Custom EFM Report Editor .......................... 9-41
R EFM ................................................................ 5-2
EFM Reports .................................................. 5-2
R1 through R10 .............................................. 7-151
Event Log ..................................................... 5-15
Radio Power Control History Print Preview ...................................... 5-9
Active Zone ................................................ 7-166 History, Alarm, and Event Logs ...................... 5-8
Discrete Output .......................................... 7-167
Plot ............................................................... 5-12
Enabled ...................................................... 7-166
Plot History ..................................................... 5-9
Hold Time ................................................... 7-167
Report Pressure As ...................................... 7-71
Low Battery Deadband ............................... 7-167
Save History ................................................... 5-9
Low Battery Shutoff .................................... 7-167 Select New ..................................................... 5-9
Off Counter ................................................. 7-167 Viewing ........................................................... 5-7
On Counter ................................................. 7-167
Viewing Calibration ......................................... 5-7
Power Timer ............................................... 7-167
Viewing Custom EFM Reports ..................... 9-42
Radio Power Control ....................... 7-164, 7-166
Viewing from a Device .................................. 5-10
Radio Power Control Tag ........................... 7-166 Viewing from a File ....................................... 5-11
Status ......................................................... 7-166 Reset Switch ..................................................... 6-26
Zone ........................................................... 7-166
Resistance Temperature Detector
Rate Alarm ........................................................ 7-17
See RTD Inputs ............................................ 7-48
Rate Alarms
Restore Window Button .................................... 1-30
PI .................................................................. 7-42
Returning the Device to Factory Default
Raw A/D Inputs ........................ 7-6, 7-51, 7-64, 7-92 Settings ........................................................... 6-26
Raw Pulse Counts .......................................... 7-103 RFT ................................................................... 4-13
RBX
ROC
AI .................................................................. 7-16
Address ........................................................ 6-10
AO ................................................................ 7-21
Collect Data .................................................... 6-2
Comm Port Attempts .................................... 3-14
Comm Ports.................................... 3-1, 3-7, 3-15
Comm Ports Alarm Index ............................. 3-15 Configuring Communications Ports ................ 3-7
Comm Ports RBX Tab .................................. 3-13 Device Security............................................. 3-25
Comm Ports Status ...................................... 3-15
Disconnect .................................................... 3-19
DI ....................................................... 7-26, 7-129
Groups .......................................................... 6-10
DO .......................................... 7-34, 7-125, 7-138
W Z
Warm Start ........................................................ 6-25 Zero Shift .......................................................... 8-27
Weights & Measurements Events Reports ....... 5-14 Zoom ................................................................. 5-13
Windows Menu ................................................. 11-1