DataSite Electronic Flow Meter and Remote Terminal Unit Catalog Numbers 1758-FLO301, 1758-FLO302, 1758RTU201, 1758-RTU202 Software User Manual FRN 1.
Important User Information Solid state equipment has operational characteristics differing from those of electromechanical equipment. Safety Guidelines for the Application, Installation and Maintenance of Solid State Controls (publication SGI-1.1 available from your local Rockwell Automation sales office or online at http://literature.rockwellautomation.com) describes some important differences between solid state equipment and hard-wired electromechanical devices.
Preface Read this preface to familiarize yourself with the rest of the manual. It provides information concerning: • • • • Who Should Use this Manual who should use this manual the purpose of this manual related documentation conventions used in this manual Use this manual if you are responsible for designing, installing, programming, or troubleshooting control systems that use DataSite controllers. You should have a basic understanding of electrical circuitry and familiarity with relay logic.
iv Related publications for DataSite controllers (Continued) Pub. Title Pub. Number Description National Electrical Code - Published by the National Fire Protection Association of Boston, MA. — An article on wire sizes and types for grounding electrical equipment. Allen-Bradley Publication Index SD499 — A complete listing of current documentation, including ordering instructions. Also indicates whether the documents are available on CD-ROM or in multi-languages.
Table of Contents Preface Who Should Use this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Purpose of this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Common Techniques Used in this Manual. . . . . . . . . . . . . . . . . . . . . . Table of Contents DataSite Configuration Settings Utility (DS Settings) 5 iii iii iii iv Chapter 1 Introduction . . .
Table of Contents Open the HART Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . 55 Understand HART Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Insert a HART Scan Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Edit a HART Scan Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Delete a HART Scan Block. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Copy a HART Scan Block. . . . . . . . . . . . . . . . . .
Table of Contents 7 Reset the DNP3 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Test the Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Initialize the File System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Display System Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Clear the Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Allocate Registers . . . . . . .
Table of Contents Configure the Historical Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Configure the Daily Historical Records . . . . . . . . . . . . . . . . . . . . 152 Configure the Hourly Historical Records . . . . . . . . . . . . . . . . . . . 154 Load the Configuration from the PC . . . . . . . . . . . . . . . . . . . . . . 156 Save the Configuration to the PC . . . . . . . . . . . . . . . . . . . . . . . . . 156 Upload the Configuration from the Controller . . . . . . . . .
Table of Contents 9 Insert a Scan Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Delete a Scan Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Copy a Scan Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Paste a Scan Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Paste a Scan Block to Multiple Rows . . . . . . . . . . . . . . . . . . . . . .
Table of Contents Configure the DS DNP3 Database. . . . . . . . . . . . . . . . . . . . . . . . 248 Configure a DS DNP3 Channel . . . . . . . . . . . . . . . . . . . . . . . . . . 252 Download the Configuration file . . . . . . . . . . . . . . . . . . . . . . . . . 256 Upload the Configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 Save the Configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 Operation and Data Validation Example . . . . . . . . .
Table of Contents 11 Command Number 21: Reset Accumulation . . . . . . . . . . . . . . . . 308 Command Number 22: Get Daily History . . . . . . . . . . . . . . . . . . 309 Command Number 23: Get Hourly History . . . . . . . . . . . . . . . . 311 Command Number 24: Read Alarm Logs . . . . . . . . . . . . . . . . . . 313 Command Number 25: Read New Alarm Logs. . . . . . . . . . . . . . 314 Command Number 26: Read Event Logs . . . . . . . . . . . . . . . . . . 315 Command Number 27: Read New Event Logs . . .
Table of Contents Publication 1758-UM002D-EN-P - October 2010
Chapter 1 DataSite Configuration Settings Utility (DS Settings) This chapter provides information on the configuration settings utility, DS Settings. IMPORTANT Introduction Use this tool to configure the 1758-RTU DataSite controllers only. DS Settings is a configuration software for 1758-RTU DataSite controllers.
DataSite Configuration Settings Utility (DS Settings) This function lets you initialize the DataSite controller back to factory defaults. • HART Settings This function lets you configure and send HART commands.
DataSite Configuration Settings Utility (DS Settings) Start DS Settings 15 Follow these steps to start DS Settings. 1. Start Microsoft Windows. 2. Click Start > Programs > Rockwell Software > DataSite Products > DataSite Tools > DS Settings. The DS Settings window appears. The default project file name is Project.
DataSite Configuration Settings Utility (DS Settings) Create a New Project Follow these steps to create a new project. 1. From the File menu, choose New Project. The New Project dialog box appears. 2. Enter the project name, for example, DS_RTU.prj. 3. Click OK. The new project file, DS_RTU.prj in this example, is created in C:\Program Files\Rockwell Automation\DS Settings\DS Settings Project. The file is opened in the project browser.
DataSite Configuration Settings Utility (DS Settings) 17 The Save As dialog box appears. 2. Browse to the location you want to store the project file in and enter the new file name. 3. Click Save. Open a Project Follow these steps to open a project. 1. From the File menu, choose Open. 2. Browse to the location of the project file you want. 3. Select the project file and click the Open button. The DS Settings window appears. Close DS Settings Follow this step to close DS Settings.
DataSite Configuration Settings Utility (DS Settings) Configure PC Communication Settings The DataSite controller can be connected to the PC via the serial port or the Ethernet (TCP/IP) port. Use PC Communication Settings to set up the communication mode and parameters for this connection. Follow these steps to configure PC Communication settings: 1. From the Tools menu, choose PC Communication Settings. The PC Communication Settings dialog box appears. 2.
DataSite Configuration Settings Utility (DS Settings) 19 3. If you have chosen TCP/IP Server, set up the parameters for the TCP/IP connection. Parameters for TCP/IP Communication Parameter Description Default Value Station number Station corresponding to the DataSite controller communication Ethernet port. 1 IP address IP address corresponding to the Ethernet communication port of the DataSite controller. The address is in the format, xxx.xxx.xxx.
DataSite Configuration Settings Utility (DS Settings) 4. If you have chosen a COM port, set up the parameters for the serial port connection. Parameters for Serial Port Communication Parameter Value range Station number 1…247 Baud rate (bps) 2400, 4800, 9600, 14400, 19200, 38400, 56000, 57600 Timeout (1 s) 1…10 Delay time (1 ms) 0…3000 5. To confirm the PC settings and close the window, click OK. To cancel the configuration and close the window, click Cancel.
DataSite Configuration Settings Utility (DS Settings) Configure Controller Communication Settings 21 Use Controller Communication settings to set controller parameters, such as serial port parameters or Ethernet parameters, and low-power settings. Follow this step to open the Controller Communication Settings dialog box. • From the Tools menu, choose Controller Communication Settings. The Controller Communication Settings dialog box appears. The file, Controller Communication Parameter.
DataSite Configuration Settings Utility (DS Settings) Configure Serial Port Settings Follow these steps to configure the serial port. 1. In the Serial Ports Settings box, double-click the row for the serial port you want to configure. The Serial Ports Settings dialog box appears. 2. Set up the parameters of the selected serial port. TIP Publication 1758-UM002D-EN-P - October 2010 You can also select another serial port from the COM pull-down menu, and set up the parameters for that port.
DataSite Configuration Settings Utility (DS Settings) 23 This table shows the options and/or value range available for each parameter.
DataSite Configuration Settings Utility (DS Settings) Master/Slave State The serial port scan block can be configured in the master state to acquire data from the slave serial communication equipment connected in a certain time interval. In the slave state, the DataSite controller can receive commands from the host, generate and return response message. For more information, see the Configuration Example on page 50. TIP Verify the protocol setting.
DataSite Configuration Settings Utility (DS Settings) 25 Configure TCP/IP Settings Follow these steps to configure the Ethernet port. 1. In the TCP/IP Settings box, double-click the row for the TCP/IP port you want to configure. The TCP/IP Settings dialog box appears. 2. Set up the parameters of the selected TCP/IP port. This table shows the value range for each parameters.
DataSite Configuration Settings Utility (DS Settings) 3. To save the settings and close the TCP/IP Settings dialog box, click OK. To close the dialog box without saving the settings, click Cancel. Register IP Settings The subnet mask and default gateway settings allow you to determine the DataSite controllers that you want to establish communication with in the network. This allows you to manage your network more efficiently.
DataSite Configuration Settings Utility (DS Settings) 27 Lower the Power Consumption The options in the Power Enable group allow you to shut the power supply to some parts of the DataSite controller to lower power consumption. Follow these steps to lower power consumption. 1.
DataSite Configuration Settings Utility (DS Settings) Display the Default Settings Follow this step to display default values. • Click Default. The message, "Default settings enabled." appears in the Information box.
DataSite Configuration Settings Utility (DS Settings) 29 Save the Controller Communication Settings Follow this step to save the settings you have made. • Click Save. The controller parameter configuration is saved into the file, Controller Communication Parameter.esy. If the file is saved successfully, the message "Save into file successful" will appear in the Information box.
DataSite Configuration Settings Utility (DS Settings) Load the Controller Communication Settings Follow this step to load the settings. This will load the last saved configuration of the DataSite controller parameters. • Click Load. Alternatively, you may double-click the file, Controller Communication Parameter.esy, from the file pane of the project browser or choose Controller Communication Settings from the Tools menu.
DataSite Configuration Settings Utility (DS Settings) 31 Upload the Controller Communication Settings from the Controller Follow this step to upload (read) the controller parameter settings from the controller. • Click Upload. If the settings are uploaded successfully, the message "Upload from controller successful" will appear in the Information box.
DataSite Configuration Settings Utility (DS Settings) Download the Controller Communication Settings to the Controller Follow these steps to download (write) the controller parameter settings to the controller. 1. Set up system parameters. 2. Click Download. IMPORTANT When connecting via a certain serial port of the controller, see COM2 as shown. 3. Change the baud rate of COM2 to 19200, and then click Download. The message "Download to controller successful" appears. 4. Click Upload.
DataSite Configuration Settings Utility (DS Settings) 33 The message "Unable to upload from controller" appears. This indicates that the COM2 baud rate of the controller has been changed to 19200. 5. Click Exit to close the Controller Communication Settings dialog box. 6. Open the PC Communication Settings dialog box. 7. Change the baud rate of the serial port on the PC to 19200. 8. Click OK. The PC Communication Settings dialog box is closed. 9.
DataSite Configuration Settings Utility (DS Settings) 10. Click Upload to upload the controller communication settings again. The message "Upload from controller successful" appears. You may encounter a similar scenario when you connect to the Ethernet port of the controller and change its setting, such as the IP address. Display the Device Information Follow this step to display the device information of the DataSite controller. • Click Device Info.
DataSite Configuration Settings Utility (DS Settings) Settings 35 For integrated modules such as the DataSite controller, the master ports can directly read/write parameters by accessing the fixed Modbus registers. We need to set scan blocks of US1 and US2 only when we want to access other pieces of equipment connected with the two serial ports (COM1, COM2). Use Scan Settings to match the register addresses of the 1758 controller with those of the serially connected equipment.
DataSite Configuration Settings Utility (DS Settings) Block Type The block type indicates the category of scan block data. Scan block types and their descriptions Name Function US1 block 1758-RTU controller Read-write data of the serial equipment connected with the serial port COM1. US2 block 1758-RTU controller Read-write data of the serial equipment connected with the serial port COM2.
DataSite Configuration Settings Utility (DS Settings) 37 When the address of the master or slave register does not map to the signal, the following error will appear. Scan Time Scan time refers to the read-write time interval of a scan block. You can use the trigger scan function for COM port by programming the function block COM_MSG in DataSite Workbench. The following units of time are available.
DataSite Configuration Settings Utility (DS Settings) The scan time is equal to the value multiplied by the unit selected. For example, if the value entered is "3" and the unit selected is "500 ms", then the scan time is 3 x 500 ms = 1500 ms as shown in the following dialog box. This means that the current scan block will be executed every 1500 ms. Scanning starts when the DataSite controller is powered, and it continues according to the scan time you have set.
DataSite Configuration Settings Utility (DS Settings) 39 Err_Cnt and Err_State These two parameters do not require user configuration. If you set up a scan block successfully, two columns for these parameters will be added in the scan block list automatically. The Err_Cnt value represents the number of times the scan block fails to communicate with the slave device.
DataSite Configuration Settings Utility (DS Settings) Open the Scan Settings Dialog Box Follow these steps to open the Scan Settings dialog box. • From the Tools menu, choose Scan Settings. The Scan Settings dialog box appears. The file, Scan Block Parameter.scn, located in the current project directory, is displayed on the project browser file pane. TIP Publication 1758-UM002D-EN-P - October 2010 You can also double-click the Scan Block Parameter.
DataSite Configuration Settings Utility (DS Settings) 41 Edit a Scan Block Follow these steps to edit a scan block. 1. In the Scan Settings dialog box, double-click the scan block you want to edit. The Edit dialog box appears. 2. Enter the values for the scan block parameters. See the table Scan block parameters and their descriptions on page 35. 3. To save the changes and close the Edit dialog box, click OK. To close the Edit dialog box without saving, click Cancel.
DataSite Configuration Settings Utility (DS Settings) Insert a Scan Block Follow these steps to insert a scan block. 1. In the Scan Settings dialog box, select a scan block. 2. Click Insert. An Invalid scan block is created and inserted above the block you selected in Step 1. 3. Double-click the block to edit it. 4. To save the changes and close the Edit dialog box, click OK. To close the Edit dialog box without saving, click Cancel. Delete a Scan Block Follow these steps to delete a scan block. 1.
DataSite Configuration Settings Utility (DS Settings) 43 Copy a Scan Block Follow these steps to copy a scan block. 1. Select the block you want to copy. 2. Click Copy. The selected scan block is copied. Paste a Scan Block Follow these steps to paste a block. 1. Select the block you want to copy and paste. 2. Click Copy to copy the block.
DataSite Configuration Settings Utility (DS Settings) 3. Select the row you want to paste the copied block to. TIP You can only select an empty row that is right after the selected block, or a row that already contains a block. 4. Click Paste to paste the copied block.
DataSite Configuration Settings Utility (DS Settings) 45 If you are pasting over a row that already contains a block, the following dialog box appears. Click Yes to overwrite the block, or No to cancel the pasting. Paste a Scan Block to Multiple Rows The Multi_Paste function allows you to paste a copied block to multiple rows. Follow these steps to paste a copied block to multiple rows. 1. Select the block you want to copy and paste. 2. Click Copy to copy the block.
DataSite Configuration Settings Utility (DS Settings) 3. Select the first row you want to paste the copied block to. 4. Click Multi_Paste. The Multi_Paste dialog box appears. 5. In the Multi_Paste dialog box: To increment the module ID of the pasted block by 1, select the check box for Address of module increase. To increment the Master Start_register address of the pasted block by 1, select the check box for Address of Master_Reg increase.
DataSite Configuration Settings Utility (DS Settings) 47 In this example, if the following settings are made: the result will be this: If you are pasting over a row that already contains a block, the following dialog box appears: Publication 1758-UM002D-EN-P - October 2010
DataSite Configuration Settings Utility (DS Settings) Use the Shortcut Menu You can also use the shortcut menu for Insert, Delete, Copy and Paste functions. Follow this step to use the shortcut menu. • Right-click the row you want to apply the function to. The shortcut menu appears. Here is an example. Load the Scan Settings This function enables you to load the scan settings from the file buffer. This allows you to verify the configuration while the DataSite controller is offline.
DataSite Configuration Settings Utility (DS Settings) 49 Save the Scan Settings This function saves the scan settings into a file buffer on the PC. Follow this step to save scan settings. • Click Save. The settings are written to the file, Scan Block Parameter.scn and the message, "Save into file successful", appears in the left corner of the status bar. Upload the Scan Settings from the Controller Follow this step to upload (read) scan settings from the DataSite controller.
DataSite Configuration Settings Utility (DS Settings) Configuration Example By configuring a scan block as a US1 or US2 block, we can read from and write to the equipment connected with the DataSite controller. For example, we can take two DataSite controllers connected via RS232 serial communication, with COM1 of one DataSite controller as the master station, and COM1 of the other controller as the slave station.
DataSite Configuration Settings Utility (DS Settings) 51 Step 2: Configure the Controller Communications Settings for the Modbus Slave Station Publication 1758-UM002D-EN-P - October 2010
DataSite Configuration Settings Utility (DS Settings) Publication 1758-UM002D-EN-P - October 2010
DataSite Configuration Settings Utility (DS Settings) 53 Step 3: Configure Scan Settings for the Modbus Master Station Publication 1758-UM002D-EN-P - October 2010
DataSite Configuration Settings Utility (DS Settings) Step 4: Read Master registers to verify communication between Master station and Slave station TIP Publication 1758-UM002D-EN-P - October 2010 00001…00004 are the DO signal registers of the slave DataSite controller, and 00100…00103 are the configured slave registers corresponding to DO signal registers of the slave DataSite controller.
DataSite Configuration Settings Utility (DS Settings) Configure HART Settings 55 Use HART Settings to configure and send HART command messages. TIP Customized function blocks that can be triggered in the user program to provide HART read/write functions are also available. For more information, see the DataSite Customized Function Blocks Reference Manual, 1758-RM001 . Open the HART Settings Dialog Box Follow this step to open the HART Settings dialog box. • From the Tools menu, choose HART Settings.
DataSite Configuration Settings Utility (DS Settings) This table provides a description of the column headers in the HART Settings dialog box. Description of HART block parameters Header Description NO. Serial number of each HART scan block. HART Channel Channel for the HART interface module to send commands to. The effective range is 0…2. •The HART0 channel supports multi-branched HART scan, and the data of up to 13 pieces of HART equipment can be scanned.
DataSite Configuration Settings Utility (DS Settings) 57 Description of HART block parameters (Continued) Header Description Command HART command to be sent to the HART equipment. The effective value of each HART command is as follows: •Read Unique Identifier: 0 •Read Primary Variable:1 •Read P. V. Current And Percent Of Range: 2 •Read Dynamic Variable And P. V.
DataSite Configuration Settings Utility (DS Settings) Here is an example of a HART configuration list: Understand HART Commands Some of the variables read from HART equipment are 32-bit floating-point values. Every floating-point value is stored in two continuous data registers. The higher 16 bits of this value will be stored in the register with a higher address and the lower 16 bits of this value will be stored in the register with a lower address.
DataSite Configuration Settings Utility (DS Settings) 59 Number of registers used in each HART command (Continued) Command Description Number of registers Send register Return register Unit register HART state register 48 Read additional Transmitter Status 0 13 0 2 54 Read Transmitter Variable Information 1 10 2 2 59 Write Number Of Response Preambles 1 0 0 2 If the number of registers is 0 in any command, you do not have to enter a register address.
DataSite Configuration Settings Utility (DS Settings) Description of HART commands (Continued) Unit register +0 = unit HART state register +0 = state 0 +1 = state 1 Command 2 Purpose Read primary variable current and percentage of span Send register Not used Return register +0, 1 = P. V. current mA (float point) +2, 3 = P. V.
DataSite Configuration Settings Utility (DS Settings) 61 Description of HART commands (Continued) Unit register Not used HART state register +0 = state 0 +1 = state 1 Command 33 Purpose Read appointed transmitter variables Send register +0 = variable 0 code, 8-bit unsigned integer +1 = variable 1 code, 8-bit unsigned integer +2 = variable 2 code, 8-bit unsigned integer +3 = variable 3 code, 8-bit unsigned integer Return register +0, 1 = Variable 0 value (float point) +2, 3 = Variable 1 value (f
DataSite Configuration Settings Utility (DS Settings) Description of HART commands (Continued) Send register +0, 1 = Actual fixed Primary Variable current level, units of milliamperes (float point) Return register Not used Unit register Not used HART state register +0 = state 0 +1 = state 1 Command 44 Purpose Write Primary Variable Units Send register +0 = Primary Variable units code, 8-bit unsigned integer Return register Not used Unit register Not used HART state register +0 = stat
DataSite Configuration Settings Utility (DS Settings) 63 Description of HART commands (Continued) Unit register +0 = Transmit variable code, 8-bit unsigned integer +1 = Transmit variable limits units code, 8-bit unsigned integer HART state register +0 = state 0 +1 = state 1 Command 59 Purpose Write Number of Responses Preambles Send register +0 = Number of preambles to be sent with the Response message from the Slave to the Master, 8-bit unsigned integer, between 5 and 20 Return register Not us
DataSite Configuration Settings Utility (DS Settings) The following tables list the definition of the first two bytes of the response code according to the HART protocol.
DataSite Configuration Settings Utility (DS Settings) 65 First byte when bit 7 = 0 (Command Response) (Continued) Bit Description 9 (Continued) •Invalid module type code—Selected module type code is not valid. •Invalid flange type code—Selected flange type code is not valid. •Frequency set point too high—Value entered for the frequency set point is too high. •Density high limit too high—Value entered for the density high limit is too high.
DataSite Configuration Settings Utility (DS Settings) First byte when bit 7 = 0 (Command Response) (Continued) Bit Description 11 This bit can mean any of the following: •Upper range value too high—Upper range value is greater than the upper sensor limit. •Excess correction attempted—Correction attempted is outside of the permissible limits of the field device. •In multidrop mode—When in multidrop mode, this command cannot be performed.
DataSite Configuration Settings Utility (DS Settings) 67 First byte when bit 7 = 0 (Command Response) (Continued) Bit Description 12 (Continued) •D2 too low—Value of the second density data is too low. •Invalid command number. •Invalid density units and calibration point. •Flow rate factor too low. 13 This bit can mean any of the following: •Upper and lower range values out of limits—Upper and lower range values are outside of their limits.
DataSite Configuration Settings Utility (DS Settings) Second byte - when unused Bit Description 7 6 5 All bits 0 (when a communication error is reported in the first byte).
DataSite Configuration Settings Utility (DS Settings) 69 Edit a HART Scan Block Follow these steps to edit a HART scan block. 1. Double-click the block you want to edit. The Edit dialog box appears. The NO. box displays the serial number of the current HART scan block. 2. From the HART Channel pull-down menu, choose a channel for the HART interface module to send commands to. The effective range is 0…2.
DataSite Configuration Settings Utility (DS Settings) Effective values of HART commands (Continued) Effective Value HART Commands Effective Value 35 Write Primary Variable Range Values Only Use in HART TRIG block 38 Reset Configuration Changed Flag 40 Enter/Exit Fixed Primary Variable Current Mode Only Use in HART TRIG block 44 Write Primary Variable Units Only Use in HART TRIG block 48 Read additional Transmitter Status 54 Read Transmitter Variable Information 59 Write Number Of Res
DataSite Configuration Settings Utility (DS Settings) 71 Delete a HART Scan Block Follow these steps to delete a HART scan block. 1. Select the block you want to delete. 2. Click Delete. A dialog box prompting you to confirm the deletion appears. 3. To confirm the deletion, click OK. To cancel the deletion, click Cancel. Copy a HART Scan Block Follow these steps to copy a HART scan block. 1. Select the block you want to copy. 2. Click Copy.
DataSite Configuration Settings Utility (DS Settings) 3. Select the row you want to paste the copied block to. TIP You can only select an empty row that is right after the selected block, or a row that already contains a block. 4. Click Paste to paste the copied block. If you are pasting over a row that already contains a block, the following dialog box appears. Click Yes to overwrite the block, or No to cancel the pasting.
DataSite Configuration Settings Utility (DS Settings) 73 Paste a HART Scan Block to Multiple Rows Use the Multi_Paste function to paste a HART scan block to multiple rows. This function works in the same way as the Multi_Paste function in the Scan Settings dialog box. For details, see Paste a Scan Block to Multiple Rows on page 45. Use the Shortcut Menu You can also use the shortcut menu for Insert, Delete, Copy and Paste functions. Follow this step to use the shortcut menu.
DataSite Configuration Settings Utility (DS Settings) Load the HART Settings This function enables you to load the HART settings previously saved in a file buffer on the PC. This allows you to verify the settings while the DataSite controller is offline. Follow this step to load HART settings from the file. • Click Load. If the settings are loaded successfully, the status bar will display the message, "Load from file successful".
DataSite Configuration Settings Utility (DS Settings) 75 Upload the HART Settings from the Controller Follow this step to upload (read) HART settings from the DataSite controller. The controller needs to be online before you can upload the settings. • Click Upload. Download the HART Settings to the Controller Follow this step to download (write) HART settings to the DataSite controller. The controller needs to be online before you can download the settings. • Click Download.
DataSite Configuration Settings Utility (DS Settings) Configure Event Settings Use Event Settings to configure these four types of RTC interruption events.
DataSite Configuration Settings Utility (DS Settings) 77 Event Examples For an illustration on how the Event Settings dialog box can be used to configure an event, see the following examples. Example for a System Event Set and get a system event that occurs at one-second intervals. 1. In the Event Settings dialog box, select the Second Event check box. Then, click Download. Another method is to use EV_SEC_CFG and EV_RTC_SET to configure the second event. 2.
DataSite Configuration Settings Utility (DS Settings) Example for an Alarm Event Set and get an alarm event at 8:30 a.m. every day. 1. In the Event Settings dialog box, select the Alarm Enable, Hour, Minute, and Second check boxes. Enter the time in the Hour, Minute, and Second boxes, and then click Download. Another method is to use EV_CLK_CFG and EV_RTC_SET to configure the alarm event. 2. Use EV_GET to read the RTC return value and check bit 3 for the alarm event.
DataSite Configuration Settings Utility (DS Settings) 79 Example for a Time Event Set and get an event that occurs at 0 seconds, 0 minutes of every hour. 1. Select the Time Enable check box and click Hour in the Event Settings dialog box. Then, click Download. Another method is to use EV_TIME_CFG and EV_RTC_SET to configure the event. 2. Use EV_GET to read the RTC return value and check bit 1 for the second event. Bit 1 will be set to ‘1’ when the second event occurs.
DataSite Configuration Settings Utility (DS Settings) Configure an Alarm Event Follow these steps to configure an alarm event. 1. Select the Alarm Enable check box. Alarm events are enabled. 2. Select the check box for the date/time attribute you want to set. 3. For each check box you have selected in step 2, enter the date/time value in the corresponding box. The alarm event will be executed based on the frequency you set.
DataSite Configuration Settings Utility (DS Settings) 81 Configure a Time Event Follow these steps to configure a time event. 1. Select the Time Enable check box. Time events are enabled. 2. Select one of the options: Minute, Hour, Midday, Midnight. The option you select determines how frequently the time event routine will be executed. • Minute At 0 seconds of every minute, a corresponding time break task is executed in the application program written by users.
DataSite Configuration Settings Utility (DS Settings) Save the Event Settings Follow this step to save the event settings into the file, Event Parameter.evt, on the PC. • Click Save. If the settings are saved successfully, the message, "Save into file successful" will appear in the status bar of the Event Settings dialog box.
DataSite Configuration Settings Utility (DS Settings) Debug the Controller Programs 83 The Controller Debug function allows you to use test registers and retrieve data from the DataSite controller for online or offline debugging of the user programs you have written for the controller in DataSite Workbench. Note that you can use this function to view a DataSite register value. Only DataSite registers can be monitored.
DataSite Configuration Settings Utility (DS Settings) Toggle between Online and Offline Debugging The Offline/Online button lets you toggle between online and offline debugging for test registers in the DataSite controller. Follow this step to toggle between online and offline debugging modes. • Click Offline/Online.
DataSite Configuration Settings Utility (DS Settings) 85 Set the Scan Time for the Online Debugging Mode When you are debugging in the online mode, register data is refreshed at regular intervals. You may change this interval according to your requirements. Follow these steps to set the scan time. 1. Click Offline to go to the offline mode. TIP This value can only be set when you are in the offline debugging mode. 2. In the scan time box, enter a value for the desired time interval.
DataSite Configuration Settings Utility (DS Settings) Delete a Register Group Follow these steps to delete a group of registers. 1. In the Register Group box, select the group you want to delete. 2. Click Delete Group. You are prompted to confirm the deletion. 3. To confirm the deletion, click OK. To cancel the deletion, click Cancel. Rename a Register Group Follow these steps to rename a register group. 1. In the Register Group box, select the register group you want to rename. 2. Click Rename Group.
DataSite Configuration Settings Utility (DS Settings) 87 The Add Register dialog box appears. 3. In the Start_Addr text box, enter the address for the register. 4. In the Reg_Cnt text box, enter the number of registers you want to add. If you are adding more than one register, the Start_Addr value will be the address for the first register. Subsequent registers will have consecutive addresses. 5.
DataSite Configuration Settings Utility (DS Settings) Edit a Register Follow these steps to edit a register. 1. In the Register Group box, select the group which contains the register you want to edit. 2. Select the register and click Edit Register. Alternatively, you can double-click the register you want to edit. The Edit dialog box appears. 3. In the Value text box, enter the new value for the register. 4. From the Type pull-down menu, select the corresponding data type for the register address. 5.
DataSite Configuration Settings Utility (DS Settings) 89 Read the Controller-Run Parameters Operational parameters for the DataSite controller include Battery Voltage, Controller Temperature, System Status, and System Clock. Follow this step to read these parameters from the controller. 1. Click Read. 2. To read these parameters continuously, select the Read Continue check box. These parameters can be read by the application programs written using DataSite Workbench.
DataSite Configuration Settings Utility (DS Settings) All the states of controller are showed by a 16-bit code. For details, see the following tables. Error codes Error Code Meaning 0x0001 Hardware register error 0x0002 Data FLASH error 0x0100 HART communication error 0x0200 US1 communication error 0x0400 US2 communication error If more than one error occurs, an "OR" operation will be performed on the codes.
DataSite Configuration Settings Utility (DS Settings) 91 Adjust the System Time There are two ways of adjusting the system time of the DataSite controller. If you want to synchronize the controller time with the system time of the host computer to the DataSite controller, do the following. • In the Debug dialog box, click Adjust Time. The controller time will be synchronized with the PC Time.
DataSite Configuration Settings Utility (DS Settings) Initialize the Controller Use the Controller Initialize function to initialize the DataSite controller. Open the Controller Initialize Dialog Box Follow this step to open the Controller Initialize dialog box. • From the Tools menu, choose Controller Initialize. The Controller Initialize dialog box appears. Switch Controller into Service Mode To initialize the controller, you must set the controller into the Service mode first.
DataSite Configuration Settings Utility (DS Settings) 93 3. From the Tools menu, choose Controller Initialize. 4. Select the Connect Controller check box. 5. Power up the DataSite controller. 6. When "US Download!" appears in the Infomation box, clear the Connect Controller check box. The DataSite controller has successfully gone into the Service mode.
DataSite Configuration Settings Utility (DS Settings) Initialize DataSite Workbench Follow these steps to clear DataSite Workbench in the DataSite controller. 1. Set the controller into the Service mode. 2. Select the DS Workbench Initialization check box. 3. Click Set. All settings will be downloaded into the controller. 4. Click Run, and exit the local connection.
DataSite Configuration Settings Utility (DS Settings) 95 See Display the Default Settings on page 28 for the default values of the controller communication parameters. Reset the Register Values Follow these steps to reset the register values in the controller to 0. 1. Set the controller into the Service mode. 2. Select the Register Initialize check box. 3. Click Set. All settings will be downloaded into the controller. 4. Click Run, and exit the local connection.
DataSite Configuration Settings Utility (DS Settings) All settings will be downloaded into the controller. 4. Click Run, and exit the local connection. Test the Communication Follow these steps to obtain the communication settings of the DataSite controller, such as baud rate of the serial port, and the IP address of the Ethernet port. 1. Set the controller into the Service mode. 2. Select the Communication Test check box. 3. Click Set. All settings will be downloaded into the controller.
DataSite Configuration Settings Utility (DS Settings) 97 4. Click Run followed by Close. Here the communication parameters of COM2 are set to be test parameters. See this table. COM2 communication test parameters Parameter name Parameter value Station 1 Protocol Modbus RTU Master/Slave state Slave Duplex Full Baud rate (bps) 57600 Parity None Data bits 8 Stop bits 1 Port type RS232 Timeout (10 ms) 100 Delay time (10 ms) 0 5.
DataSite Configuration Settings Utility (DS Settings) 6. From the Tools menu, choose Controller Communication Settings. When the upload is successfully completed, the communication settings of controller are displayed. 7. To exit the Communication Test state, power down the DataSite controller and then power it up again.
DataSite Configuration Settings Utility (DS Settings) 99 Initialize the File System The File System Initialization option lets you do the following: • Clear all the parameter settings made in DS Settings, for example, Scan block, HART scan block and PID block settings. • Clear DNP3 settings • Clear registers This is equivalent to selecting the following check boxes: • Register Initialization • DNP3 Initialization • DS Workbench inititialization Follow these steps to initialize the file system. 1.
DataSite Configuration Settings Utility (DS Settings) Status messages corresponding to the file initialization appear in the Information box. 4. Click Run, and exit the local connection.
DataSite Configuration Settings Utility (DS Settings) 101 Display System Information Follow these steps to display the basic factory information on the DataSite controller. 1. Set the controller into the Service mode. 2. Click Sys Info. Basic factory information on the DataSite controller appears in the Information box. This table provides a description of the system information that is displayed. System information Information Item Description Sn Unique serial number of the DataSite controller.
DataSite Configuration Settings Utility (DS Settings) System information Information Item Description H_Information Hardware information of the DataSite controller. This includes the I/O channels (AI, AO, DI, DO, and PI), and communication interfaces such as RS232, RS485, and Ethernet. The hardware version number is represented by "HRN". P_Information Firmware version, such as FRN 1.10. 3. Click Run, and exit the local connection.
DataSite Configuration Settings Utility (DS Settings) Allocate Registers 103 Module internal registers are divided into four types: • • • • Coil_Register State_Register Input_Register Hold_Register Coil_Register and State_Register are single-bit registers. Every register address corresponds to a binary bit. Input_Register and Hold_Register are 16-bit registers.
DataSite Configuration Settings Utility (DS Settings) Modbus Register for Signals This table lists the Modbus registers and their data types, Modbus addresses and attributes.
DataSite Configuration Settings Utility (DS Settings) 105 Value in Registers State The values in the DI, DO, AI, AO, and PI registers are not saved when the DataSite controller powers down. When the DataSite controller powers up, the DI, AI, and PI registers will receive actual values from the input signals, DI, AI, and PI but the values in the DO, AO, and PI registers will be cleared to zero.
DataSite Configuration Settings Utility (DS Settings) Publication 1758-UM002D-EN-P - October 2010
Chapter 2 DataSite Flow Configuration Utility (DS FloConfig) This chapter provides information on the configuration settings utility, DS FloConfig. IMPORTANT Introduction Use this tool to configure the 1758-FLO DataSite controllers only. DS FloConfig is a configuration software for 1758-FLO DataSite controllers. You can edit and modify parameters for the flow computer, such as AGA3/AGA7 algorithm selection, AGA3/AGA7 process parameters, and AGA8 parameters.
DataSite Flow Configuration Utility (DS FloConfig) Start DS FloConfig Follow these steps to start DS FloConfig. 1. Start Microsoft Windows. 2. Click Start > Programs > Rockwell Software > DataSite Products > DataSite Tools > DS FloConfig. The Start dialog box appears. 3. For instructions on how to create a new project, see Create a New Project File. For instructions on how to open an existing project, see Open a Project File.
DataSite Flow Configuration Utility (DS FloConfig) 109 The New Project dialog box appears. 2. In the Directory box, enter the location you want to store the new project file in. Alternatively, use the tree structure to browse to the desired location. 3. In the Project Name box, enter a name for the project file. 4. In the Device Name box, enter a name for the device. The length of the name cannot exceed eight characters. 5. Click Create.
DataSite Flow Configuration Utility (DS FloConfig) Open a Project File Follow these steps to open an existing project file. 1. In the Start dialog box, click Open Project followed by OK. The Open Project dialog box appears. 2. In the Directory box, enter the location of the desired project file. Alternatively, use the tree structure to browse to the location. 3. Click Open. The selected project file is open in the DS FloConfig window.
DataSite Flow Configuration Utility (DS FloConfig) 111 Open a Recent Project File Follow these steps to open a recent project. 1. In the Start dialog box, click Open Recent Project. 2. From the list of recent project files, select the project file you want to open. 3. Click OK. The selected project file is open in the DS FloConfig window. Close DS FloConfig Follow this step to close DS FloConfig. • From the File menu, choose Exit.
DataSite Flow Configuration Utility (DS FloConfig) Configure PC Communication Settings The DataSite controller can be connected to the PC via the serial port or the Ethernet (TCP/IP) port. Use PC Communication settings to set up the communication mode and parameters for this connection. Open the PC Communication Dialog Box Follow this step to open the PC Communication dialog box. • In the configuration tree, click PC Communication.
DataSite Flow Configuration Utility (DS FloConfig) 113 2. If you have chosen UDP, set up the parameters for the TCP/IP connection. Parameters for TCP/IP communication Parameter Description Default Value Station number Station corresponding to the DataSite controller communication Ethernet port. 1 IP address IP address corresponding to the Ethernet communication port of the DataSite controller. The address is in the format, xxx.xxx.xxx.
DataSite Flow Configuration Utility (DS FloConfig) 4. In the Timeout box, enter in milliseconds, the timeout duration for the communication response to be received from the DataSite controller. 5. In the Try box, enter the maximum number of attempts for the computer to connect to the DataSite controller. 6. Enter a password in the Password box.
DataSite Flow Configuration Utility (DS FloConfig) Configure FLO Communication Settings 115 Use FLO Communication settings to set controller parameters, such as serial port parameters or Ethernet parameters, and low-power settings in the sleep mode of the controller. Open the FLO Communication Dialog Box Follow this step to open the FLO Communication dialog box. • In the configuration tree, click FLO Communication.
DataSite Flow Configuration Utility (DS FloConfig) Configure Serial Port Settings Each 1758-FLO DataSite controller has one RS232/RS485 combo port (COM1, default as RS232), and one RS232 port (COM2). The default baud rate of each serial port is 9600 bps and the default station number is 1. Follow these steps to change the settings of the serial ports. 1. In the FLO Communication dialog box, set up the parameters for the serial ports.
DataSite Flow Configuration Utility (DS FloConfig) 117 2. In the Communication Password box, enter the password you have previously set. 3. Click Download. The new settings are applied to the DataSite controller. The following sections provide more information on some of the parameters for the serial port.
DataSite Flow Configuration Utility (DS FloConfig) Configure TCP/IP Settings Follow these steps to configure the Ethernet port. 1. Under Ethernet in the FLO Communication dialog box, set up the parameters of the Ethernet port. This table shows the value range for each parameter. TCP/IP port parameters Parameter Parameter Value Range MAC xx:xx:xx:xx:xx:xx 6 integers in hexadecimal format. For example, 00:00:BC:60:61:D0. The MAC address is read-only. IP xxx.xxx.xxx.
DataSite Flow Configuration Utility (DS FloConfig) 119 Lower Power Consumption The options in the Power Enable group allow you to shut the power supply to some parts of the DataSite controller to lower power consumption. Follow these steps to lower power consumption. 1.
DataSite Flow Configuration Utility (DS FloConfig) Change the Communication Password Follow these steps to change the communication password. 1. Open the PC Communication tree. 2. In the Password box, enter the old password and then click Apply. 3. Open the FLO Communication tree. 4. In the Communication Password box, enter the new password. 5. Click Download. The new password is saved to the DataSite controller.
DataSite Flow Configuration Utility (DS FloConfig) Configure FLO RTC Settings 121 The FLO RTC settings allow you to read the real-time clock (RTC) of the DataSite controller, calibrate the RTC, and set the contract time. Open the FLO RTC Dialog Box Follow this step to open the FLO RTC dialog box. • In the configuration tree, click FLO RTC. Read the Real-Time Clock Follow these steps to read the RTC. 1. Under FLO Time, if you want the time to be read continuously, select the Continuously check box. 2.
DataSite Flow Configuration Utility (DS FloConfig) The current date and time of the RTC appears. Calibrate the Real-Time Clock (RTC) Follow these steps to calibrate the RTC. 1. Under Time Set, enter the date and time in the corresponding boxes. You can also use the current PC time by selecting the Use PC Time check box. 2. Under Time Set, click Set. The RTC is set to the date and time entered.
DataSite Flow Configuration Utility (DS FloConfig) 123 Set the Contract Time Contract time is the start time in a contract day. This is when the DataSite controller starts taking and recording measurements. The default contract time is 8:0:0. Follow this step to display the current contract time. • Under Contract Time, click Read. Follow these steps to set the contract time. 1. Under Contract Time, enter the desired contract time in the Hour and Minute boxes. For example, if you want to set 7.30 a.m.
DataSite Flow Configuration Utility (DS FloConfig) Record Flow Results for a Meter Run DS FloConfig can record and display the flow results for up to eight meter runs. Display the Flow Results of a Meter Run Follow this step to display the flow results of a meter run. • Click the meter run in the configuration tree. For example, if you want to display the flow results for Meter Run 0, click Meter Run0 as shown in the following diagram.
DataSite Flow Configuration Utility (DS FloConfig) 125 Meter Run This is the meter run number. Flow Rate These are the measurements for gas flow rate. • Volume Rate (Base) Volume transient flow rate (ft3/hour) at base conditions. For information on settings for the base pressure and temperature, see Instrument Parameters for AGA3 Standard on page 137 and Instrument Parameters for AGA7 Standard on page 139. • Volume Rate (Flowing) Volume transient flow rate (ft3/hour) at flowing conditions.
DataSite Flow Configuration Utility (DS FloConfig) Flow Accumulated These are the measurements for the total accumulated gas flow. • Volume Total (Base) The accumulated volume flow under base conditions from the first running point to the current time, accumulated once every second. • Volume Total (Flowing) The accumulated volume flow under flowing conditions from the first running point to the current time, accumulated once every second.
DataSite Flow Configuration Utility (DS FloConfig) 127 • Mass Last Hour The accumulated mass flow during last hour. Updated at each hour point. These are the measurements for the gas flow on the previous day. • Volume Yesterday (Base) The accumulated volume flow under base conditions during the previous contract day. Updated at each Contract Hour. • Volume Yesterday (Flowing) The accumulated volume flow under flowing conditions during the previous contract day. Updated each Contract Hour.
DataSite Flow Configuration Utility (DS FloConfig) Calculated Compressibility These are the compressibility factors at base conditions and flowing conditions as calculated by AGA8. • Factor (Base) • Factor (Flowing) Error and Alarm State Display Under Alarm&Error in the Meter Run dialog box, there are six alarms or errors listed. This table provides the description for each item. Alarms and errors Item Description Para There is an error from the input of flow parameters.
DataSite Flow Configuration Utility (DS FloConfig) 129 Clear Accumulation Follow these steps to clear the value of all the accumulated variables of a meter. IMPORTANT There is no Undo for the Clear function. Use this function cautiously. 1. In the configuration tree, click the Meter Run item for the meter you want. The Meter Run dialog box for that meter appears. 2. Click Clear.
DataSite Flow Configuration Utility (DS FloConfig) All the accumulated variables will be reset to 0, similar to the following figure.
DataSite Flow Configuration Utility (DS FloConfig) 131 Perform a Flow Calculation Test Calculation Test means the flow computer will not use the measured DP/P/T/PI signals from field. Instead it will use the simulation forced values you set to calculate the flow rate. You can use this function to verify the flow calculation precision, and also can use it to do sensor calibration. Follow these steps to perform a flow calculation test. 1. On the Operation menu, click Meter Calibration. 2.
DataSite Flow Configuration Utility (DS FloConfig) 4. Click Finish. The following dialog box appears. 5. Click No followed by OK. The flow meter will calculate the flow according to these values of T, P, and DP/PI. Display the Field Parameters of a Meter Run Follow these steps to display the field parameters of a meter run. 1. In the configuration tree, click the "+" symbol for the desired meter run. Meter Run0 is used as an example here.
DataSite Flow Configuration Utility (DS FloConfig) 133 The branch for the meter run appears. 2. Click Field Parameters. The field parameters of the selected meter run appear.
DataSite Flow Configuration Utility (DS FloConfig) Select the Measurement System Follow these steps to select the measurement system for the field parameters. 1. In the configuration tree, click the Meter Run item for the meter you want. The Meter Run dialog box for that meter appears. 2. From the Unit pull-down menu, choose the measurement system you want. 3. Click Download to apply the settings to the DataSite controller. The parameter units are defined as shown in this table.
DataSite Flow Configuration Utility (DS FloConfig) 135 Metric units of measurement for field parameters Parameter Unit DS FloConfig Display Flowing and base temperature °C C Density kg/m3 kg/m3 Mass kg kg Mass flow rate kg/hr kg/hr Volume m3 m3 Volume flow rate m3/hr m3/hr Heating value MJ/m3 MJ/m3 Turbine rate pulses/m3 pulses/m3 Interval or BMP s s Enable a Meter Channel and Its Accumulation Calculation DS FloConfig lets you select the meter channel you want to enable for m
DataSite Flow Configuration Utility (DS FloConfig) IMPORTANT After installing a meter, enable one meter first. Make sure all the parameters have been set correctly and the flow rate has been calculated correctly before you select the Accumulate check box to start the accumulated flow calculation every second. Set the Flow Rate Calculation Interval The flow rate calculation interval is the interval at which flow rates are calculated. You can set this interval according to your requirements.
DataSite Flow Configuration Utility (DS FloConfig) 137 Configure AGA3 Process Parameters If you choose the AGA3 gas flow calculation standard, you need to configure these parameters: • Instrument parameters • Orifice Plate parameters TIP IMPORTANT For any changes to parameter settings to be applied to the DataSite controller, you need to click Download. Before downloading any changes to the DataSite controller, it is recommended that you perform an upload.
DataSite Flow Configuration Utility (DS FloConfig) • Cut-off Differential When the differential pressure is lower than the value entered in the Cut-off Differential box, the DataSite controller will consider any flow as inexistent. There will be a cutoff alarm in the Meter Run window, and the flow rates become zero when this happens. • Tap Location This is the location of the flange taps. It could be on the upstream or the downstream of the orifice plate.
DataSite Flow Configuration Utility (DS FloConfig) 139 • Tube Diameter This is the inner diameter of tube measured at the reference temperature specified in the Reference T box. Configure AGA7 Process Parameters If you choose the AGA7 gas flow calculation standard, you need to configure these parameters: • Instrument parameters TIP IMPORTANT For any changes to parameter settings to be applied to the DataSite controller, you need to click Download.
DataSite Flow Configuration Utility (DS FloConfig) For descriptions on these parameters, see Configure AGA3 Process Parameters on page 137. • Cut-off Pulse When the pulse of the turbine meter during the base multiplier period (BMP) is lower than the value entered in the Cut-off Pulse box, the DataSite controller will consider any flow as inexistent. There will be a cutoff alarm in the Meter Run window, and the flow rates become zero when this happens.
DataSite Flow Configuration Utility (DS FloConfig) 141 Signal Addresses You need to enter the addresses for the static pressure (P), temperature (T), and differential pressure (DP) signals. These are the signals you have connected using the Analog In (AI) and/or HART channels during the setup of the DataSite controller. You may choose to use these signals from the AI0…AI5 channels on the DataSite controller.
DataSite Flow Configuration Utility (DS FloConfig) Input Address Data Type HART Address in 4xxxx User Defined Address Signal source in 4xxxx Data USHORT Lo0…Hi0 processed value k b (Hi-Lo)/(Hi0-Lo0) Lo-Lo0*k FLOAT FLOAT Final engineering value 1 0 FLOAT Simulation data input 1 0 To obtain the P, T, or DP data from a HART instrument, first you need to use the HART function in DS FloConfig.
DataSite Flow Configuration Utility (DS FloConfig) 143 Configure Field Signal Parameters for the AGA7 Standard If you have chosen the AGA7 standard, you need to configure the parameters for the field signals accordingly. TIP IMPORTANT For any changes to parameter settings to be applied to the DataSite controller, you need to click Download. Before downloading any changes to the DataSite controller, it is recommended that you perform an upload.
DataSite Flow Configuration Utility (DS FloConfig) Select an AGA8 Method AGA8 is used for calculating compressibility factors of natural gas and other related hydrocarbon gases. There are three AGA8 methods: • Gas analysis This is the Detail Characterization Method in AGA8 standard. This method applies a detailed knowledge of the mole fractions of up to 21 components of natural gas. • HV-GR-CO2 This is the Gross Characterization Method 1 in AGA8 standard.
DataSite Flow Configuration Utility (DS FloConfig) 145 Configure Parameters for the Gas Analysis Method Follow these steps to calculate gas flow using gas analysis. 1. Under Meter Parameter, from the AGA8 Methods pull-down menu, choose Gas Analysis. Under Gas Components, all the fields become available. 2. Enter the mole percentage of each of the 21 components of natural gas.
DataSite Flow Configuration Utility (DS FloConfig) Configure Parameters for the HV-GR-CO2 Method Follow these steps to calculate gas flow using the HV-GR-CO2 method. 1. Under Meter Parameter, from the AGA8 Methods pull-down menu, choose HV-GR-CO2. 2. Under Gas Components, enter the mole percentages of carbon dioxide, hydrogen, and carbon monoxide. 3. From the Condition Type pull-down menu, choose Real or Ideal, depending on the type of relative density of the gas. 4.
DataSite Flow Configuration Utility (DS FloConfig) 147 7. To save this configuration, click Save. The Save button is located to the right of the Field Signal parameters in the Meter Run window. IMPORTANT The mole percentage of each component, the heating value and the relative density should not exceed the range which is listed in table 1 of Valid Range of Gas Characteristics for AGA8 Methods on page 148. 8. Click Download to apply the settings to the DataSite controller.
DataSite Flow Configuration Utility (DS FloConfig) 6. To save this configuration, click Save. The Save button is located to the right of the Field Signal parameters in the Meter Run window. IMPORTANT The mole percentage of each component, heating value and relative density should not exceed the range which is listed in table 1 of Valid Range of Gas Characteristics for AGA8 Methods on page 148. 7. Click Download to apply the settings to the DataSite controller.
DataSite Flow Configuration Utility (DS FloConfig) 149 The Normal Range column gives the range of gas characteristics for which the average expected uncertainty corresponds to the uncertainties identified in the following figure. The Expanded Range column gives the average uncertainties of gas characteristics. This is expected to be higher than the Normal Range, specifically outside of Range 1 shown in the following figure.
DataSite Flow Configuration Utility (DS FloConfig) Publication 1758-UM002D-EN-P - October 2010
DataSite Flow Configuration Utility (DS FloConfig) Configure the Historical Records 151 There are two types of historical records the DataSite controller can log: daily historical records and hourly historical records. There are two types of variables used in the logging of historical records—fixed variables and user variables. For user variables, you need to select the user variables you want to record, and then download the selection to the controller.
DataSite Flow Configuration Utility (DS FloConfig) Configure the Daily Historical Records Follow these steps to configure the variables you want to collect in the daily historical records. 1. In the configuration tree, double-click History. Alternatively, you can click the “+”before History to expand the History tree. 2. Click Day Config. The Day Config frame appears. 3. To select a meter run, click its corresponding button. The meter run buttons are located at the top of the Day Config frame. 4.
DataSite Flow Configuration Utility (DS FloConfig) 153 5. To save the configuration to a file buffer on the PC, click Save. The message, “Save successful” appears. 6. Click OK to close the message box. 7. Click Download. The configuration is downloaded into the controller. At the same time, the message, “Download successful” appears. 8. Click OK to close the message box. TIP The total number of daily records is 35.
DataSite Flow Configuration Utility (DS FloConfig) Configure the Hourly Historical Records Follow these steps to configure the variables you want to collect in the hourly historical records. 1. In the configuration tree, double-click History. Alternatively, you can click the “+”before History to expand the History tree. 2. Click Hour Config. The Hour Config frame appears. 3. To select a meter run, click its corresponding button. The meter run buttons are located at the top of the Hour Config frame.
DataSite Flow Configuration Utility (DS FloConfig) 155 5. To save the configuration to a file buffer on the PC, click Save. The message, “Save successful” appears. 6. Click OK to close the message box. 7. Click Download. The configuration is downloaded into the controller. At the same time, the message, “Download successful” appears. 8. Click OK to close the message box. TIP The total number of hourly records is 1080 (36 x 30). The rules of hourly historical records logged: 1.
DataSite Flow Configuration Utility (DS FloConfig) Variable Description User var1 An instantaneous value of the last hour. This variable is user-configurable. User var2 User var3 User var4 The details of some of the variables, such as flow time, can be found in Display the Flow Results of a Meter Run on page 124. Load the Configuration from the PC Follow these steps to load the configuration from the PC. 1. Click Load.
DataSite Flow Configuration Utility (DS FloConfig) 157 Download the Configuration to the Controller Follow these steps to download (write) the configuration to the DataSite controller. 1. Click Upload. 2. Click OK. View Historical Records For each meter run, you can review the daily records for the last 35 days and the hourly records for the last 36 days (including the current day). Follow these steps to view the historical records. 1. In the configuration tree, click History.
DataSite Flow Configuration Utility (DS FloConfig) The following dialog box appears. 3. Under Flow Run Range, select the meter run whose logs you want to view. 4. Under Log Range, select the check box for the type of records you want to view. You can select both Hourly History and Daily History. 5. If you have selected the Hourly History check box, click All Days if you want to retrieve the hourly records for all the past 36 days.
DataSite Flow Configuration Utility (DS FloConfig) 159 An alternative method of retrieving the historical records is by using the toolbar: 1. Click Day or Hour on the toolbar, depending on which type of historical records you want to upload. 2. From the Meter Run pull-down menu, choose the meter run. 3. From the Start Time pull-down menu, choose the start time for the historical records. 4. From the End Time pull-down menu, choose the end time.
DataSite Flow Configuration Utility (DS FloConfig) Sort Historical Records You can sort the records by clicking the column headings. For example, if you click the Time column heading once, the records will be sorted in chronological order. Clicking the column headings more than once will toggle the sort order. For example, if you click the Time column heading again, the records will be sorted in reverse chronological order.
DataSite Flow Configuration Utility (DS FloConfig) Configure Alarm Events 161 Before the DataSite controller can start recording alarm events from alarm signals, you need to configure the alarm triggers and download this configuration to the controller. Open the Alarm Config dialog box Follow these steps to open the Alarm Config dialog box. 1. In the configuration tree, double-click Events. Alternatively, you can click the “+”before Events to expand the Events tree. 2. Click Alarm Config.
DataSite Flow Configuration Utility (DS FloConfig) Fixed variables are: • • • • • • DP/PI: Differential pressure/Pulse count P: Pressure T: Temperature Hi Limit: the high limit of the alarm Lo Limit: the low limit of the alarm Dead Band: the dead band of the alarm When the signal variable exceeds the Hi Limit, a high limit alarm will occur, and the value in the alarm event is the current value of the signal.
DataSite Flow Configuration Utility (DS FloConfig) 163 Enable an Alarm Configuration Follow these steps to enable an alarm configuration. 1. In the Alarm Config dialog box, double-click the alarm configuration you want to enable. The Alarm Configuration dialog box appears. 2. Enter the values for Hi Limit, Lo Limit and Dead Band. 3. Select the Enable check box. 4. Click OK to save the configuration. The configuration is displayed as ‘Enabled’. 5. Click Download.
DataSite Flow Configuration Utility (DS FloConfig) Insert an Alarm Configuration Follow these steps to insert an alarm configuration block. 1. In the Alarm Config dialog box, click Insert. You can also double-click any blank row indexed 24…63 in the Alarm Config dialog box. The Alarm Configuration dialog box appears. 2. In the Alarm Configuration dialog box, enter the register address of the variable, and the values for Hi Limit, Lo Limit and Dead Band.
DataSite Flow Configuration Utility (DS FloConfig) 165 The new alarm configuration is added to the list. TIP The alarm variables indexed from 24…63 support only the float data type.
DataSite Flow Configuration Utility (DS FloConfig) Disable an Alarm Configuration Follow these steps to disable an alarm configuration block for fixed variables, indexed from 0…23. 1. Double-click the fixed variable alarm configuration you want to disable. 2. Clear the Enable check box. 3. Click OK. Follow these steps to disable an alarm configuration block for user variables, indexed from 24…63. 1. Double-click the user variable alarm configuration you want to disable. 2. Clear the Enable check box.
DataSite Flow Configuration Utility (DS FloConfig) 167 Delete an Alarm Configuration Follow these steps to delete an alarm configuration block. TIP Only the user variable alarm configuration blocks, indexed from 24…63, can be deleted. The fixed variable alarm configuration blocks cannot be deleted. 1. Select the user variable alarm configuration you want to delete. IMPORTANT There is no Undo or Confirm function for the Delete action.
DataSite Flow Configuration Utility (DS FloConfig) Upload Alarm Configurations Follow this step to upload (read) the list of alarm configurations from the DataSite controller. The controller needs to be online before you can upload the settings. 1. Click Upload. 2. Click OK to close the message box. Download Alarm Configurations Follow this step to download (write) the list of alarm configurations to the DataSite controller. The controller needs to be online before you can download the settings. 1.
DataSite Flow Configuration Utility (DS FloConfig) View Alarm Event Records 169 Alarm events include four types, Lo Limited, Hi Limited, Lo Recovery, and Hi Recovery. You can configure the signal variables you want to record. For more information, see Configuring Alarm Events. Examples of system events are controller power-off, power-on, and reset. Follow these steps to display the Events log. 1. In the configuration tree, click Events. 2. Click Upload from FLO. The following dialog box appears. 3.
DataSite Flow Configuration Utility (DS FloConfig) 4. Click OK. The uploading will take some time. The length of time depends on the number of alarm event logs stored on the DataSite controller. While the uploading is in progress, some information appears in the status bar. The following is an example of the type of information displayed. The following is an example display of event records after they are uploaded from the DataSite controller.
DataSite Flow Configuration Utility (DS FloConfig) 171 An alternative method of retrieving the event records is by using the toolbar: 1. From the Start Time pull-down menu, choose the start time for the event records. 2. From the End Time pull-down menu, choose the end time. 3. Click Refresh. Sort Alarm Event Records You can sort the records by clicking the column headings. For example, if you click the Time column heading once, the records will be sorted in chronological order.
DataSite Flow Configuration Utility (DS FloConfig) Understand the Alarm Record Format An alarm record consists of the following components: • ID: the serial number of the alarm record. The range of the ID is 0…65535. Once the number of records exceeds 65535, the ID starts from 0 again. • Time: the date and time that the record is created. The date is in the format, year-month-day, and time is in the format, hour:minute:second. • Type: See the following table, Descriptions of alarm event types.
DataSite Flow Configuration Utility (DS FloConfig) View Event Records 173 Events include system events and modifications to parameters. Follow these steps to display the Events log. 1. In the configuration tree, click Events. 2. Click Upload from FLO. The following dialog box appears. 3. Click Upload All Logs or Just Upload New Logs. 4. Click OK.
DataSite Flow Configuration Utility (DS FloConfig) The uploading will take some time. The length of time depends on the number of event records stored on the DataSite controller. While the uploading is in progress, some information appears in the status bar. The following is an example of the type of information displayed. The following is an example display of event records after they are uploaded from the DataSite controller.
DataSite Flow Configuration Utility (DS FloConfig) 175 An alternative method of retrieving the event records is by using the toolbar: 1. From the Start Time pull-down menu, choose the start time for the event records. 2. From the End Time pull-down menu, choose the end time. 3. Click Refresh. Sort Event Records You can sort the records by clicking the column headings. For example, if you click the Time column heading once, the records will be sorted in chronological order.
DataSite Flow Configuration Utility (DS FloConfig) Understand the Event Record Format An event record consists of the following components: • ID: the serial number of the alarm record. The range of the ID is 0…65535. Once the number of records exceeds 65535, the ID starts from 0 again. • Type: See the section, Event Types on page 176. • Time: the date and time that the record is created. The date is in the format, year-month-day, and time is in the format, hour:minute:second.
DataSite Flow Configuration Utility (DS FloConfig) 177 This table provides a list of parameter modification events and their descriptions. Descriptions of parameter modification events Parameter modification event Condition Meter Run When the meter run is enabled or disabled. Unit Type When the unit type (U.S. or Metric) is changed. Accumulate When the flow meter is set to start or stop accumulation. Automatic Components When the Automatic Components option is selected or deselected.
DataSite Flow Configuration Utility (DS FloConfig) Descriptions of parameter modification events (Continued) Publication 1758-UM002D-EN-P - October 2010 Parameter modification event Condition Pressure Data Type When the pressure data type is selected. Pressure K Factor When the pressure K factor is changed. Pressure B Factor When the pressure B factor is changed. Temperature Register When the temperature register is changed.
DataSite Flow Configuration Utility (DS FloConfig) 179 Descriptions of parameter modification events (Continued) Parameter modification event Condition nC6H14 When the percentage level of the n-hexane component is changed. nC7H16 When the percentage level of the n-heptane component is changed. nC8H18 When the percentage level of the n-octane component is changed. nC9H20 When the percentage level of the n-nonane component is changed.
DataSite Flow Configuration Utility (DS FloConfig) Calibrate the Meter Sensor The Meter Calibration function allows you to maintain continuous measurement of the flow rate by the flow meter while calibrating field sensors. You can do this by sending forced signals to the flow meter to replace the field signals from the sensors. You need to calibrate the meter sensor in the following situations: • when the sensor does not work but the meter is required to accumulate measurements continuously.
DataSite Flow Configuration Utility (DS FloConfig) 181 3. Enter the forced values for the selected signals in the corresponding boxes. TIP The forced values should be as close as possible to the average value of the field signals. 4. Click Next. The Calibration Record dialog box appears. If you want to calculate with forced values only, click Finish. The following dialog box appears.
DataSite Flow Configuration Utility (DS FloConfig) 5. To save the forced values, click No. If you click Yes, the forced values will be discarded and calculation with forced values will be disabled. For example, after entering the values shown in step 1 for meter run 0, the Meter Run0 window will display the forced values and calculate the flow rate based on these values.
DataSite Flow Configuration Utility (DS FloConfig) 183 Calibrate the Sensors Follow these steps to calibrate the sensors. 1. Apply a known signal to the sensor. 2. In the Calibration Record dialog box, enter the applied value in the Applied box. 3. In the Engineering Hi box, enter the upper limit of the value range for this sensor. 4. In the Engineering Lo box, enter the lower limit of the value range for this sensor. 5. Wait until the measured value is stable, and then click Record.
DataSite Flow Configuration Utility (DS FloConfig) Complete the Calibration Follow these steps to complete the calibration. 1. After the calibration process ends, click Finish. The system will ask you if you want to stop using forced signal values. 2. If you want the flow calculation to return to using the live single inputs from the sensors, click Yes. If you want the controller to continue using the forced values, click No. If you want to exit without stopping the forced signals, click Cancel.
DataSite Flow Configuration Utility (DS FloConfig) Initialize the Controller 185 Use the Controller Initialization function to initialize the DataSite controller. Open the Controller Initialization dialog box Follow this step to open the Controller Initialization dialog box. • From the Operation menu, choose Controller Initialization. The Controller Initialization dialog box appears.
DataSite Flow Configuration Utility (DS FloConfig) 3. From the Operation menu, choose Controller Initialization. The Controller Initialization dialog box appears. 4. Select the Connect Controller check box. 5. Power off and power on the controller. 6. When "US Download!" appears in the Information box, clear the Connect Controller check box. The DataSite controller has successfully gone into the Service mode.
DataSite Flow Configuration Utility (DS FloConfig) 187 Test the Communication Follow these steps to obtain the communication settings of the DataSite controller. This function can help you retrieve the communication parameter settings if you forget or lose them. 1. Set the controller into the Service mode. 2. Select the Communication Test check box. 3. Click Set. All settings will be downloaded into the controller. 4. Click Run followed by Close. The controller goes into the Communication Test mode.
DataSite Flow Configuration Utility (DS FloConfig) 5. Choose PC Communication Settings in the configuration tree, and set the PC baud rate as 57600. 6. Select FLO Communication in configuration tree. When the upload is completed successfully, the communication settings of the controller are displayed.
DataSite Flow Configuration Utility (DS FloConfig) 189 7. To exit the Test Communication state, power the DataSite controller off and on again. Normal communication with the controller is resumed.
DataSite Flow Configuration Utility (DS FloConfig) Follow these steps to reset the communication parameters to their default values. 1. Set the controller into the Service mode. 2. Select the System Initialization check box. 3. Click Set. The new settings are downloaded to the controller. 4. Click Run, and exit the service mode. IMPORTANT After the controller is initialized, the password you have set in the Communication Password dialog box will be reset to 0000.
DataSite Flow Configuration Utility (DS FloConfig) 191 Default values of AGA flow parameters (Continued) Parameter Name Default Value AGA8 Methods Gas analysis Calculation interval 1 BMP (Base Multiplier Period) 1 Base Pressure 14.73 Base Temperature 60 DP Cutoff 0 Pressure Type Absolute Atmospheric Pressure 14.
DataSite Flow Configuration Utility (DS FloConfig) Default values of AGA flow parameters (Continued) Parameter Name Default Value CH4 0.965222 N2 0.002595 CO2 0.005956 C2H6 0.018186 C3H8 0.004596 H20 0 H2S 0 H2 0 CO 0 O2 0 iC4H10 0.000977 nC4H10 0.001007 iC5H12 0.000473 nC5H12 0.000324 nC6H14 0.000664 nC7H16 0 nC8H18 0 nC9H20 0 nC10H22 0 HE 0 AR 0 Pulse Cutoff 0 Follow these steps to reset all the AGA flow parameters to their default values. 1.
DataSite Flow Configuration Utility (DS FloConfig) 193 Rebuild the AGA Files Follow these steps to clear all the history and event records. 1. Set the controller into the Service mode. 2. Select the AGA File Initialization check box. 3. Click Set. All the history and event records are cleared. 4. Click Run, and exit the service mode. Delete the DataSite Workbench Program Follow these steps to delete the DataSite Workbench program that is on the DataSite controller. 1.
DataSite Flow Configuration Utility (DS FloConfig) Initialize the File System The File System Initialization option lets you do the following: • Clear all the parameter settings made in DS Settings, for example, Scan block, HART scan block and PID block settings. • Clear DNP3 parameters • Clear registers This is equivalent to selecting the following check boxes: • Register Initialization • DNP3 Initialization • DS Workbench initialization Follow these steps to initialize the file system. 1.
DataSite Flow Configuration Utility (DS FloConfig) 195 Display System Information Follow these steps to check the basic factory information of the DataSite controller. 1. Set the controller into the Service mode. 2. Click Sys info. Basic factory information on the DataSite controller appears in the Information box. 3. Click Run. 4. Click Close and then exit the Service mode. Clear Status Message Follow this step to clear all the status messages in the Information box. • Click Clear info.
DataSite Flow Configuration Utility (DS FloConfig) Configure the Scan Settings For integrated modules such as the DataSite controller, the master ports can directly read/write parameters by accessing the fixed Modbus registers. We need to set scan blocks of US1 and US2 only when we want to access other pieces of equipment connected with the two serial ports (COM1, COM2). Use Scan Settings to match the register addresses of the 1758 controller with those of the serially connected equipment.
DataSite Flow Configuration Utility (DS FloConfig) 197 Scan blocks are configured in sequence, and every block has a corresponding number. The maximum number of block numbers is 128. When the type of a block is Empty Block, its subsequent block configuration is invalid. Address For 1758-RTU controller, this means the Modbus slave station number of the serial communication equipment connected with COM1 or COM2. The range of the Modbus slave station number is 1…247.
DataSite Flow Configuration Utility (DS FloConfig) Scan Time Scan time refers to the read-write time interval of a scan block. You can use the trigger scan function for COM port by programming the function block COM_MSG in DataSite Workbench. The following units of time are available. Note that ms represents milliseconds, s seconds, m minutes, and h hours: • • • • • • • • 50 ms 500 ms 5s 50 s 5m 50 m 5h 50 h The scan time is equal to the value multiplied by the unit selected.
DataSite Flow Configuration Utility (DS FloConfig) 199 Slave Register This is the start address of the register on the slave equipment for reading data from and writing data to. The controller will read data from or write data to the slave equipment from this address. The address range is determined by the signal type. Reg_Num The number of read/write data registers that follow the start register address of the master register and the slave register.
DataSite Flow Configuration Utility (DS FloConfig) Open the Scan Settings Dialog Box Follow these steps to open the Scan Settings dialog box. • In the configuration tree, click Scan Config. The Scan Config window appears.
DataSite Flow Configuration Utility (DS FloConfig) 201 Edit a Scan Block Follow these steps to edit a scan block. 1. In the Scan Config window, double-click the scan block you want to edit. The Edit dialog box appears. 2. Enter the values for the scan block parameters. See the table Scan block parameters and their descriptions on page 196. 3. To save the changes and close the Edit dialog box, click OK. To close the Edit dialog box without saving, click Cancel.
DataSite Flow Configuration Utility (DS FloConfig) Insert a Scan Block Follow these steps to insert a scan block. 1. In the Scan Config window, select a scan block. 2. Click Insert. The Scan Edit dialog box appears. 3. Enter the values for the scan block in the Scan Edit dialog box. 4. To save the changes and close the Edit dialog box, click OK. To close the Edit dialog box without saving, click Cancel. Delete a Scan Block Follow these steps to delete a scan block. 1.
DataSite Flow Configuration Utility (DS FloConfig) 203 A dialog box prompting you to confirm the deletion appears. 3. To confirm the deletion, click OK. To cancel the deletion, click Cancel. Copy a Scan Block Follow these steps to copy a scan block. 1. Select the block you want to copy. 2. Click Copy. The selected scan block is copied. Paste a Scan Block Follow these steps to paste a block. 1. Select the block you want to copy and paste. 2. Click Copy to copy the block.
DataSite Flow Configuration Utility (DS FloConfig) 3. Select the row you want to paste the copied block to. TIP You can only select an empty row that is right after the selected block, or a row that already contains a block. 4. Click Paste to paste the copied block.
DataSite Flow Configuration Utility (DS FloConfig) 205 If you want to paste over a row that already contains a block, the new scan block will be added automatically after the last scan block. Paste a Scan Block to Multiple Rows The Multi_Paste function allows you to paste a copied block to multiple rows. Follow these steps to paste a copied block to multiple rows. 1. Select the block you want to copy and paste. 2. Click Copy to copy the block.
DataSite Flow Configuration Utility (DS FloConfig) 3. Select the first row you want to paste the copied block to. 4. Click Multi-Paste. The Multi Paste dialog box appears.
DataSite Flow Configuration Utility (DS FloConfig) 207 5. In the Multi Paste dialog box: To increment the Master Start_register address of the pasted block by 1, select the check box for Add by addr. In the Count box, enter the number of blocks you want to paste.
DataSite Flow Configuration Utility (DS FloConfig) Use the Shortcut Menu You can also use the shortcut menu for Insert, Delete, Copy and Paste functions. Follow this step to use the shortcut menu. • Right-click the row you want to apply the function to. The shortcut menu appears. Here is an example. Load the Scan Settings This function enables you to load the scan settings from the file buffer. This allows you to verify the configuration while the DataSite controller is offline.
DataSite Flow Configuration Utility (DS FloConfig) 209 Save the Scan Settings This function saves the scan settings into a file buffer on the PC. Follow this step to save scan settings. • Click Save. The settings are written to the file, Scan Block Parameter.scn and the message, "Save into file successful", appears in the left corner of the status bar. Upload the Scan Settings from the Controller Follow this step to upload (read) scan settings from the DataSite controller.
DataSite Flow Configuration Utility (DS FloConfig) Configure HART Inputs The HART dialog box lets you configure and send command messages by HART protocol. Open the HART Dialog Box Follow this step to open the HART dialog box. • In the configuration tree, click Hart.
DataSite Flow Configuration Utility (DS FloConfig) 211 This table provides a description of the column headers in the HART Settings dialog box. Description of HART block parameters Header Description NO. Serial number of each HART scan block. HART Channel Channel for the HART interface module to send commands to. The effective range is 0…2. •The HART0 channel supports multi-branched HART scan, and the data of up to 13 pieces of HART equipment can be scanned.
DataSite Flow Configuration Utility (DS FloConfig) Description of HART block parameters (Continued) Header Description HART State Addr Register for storing HART equipment state returned. Effective range is 40003…49999 for 1758-RTU controllers and 40003…47999 for 1758-FLO controllers. Err_Cnt Number of times an error occurs. After the HART scan block is configured, if there is no connection with the slave device or if communication fails, this value will be incremented by 1 after each scan cycle.
DataSite Flow Configuration Utility (DS FloConfig) 213 Registers Used in HART Commands The following table lists the number of registers used in each HART command for the four register types, namely Send, Return, Unit and HART state. Number of registers used in each HART command Command Description Number of registers Send register Return register Unit register HART state register 0 Read Unique Identifier 0 10 0 2 1 Read Primary Variable 0 2 1 2 2 Read P. V.
DataSite Flow Configuration Utility (DS FloConfig) Description of HART commands (Continued) Return register +0 = manufacturer ID code, 8-bit unsigned integer +1 = manufacturer equipment type code, 8-bit unsigned integer +2 = forerunner character number, 8-bit unsigned integer +3 = global command revision level, 8-bit unsigned integer +4 = transmitter revision level, 8-bit unsigned integer +5 = software revision level, 8-bit unsigned integer +6 = hardware revision level, 8-bit unsigned integer +7 = eq
DataSite Flow Configuration Utility (DS FloConfig) 215 Description of HART commands (Continued) Unit register +0 = Primary Variable unit code, 8-bit unsigned integer +1 = Secondary Variable unit code, 8-bit unsigned integer +2 = Tertiary Variable unit code, 8-bit unsigned integer +3 = Fourth Variable Unit code, 8-bit unsigned integer HART state register +0 = state 0 +1 = state 1 Note Not all equipment return primary, secondary, tertiary and fourth variables.
DataSite Flow Configuration Utility (DS FloConfig) Description of HART commands (Continued) HART state register +0 = state 0 +1 = state 1 Command 35 Purpose Write Primary Variable Range Values Send register +0 = Primary Variable 0 code, 8-bit unsigned integer +1, 2 = Primary Variable upper range value (float point) +3, 4 = Primary Variable lower range value (float point) Return register Not used Unit register Not used HART state register +0 = state 0 +1 = state 1 Command 38 Purpose Re
DataSite Flow Configuration Utility (DS FloConfig) 217 Description of HART commands (Continued) Return register +0, 2 = device specific status, 8-bit unsigned integer +3 = Operational modes, 8-bit unsigned integer +4, 5 = Analog outputs saturated, 24-bit unsigned integer +6, 7 = Analog outputs fixed, 24-bit unsigned integer +8, 13 = Device-specific status, 8-bit unsigned integer Unit register Not used HART state register +0 = state 0 +1 = state 1 Command 54 Purpose Read Transmitter Variable Infor
DataSite Flow Configuration Utility (DS FloConfig) Variable and Command Each piece of HART equipment is designed differently. For example, when you use command 3 to read variables from HART equipment, the four dynamic variables returned may have different meanings, and not all four variables may be valid. Refer to the documentation for the HART equipment for more information. See also the table, Description of HART Commands.
DataSite Flow Configuration Utility (DS FloConfig) 219 The following tables list the definition of the first two bytes of the response code according to the HART protocol.
DataSite Flow Configuration Utility (DS FloConfig) First byte when bit 7 = 0 (Command Response) (Continued) Bit Description 9 (Continued) •Invalid module type code—Selected module type code is not valid. •Invalid flange type code—Selected flange type code is not valid. •Frequency set point too high—Value entered for the frequency set point is too high. •Density high limit too high—Value entered for the density high limit is too high.
DataSite Flow Configuration Utility (DS FloConfig) 221 First byte when bit 7 = 0 (Command Response) (Continued) Bit Description 11 This bit can mean any of the following: •Upper range value too high—Upper range value is greater than the upper sensor limit. •Excess correction attempted—Correction attempted is outside of the permissible limits of the field device. •In multidrop mode—When in multidrop mode, this command cannot be performed.
DataSite Flow Configuration Utility (DS FloConfig) First byte when bit 7 = 0 (Command Response) (Continued) Bit Description 12 (Continued) •D2 too low—Value of the second density data is too low. •Invalid command number. •Invalid density units and calibration point. •Flow rate factor too low. 13 This bit can mean any of the following: •Upper and lower range values out of limits—Upper and lower range values are outside of their limits.
DataSite Flow Configuration Utility (DS FloConfig) 223 Second byte - when unused Bit Description 7 6 5 All bits 0 (when a communication error is reported in the first byte).
DataSite Flow Configuration Utility (DS FloConfig) Edit a HART Scan Block Follow these steps to edit a HART scan block. 1. Double-click the block you want to edit. The Edit dialog box appears. 2. From the Channel pull-down menu, choose a channel for the HART interface module to send commands to. The effective range is 0…2. • The HART0 channel supports multi-branched HART scan, and the data of up to 13 pieces of HART equipment can be scanned.
DataSite Flow Configuration Utility (DS FloConfig) 225 Effective values of HART commands (Continued) Effective Value HART Commands 38 Reset Configuration Changed Flag 40 Enter/Exit Fixed Primary Variable Current Mode Only Use in HART TRIG block 44 Write Primary Variable Units Only Use in HART TRIG block 48 Read additional Transmitter Status 54 Read Transmitter Variable Information 59 Write Number Of Response Preambles IMPORTANT Effective Value Only Use in HART TRIG block Command 0 must
DataSite Flow Configuration Utility (DS FloConfig) Delete a HART Scan Block Follow these steps to delete a HART scan block. 1. Select the block you want to delete. 2. Click Delete. A dialog box prompting you to confirm the deletion appears. 3. To confirm the deletion, click OK. To cancel the deletion, click Cancel. Copy a HART Scan Block Follow these steps to copy a HART scan block. 1. Select the block you want to copy. 2. Click Copy.
DataSite Flow Configuration Utility (DS FloConfig) 227 2. Click Copy to copy the block. 3. Select the row you want to paste the copied block to. TIP You can only select an empty row that is right after the selected block, or a row that already contains a block.
DataSite Flow Configuration Utility (DS FloConfig) 4. Click Paste to paste the copied block. If you are pasting over a row that already contains a block, the following dialog box appears. Click Yes to overwrite the block, or No to cancel the pasting. Paste a HART Scan Block to Multiple Rows Use the Multi_Paste function to paste a HART scan block to multiple rows. This function works in the same way as the Multi_Paste function in the Scan Settings dialog box.
DataSite Flow Configuration Utility (DS FloConfig) 229 Use the Shortcut Menu You can also use the shortcut menu for Insert, Delete, Copy and Paste functions. Follow this step to use the shortcut menu. • Right-click the row you want to apply the function to. The shortcut menu appears. Here is an example.
DataSite Flow Configuration Utility (DS FloConfig) Load the HART Settings This function enables you to load the HART settings previously saved in a file buffer on the PC. This allows you to verify the settings while the DataSite controller is offline. Follow this step to load HART settings from the file. • Click Load. If the settings are loaded successfully, the status bar will display the message, "Load from file successful".
DataSite Flow Configuration Utility (DS FloConfig) 231 Clear the Error Count Follow this step to clear the error count in HART scan data block of controller. • Click Clear Err.
DataSite Flow Configuration Utility (DS FloConfig) Publication 1758-UM002D-EN-P - October 2010
Chapter 3 DataSite DNP3 Configuration Utility (DS DNP3) This chapter provides information on the DataSite DNP3 Configuration utility, DS DNP3. This tool can be used to configure the 1758-RTU and the 1758-FLO DataSite controllers. Introduction Distributed Network Protocol (DNP3) is a standard communication protocol based on electricity, oil, natural gas, water, sewage treatment and other industrial control systems. It is an open communication protocol which is flexible and widely used.
DataSite DNP3 Configuration Utility (DS DNP3) • Data priority classification Data objects can be classified according to priority. Requests can be issued based on priority. • Multi-connected equipment address A communication network can have up to 4 master stations, with each station being connected to up to 65,000 pieces of equipment, each with a unique address. The actual configuration for each network depends on the application. • Time synchronization Time-correcting commands are provided.
DataSite DNP3 Configuration Utility (DS DNP3) 235 DNP3 Protocol Structure DNP3 is a layered protocol based on OSI-7 layer protocols. It supports the following layers: • Application layer The application layer sends request information from the master station to the slave station, or unrequested response information from the slave station to the master station. Information in this layer can be confirmed and re-issued.
DataSite DNP3 Configuration Utility (DS DNP3) DNP3 Class Objects Under normal circumstances, each data type can be divided into static objects and event objects. A static object contains the current value of objects, and an event object is brought about by the results of data changes. In DNP3, there are four kinds of class objects: • • • • Class 0 Class 1 Class 2 Class 3 A Class 0 object contains all of the static data. Class 1, 2, and 3 objects are event objects.
DataSite DNP3 Configuration Utility (DS DNP3) SDNP3 237 SDNP3 is a simplified protocol based on DNP3. The maximum number of data points that can be configured is 400. The maximum size of each session that can be configured is 200 data points. Class 0 is static data without event characteristics. Classes 1, 2, and 3 contain event characteristics.
DataSite DNP3 Configuration Utility (DS DNP3) Point-to-point communication structure Client (DNP3 Master) Server (DNP3 Slave) Point-to-point communication can be achieved in communication channels such as RS232, RS485, Ethernet, and wireless radio stations. Point-to-multipoint communication structure Client (DNP3 Master) Server (DNP3 Slave) Server (DNP3 Slave) Server (DNP3 Slave) Point-to-multipoint communication can be realized when using RS485 and Ethernet as communication channels.
DataSite DNP3 Configuration Utility (DS DNP3) 239 SDNP3 Data Scan Mode According to the requirements for communication structures, channel types and master station to different data points, the following types of data scan mode can be selected. • Self-reporting on changes The master station will not communicate with the equipment of the slave station proactively. The equipment of the slave station reports the event data to the master station proactively.
DataSite DNP3 Configuration Utility (DS DNP3) SDNP3 Channels and Sessions Course0 Course1 Master1 Channel 0 Session 2 Master3 Master2 Channel 0 Session 0 Channel 0 Network Port Channel 0 RS232 Port Physical connection SDNP3 RTU Each channel can establish multiple session links. Each session has an independent master station number. The session master station numbers among different channels can be the same. SDNP3 has a physical channel. The largest session number of each channel is four.
DataSite DNP3 Configuration Utility (DS DNP3) 241 SDNP3 Data Objects This table lists the types of SDNP3 data objects and their descriptions.
DataSite DNP3 Configuration Utility (DS DNP3) SDNP3 Data Points and Database Choose SDNP3 data points from the Modbus register. Each SDNP data point matches a Modbus register. Each data point has a set of corresponding configuration parameters, such as number of data points, Modbus address, data types, event class and so on. Data points can match actual RTU I/O, and also match intermediate variable registers. Different data points can match the same Modbus register.
DataSite DNP3 Configuration Utility (DS DNP3) 243 SDNP3 Session I/O Points Each SDNP session has a group of session IO points (data objects), including the following types: binary input points (DI), binary output points (DO), analog input points (AI), analog output point (AO). Session IO points are selected from SDNP3 database, you can choose the same data points for different session, and also choose data points. The maximum number of data points for each session IO is 200.
DataSite DNP3 Configuration Utility (DS DNP3) Start DS DNP3 Follow this step to start DS DNP3. • Click Start > Programs > Rockwell Software > DataSite Products > DataSite Tools > DS DNP3. The DS DNP3 window appears.
DataSite DNP3 Configuration Utility (DS DNP3) Configure PC Communication Settings 245 PC communication parameter setting can be used to enable the writing of data from the host computer to the DataSite controller while the host computer can upload data from the DataSite controller according to the configuration at the same time. ATTENTION Make sure that the PC communication parameters are set correctly. Otherwise, communication between the PC and the DataSite controller will not work.
DataSite DNP3 Configuration Utility (DS DNP3) The following table lists the range and default value of each PC communication parameter. Value ranges of PC communication parameter Variable Range Default Value Connect TCP/IP, COM1…COM9 TCP/IP Baud 2400, 4800, 9600, 38400, 57600 9600 Slave 1…247 1 IP xxx.xxx.xxx.xxx 192.168.100.75 Port 5…65535 502 Delay Time 10…1000 10 Timeout 1000…10000 1000 3. From the Connect pull-down menu, select a TCP/IP or a serial (COM) port.
DataSite DNP3 Configuration Utility (DS DNP3) 247 9. Click Apply. The new settings will take effect. After downloading the DNP3 data, the DataSite controller will power off and on again automatically. Wait for this power cycle to be completed before resuming operation. IMPORTANT If NET0 or COM is configured as the communication interface for DNP3, then they cannot be used by DS FloConfig, DS Settings or Modbus Scan to communicate with the DataSite controller.
DataSite DNP3 Configuration Utility (DS DNP3) Configure DS DNP3 Use this function to configure DNP3 data points for the DataSite controller. Configure the DS DNP3 Database Follow these steps to open the database. 1. From the Settings menu in the DS DNP3 window, choose Database. Alternatively, you can also click the Database icon in the toolbar.
DataSite DNP3 Configuration Utility (DS DNP3) 249 2. Click the Add button. Each data point is added automatically to the corresponding register address. The number of data points is an incremental change which starts at 0. The register addresses correspond to the acquisition signal. For example, if you click Add, select AI in the Add dialog box that appears, and click OK, an AI data point is added.
DataSite DNP3 Configuration Utility (DS DNP3) 3. To edit the values in the Register, Event Val or Description fields, click Modify and enter the new values. For example, if you want to change the register address for a data point, click Modify and enter the new value in the Modify dialog box that appears. 4. Click Modify to modify the signal type, data type, storage type and event type for a record. You can select a different option for each attribute from its pull-down menu in the Modify dialog box.
DataSite DNP3 Configuration Utility (DS DNP3) 251 The following table provides a description of the options for these attributes. Options for Signal Type, Data Type, Storage Type and Event Type Attribute Option Signal Type AI, AO, DI, DO, PI, and String. Only AO and DO have a local flag. Set the flag when some or all of the outstation's digital output points are in the Local state. This means that the Outstation's control outputs are not accessible through the DNP protocol.
DataSite DNP3 Configuration Utility (DS DNP3) Configure a DS DNP3 Channel Follow these steps to configure a port on the DataSite controller for DNP3 communication. 1. Open the DNP Settings tree. 2. In the DNP Settings tree, click Channel 0. The dialog box for configuring DNP3 channels appears. 3. Set up the following parameters according to your requirements. The following table provides the description, range and default value of each parameter.
DataSite DNP3 Configuration Utility (DS DNP3) 253 Configure a DS DNP3 session The DataSite controller allows up to four sessions to be executed simultaneously. This means, when there is a slave station with multiple master stations, the slave station can connect up to four master stations. Follow these steps to configure a DNP3 session. 1. Select the session you want to configure from the navigation pane. The settings dialog box for the selected session appears. 2.
DataSite DNP3 Configuration Utility (DS DNP3) If the Unsolicited Response check box was selected, the controller works in a self-reporting mode and sends unsolicited information to the master station automatically. In this mode of operation, the connection between controller and master station is very important. In a case where the connection has failed, the events will be saved in the events buffer. After the connection is restored, the saved events will be sent to the master station.
DataSite DNP3 Configuration Utility (DS DNP3) 255 SDNP3 object library (Continued) Object No. Variant No.
DataSite DNP3 Configuration Utility (DS DNP3) SDNP3 object library (Continued) Object No. Variant No. Description 40 3 Short floating-point analog output state 50 0 Time and date 50 1 Time and date 51 1 Time and date CTO 80 1 Internal indications 110 String length Octet string object 111 String length Octet string event object 5. If you want the host computer to check the RTC of the DataSite controller periodically, select the Time Synchronization box.
DataSite DNP3 Configuration Utility (DS DNP3) 257 Upload the Configuration file To view the DNP3 configuration of the DataSite controller, upload it to the PC. Follow this step to upload the DNP3 configuration. • From the Control menu, choose Upload. You can also click the Upload button on the toolbar. Save the Configuration file The DNP3 configuration file can also be saved into a file.
DataSite DNP3 Configuration Utility (DS DNP3) Operation and Data Validation Example If you want to communicate with the DataSite controller through TCP/IP by using the DNP3 protocol, you need to have four data points each for AI, DI, AO, and DO to send unsolicited responses. You need to configure the controller as having one slave and multiple masters. The following is an example to help you understand the use of DS DNP3 better. Example The system includes one outstation and four master stations.
DataSite DNP3 Configuration Utility (DS DNP3) 259 Step 2: Configure the channel as follows. You should select "NET0" for DNP3 communication and set the DNP3 slave address as ’4’. Step 3: Configure the data points in the database. 1. Click the Database tree. A screen similar to the following appears.
DataSite DNP3 Configuration Utility (DS DNP3) 2. Click the Add button for the type of data point you want to add. For example, if you want to add an AI data point, click Add, select AI in the Add dialog box that appears, and click OK. Repeat this step until you have added a data point for each type. 3. Configure the properties for each data point, including the register address, class, and event value.
DataSite DNP3 Configuration Utility (DS DNP3) 261 Step 4: Configure the session parameters. 1. Expand the Session0 tree and click Points. The data points you have bound in Step 3 are displayed.
DataSite DNP3 Configuration Utility (DS DNP3) 2. Click the Session0 button to display the parameters for session 0.
DataSite DNP3 Configuration Utility (DS DNP3) 263 3. Select the station address for the session. The station address is the address of the DNP3 master. It is 3 for session 0 in this case. 4. Select the objects as described in the table, SDNP3 object library on page 254. 5. Select Last Value for DI and AI Event Mode. This means sending the latest value to the DNP3 master. 6. Select the scan time. 7. Select the Unsolicited Response check box. 8. Repeat steps 1 through 7 to set the parameters for session 1.
DataSite DNP3 Configuration Utility (DS DNP3) 9. Repeat steps 1 through 6 to set the parameters for session 2. For session 2, the station address is 5. The controller will send the AI change events to the master immediately as class 1 type and save the AI events into the buffer in case the connection fails. The buffer length is 2000 and scan time is 1000 ms. It is not necessary to detect DI events.
DataSite DNP3 Configuration Utility (DS DNP3) 265 10. Repeat steps 1 through 6 to set the parameters for session 3. For session 3, the station address is 6. The controller will send the DI change events to the master immediately as class 1 type, and save the DI events into the buffer in case the connection fails. The buffer length is 2000 and scan time is 200 ms. It is not necessary to detect AI change events.
DataSite DNP3 Configuration Utility (DS DNP3) Notes: Publication 1758-UM002D-EN-P - October 2010
Chapter 4 Extension Modbus Protocol for DataSite Controllers (1758-FLO) This chapter describes communication with a SCADA system using the Extension Modbus protocol. The Extension Modbus protocol is fully compatible with standard Modbus. All data interchanges, including flow history data, are accomplished using the Extension Modbus protocol. Modbus Register Definition The DataSite controller uses the Modbus address to share data between C programs and communication protocols.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Modbus Register Range The registers used in the DataSite controller include four types of I/O registers. Coil registers Coil registers are single-bit registers located in the digital output section of the I/O database. There are 4096 coil registers numbered from 00001 to 04096. State registers State registers are single registers located in the digital input section of the I/O database.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 269 Modbus Registers for Physical I/O Hardware All of the I/O hardware that is used by the DataSite controller must be assigned to I/O database registers in order for the I/O points to be accessed. They are mapped as below.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Modbus Registers used by the 1758-FLO Controllers The following registers are used by the 1758-FLO controllers for configuration, display and data archival. These registers are described in the following sections.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 271 Modbus Registers for Firmware and Hardware Version (RO) Modbus addresses for firmware and hardware versions Name Description Data Type Modbus Address Flo_FRN1 Firmware version u_short 30081 Flo_FRN2 Flo_HRN1 30082 Hardware version u_short Flo_HRN2 30083 30084 Modbus Registers for RTC (RO) Modbus addresses for RTC Name Description Data Type Modbus Address rtu_hour Controller hour u_short 30091 rtu_minute Controller minu
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Parameters in calculation results block 1 Parameter Name Description Data Type Modbus Addresses for Meter Run 0 Parameters (= X) DP/PI Differential pressure real-time acquisition value (AGA3 only), pulse count real-time acquisition value (/sec.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 273 Modbus addresses for calculation results block 2 Meter Run Starting Address Parameter Address Address Number 0 33101 X 50 1 33151 X + 50 50 2 33201 X + 100 50 3 33251 X + 150 50 4 33301 X + 200 50 5 33351 X + 250 50 6 33401 X + 300 50 7 33451 X + 350 50 Parameters in calculation results block 2 Parameter Name Description Data Type Modbus Addresses for Meter Run 0 Parameters (= X) qeh_pval Energy hour
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Modbus Registers for Flow Configuration Parameters (RO) Modbus addresses for flow configuration parameters Meter Run Starting Address Parameter Address Address Number 0 32101 X 100 1 32201 X + 100 100 2 32301 X + 200 100 3 32401 X + 300 100 4 32501 X + 400 100 5 32601 X + 500 100 6 32701 X + 600 100 7 32801 X + 700 100 Flow configuration parameters Parameter Name Description Data Type Modbus Address of
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 275 Flow configuration parameters (Continued) Parameter Name Description Data Type Modbus Address of Meter Run 0 = X force_flag Indicate which parameter will use force input. Bit 0: Differential pressure or pulse Bit 1: Static pressure Bit 2: Temperature u_short 32114 dp_B Differential pressure B factor for AGA3 calculation. This parameter is not used for AGA7 calculation.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Flow configuration parameters (Continued) Parameter Name Description Data Type Modbus Address of Meter Run 0 = X x_c3h8 Propane float 32167…32168 x_h20 Water float 32169…32170 x_h2s Hydrogen sulfide float 32171…32172 x_h2 Hydrogen float 32173…32174 x_co Carbon monoxide float 32175…32176 x_o2 Oxygen float 32177…32178 x_ic4h10 i-Butane float 32179…32180 x_nc4h10 n-Butane float 32181…32182 x_ic5h12 i-Pentan
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 277 Modbus Registers for the Power Shutdown Time These registers record the previous shutdown time of the controller.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Offset structure table (Continued) Data Type Offset Name Description float 4 C3H8 Propane float 5 H2O Water float 6 H2S Hydrogen sulfide float 7 H2 Hydrogen float 8 CO Carbon monoxide float 9 O2 Oxygen float 10 iC4H10 i-Butane float 11 nC4H10 n-Butane float 12 iC5H12 i-Pentane float 13 nC5H12 n-Pentane float 14 nC6H12 n-Hexane float 15 nC7H16 n-Heptane float 16 nC8H18 n-Octane float 1
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 279 Range of parameter values (Sum of all components must be within 1 +/- 0.0001 No.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Modbus registers for SCADA communication Publication 1758-UM002D-EN-P - October 2010 Modbus Register Description 49000…49999 Registers used by the Extension Modbus protocol for communication with the SCADA system. A description of these registers is provided in the next section.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Addresses Associated with the Extension Modbus Protocol Commands 281 The two blocks, buffer 1 and buffer 2, have different meanings for different commands. The following table provides the register address, data type, attribute and description for each command.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Command List Extension Modbus protocol commands Publication 1758-UM002D-EN-P - October 2010 Command Number Description 1 Correct time 2 Set pass code 3 Set device name 4 Read device name 5 Disable/enable meter run 6 Read disable/enable setting of meter run 7 Set transaction (contract) time 8 Read transaction (contract) time 9 Set signal test 10 Read signal test settings and values 11 Disable/enable accumulation calc
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 283 Command Number 1: Correct the System Time Use command number 1 to set up the system time of the 1758-FLO DataSite controllers. IMPORTANT Enter a valid time, such as 2009-2-21 13:59:00. The day of the week should correspond to the date.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Return codes for command number 1 Return Code Description 00 OK 01 Year invalid 02 Month invalid 03 Day invalid 04 Hour invalid 05 Minute invalid 06 Second invalid 07 Week invalid 100 Pass code is wrong Other Invalid Command Number 2: Set the Pass Code Use command number 2 to set a new pass code. The default pass code is 0.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 285 Command Number 3: Set the Device Name Use command number 3 to set the device name of the 1758-FLO DataSite controllers. The maximum string length is eight characters.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Parameters for command number 4 (Continued) Address Data Type Attribute Description 49028 u_int W Pass code for user 49030…49034 — — Reserved 49035 u_short R Device name 1 49036 u_short R Device name 2 49037 u_short R Device name 3 49038 u_short R Device name 4 49039 u_short R Device name 5 49040 u_short R Device name 6 49041 u_short R Device name 7 49042 u_short R Device name 8 There is no event
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 287 Event codes for command number 5 Event Name Event Code EVENT_RUN_ENABLE 11 EVENT_RUN_DISABLE 12 Return codes for command number 5 Return Code Description 00 OK 01 Meter run is invalid 02 Input value is invalid 100 Pass code is incorrect Other Invalid Command Number 6: Read the Disable/Enable Flow Calculation Setting Use command number 6 to read the disable/enable setting of the flow calculation for a meter run.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Command Number 7: Set the Transaction (Contract) Time Use command number 7 to set the transaction (contract) time. The daily record will be saved at the contract time every day.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 289 Parameters for command number 8 (Continued) Address Data Type Attribute Description 49035 u_short R Contract hour (0…23) 49036 u_short R Contract minute (0…59) 49037 u_short — Reserved There is no event code for command number 8.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) There is no event code for command number 9.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 291 There is no event code for command number 10. Return codes for command number 10 Return Code Description 00 OK 01 Meter run is invalid 100 Pass code is wrong Other Invalid Command Number 11: Disable/Enable the Accumulation Calculation Use command number 11 to disable or enable accumulation calculation for a meter run.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Command Number 12: Read Disable/Enable Setting for Accumulation Calculation Use command number 12 to read the disable/enable setting for accumulation calculation for a meter run.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 293 Parameters for command number 13 (Continued) Address Data Type Attribute Description 49035 u_short W Address of differential pressure or pulse 49036 u_short W Data type of differential pressure or pulse 0: u_short 1: float 49037 float W K factor of differential pressure or pulse 49039 float W B factor of differential pressure or pulse 49041 u_short W Address of pressure 49042 u_short W Data type of pressure 0: u_s
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Event codes for command number 13 (Continued) Event Name Event Code EVENT_INPUT_PL_Address 51 EVENT_INPUT_PLD_Type 52 EVENT_INPUT_PL_K 53 Return Codes for Command number 13 Return Code Description 00 OK 01 Meter run is invalid 02 DP_Aaddress is invalid 03 P_Aaddress is invalid 04 T_Aaddress is invalid 100 Pass code is incorrect Other Invalid Command Number 14: Read the Input Parameters Use command number 14 to read t
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 295 Parameters for command number 14 (Continued) Address Data Type Attribute Description 49041 u_short R Address of pressure 49042 u_short R Data type of pressure 0: u_short 1: float 49043 float R k factor of pressure 49045 float R b factor of pressure 49047 u_short R Address of temperature 49048 u_short R Temperature data type 0: u_short 1: float 49049 float R k factor of temperature 49051 float R b factor of
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Parameters for command number 15 (Continued) Address Data Type Attribute Description 49036 float W Upper alarm limit of differential pressure or pulse 49038 float W Lower alarm limit of differential pressure or pulse 49040 float W Alarm dead-band of differential pressure or pulse 49042 u_short W Enable or disable static pressure alarm 0: Disable 1: Enable 49043 float W Upper alarm limit of static pressure 49045 floa
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 297 Command Number 16: Read the Alarm Range of Input Parameters Use command number 16 to read the upper and lower alarm limits and alarm dead-band of static pressure, temperature, and differential pressure or pulse.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) There is no event code for command number 16. Return codes for command number 16 Return Code Description 00 OK 01 Meter run is invalid 100 Pass code is incorrect Other Invalid Command Number 17: Set Up the Calculation Input Parameters Use command number 17 to set up the corresponding parameters, excluding the gas component parameters, for one meter run.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 299 Parameters for command number 17 (Continued) Address Data Type Attribute Description 49042 u_short W Base Multiplier Period (BMP) 49043 float W Contract standard reference ratio pressure 49045 float W Contract standard reference ratio temperature 49047 float/u_int W Cut-off differential pressure or cut-off pulse 49049 u_short W Pressure type 0: Gauge 1: Absolute 49050 float W Atmospheric pressure 49052 u_short
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Event codes for command number 17 Publication 1758-UM002D-EN-P - October 2010 Event Name Event Code EVENT_COMPONENT_SELECT 16 EVENT_INPUT_AGA_Type 17 EVENT_INPUT_Z_Mode 18 EVENT_INPUT_INTERVAL 19 EVENT_INPUT_BMP 20 EVENT_INPUT_AGA_Pb 21 EVENT_INPUT_AGA_Tb 22 EVENT_INPUT_Cutoff 23 EVENT_INPUT_P_Type 24 EVENT_INPUT_Barometric 25 EVENT_INPUT_TapLocation 26 EVENT_INPUT_Hd_Type 27 EVENT_INPUT_Dr_Orifice 28 EVENT_INP
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 301 Return codes for command number 17 Return Code Description 00 OK 01 Meter run is invalid 02 Disable/enable setting of meter run is invalid 03 Unit of measurement is invalid 04 Accumulate setting is invalid 05 Setting for the use of automatic component analysis instrument is invalid 06 Calculation type is invalid 07 Algorithm selected for the calculation of the compressibility factor is invalid 08 Pressure type is invalid
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Parameters for command number 18 (Continued) Publication 1758-UM002D-EN-P - October 2010 Address Data Type Attribute Description 49036 u_short R Units of measurement 0: U.S.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 303 Parameters for command number 18 (Continued) Address Data Type Attribute Description 49063 u_short R Relative density type 0: Relative density 1: Ideal density 49064 float R Relative density 49066 float R Reference pressure for measuring relative density 49068 float R Reference temperature for measuring relative density 49070 float R AGA8 gas heating value 49072 float R Reference temperature for gas heating value
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Parameters for command number 19 (Continued) Address Data Type Attribute Description 49039 float W CO2 49041 float W C2H6 49043 float W C3H8 49045 float W H2O 49047 float W H2S 49049 float W H2 49051 float W CO 49053 float W O2 49055 float W i-C4H10 49057 float W n-C4H10 49059 float W i-C5H12 49061 float W n-C5H12 49063 float W n-C6H14 49065 float W n-C7H16 49067 float W n-C8H18
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 305 Event code for command number 19 (Continued) Event Name Event Code EVENT_COMPOSE_14 67 EVENT_COMPOSE_15 68 EVENT_COMPOSE_16 69 EVENT_COMPOSE_17 70 EVENT_COMPOSE_18 71 EVENT_COMPOSE_19 72 EVENT_COMPOSE_20 73 EVENT_COMPOSE_21 74 Publication 1758-UM002D-EN-P - October 2010
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Return codes for command number 19 Publication 1758-UM002D-EN-P - October 2010 Return Code Description 00 OK 01 Meter run is invalid 02 CH4 is invalid 03 N2 is invalid 04 CO2 is invalid 05 C2H6 is invalid 06 C3H8 is invalid 07 H2O is invalid 08 H2S is invalid 09 H2 is invalid 10 CO is invalid 11 O2 is invalid 12 i-C4H10 is invalid 13 n-C4H10 is invalid 14 i-C5H12 is invalid 15 n-C5H12 is invalid 16 n-C6H
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 307 Command Number 20: Read the Gas Component Parameter Use command number 20 to read the settings of the gas components for each meter run.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) There is no event code for command number 20. Return codes for command number 20 Return Code Description 00 OK 01 Meter run is invalid 100 Pass code is incorrect Other Invalid Command Number 21: Reset Accumulation Use command number 21 to clear accumulation to zero for one meter run.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 309 Command Number 22: Get Daily History Use command number 22 to get daily history data. Parameters for command number 22 Address Data Type Attribute Description 49025 u_short RW 22 49026 u_short W Return code 0: OK 49027 u_short W Meter run (0…7) 49028 u_int W Pass code for user 49030 u_short W Start date index (1…35).
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Registers for record 1 of daily history data (Continued) Address Data Type Attribute Description 49057 float R Reserved 49059 float R User variable 1 49061 float R User variable 2 49063 float R User variable 3 49065 float R User variable 4 The following table lists the register addresses for records 2…8 of daily history data.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 311 Command Number 23: Get Hourly History Use command number 23 to get hourly history data. Parameters for command number 23 Address Data Type Attribute Description 49025 u_short RW 23 49026 u_short W Return code 0: OK 49027 u_short W Meter run (0…7) 49028 u_int W Pass code for user 49030 u_short W Start date index (0…35).
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Registers for record 1 of hourly history data (Continued) Address Data Type Attribute Description 49055 float R EXT (AGA3)/ Uncorrected volume (AGA7) 49057 float R Reserved 49059 float R User variable 1 49061 float R User variable 2 49063 float R User variable 3 49065 float R User variable 4 The following table lists the register addresses for records 2…8 of hourly history data.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 313 Command Number 24: Read Alarm Logs Use command number 24 to read alarm logs for up to 15 alarms at a time. Each alarm consists of 12 registers.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Registers for alarms 2…15 (Continued) Address Data Type Attribute Description 49083…49094 See above See above Alarm 5 49095…49106 See above See above Alarm 6 49107…49118 See above See above Alarm 7 49119…49130 See above See above Alarm 8 49131…49142 See above See above Alarm 9 49143…49154 See above See above Alarm 10 49155…49166 See above See above Alarm 11 49167…49178 See above See above Alarm 12 49179…4
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 315 Parameters for command number 25 (Continued) Address Data Type Attribute Description 49031 u_short R Number of remaining new records 49032 u_short R Number of lost records 49033…49034 — — Reserved There is no event code for command number 25.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Registers for event 1 (Continued) Address Data Type Attribute Description 49038 u_char[0] R Day of the event date(1) u_char[1] R Hour of the event time(2) u_char[0] R Minute of the event time(2) u_char[1] R Second of the event time(2) u_char[0] R Event value (see Chapter 6‚ Global Event Codes for Modbus Protocols) u_char[1] R Event occurred in meter run(3) 49041 float R Value before event happens(4) 49043 float
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 317 Registers for events 2…20 (Continued) Address Data Type Attribute Description 49195…49204 See above See above Event 17 49205…49214 See above See above Event 18 49215…49224 See above See above Event 19 49225…49234 See above See above Event 20 There is no event code for command number 26.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) There is no event code for command number 27. Return codes for command number 5 Return Code Description 00 OK 100 Pass code is incorrect Other Invalid Command Number 28: Disable/Enable the Automatic Components Analysis Instrument Use command number 28 to set whether or not to read the gas component parameters from a gas component analyzer automatically.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 319 Command Number 29: Read the Flag of Getting Gas Component Parameters from the Gas Component Analyzer Use command number 29 to read the flag of whether or not the gas component parameters are read from the gas component analyzer.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Parameters for command number 30 (Continued) Address Data Type Attribute Description 49030…49034 — — Reserved 49035 — — Reserved … — — Reserved There is no event code for command number 30. Return codes for command number 30 Return Code Description 00 OK 01 Pass code is incorrect Other Invalid Command Number 31: Acknowledge Events Use command number 31 to acknowledge all the new events in the event log.
Extension Modbus Protocol for DataSite Controllers (1758-FLO) 321 Notes: Publication 1758-UM002D-EN-P - October 2010
Extension Modbus Protocol for DataSite Controllers (1758-FLO) Publication 1758-UM002D-EN-P - October 2010
Chapter 5 Enron Modbus Protocol for the 1758-FLO DataSite Controller The Modbus protocol is designed as a means to communicate control data between controllers and sensors using an RS232 port. The Enron Modbus protocol, used in the oil and gas industry, is based on the Modbus ASCII and Modbus RTU protocols. The 1758-FLO DataSite controllers support Enron Modbus and standard Modbus protocols on the same serial port.
Enron Modbus Protocol for the 1758-FLO DataSite Controller Register Addresses The following table lists the address ranges of the Enron registers that hold short integers, long integers, and single precision floats.
Enron Modbus Protocol for the 1758-FLO DataSite Controller Information Variables 325 This section describes global variables used in the DataSite controller. These variables contain the information about the controller and can be accessed by using the Enron Modbus protocol. Short Integer Variables Short integer variables are accessed using commands 3, 6, and 16. These commands are similar to the corresponding standard Modbus commands, and they use Enron Modbus addressing.
Enron Modbus Protocol for the 1758-FLO DataSite Controller ID variables for 1758-FLO controllers Register Description Access 3011 Device name character 1. Range: 33…126 R/W 3012 Device name character 2. Range: 33…126 R/W 3013 Device name character 3. Range: 33…126 R/W 3014 Device name character 4. Range: 33…126 R/W 3015 Device name character 5. Range: 33…126 R/W 3016 Device name character 6. Range: 33…126 R/W 3017 Device name character 7.
Enron Modbus Protocol for the 1758-FLO DataSite Controller 327 General input configuration variables Register Description Access 3053 Input unit type. Bit 3: 0 = US, 1 = Metric R/W 3054 Flow calculation type.
Enron Modbus Protocol for the 1758-FLO DataSite Controller Current pointer index for hourly and daily logs Register Description Access 3068 Current pointer index for hourly log RO 3069 Current pointer index for daily log RO Collecting Components Analysis Instrument Automatically Publication 1758-UM002D-EN-P - October 2010 Register Description Access 3070 bit4: Flag for collecting components analysis instrument automatically (0 = no,1 = yes) RW 3071 The interval for collecting compone
Enron Modbus Protocol for the 1758-FLO DataSite Controller 329 Long Integer Variables Long integer variables are accessed using commands 3, 6, and 16. These commands are similar to the corresponding standard Modbus commands, and they use Enron Modbus addressing. The size of the data fields for each variable is determined by the variable address. The read command returns four bytes for each requested register. The write command provides four bytes for each register value.
Enron Modbus Protocol for the 1758-FLO DataSite Controller The following tables list all the floating point variables used by Enron Modbus in the DataSite controller.
Enron Modbus Protocol for the 1758-FLO DataSite Controller 331 Accumulated flow variables Register Description Access 7017 Flow volume at base conditions during the contract day RO 7018 Flow mass at base conditions during the contract day RO 7019 Reserved — 7020 Reserved — 7021 Mass quantity of the previous day RO 7022 Volume quantity of the previous day in base conditions RO 7023 Volume quantity of the previous day in flowing conditions RO 7024…7028 Reserved — 7029 Average diff
Enron Modbus Protocol for the 1758-FLO DataSite Controller Static pressure input variables Register Description Access 7045 Reserved — 7046 Static pressure b factor R/W 7047 Static pressure k factor R/W Differential input variables Register Description Access 7048 Differential pressure input register Modbus address R/W 7049 Differential pressure b factor R/W 7050 Differential pressure k factor R/W Other input variables Register Description Access 7051 Atmospheric pressure
Enron Modbus Protocol for the 1758-FLO DataSite Controller 333 AGA-3 configuration variables (Continued) Register Description Access 7069 Methane RO 7070 Nitrogen RO 7071 Carbon dioxide RO 7072 Ethane RO 7073 Propane RO 7074 Water RO 7075 Hydrogen sulfide RO 7076 Hydrogen RO 7077 Carbon monoxide RO 7078 Oxygen RO 7079 i-Butane RO 7080 n-Butane RO 7081 i-Pentane RO 7082 n-Pentane RO 7083 n-Hexane RO 7084 n-Heptane RO 7085 n-Octane RO 7086 n-Nonae RO
Enron Modbus Protocol for the 1758-FLO DataSite Controller Meter Runs 1…7 Data Variables Data variables for meter runs 1…7 use the same structure as meter run 0 data variables. The data variables are offset from meter run 0 variables according to the following tables. Meter run 1 data variables Register Data Type Description 3101…3150 Short integer Meter run 1 data variables • Identical structure to meter run 0 data variables. • Offset by a value of 50.
Enron Modbus Protocol for the 1758-FLO DataSite Controller 335 Meter run 3 data variables Register Data Type Description 3201…3250 Short integer Meter run 3 data variables • Identical structure to meter run 0 data variables. • Offset by a value of 30. 5031…5040 Long integer Meter run 3 data variables • Identical structure to meter run 0 data variables. • Offset by a value of 60. 7301…7400 Float Meter run 3 data variables • Identical structure to meter run 0 data variables.
Enron Modbus Protocol for the 1758-FLO DataSite Controller Meter run 5 data variables Register Data Type Description 3301…3350 Short integer Meter run 5 data variables • Identical structure to meter run 0 data variables. • Offset by a value of 250. 5051…5060 Long integer Meter run 5 data variables • Identical structure to meter run 0 data variables. • Offset by a value of 50. 7501…7600 Float Meter run 5 data variables • Identical structure to meter run 0 data variables.
Enron Modbus Protocol for the 1758-FLO DataSite Controller 337 Meter run 7 data variables Register Data Type Description 3401…3500 Short integer Meter run 7 data variables • Identical structure to meter run 0 data variables. • Offset by a value of 350. 5071…5080 Long integer Meter run 7 data variables • Identical structure to meter run 0 data variables. • Offset by a value of 70. 7701…7800 Float Meter run 7 data variables • Identical structure to meter run 0 data variables.
Enron Modbus Protocol for the 1758-FLO DataSite Controller Format of hourly and daily records (Continued) Field Size Type Description VAR2 4 FLOAT User defined variable VAR3 4 FLOAT User defined variable VAR4 4 FLOAT User defined variable Archives are stored in the following registers.
Enron Modbus Protocol for the 1758-FLO DataSite Controller 339 Event and Alarm Logs The 1758-FLO DataSite event and alarm logs can be read as the Enron Modbus event/alarm log. The format of the log is shown in the following tables. The events are saved in records 1…700 in the log, and alarms are saved in records 701…1000 in the log. For the Event Type or Event Code, see Chapter 6, Global Event Codes for Modbus Protocols.
Enron Modbus Protocol for the 1758-FLO DataSite Controller The following table lists the register addresses associated with the alarm parameters for each meter run.
Enron Modbus Protocol for the 1758-FLO DataSite Controller 341 Notes: Publication 1758-UM002D-EN-P - October 2010
Enron Modbus Protocol for the 1758-FLO DataSite Controller Publication 1758-UM002D-EN-P - October 2010
Chapter 6 Global Event Codes for Modbus Protocols Global Event Codes The following table lists the codes for global events. They are not specific to meter runs and are common to the controller.
Global Event Codes for Modbus Protocols Codes for parameter modification events (Continued) Publication 1758-UM002D-EN-P - October 2010 Code Parameter Modification Event 30 Tube material modified 31 Tube diameter modified 32 Tube reference temperature modified 33 Relative density type modified 34 Relative density modified 35 Reference pressure for measuring relative density modified 36 Reference temperature for measuring relative density modified 37 Gas heating value modified 38 R
Global Event Codes for Modbus Protocols 345 Codes for parameter modification events (Continued) Code Parameter Modification Event 66 iC5H12 component level modified 67 nC5H12 component level modified 68 nC6H14 component level modified 69 nC7H16 component level modified 70 nC8H18 component level modified 71 nC9H20 component level modified 72 nC10H22 component level modified 73 HE component level modified 74 AR component level modified 75 Cut-off pulse modified 76 Interval for collect
Global Event Codes for Modbus Protocols Notes: Publication 1758-UM002D-EN-P - October 2010
Rockwell Automation Support Rockwell Automation provides technical information on the Web to assist you in using its products. At http://www.rockwellautomation.com/support/, you can find technical manuals, a knowledge base of FAQs, technical and application notes, sample code and links to software service packs, and a MySupport feature that you can customize to make the best use of these tools.
