17
ELM0098A All efforts have been made to ensure the accuracy and completeness of the information contained in this document. RST Instruments Ltd reserves the right to change the information at any time and assumes no liability for its accuracy. Copyright © 2019. RST Instruments Ltd. All rights reserved. Document Number: ELM0098A Release Date: August 27, 2019 RTU Host Instruction Manual

RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

  • Upload
    others

  • View
    31

  • Download
    0

Embed Size (px)

Citation preview

Page 1: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

ELM0098A

All efforts have been made to ensure the accuracy and completeness of the information contained in this document. RST Instruments Ltd reserves the right to change the information at any time and assumes no liability for its accuracy. Copyright © 2019. RST Instruments Ltd. All rights reserved.

Document Number: ELM0098A

Release Date: August 27, 2019

RTU Host

Instruction Manual

Page 2: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page i

REVISION TABLE

Rev. Revision History Date Prepared By

Approved By

A Initial release 2019-08-27 MP PL, HC

Page 3: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page ii

TABLE OF CONTENTS

1 INTRODUCTION ............................................................................................................ 1

2 HOST SYSTEM REQUIREMENTS .................................................................................... 1

2.1 PC Hardware .................................................................................................... 1

2.2 Windows Host Operating System ...................................................................... 2

3 QUICK START INSTRUCTIONS ....................................................................................... 2

3.1 Software Installation .......................................................................................... 2

3.2 Help System ..................................................................................................... 2

4 OPERATION ................................................................................................................ 3

4.1 Connection Status ............................................................................................. 3

4.2 RTU .................................................................................................................. 3

4.3 Wireless ............................................................................................................ 3

4.3.1 Advanced Settings .................................................................................. 4

4.4 Data File Folder ................................................................................................ 4

4.5 Interval .............................................................................................................. 4

4.6 Base Date Time ................................................................................................ 4

4.7 Software Update Check .................................................................................... 5

4.8 Logger Configuration Display and Modification ................................................. 5

4.8.1 Display Logger Configuration .................................................................. 5

4.8.2 Display Logger Calibration ...................................................................... 5

4.8.3 Save All Logger Configurations to File .................................................... 7

4.9 Logger Configuration Update ............................................................................ 7

4.9.1 Clear All Logger Configuration ................................................................ 8

4.9.2 Add All Logger Configuration .................................................................. 8

4.9.3 Add Customized Logger Configuration .................................................... 8

4.9.4 Add Selected Logger Configuration ........................................................ 9

5 TROUBLESHOOTING .................................................................................................... 9

5.1 Connection Problems ........................................................................................ 9

5.2 Software Stability ............................................................................................ 10

5.3 Manual RTU USB Driver Set Installation ......................................................... 10

5.4 RST Contact ................................................................................................... 13

Page 4: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page iii

LIST OF FIGURES

Figure 1-1 RSTAR configuration diagram ................................................................................... 1

Figure 4-1 Main window ............................................................................................................. 3

Figure 4-2 RTU advanced settings dialog box ............................................................................ 4

Figure 4-3 Logger configuration dialog ....................................................................................... 5

Figure 4-4 Logger calibration display dialog ............................................................................... 6

Figure 4-5 Logger configuration snapshot file............................................................................. 7

Figure 4-6 Logger configuration update dialog box .................................................................... 8

Figure 5-1 New hardware wizard for device ............................................................................. 11

Figure 5-2 Accepting the End User License Agreement ........................................................... 11

Figure 5-3 New hardware wizard for device – installation complete ......................................... 12

Figure 5-4 New hardware wizard for device – installation complete ......................................... 12

Figure 5-5 Windows 7, 8, 8.1, and 10 device manager ............................................................. 13

LIST OF TABLES

Table 5-1 Status messages...................................................................................................... 10

Page 5: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page 1

1 INTRODUCTION

The RSTAR Array Radio Series (RSTAR) uses wireless technology to provide continuous data acquisition from RST field instruments to RST data loggers. The RSTAR Nodes use the same star topology at the sensor level as a continuously active RTU Hub. The individual Nodes are accessed via ModBus RTU commands from an RTU Hub interfaced with a FlexDAQ data logger. The RTU Hub is based on 900 MHz-, 868 MHz-, and 2.4 GHz-spread spectrum bands (the spectrum band used depends on the country in which it is deployed), with an extensive open-country range through use of a simple dipole antenna. A complete RSTAR system is packet-oriented and consists of RSTAR Nodes (slaves) and an RTU Hub (master). The RSTAR Nodes wake from low-power sleep to collect data from their attached sensors, such as RST’s Vibrating Wire Piezometers. This data, which includes the module address, hub address, sensor module serial number, diagnostics, data, and CRC check, is then sent wirelessly as a packet to the RTU Hub. Upon receipt by the FlexDAQ, the RTU Hub will issue an ACK signal which may include clock synchronization and rate data. The RTU Hub stores the data in a temporary register set that is overwritten as new data is received; there is an intermediate data logging function in the RSTAR Node. The data logger within the FlexDAQ has the ultimate responsibility for logging data.

