User’s Manual WX1 GateMODBUS IM WX1-05E 7th Edition
This manual describes the functions and operating procedures of GateMODBUS. To ensure correct use, please read this manual thoroughly before beginning operation. After reading the manual, keep it in a convenient location for quick reference in the event a question arises. GateMODBUS is a software program that uses the Modbus protocol to acquire data from measurement instruments and transfer that data to DAQLOGGER or Remote Monitor.
Software License Agreement IMPORTANT - PLEASE READ CAREFULLY BEFORE INSTALLING OR USING: THANK YOU VERY MUCH FOR SELECTING SOFTWARE OF YOKOGAWA ELECTRIC CORPORATION ("YOKOGAWA"). BY INSTALLING OR OTHERWISE USING THE SOFTWARE PRODUCT, YOU AGREE TO BE BOUND BY THE TERMS AND CONDITIONS OF THIS AGREEMENT. IF YOU DO NOT AGREE, DO NOT INSTALL NOR USE THE SOFTWARE PRODUCT AND PROMPTLY RETURN IT TO THE PLACE OF PURCHASE FOR A REFUND, IF APPLICABLE. Software License Agreement 1.
Software License Agreement 5. Infringement 5.1 If you are warned or receive a claim by a third party that the Software Product in its original form infringes any third party's patent (which is issued at the time of delivery of the Software Product), trade mark, copyright or other intellectual property rights ("Claim"), you shall promptly notify Yokogawa thereof in writing. 5.
Overview of This Manual Structure of This Manual This user’s manual consists of the following chapters. Chapter 1 Title Overview 2 Operating Procedure 3 Detailed Description of Functions Index Description Gives an overview of the GateMODBUS software. Lists the PC requirements for running Gate-MODBUS and gives information about system configuration. Gives procedures for entering environment and data logging interval settings, and how to monitor the operational status of the software.
1 Contents Software License Agreement............................................................................................................. ii Overview of This Manual.................................................................................................................. iv Chapter 1 Overview 1.1 1.2 Chapter 2 Overview of GateMODBUS Functions.................................................................................. 1-1 System Overview.............................................
Chapter 1 Overview 1.1 1 Overview of GateMODBUS Functions Features • • • • Runs as a Windows application. Supports the Modbus/RTU (serial) and Modbus/TCP (Ethernet) protocols. Allows you to read the input and holding registers from various measuring instruments. Measurement can be performed at intervals of up to 0.5 seconds*. * IM WX1-05E However, DAQLOGGER’s shortest interval is 1 second. Also, the maximum speed of 0.
1.2 System Overview System This software can perform data logging when connected with instruments (devices) meeting the following criteria. • The ability to perform communications using the Modbus/RTU (serial) or Modbus/TCP (Ethernet) protocol. • For serial communications, the ability to operate under a baud rate of 4800, 9600, 19200, or 38400. • The ability to read registers using one or both of the following two Modus function codes.
1.2 System Overview A video card that is recommended for the OS and a display that is supported by the OS, has a resolution of 1024×768 or higher, and that can show 65,536 colors (16-bit, high color) or more. Note An RS-232 to RS-422-A/RS-485 converter is required to perform communications between the software and another Modbus device via RS-422-A/RS-485 (Yokogawa ML2 RS232C/RS485 converter recommended).
1.2 System Overview System Configuration GateMODBUS TCP/IP connection Monitor server protocol Data transfer Remote monitor Converter Ethernet Ethernet RS-422-A/RS-485 PV 2 SP 3 4 SP AL 1 2 3 MAN A/M SET/ENT Modbus/RTU devices JUXTA (VJET), Temperature controllers Modbus/TCP devices It is recommended that you run GateMODBUS and DAQLOGGER on separate PCs depending on the number of devices that the system supports and other factors affecting the load.
Chapter 2 2.1 Operating Procedure 1 Running and Exiting GateMODBUS Running the Software 2 Procedure GateMODBUS > GateMODBUS. Operating Procedure 1. From the Windows Start menu, choose Programs > YOKOGAWA DAQWORX > 3 The GateMODBUS Configurator opens. Index Note • • When you start GateMODBUS, it is restored to the same status that was active during the previous session. If the program is closed while a process or service is running, the license will be considered to be “in use.
2.2 Entering Environment Settings The following settings can be entered using the configurator. • Serial port and Ethernet port settings (Serial Setting tab) • Data acquisition conditions, communication retry (Scan Interval tab) • Tag settings (Tag Setting tab) • Group settings (Group Setting tab) • TCP/IP settings for the monitor server port (Port Setting tab) Serial Port Settings Procedure 1. Click the Comm. Setting tab or choose View > Comm. setting from the menu bar.
2.2 Entering Environment Settings 5. Enter the IP address or host name and port number. (The default port number for 1 Modbus/TCP is 502. Use this port number if no particular setting is required by the instrument.) 2 Data Acquisition Conditions, Communication Retry 1. Click the Scan Interval tab or choose View > Scan Interval setting from the menu bar. Operating Procedure Procedure 3 Index 2. Set the scan interval, timeout time, and number of retries. Logging interval: 0.5–3600 sec.
2.2 Entering Environment Settings Tag Settings Procedure 1. Click the Tag Setting tab or choose View > Tag setting from the menu bar.
2.2 Entering Environment Settings 1 Group Settings Procedure 1. Click the Group Setting tab or choose View > Group setting from the menu bar. 2 Operating Procedure 3 Select/deselect all items Click here to display the Tag No. dialog box.
2.3 Saving and Restoring Environment Settings Saving Environment Settings Procedure 1. Click the Save button or choose File > Save from the menu bar. Save button The current settings are saved. Restoring Environment Settings This procedure clears all settings currently being entered and restores the most recently saved settings. Procedure 1. Choose File > Revert from the menu bar.
2.4 1 Reading Data from a Modbus Device and Transferring the Data as the Monitor Server Note The maximum number of DAQLOGGERs or Remote Monitors that can be connected at once is 16. Running the Executable Function Procedure 1. Enter environment settings. (See section 2.2, “Entering Environment Settings.”) Running from the Menu Bar 2. To run the function as a process, click the Process Execution button or choose Execute > Process from the menu bar.
2.4 Reading Data from a Modbus Device and Transferring the Data as the Monitor Server Running the Executable Function from the Practice/Status Tab 2. Select the type of execution from the Practice/Status tab, then click the Practice button. The Practice Status item displays “Process” or “Service,” as well as the names of connected clients, the connection status, and the addresses of disconnected DAQLOGGERS and Remote monitors. Stopping the Executable Function Procedure Stopping from the Menu Bar 1.
2.5 1 Performing the Loop Back Test Performing the Loop Back Test 2 Operating Procedure Note The loop back test or service cannot be performed while other processes or a services are running. 3 Procedure Index 1. Choose Test > Loop Back Test from the menu bar. The Loop Back Test dialog box opens. Select/deselect all items Drag to select a range of items 2. Drag to select the addresses on which you wish to perform the loop back test. 3. Click Practice.
2.5 Performing the Loop Back Test Executing the Test Procedure Starting the Test 1. Choose Test > Test from the menu bar. The Test Exec dialog box is displayed. Select/deselect all items Drag to select a range of items 2. Drag to select the tag numbers on which you wish to perform the test. 3. Click Practice. The scaled result is displayed. Stopping the Test 4. Click STOP. The test stops.
2.6 Viewing the Status of the Executable Function and Retrying Communications Viewing the Status of the Executable Function 1 2 Procedure bar. Operating Procedure 1. Click the Practice/Status tab or choose View > Execution/Status from the menu 3 The practice type, practice status (running as process, running as service, or stopped), client connection status, and communication cutting addresses are displayed.
2.6 Viewing the Status of the Executable Function and Retrying Communications Note • • • Click the Start button to download data from the Modbus devices. The interval at which data is downloaded is determined by the data acquisition conditions (scan interval, timeout time, and number of retries). If a warning message is displayed (code Wxxxx), the lamp that displays the connection status by color does not blink red. When an error occurs and the lamp blinks red, the Error Indicator dialog box appears.
2.7 1 Viewing Version Information Procedure 2 1. Click the About button or choose Help > About from the menu bar. Operating Procedure The Version dialog box opens.
Chapter 3 3.1 Detailed Description Functions 1 Overview GateMODBUS performs serial communications with Modbus devices and acquires data at regular intervals. Through the monitor server function, the acquired data is transferred to DAQLOGGER or Remote Monitor via Ethernet. The following is a list of the features of each software function.
3.1 Overview Executable Function Features of the executable function are as follows: • Running as a process and as a service is possible. • Data is acquired from Modbus devices at regular intervals. • Retries communications. • Runs as a monitor server if DAQLOGGER or Remote Monitor is the client.
3.2 1 Detailed Description of Functions 2 Communication Port The communications ports available to GateMODBUS are the COM1–COM9 serial (RS-232) ports the Ether1 to Ether16 Ethernet ports. The following items are specified in the Serial Setting tab. Serial port setting Index Ethernet port setting • IP address or host name • Password Note The Modbus protocol’s RTU (remote terminal unit) mode prescribes stop bit 2 for no parity, and stop bit 1 for odd or even parity.
3.2 Detailed Description of Functions Logical Configuration Item Tag Group Description Indicates one data item. Assigns tags. Up to 32 tags can be assigned to a group. Limit 300 50 Logical Configuration Diagram GateMODBUS TAG001 TAG002 Assignments Group TAG003 TAG004 Tag Group TAG200 Acquisition Conditions The following items are included in the acquisition conditions. • Data scan interval (0.
3.2 Detailed Description of Functions Tag Name Enter a tag name as needed. You can enter up to 16 alphanumeric characters. Tags can be downloaded (tag data is received) using a DAGLOGGER tag software or Remote Monitor that is connected to GateMODBUS. 1 2 Unit Enter a unit as needed. You can enter up to 6 alphanumeric characters. The unit string is the unit string on the DAQLOGGER or Remote Monitor connected to GateMODBUS. Enter a decimal place of 0, 1, 2, 3, or 4.
3.2 Detailed Description of Functions Group Names You can assign names to groups. Names can contain up to 30 alphanumeric characters. The group names specified here are the default values when Remote Monitor is connected to GateMODBUS. Acquiring Data at Fixed Intervals Using GateMODBUS, data can be acquired concurrently on each port. Therefore data is logged more efficiently when connecting each Modbus device to a separate port rather than connecting several Modbus devices to a single port.
3.2 Detailed Description of Functions In this case, as much time as possible must be given to interval ∆T to acquire all tags assigned to the port. • When data reading times out due to such instances as noise interference during communication, or when a Modbus device’s power turns OFF In the figure below, with the data reading at time T, the reading of all tags occurs within the logging interval ∆T, but with data reading at time T1, TAG0003 times out, and data reading at time T2 is dropped.
3.2 Detailed Description of Functions Data Type With the Modbus protocol, the data type within the read registers is not defined. Therefore, the data type in the read registers depends on the Modbus device’s manufacturer. GateMODBUS supports the following data types. Signed 16–Bit Integer (INT16) Enter this setting if a signed 16–bit integer is assigned to the Modbus device registers.
3.2 Detailed Description of Functions GateMODBUS tag data Modbus registers Register number (small) Unsigned 32–bit integer (high) Unsigned 32–bit integer (low) 2 Register number (large) Enter this setting if an unsigned 32–bit integer is assigned to the Modbus device registers and the register numbers are assigned from low to high starting with the smallest register.
3.2 Detailed Description of Functions Data Scaling There are times when the values obtained by reading registers during Modbus communication are not physical values. GateMODBUS performs the following calculations on Modbus register values. X=A•x+B X: calculated result x: Modbus register value A: Coefficient B: Offset The user can specify a desired value for coefficient A and offset B above using the configurator.
3.3 1 Messages and Corrective Actions Error Message Cannot write to file. Cannot read file. E213 Cannot open file. E401 Communication error. E402 E403 E1010 Communication timeout. Cannot open a communication port. Invalid license number. Please reinstall the software. Execution of a process failed. E1011 Execution of a service failed. E501 Corrective Actions Check if the disk capacity is sufficient or if the file systems is normal.
Index 1 Index A S acquiring data at fixed intervals............................................. 3-6 acquisition conditions............................................................ 3-4 saving environment settings.................................................. 2-6 serial port............................................................................... 3-3 Serial Port Settings................................................................ 2-2 software configuration...............................
