Instruction Manual for GO SYSTEMELEKTRONIK models including: Modbus Tool.exe for GO Modbus Sensors, Modbus Tool.exe, Tool.exe, GO Modbus Sensors
Modbus Sensor Configuration GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: 49 431 58080-0 Fax: -58080-11 Page 1 / 16 www.go-sys.de info@go-sys.de
BlueTrace - Öl in Wasser Sensor
File Info : application/pdf, 16 Pages, 959.27KB
DocumentDocumentModbus Sensor Configuration DOC 420 6500-E-1.4-BDA Manual Modbus Tool.exe for GO Modbus Sensors Creation date: 19.11.2021 Described software version: 1.07 File name: DOC 420 6500-E-1.4-BDA Modbusconfig.pdf © GO Systemelektronik GmbH 1 Introduction This manual describes the operation of the Modbus configuration program Modbus Tool.exe of GO Systemelektronik in version 1.07 with the article number 420 6500 for the following sensors: Modbus sensor BlueTrace Oil in Water BlueTrace Crude Oil BlueTrace Turbidity BlueEC Conductivity Article number 461 6200 461 6300 461 6780 461 2092 The program automatically recognises the connected Modbus sensors. Modbus Tool.exe is included with the above-mentioned Modbus sensors of GO Systemelektronik. With Modbus Tool.exe you can, for example, read out sensor information, assign a Modbus address, determine the internal amplification of the input signal, calibrate the sensor and display measurement values. The program runs under Windows 7 and newer. An Installation is not necessary; the program starts when Modbus Tool.exe is called up. The products of GO Systemelektronik are constantly being developed, therefore deviations between this manual and the delivered product can result. Please understand that no legal claims can be derived from the contents of this manual. Table of Contents 1 Introduction........................................................................................................................................................................................ 1 2 Preparation ........................................................................................................................................................................................ 2 2.1 Opening the Converter Housing .................................................................................................................................................2 3 Program Properties with Connected Modbus Sensors .................................................................................................................... 3 3.1 The Start Window (Modbus Connection)....................................................................................................................................3 3.2 The Info Window ..........................................................................................................................................................................4 3.3 The Parameter Window...............................................................................................................................................................4 3.4 The BlueTrace Calibration Window............................................................................................................................................7 3.4.1 The Calibration Table ..........................................................................................................................................................8 3.5 The Measurement Value Window ...............................................................................................................................................9 3.6 The Measurement Value Recording Window ...........................................................................................................................11 4 General Modbus Specification for GO Modbus Sensors................................................................................................................. 12 5 BlueTrace Oil in Water 461 6200 Modbus Address Overview ...................................................................................................... 14 6 BlueTrace Turbidity 461 6780 Modbus Address Overview .......................................................................................................... 15 7 BlueEC Conductivity 461 2092 Modbus Address Overview.......................................................................................................... 16 If not, contact GO Systemelektronik GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 www.go-sys.de info@go-sys.de Page 1 / 16 Modbus Sensor Configuration 2 Preparation To enable your PC to communicate with a Modbus sensor, you need a converter from RS485 to USB and driver software. Here, as an example, the Modbus USB converter of GO Systemelektronik (article number 486 S810) with the driver software at: https://ftdichip.com/drivers/d2xx-drivers there ,,D2XX Drivers" The driver software creates a virtual COM port in the Windows system in this example "USB Serial Port (COMn)". A Modbus sensor is connected via the clamp socket strip in slot X1. If a Modbus sensor is to be connected to a BlueConnect module of GO Systemelektronik, the clamp socket strip from the BlueConnect module can be used at slot X1. Exception: If a Modbus sensor is to be connected to the BlueSense Transducer of GO Systemelektronik, the clamp socket strip on the BlueSense Transducer can be used at slot X2. In case of communication problems: Check the earth connection of the converter. Install the latest driver. Earth the converter. This is the only way to ensure trouble-free operation. The earth connection is on the left side of the housing. Converter module circuit board X1 X1 BU WH BN BK GN BK RD BN OR Modbus BlueTrace 461 6200 OiW 461 6780 Turb. Modbus BlueEC Conductivity 461 2092 2.1 Opening the Converter Housing Turn the housing bracket to the right. Loosen the screws (Torx T20). Open housing cover to the left. USB 2.0 and newer GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 www.go-sys.de info@go-sys.de Page 2 / 16 Modbus Sensor Configuration 3 Program Properties with Connected Modbus Sensors Note: Decimal separator is the comma. Modbus Tool V1.07 File Language Exit English Deutsch minimises the window Title bar Menu bar closes the program selects the program language 3.1 The Start Window (Modbus Connection) In the start window you can · establish the connection with your PC via a selected COM Port, · automatically recognise connected Modbus sensors, · and change the Modbus Slave ID of detected Modbus sensors. After starting the program, the Modbus connection window opens. Click on button <Start> . The Select Port window opens. Select the correct COM Port for communication with the converter. Via <Change COM Port> you can afterwards change the COM Port. The program searches for the Modbus Slave ID of a connected Modbus sensor. The starting point of the search is the value entered at . Modbus Tool V1.07 File Language Serial Communication Modbus Start Search for Sensor/Module all > Modbus Change COM Port Modbus Slave ID Reset ID to 1 Change ID COM 1 selected Modbus Slave ID: The value entered here (default value is 1 - quick selection 1 to 16 or input 1 to 230) is the start value from which the program searches for the next Modbus Slave ID of a connected sensor after clicking the <Start> button . If the program does not find a sensor with this Modbus Slave ID, the message "No Modbus sensor was found !!!" appears. Reset to 1: The Modbus Slave ID of a detected Modbus sensor is set to 1 and the value in is set to 1. Change ID: The Modbus Slave ID of a detected Modbus sensor is set to the entered value (1 to 230) and the value in is set to the same value. see 2 Preparation The COM Ports of your PC are displayed in the Windows Device Manager. GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 www.go-sys.de info@go-sys.de Page 3 / 16 Modbus Sensor Configuration 3.2 The Info Window Modbus Tool V1.07 File Language all > Info Serial Communication Modbus BlueTrace Oil in Water Info Parameter Calibration Measuring Data Processing Data Device Firmware Version Serial Number Modbus Slave ID Baudrate Production Date BlueTrace Oil in Water 2.12 99 1 9600 25.10.2021 COM 1 selected After the program has detected the connected sensor (here BlueTrace oil in water), the info window of the sensor opens. 3.3 The Parameter Window BlueTrace Oil in Water > Parameter Modbus Tool 1.07 File Language Serial Communication Modbus BlueTrace Oil in Water Info Parameter Calibration Measuring Data Processing Data RS485 Termination on o ff Gain Coefficients A0 A1 A2 A3 A4 A5 1 -4,975610E-01 1,488027E+00 -9,711752E-02 0,000000E+00 0,000000E+00 0,000000E+00 write changes COM 1 selected RS485 Termination Switches the termination of the Modbus (RS485) on and off. Gain Selection of the internal gain of the input signal from 1 to 128 Coefficients Calibration coefficients, the displayed values are from the calibration function. see 3.4 The BlueTrace Calibration Window write changes Writes the current settings to the sensor memory. Settings that have not yet been saved are marked in red. Note: Decimal separator is the comma; if a dot is entered, an error message appears. GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 www.go-sys.de info@go-sys.de Page 4 / 16 Modbus Sensor Configuration BlueTrace Turbidity > Parameter Modbus Tool 1.07 File Language Serial Communication Modbus BlueTrace Turbidity Info Parameter Calibration Measuring Data Processing Data RS485 Termination on Coefficients Turbidity A0 -4,975610E-01 A1 1,488027E+00 A2 -9,711752E-02 A3 0,000000E+00 A4 0,000000E+00 A5 0,000000E+00 o ff Average filter on Filter length o ff sec Coefficients TSS A0 00 A1 00 write changes COM 1 selected RS485 Termination Switches the termination of the Modbus (RS485) on and off. Coefficients Turbidity Calibration coefficients, the displayed values are taken from the calibration function. see 3.4 The BlueTrace Calibration Window Average filter Filter length Calculates the measurement value as moving average from the measurement values determined in Filter length ( 1 measurement value per second) Coefficients TSS Calculation coefficients TSS write changes Writes the current settings to the sensor memory. Settings that have not yet been saved are marked in red. Note: Decimal separator is the comma; if a dot is entered, an error message appears. BlueTrace Crude Oil > Parameter Like BlueTrace Turbidity > Parameter, but without Coefficients TSS. GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 www.go-sys.de info@go-sys.de Page 5 / 16 Modbus Sensor Configuration BlueEC Conductivity > Parameter Modbus Tool 1.07 File Language Serial Communication Modbus Conductivity Info Parameter Measuring Data Processing Data Measuring Range 0 - 3000 µS 0 - 120 mS RS485 Termination on o ff Temperature Correction Temperature 25 Factor 0,02 TDS Factor 0,67 write range write changes COM 1 selected Measuring range Selection between two measurement ranges write range Writes the selected measuring range into the sensor memory. A selection that has not yet been saved is marked in red. RS485 Termination Switches the termination of the Modbus (RS485) on and off. Temperature Correction Temperature: Temperature value of the temperature compensation, here 25 (default value) Factor: Factor of the temperature compensation, here 0,02 (default value) TDS Factor: Temperature factor calculation TDS, here 0,67 (default value) write changes Writes the current settings to the sensor memory. Settings that have not yet been saved are marked in red. Note: Decimal separator is the comma; if a dot is entered, an error message appears. GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 www.go-sys.de info@go-sys.de Page 6 / 16 Modbus Sensor Configuration 3.4 The BlueTrace Calibration Window BlueTrace Oil in Water / BlueTrace Turbidity > Calibration A calibration compares the value pairs of the measured sensor raw values and allocated reference values from calibration liquids. These value pairs are taken as points in a coordinate system. The curve of a 1. to 5. Order polynomial is placed through these points as accurately as possible; this is how the calibration polynomial is created. Example with a 2. Order polynomial: Calibration table Calibration coefficients Note: BlueEC Conductivity does not have a calibration window. A raw sensor value is the uncalibrated sensor reading. GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 www.go-sys.de info@go-sys.de Page 7 / 16 Modbus Sensor Configuration 3.4.1 The Calibration Table There are two ways to enter the raw values · manual input gives the possibility to calculate hypothetical calibrations · measurement value transfer current measured raw values for the actual calibration Reference values are always entered manually. You can enter up to 10 value pairs. ,,measured value [ppm]" is the reference value of a calibration liquid. Note: Decimal separator is the comma; dots are not accepted. Manual input: not activated: Measure After the first opening of the calibration window, the cali- bration table has only one row. Click with the cursor in the "raw value" cell and enter the first raw value, click with the cursor in the "measured value" cell and enter the first refer- ence value, or vice versa. Measurement value transfer: activated: Measure After the first opening of the calibration window, the cali- bration table has only one row. Click with the cursor on the first row key : As long as the row key is active , the current measured raw value appears in the "raw value" cell. Click with the cursor in the "measured value" cell and enter the first reference value. To create a new line, click with the cursor in the last line wit To delete a line, delete all line entries and click in another line. Row keys AVG Progress bar for the calculation of the measurement value. A measure- only at Oil in Water ment value of the BlueTrace is the result of a moving average of 45 indi- vidual measurements. A single measurement takes place every second Signal Level Display of the signal strength of the bright value (LED on). If the AD converter is overloaded, the display field is highlighted in red. Order: Order means the order/degree of the calibration polynomial. Click on one of the Order buttons 1 to 5 to get the best fit. The graph of the calibration polynomial is displayed. apply coefficients Button, copies the calculated coefficient values into the sensor. When activated, the warning message Attention! Raw value passes 45 seconds average filter appears. see under AVG on this page GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 www.go-sys.de info@go-sys.de Page 8 / 16 Modbus Sensor Configuration 3.5 The Measurement Value Window BlueTrace Oil in Water > Measuring Modbus Tool 1.07 File Language Serial Communication Modbus BlueTrace Oil in Water Info Parameter Calibration Measuring Data Processing Data The measurement value is updated every second. Fluorescence ppm read COM 1 selected read read Starts and stops the measurement display. BlueTrace Turbidity > Measuring Modbus Tool 1.07 File Language Serial Communication Modbus BlueTrace Turbidity Info Parameter Calibration Measuring Data Processing Data The measurement values are updated every second. Turbidity FNU Temperature °C read TSS mg/l Turbidity Raw mV COM 1 selected read read Starts and stops the measurement display. GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 www.go-sys.de info@go-sys.de Page 9 / 16 Modbus Sensor Configuration BlueEC Conductivity > Measuring Modbus Tool 1.07 File Language Serial Communication Modbus Conductivity Info Parameter Measuring Data Processing Data Sensor Assignment Sensor 1 Conductivity Sensor 2 Conductivity uncomp. Sensor 3 Temperature The measurement values are updated every second. µS µS write changes °C read Measuring Range 0 - 3000 µS COM 1 selected You can select five measurement values from each of the three drop-down menus. If the display is activated, the current measurement values of the selection are shown every second. A BlueBox/BlueMon system receives all three selected measured values, a BlueSense Transducer only the first two. write changes Writes the selection to the sensor memory. -none- -noneConductivity Temperature Conductivity uncomp. Salinity TDS Note: This selection is only possible with a sensor firmware version 2.03. Otherwise, standard measurement values are used: Conductivity Temperature Conductivity uncomp. read read Starts and stops the measurement display. Note: Salinity according to the generally valid UNESCO formula for seawater GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 Page 10 / 16 www.go-sys.de info@go-sys.de Modbus Sensor Configuration 3.6 The Measurement Value Recording Window Modbus Tool 1.07 File Language Serial Communication Modbus BlueTrace Oil in Water Info Parameter Calibration Measuring Data Processing Data Sensor live data Fluorescence Fluorescence Raw read Data Logger Interval 1 s save (csv format) COM 1 selected all > Data read read Starts and stops the running measurement display. Interval 1 s Drop-down field for input/selection of the recording interval save (csv format) Opens a window for entering the storage path of a csv file. After the file has been created, the recording of the measurement values into the csv file starts. The button changes to: save (csv format) At the bottom right of the program window this appears: Data Logger running Stop Click on <Stop> stops the data recording. Modbus Tool 1.07 File Language Serial Communication Modbus BlueTrace Turbidity Info Parameter Calibration Measuring Data Processing Data Sensor live data Turbidity Temperature TSS read COM 1 selected Data Logger Interval 1 s save (csv format) Differences BlueTrace Crude Oil BlueTrace Turbidity BlueEC Conductivity Crude Oil Turbidity Conductivity empty Temperature Temperature empty TSS Conductivity uncomp. GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 Page 11 / 16 www.go-sys.de info@go-sys.de Modbus Sensor Configuration 4 General Modbus Specification for GO Modbus Sensors General The data to be transferred is always in a fixed frame and is defined as follows: Address Function code Data 1 byte 1 byte 0 ... 252 byte(s) CRC 2 bytes Description Address: Function code: Data: CRC: Sensor address (valid from 1 230) Address 0 is the broadcast address and will not be answered. Here you define whether parameters are to be read or written. e.g. from the master: Which parameters are requested? e.g. from the slave: content of the requested parameters CRC16 Data types Standardized data types: Extended data types: byte (8-bit) and short integer (16-bit) According to the Modbus specification, a register always transmits the high-byte first, followed by the low-byte. 32-bit integer and 32-bit float are transmitted as 2 consecutive 16-bit registers. The format of the float number corresponds to the IEEE standard 754. Function codes Function code Name Description 03 Read Hold Register Read device parameters (Integer / Float) 04 Read Input Register Read actual values (Integer / Float) 06 Write Single Register Write device parameters word by word 16 Write Multiple Register Write several device parameters word by word only approved for sensor coefficients GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 Page 12 / 16 www.go-sys.de info@go-sys.de Modbus Sensor Configuration Transmission parameter RTU Modus 9600 Baud 8 data bits no parity bit 1 stop bit Register Modbus provides to store the data in different registers. Each register stores 2 byte. A difference is made in the following registers: Register number Register address Type Modbus designation Description read / write Discrete Output Coils Discrete outputs read only Discrete Input Contacts Discrete inputs 0x0100 0x0FFF write only (except IO) Input Registers Input register, Measurement values of the sensors 0x0000 0x00FF read / write Output Holding Registers Hold register for parameters, Device configuration, etc. Slave table Each slave has a parameter table and an actual value table. From these tables it can be seen which parameters can be found under which addresses. Coils should not be used, I/Os are managed via the parameter table. GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 Page 13 / 16 www.go-sys.de info@go-sys.de Modbus Sensor Configuration 5 BlueTrace Oil in Water 461 6200 Modbus Address Overview 29.6.2021 Address Parameter name 0x00 Device ID 0x01 Firmware Version 0x02 Serial No. 0x03 Modbus Slave ID 0x04 Baud rate 0x05 Production date Range 102 100 9999 0 65535 1 230 0 2 ddmmyyyy Meaning Data type 102 BlueTrace Oil in Water Short 100 = 1.00, 2410 = 24.1 Short Serial number Short Modbus address Short 0 = 9600 8N1 Short Date Short x 2 Authorization R R R R/W R R Address Parameter name 0x14 A0 0x16 A1 0x18 A2 0x1A A3 0x1C A4 0x1E A5 Range Meaning 0 0xffffffff Cal Coefficient A0 0 0xffffffff Cal Coefficient A1 0 0xffffffff Cal Coefficient A2 0 0xffffffff Cal Coefficient A3 0 0xffffffff Cal Coefficient A4 0 0xffffffff Cal Coefficient A5 Data type Authorization 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W Address Parameter name 0xD1 Gain Range 0 7 0xD3 Modbus 0 1 termination Meaning 1 128 Termination resistor Data type Short Authorization R/W Short R/W Address Parameter name 0x101 Value Sensor 1 [ppm] 0x104 Value Sensor 1 RAW Range 0 0xffffffff 0 0xffffffff Data type Authorization 32 bit Float R 32 bit Float R Note on 32 bit Float data (MSB = 0xByte 4, LSB = 0xByte 1) , The Receiving sequence of the values (Hex) is: 0x [Byte 2] [ Byte 1] [ Byte 4] [ Byte 3] GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 Page 14 / 16 www.go-sys.de info@go-sys.de Modbus Sensor Configuration 6 BlueTrace Turbidity 461 6780 Modbus Address Overview 29.6.2021 Address Parameter name 0x00 Device ID 0x01 Firmware Version 0x02 Serial No. 0x03 Modbus Slave ID 0x04 Baud rate 0x05 Production date Range 109 100 9999 0 65535 1 230 0 2 ddmmyyyy Meaning 109 BlueTrace Turbidity 100 = 1.00, 2410 = 24.1 Serial number Modbus address 0 = 9600 8N1 Date Data type Short Short Short Short Short Short x 2 Authorization R R R R/W R R Address Parameter name 0x14 A0 0x16 A1 0x18 A2 0x1A A3 0x1C A4 0x1E A5 0x2A A0 0x2E A1 Range Meaning 0 0xffffffff Cal Coefficient A0 0 0xffffffff Cal Coefficient A1 0 0xffffffff Cal Coefficient A2 0 0xffffffff Cal Coefficient A3 0 0xffffffff Cal Coefficient A4 0 0xffffffff Cal Coefficient A5 0 0xffffffff Cal Coefficient A0 TSS 0 0xffffffff Cal Coefficient A1 TSS Data type Authorization 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W Address Parameter name 0xD3 Modbus termination Range 0 1 Meaning Termination resistor Data type Short Authorization R/W Address Parameter name 0x101 Turbidity [FNU] 0x104 Temperature [°C] 0x107 TSS [mg/l] Range 0 0xffffffff 0 0xffffffff 0 0xffffffff Data type Authorization 32 bit Float R 32 bit Float R 32 bit Float R Note on 32 bit Float data (MSB = 0xByte 4, LSB = 0xByte 1) , The Receiving sequence of the values (Hex) is: 0x [Byte2] [Byte1] [Byte4] [Byte3] GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 Page 15 / 16 www.go-sys.de info@go-sys.de Modbus Sensor Configuration 7 BlueEC Conductivity 461 2092 Modbus Address Overview Address Parameter name Range Meaning 0x00 Device ID 101 101 BlueEC Conductivity 0x01 Firmware Version 100 9999 100 = 1.00, 2410 = 24.1 0x02 Serial No. 0 65535 Serial number 0x03 Modbus Slave ID 1 230 Modbus address 0x04 Baud rate 0 2 0 = 9600 8N1 0x05 Production date ddmmyyyy Date Data type Short Short Short Short Short Short x 2 29.6.2021 Authorization R R R R/W R R Address Parameter name 0x14 A0 0x16 A1 0x18 A2 0x1A A3 0x1C A4 0x1E A5 Range 0 0xffffffff 0 0xffffffff 0 0xffffffff 0 0xffffffff 0 0xffffffff 0 0xffffffff Meaning Cal Coefficient A0 Cal Coefficient A1 Cal Coefficient A2 Cal Coefficient A3 Comp. - Temperature Comp - Correction factor Data type Authorization 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W 32 bit Float R/W Address Parameter name 0xD0 Meas. range Range 0 1 0xD1 0xD3 Modbus termination TDS factor 0 1 0 100 Meaning 0: 0 3000 µS 1: 0 120 mS Termination resistor Value/100 Data type Short Authorization R/W Short R/W Short R/W Address Parameter name Standard Range Data type Authorization 0x101 Value Sensor 1 selectable Cond. comp. 0 0xffffffff 32 bit Float R 0x104 Value Sensor 2 selectable Temperature 0 0xffffffff 32 bit Float R 0x107 Value Sensor 3 selectable Cond. uncomp 0 0xffffffff 32 bit Float R 0x10A Value Sensor 4 Salinity 0 0xffffffff 32 bit Float R 0x10D Value Sensor 5 TDS 0 0xffffffff 32 bit Float R Note on 32 bit Float data (MSB = 0xByte 4, LSB = 0xByte 1) , The Receiving sequence of the values (Hex) is: 0x [Byte 2] [ Byte 1] [ Byte 4] [ Byte 3] GO Systemelektronik GmbH Faluner Weg 1 24109 Kiel Germany Tel.: +49 431 58080-0 Fax: -58080-11 Page 16 / 16 www.go-sys.de info@go-sys.de