This driver is an extension driver. It provides additional application-specific functionality to the 'parent' driver with which it is associated. To interact successfully with devices using an extension driver, you need to:
- Install and run both the extension driver and its 'parent' driver (and, if applicable, its 'grandparent' driver)
- Ensure that the extension driver and its 'parent' driver (and, if applicable, its 'grandparent' driver) are licensed
(some extension drivers are licensed separately to their 'parent' driver) - Configure the required database items and settings on the 'parent 'driver (and, if applicable, the 'grandparent' driver)
- Configure the required database items and settings on this extension driver.
- Ensure that the database items (and any database items on which they depend) have valid, saved, configuration and are 'In Service'.
Intended Audience
This guide is primarily intended for engineers who are responsible for configuring Lufkin SAMS items and features in the ClearSCADA database.
The guide also contains information for operators and engineers who use the Lufkin SAMS driver to monitor rod pump activity.
Document Scope
This guide explains the configuration, features and database items that are specific to ClearSCADA’s Lufkin SAMS driver. The driver is an Advanced Modbus extension driver. The driver provides additional functionality to enable ClearSCADA to interface with Lufkin SAM rod pump controllers. The driver enables ClearSCADA to communicate with the controllers using the Modbus protocol with proprietary extensions. Using the driver, ClearSCADA can retrieve and process rod pump stroke and other data associated with monitoring the effectiveness of the rod pumps that are being used to lift liquid out of wells. The uploaded dynacard data can then be displayed as a series of Dynagraphs that users can analyze to determine the effectiveness of the pumps in the well fields.
Prerequisite Reading
This guide contains technical information that is intended for users that are sufficiently familiar with ClearSCADA configuration and operation. Before reading this driver guide, ensure that you are familiar with:
- ClearSCADA configuration practices, procedures, and the configuration of properties that are common to many database items. For more information, see the ClearSCADA Guide to Core Configuration, and the ClearSCADA Guide to Core Point Configuration.
- Driver structure, components, and configuration properties, pick actions, and status attributes that are common to many drivers. For more information, see the ClearSCADA Guide to Drivers.
- Advanced driver configuration order, outstation types, and configuration properties and logging options that are common to many advanced drivers. For more information, see the ClearSCADA Guide to Advanced Drivers.
- The database items and configuration that are specific to this extension driver's 'parent' driver, along with any pick actions, status attributes, and logging options that are specific to that 'parent' driver. (Unless stated otherwise, this extension driver supports the features and options that are supported by its 'parent' driver, in addition to the features and options that are described in this extension driver guide.)
Some sections of this guide are intended for operator-level users. These sections are intended for users that are familiar with the navigational and operational aspects of ClearSCADA. Before reading the operational sections in this guide, ensure that you are familiar with:
- The ClearSCADA user interfaces (ViewX and WebX), the various types of display, their navigation and operation. For more information, see the ClearSCADA Guide to ViewX and WebX Clients.
In order to communicate with Lufkin SAM controllers, ClearSCADA needs to run both the Advanced Modbus driver and the Lufkin SAMS extension driver (see Confirm that the Lufkin SAMS Server Component is Installed).
Use this ClearSCADA Guide to the Lufkin SAMS Driver alongside the ClearSCADA Guide to the Advanced Modbus Driver. As much of the information in the latter guide is assumed knowledge, we recommend that you read the ClearSCADA Guide to the Advanced Modbus Driver before reading this driver guide.
The Lufkin SAMS driver documentation explains how to:
- Confirm that the Lufkin SAMS Server Component is Installed
- Configure Lufkin SAMS Devices in ClearSCADA.
It also explains features that are of interest to operators, such as:
- Lufkin SAMS Specific Alarm and Event Categories
- Actions that are Specific to the Lufkin SAMS Driver.
System administrators and engineers who are investigating unexpected behavior relating to the Lufkin SAMS driver might wish to refer to the following section:
For further information on Lufkin SAM devices, or on analyzing rod pump data, please refer to the documentation provided with the Lufkin SAM controllers and well field equipment.