| Expand | ||||
|---|---|---|---|---|
| ||||
|
Recommended Configuration Steps
These are the objects needed to communicate with a ROC. These objects are linked together:
A Port object. From the Port object create the Connections Settings object and then it will automatically link them together.
The ROC object which will link to the Port object.
And on the same tab, create a Schedule object.
From the ROC object, create each of the following:
If Time Synchronization is needed, create a Time Synchronization object.
Meter objects: A ROC requires a Station Meter object as well as a meter object for each Meter run.
If collecting history, create one or more of the following, depending on the type of history being collected:
Daily Archive object
Event Archive object
Hourly Archive object
These are the objects needed to be able to publish history. These objects ARE NOT linked to the ROC object:
...
Publisher object.
...
| Info |
|---|
See the General Object Configuration guide for assistance configuring the General, Options, Details, and Logging tabs. See the Device Object General Connection/Schedule page for assistance with the Connection tab. |
Device Tab
...
ROC Series
Select from REGFLO, FloBoss™ 100 series & FBx, ROC300 ROCPAC (Default), ROC300 FLASHPAC, ROC407, FloBoss™ 503, FloBoss™ 504, and ROC 800 Series
Industry Canada ROC
Default = Not selected. Select to enable Industry Canada Support.
ROC Unit Address
Default = 1.
Host Unit Address
Default = 1.
ROC Group Address
Default = 2.
Host Group Address
Default = 0.
TLP Format
Use TLP Format (Default). When outputting data and item names are used, the item name will be written in TLP format.
Use String Format. When outputting data and item names are used, the item name will be written in String format.
Max Message Length
Default = 240.
PGAS Output Options
Default: No special mapping for PGAS output. Option1: Map Volume to Index Off and '0' to Index On.
Schedule Reinitialization
Default: Off. Allows you to configure the device to execute the command “Reinitialize” on a scheduled interval. Reinitializing resets items, rebuilds poll messages, and rereads the field device configuration.
Protocol Options
Do not retrieve config after comm fail. For communication efficiency, Meter Configuration data is only collected during specific history collections times. One of those times is the next history collection after a communication outage. This option prevents ACM from re-reading meter characteristics after a communication outage.
Read user opcode data via opcode 10. This option causes ACM to read user opcode points using ROC protocol opcode 10 instead of opcode 180. This can be a more efficient way to read user opcode points, as long most of the requested points are continuous. If there are many gaps between requested user opcode points, then this option may not be desirable, as gaps will cause items to be polled in separate reads. This option is sometimes required to read user opcode data sourced from a user program running the ROC device that cannot be read with opcode 180.
Log EFM Upload Progress. This option turns on detailed logging for history collection.
Do not switch ROC series automatically. ACM will internally change the configured ROC type, to the ROC series returned in the opcode 6 read that is performed the first time ACM communicates with a ROC device. This automatic switch overrides the user selected device type and is intended to give ACM a better chance of accurately collecting and processing EFM data and dealing with the variances between ROC models. This automatic switch has caused issues for AUTOSOL users with FloBoss™ 503 models configured for AGA7 with old firmware (not typically the role of a FloBoss™ 503). This option was added to allow those users to disable the automatic switching behavior.
Upload Alarms on Report-by-Exception. This option causes ACM to upload new alarm records from the device during RBX processing.
Allow mapping of points to run from non-associated segments (ROC Plus). To be supplied.
Disable writes (ROC Opcode 11 & 181). This option forces read only behavior from ACM to the ROC. It prevents any writes including set point changes, configuration changes, etc. from being sent from ACM to the ROC device.
Use Mark West Liquid Setup.
Read K Factor from Point Type 7 Param 21 for FloBoss™100/500 series.
Store unmapped history points with Station Meter.
Store events only with associated meters. This option will take certain ROC configuration events and publish them only to meters associated with the specific run. If there is no specific run in the event, it will continue to be published to all meters.
Exclude NSV and S&W Fields Transaction/Batch Records.
Do not write to E2PROM at the end of GC Write.
Combine data from all segments into the same archive record. This option should be used if advanced mapping is being used and history points from different segments are configured to go to the same meter.
Use indicated volume for mass in liquid mass meters. This option should be used if the user needs indicated volume to be published to mass instead of indicated volume.
Collect history on a ROC with no configured meters (non-RocPlus). This option should be used when the ROC device is running without meters in its configuration. An external map for the historical collection may be required. Not intended for use with ROC800 series.
Device is an FB107 with firmware version 2.0 or higher. This option should be used if collecting history from an FB107 device that has had its firmware updated to version 2.0 or later. The new firmware removed Point Types that are used for meter configuration polling and this option will modify the read requests to use the updated Point Types.
Time Sync Tab
...
Enable Time Synchronization
Default = Disabled. Enable this to configure and allow requests to be made.
Time Synchronization Configuration
Connection Object assigned to this device. Click 
to select or create one. See the Time Synchronization section for more details.
Time Synchronization Interval
Select the desired Time Synchronization Interval relating to the Schedule object assigned on the Connection tab. Time Synchronization checks occur on the frequency of this interval.
Time Synchronization Priority
Low. Queues up with other Low priority items.
Medium (Default). Interrupts Low priority items, and queues up with other Medium priority items.
High. Interrupts Medium and Low priority items, and queues up with other High priority items.
Timezone
Default = UTC-06:00 Central Time (US & Canada).
Archive Collection Tab
...
Collection Priority
Low (Default).Queues up with other Low priority items.
Medium. Interrupts Low priority items, and queues up with other Medium priority items.
High. Interrupts Medium and Low priority items, and queues up with other High priority items.
Collect Archive
Default = Not selected. Select to collect.
For more information on Haul, Gas Lift, and Cycle Transaction Log collection, see Transaction Logs.
Collection Interval
Select the desired Interval relating to the Schedule object assigned on the Connection tab.
| Info |
|---|
NoteIf multiple schedule objects are selected for this device (Primary, Secondary, or Alternate) ensure that each schedule has the same interval numbers configured. |
Archive Limits
Click to select or create an Archive Limits for each archive type. See the Archive Limits section for more details.
Archive Mapping (Optional)
The AUTOSOL ROC protocol driver has an internal archive map for each type of ROC device it supports.
The internal archive maps are based on information obtained from Emerson’s documentation on EFM and AGA Reporting. They contain the details of each point that is expected to be defined in the ROC history configuration and cover the majority of gas and liquid measurement applications.
The Archive Mapping option is intended to be used to supplement the internal archive maps, or for special cases that the internal maps do not cover. It is recommended that you start off using the internal maps and ensure the ROC history configuration is configured to match before building user defined maps. To view the internal archive mappings, click on “view Internal Archive Map Details…” button on the “Archive Collection” tab.
Under the Archive Mapping option, each type of archive can be configured as “Internal”, “External” or “Both”. Choosing “External” will completely override the internal mapping and use only the points defined in the user-assigned map object. Choosing “Both” will use the internal map plus any points that are defined in the user-assigned map object. If any points are found in both the internal map and the user-assigned map object, the point will be handled as configured in the user-assigned map object.
...
An Example
In the example which follows, the eighth meter (AKA LiqMtr6) is oddly configured (in ROCLink) to history segment 6.
...
And if we examine history segment 6 we see four points configured as seen below.
...
Now to upload the proper history for that meter we must make a ROC Mapping Object.
...
The two most important configurable properties in the ROC Mapping object are:
“History Point Base” and “History Point Record Data”.
The “History point Base” is used to define whether the first point is “0” or the first point is “1”. The example above shows ROCLink history configuration, specifically for Segment 6 (called “#6, Segment 6”). The first point (CCF) is listed as point “1”. If “History Point Base” is configured with “0” then in the map it should be referred to as point “0”.
The “History Point Record Data” contains the actual map of points. Access it by clicking the ellipsis (...) next to "(Collection)".
Be sure to click “Tabular Display” to see the map in the spreadsheet-style editor as illustrated below.
...
The first column (RecordId) can be anything you like.
The second column (Map Type) determines if you are mapping by History Point or by TLP.
The third, fourth and fifth columns are the TLP values if you chose TLP for Map Type. Leave zeros if not.
The sixth column is the archive Type (Totalize, Average, etc.) and should match the archive type as defined in the ROCLink history segment configuration.
The seventh column is the History Segment and should match the ROCLink configured history segment for that meter.
The eighth column is the index down the History point list if Map Type is “History Point”, leave zeros if Map Type is TLP.
The ninth column is the EFM field that this data will go into for FlowCal, etc. Click the underlined field to get a selectable list of EFM fields.
The tenth column is the meter being configured.
Meter Runs Tab
...
Meter 1-18/Station Meter
Click to select or create the Meter Object assigned. See the Meter section for more details.
| Info |
|---|
Meter OrderingMeter run assignments in ACM are determined by meter type and position in the run listing above. Orifice meters are to be assigned before any Turbine/Linear meters (ROCPlus 800L). Example: The ROC device has 2 Orifice Meters and 1 Turbine Meter. The resulting assignments would be: Meter 01 = Orifice Meter Meter 02 = Orifice Meter Meter 03 = Turbine Meter If an additional Orifice Meter is configured in the ROC device, the ACM assignments above would be changed to the following: Meter 01 = Orifice Meter Meter 02 = Orifice Meter Meter 03 = New Orifice Meter Meter 04 = Turbine Meter |
V-Cone Tab
...
The V-Cone tab is only used if a configuration has a V-Cone meter associated with one or more orifice meters. In ROCLink, under User Programs V-Cone configuration the V-Cone points are listed.
...
Point Types
...
The number of V-Cone meters should be set to the number of V-Cone points configured in ROCLink. In this example: 12 (see above 2 images).
The AUTOSOL ROC driver will examine each of the V-Cone points looking for an associated Orifice Run. If it finds an associated orifice run, the logical that it finds in the TLP is the index of the meter associated with the V-Cone point. In the example configuration in the figure below, the first orifice meter is associated with the first V-Cone point. As a result, when this meter is published, flow coefficient will be read from this point (61.2:0 in this example), in the published output the meter type will be set to V-Cone and the Calculation Method will be set to V-Cone.
...
History Segments Tab
...
Select the History Segments (or RAM Modules) should be included in the archive collection. All are selected by default.
Store And Forward Tab
...
Enable
Default = Not selected. Select to enable ROC Store and Forward Protocol which is used to communicate with a given ROC through intermediaries. Select to configure the address and group fields.
GC Write Override Tab
The GC Write tab allows users to configure which TLPs are written to upon gas chromatograph write events,
...
Configuring GC Write override is optional. If you do not configure GC Write overrides here, the ROC protocol will default to the following TLPs:
...
Component
...
ROC 800 Gas Meters
...
ROC800 Liquid Meters
...
All other Gas Meters
...
METHANE
...
112.28
...
203.105
...
7.28
...
ETHANE
...
112.29
...
203.106
...
7.29
...
PROPANE
...
112.30
...
203.107
...
7.30
...
IBUTANE
...
112.32
...
203.109
...
7.32
...
NBUTANE
...
112.31
...
203.108
...
7.31
...
IPENTANE
...
112.34
...
203.111
...
7.34
...
NPENTANE
...
112.33
...
203.110
...
7.33
...
NEOPENTANE
...
N/A
...
203.104
...
N/A
...
NHEXANE
...
112.35
...
203.112
...
7.35
...
NHEPTANE
...
112.36
...
203.113
...
7.36
...
NOCTANE
...
112.37
...
203.104
...
7.37
...
NDECANE
...
112.39
...
203.126
...
7.39
...
C6PLUS
...
112.47
...
N/A
...
N/A
...
H2
...
112.45
...
N/A
...
7.42
...
H2O
...
112.41
...
203.128
...
7.26
...
H2S
...
112.40
...
203.120
...
7.25
...
O2
...
112.43
...
203.118
...
7.40
...
CO
...
112.44
...
N/A
...
7.41
...
CO2
...
112.27
...
203.119
...
7.24
...
N2
...
112.26
...
203.117
...
7.23
...
HELIUM
...
112.42
...
203.127
...
7.27
...
ARGON
...
N/A
...
N/A
...
N/A
...
BTU
...
112.22
...
N/A
...
7.6
...
SPECIFICGRAVITY
...
112.23
...
N/A
...
7.5
...
USERDEFINEDSTRING1
...
N/A
...
N/A
...
N/A
...
USERDEFINEDSTRING2
...
N/A
...
N/A
...
N/A
...
USERDEFINEDDOUBLE1
...
N/A
...
201.8
...
N/A
...
USERDEFINEDDOUBLE2
...
N/A
...
N/A
...
N/A
...
USERSTRING
...
N/A
...
N/A
...
N/A
If you do link a Gas Chromatograph object for a specific meter and you wish to override the default TLP that is written to for a specific component, you must be explicit which TLP you would like to write to. In the example below, for the meter in question, when the user or system sends a USERDEFINEDDOUBLE1 value, that value will be written to the soft point 98.3:4. Since all the other component entries in that Gas Chromatograph object example are empty, they will default to the TLP as defined in the table above.
...
Supported Op_Codes
The following specific Host-to-RTU operational codes are supported:
...
Op_Code
...
Description
...
0
...
Get general update of the current state for the physical I/O and applications
...
2
...
Get 240 characters of test data
...
6
...
Get ROC configuration
...
7
...
Get current date and time
...
8
...
Set current date and time
...
10
...
Reads data defined by a configurable Opcode point
...
11
...
Writes data defined by a configurable Opcode point.
...
17
...
Set operator ID (Login)
...
24
...
Store and Forward
...
103
...
Get last power on/off time
...
120
...
Get alarm, event, and historical modules log pointer
...
121
...
Get requested number of alarms from alarm log
...
122
...
Get requested number of events from event log
...
126
...
Get last 60 minutes of data from requested history module
...
128
...
Get data for requested day/month from requested history module
...
130
...
Get requested number of hours of data from requested history module
...
135
...
Get requested number of hours of data from requested history module
...
165
...
Get historical data configuration
...
167
...
Get specified contiguous block of parameters
...
180
...
Get requested parameters
...
181
...
Set requested parameters
...
224
...
Report-by-exception from ROC
...
225
...
Report-by-exception acknowledge from host
...
255
...
Invalid request received by ROC
Physical I/O Addressing
For I/O points such as discrete inputs and outputs, and analog inputs and outputs, a specific point is requested by specifying its “TPL” or Point Type, Parameter, and Physical Location in the I/O module rack.
NOTE: This is more commonly known as “TLP” in the ROC Protocol, but the format used in ACM is “TPL.”
Point Type and Parameter
The Point Type and Parameter can be represented by text, number, or a combination of the two. For example, if you wanted to request the “Filtered EU value (Parameter 14)” of the “ROC Analog Input (Point Type 3),” you could enter the “ROC Analog Input (Point type 3)” as the text “AI” or as the number “3,” and the “Filtered EU value (Parameter 14)” as the text “FILTERED_EU” or as the number “14.” Item names are not case sensitive.
Examples:
...
Tag
...
Description
...
DI.EU_VALUE:0
...
Item name in upper case.
...
di.eu_value:0
...
Item name in lower case.
...
DI.21:0
...
Parameter name replaced with its parameter number.
...
1.EU_VALUE:0
...
Point type name replaced with its point type number.
...
1.21:0
...
Both the point type name and parameter name replaced with their numbers.
NOTE: Most of the point types and parameters can be found in the “Protocol Items” section of this manual, and all of the point types and parameters can be found in the ROC and ROC Plus Protocol Specifications Manuals as provided by the manufacturer.
Physical location numbers in the ROC unit begin at one (1), whereas physical location numbers for the ROC protocol in ACM are zero-based and begin at zero (0). The Physical location can be found when configuring the RTU in ROCLINK, and can be related to the meter run number or can be displayed in ROCLINK as “Point Number”. Point number will be displayed in ROCLINK in one of two ways, but when used with ACM, it will need to be converted into its decimal equivalent. The screenshots and tables below indicate where to find the Point Number and the definition of the conversions.
Point Number in ROCLINK
The Point number can be found on this display in ROCLINK:
...
Converting Point Number to decimal equivalent
...
Use the following syntax to address I/O points by their physical location:
<T.P:L> or <IO Point Type>.<Parameter>:< Physical Location >.
Examples:
Use AI.FILTERED_EU:0, 3.14:0, AI.14:0, or 3.FILTERED_EU:0 to read the Filtered EU parameter from an AI module located in point number A1.Use DI.STATUS:4, 1.2:4 to read the Status parameter from a DI module located in point number A5.
ROC Plus Protocol for ROC800 Series
In this Series the Logical Compatibility Mode (found under ROC -> Information in ROCLink - see screen shot below) can be configured to be 16-Points Per Module or 8-Points Per Module. This will determine which conversion chart will be used.
...
Find the Point Number in ROCLINK
The Point number can be found on this display in ROCLINK:
...
If the Logical Compatibility Mode is set to 8-Points Per Module, use the following conversion chart:
Converting Point Number to Decimal Equivalent: 8-Point Logical
...
If the Logical Compatibility Mode is set to 16-Points Per Module, use the conversion chart below. Note that logical numbers beyond 239 are not available to be polled.
Converting Point Number to Decimal Equivalent: 16-Point Logical
...
Use the following syntax to address I/O points by their physical location:
<T.P:L> or <IO Point Type>.<Parameter>:< Physical Location >.
...
Use AI.FILTER:80, 103.5:80, AI.5:80, or 103.FILTER:80 to read the Filter parameter from an AI module located in point number 5-1.
Use DI.STATUS:119, 101.3:119, DI.3:119, or 101.STATUS:119 to read the Status parameter from a DI module located in point number 7-8.
Physical Locations of modules for ROC 800 series
The following picture shows how modules locations are numbered in the ROC809 (ROC Plus Protocol). This is another way that you can find the physical location numbers.
...
ROC 800 Module Offsets
...
Logical I/O Addressing
I/O Modules can be addressed by their logical order (zero based) beginning with ROC Version 5.5.3.0. Use the following syntax to address I/O points logically:
<IO Point Type>.<Parameter>:L<zero based logical offset>.
Examples:
Use Di.Status:L2 to read the status parameter of the third DI in the ROC.
Use Ai.Filter:L6 to read the filter parameter from the seventh AI in the ROC.
NOTE: Use the RE_INITIALIZE_IO item to control the reading of the IO Modules Configuration. See the definition of this item in the items section of this document for more details.
Bit Access of Data
...
.