Electronic Valve Actuator. SEVA Modbus RTU Communication Protocol Setup. User Manual. RCV-UM EN-01 (September 2018)

Transcription

1 Electronic Valve Actuator SEVA Modbus RTU Communication Protocol Setup RCV-UM EN-01 () User Manual

2 Electronic Valve Actuator, SEVA Modbus RTU Communication Protocol Setup CONTENTS Scope of This Manual 3 Supported Features 3 SoloCUE Flow Device Manager Software 3 Supported Features 3 Wiring 4 RS485 Output 4 Communication Settings 5 Setting IP Address and Subnet Mask 5 Registers/Starting Address 7 Function Codes 7 Word Order/Endian 7 Modbus Registers 8 Holding Registers 8 Troubleshooting 9 Page 2 RCV-UM EN-01

3 Scope of This Manual SCOPE OF THIS MANUAL This document describes the supported features of Modbus RTU and how these features are related to the Smart Electronic Valve Actuators (SEVA). This document also describes the type of data that is accessible over Modbus RTU and any special considerations. This document is intended for readers who have a general understanding of Modbus RTU protocol. This document is intended to complement other documentation for SEVA 100 and SEVA 200. Supported Features The Modbus RTU card on the SEVA 100 and SEVA 200 supports Modbus RTU messaging for commonly used parameters in the device. SoloCUE Flow Device Manager Software Go to our website, to download the software. Supported Features The Smart Electronic Valve Actuators (SEVA) have an option for the Modbus RTU protocol with an EIA-485 port. This document describes the type of data that is accessible over Modbus RTU and any special considerations. This document is intended for readers who have a general understanding of Modbus RTU. This document is intended to complement other documentation for SEVA 100 and SEVA 200. RCV-UM EN-01 Page 3

4 Wiring WIRING WARNING DO NOT OPEN WHILE AN EXPLOSIVE ATMOSPHERE IS PRESENT. DISCONNECT POWER BEFORE OPENING. AVERTISSEMENT NE PAS OUVRIR DANS UNE ATMOSPHÈRE EXPLOSIVE. DÉCONNECTER LA SOURCE D'ALIMENTATION AVANT L'OUVERTURE. The optional Modbus RTU card can be ordered with the SEVA 100 and SEVA 200 units and includes an EIA-485 port. The Modbus RTU option comes with an additional board to simplify wiring in the field. To install the Modbus RTU wiring: 1. Thread the Modbus RTU wiring through the cable port on the right side of the actuator. 2. Wire the adapter terminal board according to the chart below. Terminal Signal Description 1 GND Bus polarization, ground (isolated) 5 B-Line RS-485 B-Line (+) 9 A-Line RS-485 A-Line (-) Terminal 9 Terminal 5 Terminal 1 Cable Entry 3. When the terminal board is wired, connect it to the Modus RTU protocol card on the SEVA control board. 4. Slide a mini flat head screwdriver (1/8 in.) through the cable entry to secure the terminal board adapter. Push-button 1 Push-button 2 Push-button 3 Push-button 4 Rotary switch USB J4 Analog I/O 9 - AOUT GRN 8 - AOUT SHIELD 6 - AIN_GND 5 - AIN 1+ Protocol daughter board RS485 Output The RS485 feature allows up to 126 transmitters to be placed on a single three-wire cable up to 4000 feet. All transmitters are assigned a unique numeric address that allows all of the transmitters on the cable network to be independently accessed. The RS485 transmitter is galvanically isolated to prevent current flow to the other SEVA boards. Use a shielded twisted-pair cable no less than 24 AWG for connecting devices on an RS485 network. Page 4 RCV-UM EN-01

5 Communication Settings COMMUNICATION SETTINGS You can download SoloCUE (the setup software for SEVA) from Before using the software, make sure that the USB programming cable is connected to the SEVA and the computer with the software. While connected, the frequency outputs are disabled. Setting IP Address and Subnet Mask To set up the meter for Modbus RTU. 1. Press + to add device or select Device > Add Device from the menu bar. 2. Select either Auto or Manual scan mode to identify the SEVA device. For the Manual mode, select the Com Port the device is connected to, then select the Baud Rate. 3. Click Scan to find the device. RCV-UM EN-01 Page 5