FIGURE 1-1 RSTAR CONFIGURATION DIAGRAM

RTU Host software allows users to easily edit settings using a familiar Windows graphical interface. All RTU Hub configurations can be viewed and edited.

2 HOST SYSTEM REQUIREMENTS

2.1 PC HARDWARE

The following hardware is required on the desktop or laptop computer that will run RTU Host:

• Intel or AMD processor, and

Page 6: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page 2

• USB Port

2.2 WINDOWS HOST OPERATING SYSTEM

The following Microsoft™ Windows Operating Systems are currently supported:

• Windows Server 2008 (x86 and x64),

• Windows 7 (x86 and x64),

• Windows Server 2008 R2 (x64),

• Windows 8 (x64),

• Windows Server 2012 R2 (x64),

• Windows 8.1 (x64), and

• Windows 10 (x86 and x64).

3 QUICK START INSTRUCTIONS

The following section provides brief instructions to assist with the installation of RTU Host.

3.1 SOFTWARE INSTALLATION

1 Run the software installation file RTUHost_Setup_X.XX.X.exe, where X.XX.X indicates the current software version. The most recent version can be downloaded from https://rstintruments.com/rst-software/software-rstar.

2 Follow the on-screen prompts to install the software. The default directory is C:\Program Files (x86)\RST Instruments\RTU Host.

3.2 HELP SYSTEM

An extensive Help System can be accessed any time by pressing F1 or the Help icon. Answers to common problems and troubleshooting tips can be found by browsing through the help topics or searching using keywords.

NOTE: THE RTU HOST SOFTWARE REQUIRES A SET OF DRIVERS INSTALLED ON THE

HOST COMPUTER IN ORDER TO COMMUNICATE OVER A USB COMMUNICATION PORT. IF

AUTOMATE DRIVER UPDATES ARE ENABLED AND AN INTERNET CONNECTION IS

AVAILABLE, RST USB DRIVERS WILL BE DOWNLOADED FROM MICROSOFT™ WINDOWS

UPDATE SERVER AND INSTALLED AUTOMATICALLY. IF THE DRIVERS NEED TO BE

INSTALLED MANUALLY, PLEASE SEE SECTION 5.3.

Page 7: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page 3

4 OPERATION

RTU Hub status and settings can be accessed and changed through the Main Window of RTU Host. The following sections discuss some of the features available through the Main Window.

FIGURE 4-1 MAIN WINDOW

4.1 CONNECTION STATUS

Once connected to an RTU Hub, the software will automatically establish a communication link and the “Connected” status will be displayed. If this does not occur, see Section 5 for more information.

4.2 RTU

This section provides information about the currently connected RTU Hub. This includes the serial number, firmware version, board revision, and label. Ensure that the serial number matches what is expected (in this example, the serial number is 03245). If it does not, check the status indicators in the bottom left-hand corner of the window to ensure a connection to the RTU Hub has ben established.

4.3 WIRELESS

This section displays the RSTAR Array Radio Series system configuration settings. The radio module case serial number, power level, RF frequency, and radio module type are all displayed here. For more wireless settings, click on the “Advanced” button.

Page 8: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page 4

4.3.1 Advanced Settings

The Advanced settings dialog can be used to display various system settings (Figure 4-2). Click on “Query RTU” to show the system status. Adjustments of other device settings should only be performed with the assistance of RST Instruments personnel.

FIGURE 4-2 RTU ADVANCED SETTINGS DIALOG BOX

4.4 DATA FILE FOLDER

The Main Window shows the file path of the file data folder. Click on “Browse” to change the destination. By default, data files are saved to: C:\...\My Documents\Multichannel\.

4.5 INTERVAL

The data logging interval can be set in this section. Use the arrow buttons to scroll up or down through pre-set values to select the desired logging interval.

4.6 BASE DATE TIME

