Professional Documents
Culture Documents
Sam Map413
Sam Map413
Sam Map413
MODBUS MAP
RPC APPLICATION
DATE: 3/1/2004
VERSION: 4.13
Revision History
Revision Date Description
0.01 05/07/01 Created
0.02 05/08/01 Released
0.03 05/23/01 Modified for initial release
0.04 06/05/01 00005-00008 Added to the map for laptop/host calibration support
32520
42165-42166
41433-41434 Corrected Gauge Off Time Register. ( Changed from 1 Register to 2
Registers
32501 Added Well State Numbers
00010 Changed To Reserved ( DST is in Reg 4XXXX )
0.05 07/12/01 42198-42199 Corrected Typographical Error
42200-42201 Corrected Typographical Error
42206-42207 Corrected Typographical Error
31971-31986 Added AGA Status Registers
0.06 07/18/01 42221-42222 Corrected the bit numbers on this register
1.00 07/24/01 00003-00004 Removed recover from loss of programming and clear loss of
programming
00011-00012 Removed logic expression flags
11151-11156 Removed common poll/why alarm data
30039-30040 Corrected analog input raw reading size
30359-30360 Corrected analog ouput raw reading size
31203-31502 Removed alarm log information
31503-31682 Removed common stamp event, last occurrence
31823-31847 Removed logic expression results
32501 Removed downtime high fluid level well state
32574 Removed yesterday's low RPM
32580 Removed yesterday's low power
41444-41781 Removed logic expression configuration
2.00 08/13/01 Changed this document to an Microsoft Excel File Type
30603-31202 Corrected the size of these Event Log and Event Time
2.01 08/14/01 32669-36624 Corrected the header organization for the pump card buffers
2.02 08/14/01 40018-40020 Added the enable/disable register for the analog inputs
10065-10320 Added Analog Input Alarm Section
30433-30452 Changed To Reserved
30573-30602 Changed To Reserved
2.03 08/20/01 32669-34704 Added description of card order in Card Buffers
42496-42499 Reversed the order of the pumpometer and rodometer registers
32605 Changed description to x10 from x100
32606 Changed description to x10 from x100
2.04 08/27/01 42009-42001 Reversed the order of these two registers
42071 Added the constant differential pressure register
42062 Changed the resolution of orifice diameter register
Sam Modbus Map Page 4 of 91
Lufkin Automation
Version 4.12 Revision History
2.05 09/25/01 110 Added Load Valve Check Buffer 1 Command Function
111 Added Load Valve Check Buffer 2 Command Function
32582 Added Record Peak Polished Rod HP
32583 Added Yesterday's Peak Polished Rod HP
38365-38441 HISTORICAL BUFFERS - Register Address of this Section Changed
36665-36724 Added 60 Day Peak Polished Rod HP Buffer
38410 - 38441 Added Auto Downtime Buffer and Timestamp
42518-42519 Added VFD Peak and Min Working Speed
42178 Added Pump Depth
42346 Added Refrence Polished Rod HP Timestamp
42348 Added Reference Polished Rod HP
42349 Added Maximum Allowed Polished Rod HP
45001-47429 Added Valve Check Buffer
2.06 10/04/01 10001 - 10003 Added alarm registers
2.07 10/22/01 43250 Added Fill Base
100 Added Global Off Command Function
110-111 Redefined these definitions
38442-39801 Added Reserved Section
39801-39999 Added Special Application Registers
31603 Changed Event Log Descriptions
10001 - 10064 Added Dynamic and Latched Alarms
10321-10384 Added Digital Status
32501 Removed Counter Balance Check State
32501 Removed Downtime Power On Delay State
32614 Added Description of Pump Fillage
42209 Changed Description
2.08 11/26/01 31823-31847 Added Description for Logic Expression Error Codes
32607 Changed Size of this reserved section
32608-32609 Added Pump Cycle Registers
42190 Added IPA Control Enable/Disable
42191 Added IPA Control Reference
42211 Added HOA Switch Enable/Disable
42212 Added HOA Switch On Digital In
42213 Added HOA Switch Off Digital In
42351 Added Linear Pump Distance Between Sprockets
42154 Changed Description of Load Gain Register
42353 Added Linear Pump Sprocket Radius
42355 Added Linear Pump Malfunction Digital Out Channel
2.09 01/02/02 Campo Boscan Added the Campo Boscan Special Application Registers
32501 Added Main Board Diagnostic State
42276 Added Pumping Unit ID
2.10 02/15/02 42179 Added Generated Position Phase Synch
42213 Changed Description to HOA Auto Digital In
42217-42221 Added Violation Enable/Disable Strucutures for all operation modes
43001-45000 Added Pumping Unit Database Information
2.11 02/18/02 30603 Added Event Numbers 25,26,27
2.12 04/03/02 201 Changed Digital Output start address to 00225
10385-10392 Added Logic Expression Results
32522 Added VFD Run Scaled
43001-45000 Removed Pumping Unit Database Information
Sam Modbus Map Page 5 of 91
Lufkin Automation
Version 4.12 Revision History
2.13 04/09/02 4XXXX Corrected the size of the Analog Output Configuration Section
thus correcting the addressing for the following 4XXXX registers
2.14 04/15/02 41431 Removed day of week ( Not supported )
2.15 04/16/02 42217-42221 Added Descriptions to all violation enable/disable structures
2.16 04/17/02 42276 Change Pumping Unit ID To Counter Balance Phase Angle
4.01 05/22/02 30603 Added Event Numbers 22,23
42219 Added Logic Expression Enable/Disable to Timed Mode
42356 Changed Output Ratio Calcualation
4.02 06/10/02 112-143 Added Coils to load 24 hour analog input historical buffers
144-175 Added Coils to load 60 day analog input historical buffers
30033-30352 Added Current 8 Minute Average to Analog Input Status Structures
30603 Removed Event Numbers 30,31,32,35,39
Added Event Numbers 43,44,45
38442-38801 Added a 180 floating point buffer to be loaded with special coils
38802-38921 Added a 60 floating point buffer to be loaded with special coils
4.03 07/15/02 41233-41424 Added support for the Alarm Registers
41175-41424 Moved Accumulator Config Section to 40983
32669-36624 Added Shutdown Causes to Dynagraph Card Headers
4.04 07/16/02 38005 Corrected Adress in Load Buffer Header
4.05 09/06/02 30453-30602 Added support for Accumulator Status
32669-36624 Changed Card Buffer to Generic Buffer ( See Generic Buffer Desc )
40983-41182 Added support for Accumulator Configuration
4.06 10/09/02 10393-10556 Added Register Alarm Alarm and Alert Section
32629 Added Tubing Movement Register
42170 Added Intrinsic Barrier Support Enable/Disable Register
42358-42495 Added Tubing Movement Configuration
4.07 10/30/02 40983-41182 Corrected the location of reserved registers in Accumulator Config
4.08 02/06/03 00481-00545 Added Support for Modbus Master
10457-10520 Added Digital Dynamic Alarms
10521-10584 Added Digital Latched Alarms
10585-10594 Added Modbus Master Communications Failure Dynamic Alarms
10595-10604 Added Modbus Master Communications Failure Latched Alarms
30453-30602 Added Support for 2 more Accumulators
31203-31502 Added Description for Alarm Log
32017-32142 Added Data Section for Modbus Master
40983-41182 Added Support for 2 more Accumulators
42073 Added Differential Pressure Zero Cutoff
45003-47432 Corrected Register Address Range from Valve Check Buffer
47430-49899 Added Modbus Master Support Registers
4.09 03/11/03 10385-10612 Corrected Coil Address in this range.
4.10 11/06/03 00545-00560 Added Load Alarm Tracking History Coils
00571-00580 Added Load Register Log 1440 Coils
01000-01002 Added Clear Log Coils
10032 Added Active Dynamic Alarm Coil
10064 Added Active Latched Alarm Coil
10603-10644 Added Well State Alarms
31503 Added New Event Counter to Alarm Log
32142-32161 Added Programmable Calculation Results
32342-32389 Added Alarm Tracking Status
32607 Added Accumulated Runtime Minutes Register
Sam Modbus Map Page 6 of 91
Lufkin Automation
Version 4.12 Revision History
00000 Registers
Note: Use Function Code 01 to Read these bits. Code 05/15 to Write these bits
Note: Use Function Code 01 to Read these bits. Code 05/15 to Write these bits
Note: Use Function Code 01 to Read these bits. Code 05/15 to Write these bits
There is a 60 floating point historical buffer for each analog input that holds 60 days of daily average of that
inputs recorded at gauge off time. The forcing of a coil in the range of 144-175 invokes the requested
buffer to be loaded into the register range of 38802-38921.
144 1 Analog Input 1 Load 60 Day Analog Input History
145 1 Analog Input 2 Load 60 Day Analog Input History
146 1 Analog Input 3 Load 60 Day Analog Input History
147 1 Analog Input 4 Load 60 Day Analog Input History
148 1 Analog Input 5 Load 60 Day Analog Input History
149 1 Analog Input 6 Load 60 Day Analog Input History
150 1 Analog Input 7 Load 60 Day Analog Input History
151 1 Analog Input 8 Load 60 Day Analog Input History
152 1 Analog Input 9 Load 60 Day Analog Input History
153 1 Analog Input 10 Load 60 Day Analog Input History
154 1 Analog Input 11 Load 60 Day Analog Input History
155 1 Analog Input 12 Load 60 Day Analog Input History
156 1 Analog Input 13 Load 60 Day Analog Input History
157 1 Analog Input 14 Load 60 Day Analog Input History
158 1 Analog Input 15 Load 60 Day Analog Input History
159 1 Analog Input 16 Load 60 Day Analog Input History
160 1 Analog Input 17 Load 60 Day Analog Input History
161 1 Analog Input 18 Load 60 Day Analog Input History
162 1 Analog Input 19 Load 60 Day Analog Input History
163 1 Analog Input 20 Load 60 Day Analog Input History
164 1 Analog Input 21 Load 60 Day Analog Input History
165 1 Analog Input 22 Load 60 Day Analog Input History
166 1 Analog Input 23 Load 60 Day Analog Input History
167 1 Analog Input 24 Load 60 Day Analog Input History
168 1 Analog Input 25 Load 60 Day Analog Input History
169 1 Analog Input 26 Load 60 Day Analog Input History
170 1 Analog Input 27 Load 60 Day Analog Input History
171 1 Analog Input 28 Load 60 Day Analog Input History
172 1 Analog Input 29 Load 60 Day Analog Input History
173 1 Analog Input 30 Load 60 Day Analog Input History
174 1 Analog Input 31 Load 60 Day Analog Input History
175 1 Analog Input 32 Load 60 Day Analog Input History
Sam Modbus Map Page 11 of 91
Lufkin Automation
Version 4.12 00000 Registers
Buffer Description:
Internally there is a 1440 buffer of floating point values for each accumulator. This buffer contains the last
1440 average rate values calculated at the user defined interval.
Buffer Size:
1440 Double Word values ( x100 ) ( 2880 16-bit registers )
Action:
Forcing a coil in the range of 176-183 will populate the Generic Buffer ( starting at register 32669 ) with the
values from the buffer corresponding to the coil.
Buffer Description:
Internally there is a 60 data point buffer of long values for each accumulator. This buffer contains the daily
total accumulation of an accumulator stored at gauge off time.
Buffer Size:
60 Floating point values ( 120 16-bit registers)
Action:
Forcing a coil in the range of 184-191 loads the corresponding 60 day accumulator buffer into the Generic
Buffer ( starting register of 32669 ).
Note: Use Function Code 01 to Read these bits. Code 05/15 to Write these bits
Reserved 00289-00480
Note: Use Function Code 01 to Read these bits. Code 05/15 to Write these bits
Note: Set these coils to load the alarm tracking history into the generic buffer beginning at 32669. A
description of these buffers is in the Generic Buffer Description of this document.
545 1 Load Alarm Track 1 Hist Load Alarm Track 1 60 Day History
546 1 Load Alarm Track 2 Hist Load Alarm Track 2 60 Day History
547 1 Load Alarm Track 3 Hist Load Alarm Track 3 60 Day History
548 1 Load Alarm Track 4 Hist Load Alarm Track 4 60 Day History
549 1 Load Alarm Track 5 Hist Load Alarm Track 5 60 Day History
550 1 Load Alarm Track 6 Hist Load Alarm Track 6 60 Day History
551 1 Load Alarm Track 7 Hist Load Alarm Track 7 60 Day History
552 1 Load Alarm Track 8 Hist Load Alarm Track 8 60 Day History
553 1 Load Alarm Track 9 Hist Load Alarm Track 9 60 Day History
554 1 Load Alarm Track 10 Hist Load Alarm Track 10 60 Day History
555 1 Load Alarm Track 11 Hist Load Alarm Track 11 60 Day History
556 1 Load Alarm Track 12 Hist Load Alarm Track 12 60 Day History
557 1 Load Alarm Track 13 Hist Load Alarm Track 13 60 Day History
558 1 Load Alarm Track 14 Hist Load Alarm Track 14 60 Day History
559 1 Load Alarm Track 15 Hist Load Alarm Track 15 60 Day History
560 1 Load Alarm Track 16 Hist Load Alarm Track 16 60 Day History
561 10 Reserved Reserved
Reserved 00581-00999
Note: Use Function Code 01 to Read these bits. Code 05 to Write these bits
10000 Registers
Dynamic Alarms 10001-10032
Note: Use Function Code 02 to Read these bits.
30000 Registers
If the Alarm ID is less than 10000, then add 10000 to the Alarm ID and the resulting value corresponds to an
alarm flag in the 1XXXX range.
Example…
If there is Alarm ID of 10001, then this alarm tells us that a Belt Slippage alarm occurred at the corresponding
timestamp.
Likewise if the Alarm ID is 00001, this alarm tells us that a Belt Slippage alarm state was cleared at the time of the
corresponding timestamp.
Note: This section gives the communications stats for 1device. This section is loaded when a coil in the range of 513-522 is
set.
Note: This section holds the latest data from one slave device. This section is loaded when a coil in the range of 513-522 is
set.
The data in the array corresponds to the register addresses in the range of 49850 - 49899. This range is also loaded when a
coil in the range of 513-522 is set. The first register of data ( reg 32017 ) is the value of the register number held in 49850.
20-26 Reserved
54-69 Reserved
NAME DESCRIPTION
Register # Regs F L A
32567 1 Record Peak Load Scaled Peak Load Since Commission
32568 1 Yesterday Peak Load Scaled Yesterday Peak Load. Updated at
Gage Off Time
32569 1 Last Stroke Peak Load Scaled Last Stroke Peak Load.
32570 1 Record Min Load Scaled Min Load Since Commission
32571 1 Yesterday Min Load Scaled Yesterday Min Load. Updated at
32572 1 Last Stroke Min Load Scaled Last Stroke Min Load.
32573 1 Record Low RPM Scaled Low RPM since Commission
32574 1 Reserved Reserved
32575 1 Last Stroke Low RPM Scaled Last Stroke Low RPM.
32576 1 Record Peak Torque Scaled Peak Torque Since Commission
32577 1 Yesterday Peak Torque Scaled Yesterday Peak Torque. Updated at
Gauge Off Time
32578 1 Last Stroke Peak Torque Scaled Last Stroke Peak Torque.
32579 1 Record Low Power (Motor Power ) Scaled Low Power since Commission
32580 1 Reserved Reserved
32581 1 Last Stroke Low Power ( Motor Power ) Scaled Last Stroke Low Power.
32582 1 Record Peak Polished Rod HP ( x10 ) Since Commission
32583 1 Yesterday's Peak Polished Rod HP ( x10 ) Since Gauge Off
32584 19 Reserved Reserved
NAME DESCRIPTION
Register # Regs F L A
32608 1 Yesterday Cycle Counter Number of Pump Cycles Yesterday
32609 1 Current Cycle Counter Number of Pump Cycles since Gauge Off
32610 1 Yesterday Percent Run Yesterday Percent Runtime Updated at
Gauge Off
32611 1 Current Percent Run Percent Runtime Since Gauge Off
NAME DESCRIPTION
Register # Regs F L A
32612 1 NREVS # Of Motor Revolutions Per Stroke
32613 1 Fluid Load
32614 1 Pump Fillage x 100
32615 1 Pump Card Peak Load
32616 1 Pump Card Min Load
32617 1 Net Stroke
32618 1 Gross Stroke
32619 2 X Polished Rod HP
32621 2 X Pump HP
32623 2 X Max Torque Upstroke
32625 2 X Max Torque Downstroke
32627 2 X Pseudo Avg HP
32629 2 X Tubing Movement
32631 38 Reserved
Page 49 of 91
SAM Modbus Map
Lufkin Automation 30000 Registers
Version 4.12
Use coil range 103-109 & 176-191 to load data into this buffer
Register # Regs F L A NAME DESCRIPTION
32669 3696 Generic Buffer
Page 50 of 91
SAM Modbus Map
Lufkin Automation 30000 Registers
Version 4.12
40000 Registers
Analog Inputs Config 40001 - 40640 # Registers 640
Note: Use Function Code 03 to Read this Data. Use Function Code 6/16 to Write this Data
NOTE: Analog input description register describes the physical board and point number of the input. It is formatted as
follows.
Bits
0-7 Reserved
8-11 Board Number
12-16 Point Number
Sam Modbus Map Page 54 of 91
Lufkin Automation
Version 4.12 40000 Registers
NOTE: Analog output description register describes the physical board and point number of the output. It is formatted as
follows.
Bits
0-7 Reserved
8-11 Board Number
12-16 Point Number
Sam Modbus Map Page 55 of 91
Lufkin Automation
Version 4.12 40000 Registers
0 - Disable 1 - Enable
Bit
0 - Monday
1 - Tuesday
2 - Wednesday
3 - Thursday
4 - Friday
5 - Saturday
6 - Sunday
Note: If IPA Control is Enabled and the current IPA is greater than IPA Control Reference Register, then the
controller will automatically invoke a DT/IPA Cutoff State. The controller will remain in the state until the next
Gauge Off Time. At which point in time the controller will restart the pumping unit.
Sam Modbus Map Page 69 of 91
Lufkin Automation
Version 4.12 40000 Registers
0-Disable 1 - Enable
Bit Function
0 - 15 Reserved
16 Peak Load
17 Min Load
18 - 20 Reserved
21 No RPM
22 No Crank
23 Belt Slippage
24 - 31 Reserved
0-Disable 1 - Enable
Bit Function
0 - 15 Reserved
16 Peak Load
17 Min Load
18 Logic Expression
19 Peak Torque
20 Low Motor RPM
21 No RPM
22 No Crank
23 Belt Slippage
24 - 31 Reserved
0-Disable 1 - Enable
Bit Function
0 - 15 Reserved
16 Peak Load
17 Min Load
18 Logic Expression
19 Peak Torque
20 Low Motor RPM
21 No RPM
22 No Crank
23 Belt Slippage
24 Malfunction Setpoint
25 Pumpoff Setpoint
26 Low Fluid Load
27 Pump Fillage Setpoint
28 Peak Power
29 - 31 Reserved
42223 1 Low RPM Limit
42224 1 Consecutive Low RPM Allowed
42225 1 Low RPM Start Delay
42226 1 Peak Load Limit
42227 1 Consecutive Peak Load Allowed
42228 1 Minimum Load Limit
42229 1 Consecutive Min Load Allowed
42230 1 Reserved Reserved
Sam Modbus Map Page 71 of 91
Lufkin Automation
Version 4.12 40000 Registers
Note: Use Function Code 03 to Read this Data. Use Function Code 6/16 to Write this Data
*NOTE: The section below must be loaded before it is read. This can be accomplished with the command functions in the
0XXXX range. (Registers 110 - 111)
Register # Regs F L A NAME DESCRIPTION
45003 30 Valve Check Header Valve Check Header
45033 1200 X Valve Check Load Buffer Valve Check Load Buffer
46233 1200 X Valve Check Position Buffer Valve Check Position Buffer
Note: Load and Position Samples are taken every 200 ms
NOTE: The host can configure the communication parameters for the modbus slave devices by writing to the above
registers.
Once the registers are written, the host system must set the appropriate coil to signal storing of the configuration
data for the desired slave device. This coil range is 481-490.
NOTE: This section of registers is also populated when a Load Modbus Master Data coil is set. It then holds the data
specific to the slave device from which data is requested.
Sam Modbus Map Page 81 of 91
Lufkin Automation
Version 4.12 40000 Registers
NOTE: The host can configure up the reading of up to 125 registers per slave device by writing register addresses to the
above registers. Once the registers are written the host must set the appropriate coil to signal the storing of
configuration data for the desired slave device. The coil range is 497-506
NOTE: This section of registers is also populated when a Load Modbus Master Data coil is set. It then holds the data
specific to the slave device from which data is requested.
NOTE: The host can write up to 25 registers to a slave device. This is accomplished by writing the above registers with
addresses and data. Once the registers are written the host must set the appropriate coil to signal the write to the
desired slave device. This coil range is 529-538
Sam Modbus Map Page 85 of 91
Lufkin Automation
Version 4.12 Campo Boscan
**Note: Card data is in reverse chronological order. Therefore it begins at bottom of stroke and procedes through the
downstroke to the top of stroke then through the upstroke and returns to bottom of stroke.
32669 180 X 60 Day Alarm Tracking Buffer 60 Day Alarm Tracking Buffer
Register Descriptions
None
# Regs F L A NAME DESCRIPTION
1 Category 0
8 Description Structure
Reg # F LA Name Description
8 Reserved Reserved
Analog Input
# Regs F L A NAME DESCRIPTION
1 Category 1
8 Description Structure
Reg # F LA Name Description
1 Analog Input Number Analog Input Number
1 Scaled or Raw 0 - Scaled
1 - Raw
6 Reserved Reserved
Accumulator Input
# Regs F L A NAME DESCRIPTION
1 Category 2
8 Description Structure
Reg # F LA Name Description
1 Accumulator Number Accumulator Number
1 Scaled or Raw 0 - Scaled
1 - Raw
6 Reserved Reserved
AGA Data
# Regs F L A NAME DESCRIPTION
1 Category 5
8 Description Structure
Reg # F LA Name Description
1 AGA Data Value 0 - Flow Rate
1 - Differential Pressure
2 - Static Pressure
3 - Flow Temperature
4 - Supercompressibility
7 Reserved Reserved
Constant Value
# Regs F L A NAME DESCRIPTION
1 Category 6
8 Description Structure
Reg # F LA Name Description
2 X Constant Value Constant Value
6 Reserved Reserved