6 Communication Settings 4. Click the checkbox under Add to Device List. 5. Click OK to add the selected device. The Device Setup screen displays. 6. Select the Communication tab. 7. Verify that the baud rate, parity, stop bits and word order (endian) match the master device. Set the address (1 127). Use the table in Holding Registers on page 7 to map each address. Select which parameters the master device can write to: All coil outputs and read/write holding registers Coil outputs only (resets) None (read only). Page 6 RCV-UM EN-01

7 Registers/Starting Address REGISTERS/STARTING ADDRESS It is important to know whether the master device uses function codes with starting addresses or registers/coils. It is important to know whether the master device uses starting addresses or registers/coils as these numbers are offset by 1. For example, holding register is starting address 00 (hex). Function Codes The SEVA 100 and 200 transmitter support the following function codes as applicable: Function Code 3 Read Holding Registers 4xxxx Address Range (Holding Registers Function Code 6 Single Register 4xxxx Address Range (Holding Registers Function Code 17 Report Slave ID Identification string with Manufacturer, Firmware Version and Model Code. Word Order/Endian Each Modbus holding register represents a 16-bit integer value (2 bytes). The official Modbus standard defines Modbus as a big-endian protocol where the most significant byte of a 16-bit value is sent before the least significant byte. For example, the 16-bit hex value of 1234 is transferred as Beyond 16-bit values, the protocol itself does not specify how 32-bit (or larger) numbers that span over multiple registers should be handled. It is very common to transfer 32-bit values as pairs of two consecutive 16-bit registers in little-endian word order. For example, the 32-bit hex value of is transferred as The register bytes are still sent in bigendian order per the Modbus protocol, but the 16-bit registers are sent in little-endian order. As long as the transferring and receiving device transmit the data in the same manner, it does not matter in which order the words are sent. The word order is fixed to little Endian in the SEVA. RCV-UM EN-01 Page 7

8 Modbus Registers MODBUS REGISTERS Holding Registers Instance Name Description ADI No. (Instance#) Holding Register ID Decimal Register Hex Access Data Type No. of Bytes Min Value Max Value Enumeration 1 FdBk Pos Perc Feedback signal in percent of span 0x Read Float N/A 2 Calc Thrust Instantaneous calculated thrust value (LBF) 0x Read Float /200 N/A 3 Calculated Instantaneous calculated speed Speed (steps/sec) 0x Read Float N/A 4 Max Thrust Maximum thrust capacity at current Cap speed setting 0x Read Float /200 N/A 5 Max Speed Current maximum speed setting 0x Set Float N/A 6 Cmd Pos Commanded position in percent 0x Perc of span Float N/A 7 Tag Info Device tag information 0x Char 16 N/A 8 Temperature C Internal device temperature ( C) 0x Read Float 4 N/A 9 Triple Point Status of the triple point input 0x Read Enum = No change 1 = Open 2 = Close 3 = Inactive 4 = Mid 10 Serial Number Device serial number 0x2A Read Char 16 N/A 11 Version Number Device firmware version 0x2B Read Char 16 N/A 12 Hardware Rev Device hardware revision 0x2C Read Char 16 N/A 13 Model Code Device model code 0x2D Read Char 16 N/A 14 Device Descrip Device description 0x2E Read Char 16 N/A 0 = Close 30 1 = Open Response of device upon command Sig. Loss 2 = Hold Position singal loss (functional in 4-20 Run 0x3E Enum Config mode Only) 3 = Target Value Sig. Loss Value Fail Safe Config Fail Safe Value Fail Safe Time Target value upon signal loss in percent of span Response of device upon loss of AC main power (24V DC backup power must be present) 0x3F x Target value upon power loss 0x Delay time in seconds following a loss of power before fail safe action occurs 0x Float N/A Enum = Inactive (off) 1 = Close 2 = Open 3 = Hold Position 4 = Target Value Float N/A Float N/A Page 8 RCV-UM EN-01

9 Troubleshooting TROUBLESHOOTING Symptoms Possible Causes Recommended Action No communication Transmit and receive are Check the network wiring from the meter. wired incorrectly. Baud rate does not match master. Check the baud rate of the master and ensure the baud rate of the meter matches the master. The master is often a PLC or BAS. If it does not match, change the Baud Rate setting in the Modbus RTU Communication menu. Parity and stop bits do not Check that the settings are compatible with the master. If it does not match, change Intermittent communication Unable to read specific parameters correctly Unable to write specific parameters match the master Slave address is not unique. Another device is on the network with the same address Cable is not terminated properly Cable or chain longer than 4000 feet Cable is not properly shielded Cable routed near power cables such a variable frequency drives Cable is not terminated properly Cable or chain longer than 4000 feet Word order (endian) or data type/format Transmitter is set up for read only or is set up for read and write only to resets Word order (endian) or data type/format the Parity or Stop Bit setting in the Modbus RTU Communication menu. Check the addresses of the other devices on the network. Check that the slave address is not 1. For Modbus RTU on EIA-485 network, devices can be daisy chained together. The two devices on the end of the chain need to have terminated resistors. Terminating resistors can be enabled through the Modbus RTU Communication menu. For Modbus RTU on EIA-485 network, the full length of the network cannot exceed 4000 feet. Check the length of the cabling. Communication cables must have shielding to protect the quality of the communication signals from electromagnetic interference (EMI). Check that the cable has a shield. Typically, one end of the shield drain is connected to a clean ground to dissipate EMI and prevent ground loops. However, depending on the ground quality, cable length and type of interference, other methods can be employed. Cables carrying high currents cause a high degree of electromagnetic interference that can interfere with the quality of the communication signals. Route signal cables away from power cables. For Modbus RTU on EIA-485 network, devices can be daisy chained together. The two devices on the end of the chain need to have terminated resistors. Terminating resistors can be enabled through the Modbus RTU Communication menu. For Modbus RTU on EIA-485 network, the full length of the network cannot exceed 4000 feet. Check the length of the cabling. In Modbus RTU, floating point, long integers and string character registers may have the word order (endian) swapped. Check the data type and endian of the master and verify that the register in the meter matches the matches. If it does not match, change the Word Order setting in the Modbus RTU Communication menu. These settings are commonly used to prevent accidental or unauthorized changes to the a device over a network. Check the Access setting in the Modbus RTU menu. In Modbus RTU, floating point, long integers and string character registers may have the word order (endian) swapped. Check the data type and endian of the master and verify that the register in the meter matches the matches. If it does not match, change the Word Order setting in the Modbus RTU Communication menu. RCV-UM EN-01 Page 9

10 Electronic Valve Actuator, SEVA Modbus RTU Communication Protocol Setup INTENTIONAL BLANK PAGE Page 10 RCV-UM EN-01

11 User Manual INTENTIONAL BLANK PAGE RCV-UM EN-01 Page 11

12 Electronic Valve Actuator, SEVA Modbus RTU Communication Protocol Setup Control. Manage. Optimize. Research Control is a registered trademark of Badger Meter, Inc. Other trademarks appearing in this document are the property of their respective entities. Due to continuous research, product improvements and enhancements, Badger Meter reserves the right to change product or system specifications without notice, except to the extent an outstanding contractual obligation exists Badger Meter, Inc. All rights reserved. The Americas Badger Meter 4545 West Brown Deer Rd PO Box Milwaukee, WI México Badger Meter de las Americas, S.A. de C.V. Pedro Luis Ogazón N 32 Esq. Angelina N 24 Colonia Guadalupe Inn CP México, DF México Europe, Eastern Europe Branch Office (for Poland, Latvia, Lithuania, Estonia, Ukraine, Belarus) Badger Meter Europe ul. Korfantego Knurów Poland Europe, Middle East and Africa Badger Meter Europa GmbH Nurtinger Str Neuffen Germany Europe, Middle East Branch Office Badger Meter Europe PO Box Dubai Silicon Oasis, Head Quarter Building, Wing C, Office #C209 Dubai / UAE Slovakia Badger Meter Slovakia s.r.o. Racianska 109/B Bratislava, Slovakia Asia Pacific Badger Meter 80 Marine Parade Rd Parkway Parade Singapore Switzerland Badger Meter Swiss AG Mittelholzerstrasse Bern Switzerland