This section allows the user to set the date and Time for the RTU Hub. Clicking on “Sync to Computer Date/Time” and then “Apply” will synchronize the clock in the RTU to the connected PC. Checking the “Auto Sync Date / Time” checkbox will update the RTU’s internal clock each time the “Update RTU” button is pressed.

Page 9: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page 5

4.7 SOFTWARE UPDATE CHECK

Click on “Software Update Date” and then on “Check now” to determine whether software updates are available for automatic download and installation. To change the online update options, click on “Update Options”.

4.8 LOGGER CONFIGURATION DISPLAY AND MODIFICATION

The RTU Hub retains a copy of the configuration of each connected logger. The RTU Host software allows the user to display and modify the settings of each logger save in the RTU’s memory.

4.8.1 Display Logger Configuration

Click on the “Logger Config Display” button. The Logger Configuration dialog will open (Figure 4-3).

FIGURE 4-3 LOGGER CONFIGURATION DIALOG

4.8.1.1 Logger Selection

Use the drop-down list to select one of the loggers saved in the RTU’s memory.

4.8.1.2 Selected Logger

This section displays information about the currently selected data logger. This includes the type of logger, the serial number, and the data ID.

4.8.2 Display Logger Calibration

Click on the “Logger Cal” button on the Logger Configuration dialog box to display the calibration settings of the currently selected data logger (Figure 4-4).

Page 10: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page 6

FIGURE 4-4 LOGGER CALIBRATION DISPLAY DIALOG

4.8.2.1 Selected Logger

This section provides information about the currently selected data logger, including logger type, serial number and data ID.

4.8.2.2 Linear Conversion

This section shows the linear conversion calibration coefficients.

4.8.2.3 Polynomial Conversion

This section displays the polynomial conversion calibration coefficients.

4.8.2.4 Temperature Correction

The temperature correction factor and an initial temperature reading are shown in this section, if temperature correction was enabled in the logger.

4.8.2.5 Units Conversion

If the units conversion was enabled on the data logger, the selected choices will be displayed in this section:

Unit type: Pressure, distance, force, strain, VW temp, incline, or custom units.

Input units: These are the units of the calibration that were recorded into either the linear conversion or

Page 11: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page 7

polynomial conversion methods. In general, the calibration constants reported on instrument calibration sheets are either in kPa/B units or psi/B unit, depending on the type of instrument. In the case of strain gauges, however, this could be mm/B unit.

Output units: These are the units that have been selected as output. The conversion will be done automatically, resulting in the desired unit being recorded in the downloaded file data.

Output offset: This is a user-defined offset value. For example, in certain circumstances, the user may wish to enter in the elevation of a given pressure transducer. This way, the reported pressure will be correlated to a reference elevation (i.e. above sea level).

4.8.3 Save All Logger Configurations to File

Click on “Save All Config To File” to generate a snapshot of all logger configurations (Figure 4-5). This snapshot can then be saved to file, if desired.

FIGURE 4-5 LOGGER CONFIGURATION SNAPSHOT FILE

4.9 LOGGER CONFIGURATION UPDATE

To help with any RSTAR system modifications and upgrades, the RTU Host software provides users with the option to remove recorded configurations for selected loggers by clicking on “Logger Config Update” on the Main Window. In the Logger Configuration

Page 12: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page 8

Update dialog box (Figure 4-6), users are also able to add default configurations when adding new loggers with known data IDs.

FIGURE 4-6 LOGGER CONFIGURATION UPDATE DIALOG BOX

4.9.1 Clear All Logger Configuration

By clicking on the “Clear All Logger Config” button, users are able to delete all settings saved in the RTU’s memory.

4.9.2 Add All Logger Configuration

Since the RTU Host software retains a copy of the RTU Hub’s configuration during the current software session, all logger configurations can be reloaded back to the RTU’s memory by click on “Add All Logger Config”.

4.9.3 Add Customized Logger Configuration

The default logger configurations can be appended by selecting the logger type and Data ID.

NOTE: THE SOFTWARE RETAINS CONNECTED RTU CONFIGURATIONS DURING THE

CURRENT SOFTWARE SESSION. AFTER THE RTU’S MEMORY IS CLEARED AND THE

SOFTWARE CLOSED, ALL CONFIGURATION DATA IS LOST.

Page 13: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page 9

4.9.4 Add Selected Logger Configuration

Since the RTU Host software retains a copy of the RTU Hub’s configuration during the current software session, the configuration of the selected logger can be reloaded back onto the RTU’s memory.

5 TROUBLESHOOTING

5.1 CONNECTION PROBLEMS

Upon launching the RTU Host software, the program will attempt to connect to the RTU Hub using current communications settings. Once connected, the port and status indicators on the Main Window turn green and the Main Window should display the RTU Hub information.

The connection status is displayed on the status bar. If the connection fails (i.e. the status indicators are red or yellow, or the dialog screen shows no status data), take note of the message and the number displayed and then find the corresponding description in the table below.

NOTE: CLICK ON THE “RELOAD” BUTTON TO RECONNECT THE RTU HUB AND LOAD THE

CURRENT RTU CONFIGURATION SETTINGS TO THE RTU HOST PROGRAM.

Page 14: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page 10

TABLE 5-1 STATUS MESSAGES

# Status Message Description

1 Communication port open The communication port is open

2 Unable to open communication port Some other application is using the port

3 Connecting to the RTU RTU Host is trying to connect to the RTU Hub

4 Connection not established RTU Host was unable to connect to the RTU Hub

5 Connection established to the RTU RTU Host was able to connect to the RTU Hub

6 Reading RTU settings All logger settings are copies to eh RTU Host for display

7 Error during settings read An error occurred during settings read

8 Idle Idle time between the status or data reads

9 New RTU Hub detected An RTU Hub has been exchanged with another RTU Hub

10 RTU settings successfully read All logger settings were successfully transferred to the RTU Host

11 Error reading logger settings An error occurred during reading logger settings

12 Connection error Connection attempts timed out

15 Error during settings write An error occurred while writing settings to the RTU Hub

5.2 SOFTWARE STABILITY

The RTU Host real-time readout relies on continuous data transmission over a serial communication port. This transmission may occasionally be interrupted by other computer activity, resulting in the program freezing or displaying erroneous data. If this happens, the RTU Host program needs to be shut down and restarted. Always exit the RTU Host program when changing RTU Hubs or reconnecting a USB communication cable.

5.3 MANUAL RTU USB DRIVER SET INSTALLATION

In the event that the USB drivers need to be reinstalled, follow the steps below to manually install the RTU Controller Driver Set on Microsoft™ Windows 7, 8, 8.1, and 10 platforms.

1 After the RTU Host software has been installed, click on “Install USB Drivers” in the “Tools” section of the RTU Host program group. The RTU Host group should reside under “RST Instruments” in the Start menu by default.

2 The USB driver setup starts by displaying the following dialog box:

Page 15: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page 11

FIGURE 5-1 NEW HARDWARE WIZARD FOR DEVICE

3 Click “Next” to proceed with the USB driver installation.

4 Select your acceptance of the RST Instruments End User License Agreement and click “Next.

FIGURE 5-2 ACCEPTING THE END USER LICENSE AGREEMENT

Page 16: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page 12

FIGURE 5-3 NEW HARDWARE WIZARD FOR DEVICE – INSTALLATION COMPLETE

FIGURE 5-4 NEW HARDWARE WIZARD FOR DEVICE – INSTALLATION COMPLETE

5 After the successful installation of the USB to UART device drivers, the RTU Hub should be connected to the host computer. The Microsoft™ Windows system should detect the new device and display the message balloon in the lower right-hand corner stating that all device drivers are installed and ready to use.

6 Open the Device Manager (located in the “Control Panel\System”, click “Device Manager”) and expands “Ports” branch. The device appears as “RST RTU RSTAR USB to UART” (Figure 5-5).

Page 17: RTU Host Instruction Manual · • Windows Server 2008 (x86 and x64), • Windows 7 (x86 and x64), • Windows Server 2008 R2 (x64), • Windows 8 (x64), ... connection to the RTU

RTU Host Instruction Manual

ELM0098A RST Instruments Ltd. Page 13

FIGURE 5-5 WINDOWS 7, 8, 8.1, AND 10 DEVICE MANAGER

7 If the driver was installed correctly, the RST RTU USB to UART port will appear, as shown in Figure 5-5. If it was not installed correctly, a yellow exclamation mark will appear next to the device on the Device Manager.

8 Once the installation has been verified, note the COM number which has been assigned to the USB serial port. This will vary from computer to computer. In the example shown in Figure 5-5, the COM number is COM32.

9 Close the Device Manager and launch the RTU Host software. The RTU Host software should now connect to the RTU Hub. Confirmation of the connection can be seen in the bottom left-hand corner of the Main Window (Figure 4-1).

5.4 RST CONTACT

For additional assistance, contact RST Instruments directly.