modbus module supplementary operating manual - ksb · modbus rtu consistently uses 16-bit...

Modbus Module

Supplementary OperatingManual

Legal information/Copyright

Supplementary Operating Manual Modbus Module

Original operating manual

KSB Aktiengesellschaft

All rights reserved. The contents provided herein must neither be distributed, copied, reproduced, edited or pro-cessed for any other purpose, nor otherwise transmitted, published or made available to a third party withoutKSB's express written consent.

Subject to technical modification without prior notice.

© KSB Aktiengesellschaft Frankenthal 21.03.2013

Contents

1 Supplementary Operating Manual ......................................................4

1.1 General .............................................................................................................. 4

1.2 Description of the Modbus module ................................................................ 4

1.3 Installing the Modbus module ......................................................................... 5

1.4 Commissioning the Modbus module ............................................................... 7

1.5 Measured values and parameters via Modbus ............................................... 9

1.6 Parameter lists ................................................................................................ 11

Contents

Modbus Module 3 of 18

1 Supplementary Operating Manual

1.1 General

This supplementary operating manual accompanies the operating/installation man-ual. All information contained in the operating/installation manual must be ob-served.

Table 1: Relevant operating manuals

Type series Reference number of the operating/installation man-ual

PumpDrive 4070.8

1.2 Description of the Modbus moduleGeneral description

The Modbus module is used to connect PumpDrive BASIC/ADVANCED to a Modbusnetwork. This Modbus module is a Modbus slave. Data is transferred using ModbusRTU.

1

2

3

Fig. 1: Modbus module

1 Modbus board 2 DIP switches3 Terminal strip

An LED is located between the two boards.

Data flow is indicated by a flashing LED.

1.2.1 Communication protocol

The Modbus module is equipped with an RS485 interface with the Modbus RTU pro-tocol in accordance with specification V1.1b. A graphical control panel or Modbusmaster is required in order to set it.

Communication protocol MODBUS (RTU)Bus termination 120 ohms (depending on the hardware)Interface EIA-485 (RS485)Transmission rate 19,200 bit/s (variable)Device type SlaveBus access Polling between master and slaveParity Even (non-editable)

Table 2: Pre-set device address

Device address Modbus addressGateway 247 (variable)

PumpDrive 11) 1

LED status


4 of 18 Modbus Module

Device address Modbus addressPumpDrive 21) 2PumpDrive 31) 3PumpDrive 41) 4PumpDrive 51) 5PumpDrive 61) 6

1.3 Installing the Modbus module

DANGER

Incorrect electrical installationDanger of death from electric shock!

▷ Electrical connection to be made by a qualified electrician only.

▷ Observe the technical connection requirements of local and national energysupply companies.

DANGER

Unintentional start-upDanger of death from electric shock!

▷ Disconnect the PumpDrive from the power supply before performing any main-tenance or installation work.

▷ Ensure that the PumpDrive cannot be switched on again during maintenanceand installation work.

CAUTIONShort circuit due to incorrect installationDamage to the Modbus module!

▷ Never connect the Modbus module to the rear of the control panel.

▷ Attach the Modbus module to the P8 slot intended for this purpose on thePumpDrive.

▪ For high-frequency shielding, use shielded cables and assemble according to EMCrequirements.

▪ A cable specified for Modbus that has the following properties must be used as aconnecting cable:

– Flexible

– At least 3 wires

– Shielded

– Wires twisted in pairs

▪ A minimum distance of 300 mm is recommended between such cables and otherelectric conductors.

▪ Besides the Modbus module, do not make any further connections using the buscable, for example, 230 V alert and 24 V start.

The following devices are required for installing and commissioning the Modbusmodule:

▪ PC for Modbus master

Connection cables

System requirements

1) The number of PumpDrives is identified automatically. However, only the addresses that are available in the hardware areassigned. Example: In a multiple pump system with 2 devices (PumpDrive ID 1 and 2), only the Modbus addresses 1 and 2are assigned.



GN D P 4DI6DI5DI4DI3DI2DI1+24V

AGNDAN-OUT

109

87

65

43

21

2019

1817

1615

1413

1211

SB1_GNDSB1 +SB1 -

SB1_GNDSB1 +SB1 -SB1 Z -SB1 Z +

ABNG P7AIN1

GNDAIN2+24VNO2COM2NO1COM1

109

31

24

56

78

109

87

65

43

21

U+

+24VGNDSB1 +SB1 -SB1 Z+SB1 Z-

AB

U-

GN D P 4DI6DI5DI4DI3DI2DI1+24V

AGNDAN-OUT

109

87

65

43

21

2019

1817

1615

1413

1211

SB1_GNDSB1 +SB1 -

SB1_GNDSB1 +SB1 -SB1 Z -SB1 Z +

ABNG P7AIN1

GNDAIN2+24VNO2COM2NO1COM1

109

31

24

56

78

P6

P3

P5

P8

P9

P7 P7

P4

P3

P6

P5P4

a) b)

12

O N

Fig. 2: PumpDrive interior view: a) without Modbus module, b) with Modbus module

The Modbus module is equipped with a 10-pin terminal connection (J202).

Table 3: Terminal assignments

Terminal Signal Allocation Modbus rele-vant

1 -U - -2 B RS 485 ✘3 A RS 485 ✘4 +U - -5 SBZ- - -6 SB+ - -7 SB- - -8 SB+ - -9 GND Modbus cable shield ✘10 +24V - -

CAUTIONIncorrect installationDamage to the Modbus module!

▷ Never supply power to the Modbus module via the terminal connection.

1. Attach the Modbus module to the lower P8 slot on the PumpDrive.

2. Connect the Modbus cable to terminals 2 and 3.

3. Connect the Modbus cable shield to terminal 9.

Terminal assignments



1.4 Commissioning the Modbus module

Field bus control must be activated in the KSB PumpDrive when using the Modbusmodule.

Table 4: Parameters for activating field bus control

Parameter Description Selection list3-2-1-5 Activate/deactivate field

bus control1-disabled2-enabled

The PumpDrive ID must be set depending on the operating mode (single-pump ormultiple pump operation).

Table 5: Parameters for setting the operating mode

Operating mode Parameter Description Selection listSingle-pump operation 3-2-1-2 PumpDrive ID 1Multiple pump operation 1 - 6

The Modbus module is designed as a gateway. The Modbus protocol is converted tothe KSB local bus by the Modbus module.

ModbusPumpDrive 1

KSBLocal-BusModbus

Gateway

Fig. 3: Single-pump operation

ModbusPumpDrive 1

PumpDrive 2

PumpDrive 6

KSB Local-BusModbus

Gateway

...

Fig. 4: Multiple pump operation

Assigning internal addresses – Modbus addresses

The Modbus module is assigned its own address. Each PumpDrive is also assigned itsown Modbus address so that every PumpDrive can be addressed via Modbus. For asystem with 6 PumpDrives, 7 Modbus addresses are, therefore, required. In terms ofthe Modbus, the number of Modbus addresses assigned is governed by the numberof PumpDrives in the multiple pump system.

The following number of Modbus slave addresses are required:number of PumpDrives +1

Field bus control

Setting the PumpDrive ID

Physical structure



Modbus

Modbus module

PumpDrive 1PumpDrive ID: 1

PumpDrive 2

PumpDrive 6

KSB Local-Bus

...Modbus Address 1 PumpDrive ID 1

Modbus Address 2 PumpDrive ID 2

Modbus Address 6 PumpDrive ID 6

... ...

PumpDrive ID: 2

PumpDrive ID: 6

Fig. 5: Internal address assignment (factory default setting)

Internal assignment of addresses in the Modbus module is governed by the Pump-Drive ID of the respective PumpDrive. In the standard configuration, PumpDrive 1 isassigned to Modbus slave address 1. For example, if slave address 3 is entered in byte1 of the Modbus telegram, the PumpDrive with the PumpDrive ID 3 is addressed. Inthe Modbus module, a Modbus slave address can be freely assigned to a PumpDriveID. Modbus addresses and assigning them to the respective PumpDrive ID can be setvia the corresponding parameters (⇨ Section 1.6.5 Page 16). Parameterisation is possi-ble via the display and via the Modbus master.

To access Modbus parameters in menu 3-14, you must switch to the Modbus modulevia menu 3-1-1-4. The PumpDrive parameters are then hidden. Once parameterisa-tion in menu 3-14 has been completed, you can return to the PumpDrive parametersvia menu 3-1-1-4.

If the factory default settings of the Modbus addresses (Modbus address of thePumpDrive with PumpDrive ID 1 = 1) have to be changed, this can be done via theModbus master (⇨ Section 1.6.5 Page 16) .Addresses are assigned in the KSB local bus using PumpDrive IDs. Each PumpDrive hasits own PumpDrive ID. In the Modbus module, a Modbus address is assigned to eachPumpDrive ID. In the standard configuration, the PumpDrive ID is assigned exactly tothe Modbus slave address. For example, if slave address 98 is entered in byte 1 of theModbus telegram, the PumpDrive with the PumpDrive ID 3 is addressed.

Fig. 6: Address assignment for multiple pump systems in the same Modbus network

Multiple pump system 1 Multiple pump system 22)

PumpDrive ID: 1 Modbus address 1 PumpDrive ID: 1 Modbus address 4PumpDrive ID: 2 Modbus address 2 PumpDrive ID: 2 Modbus address 5

Parameterisation via thegraphical control panel

Example of address assign-ment for multiple pump

systems in the same Mod-bus network

2) Factory default settings must be adapted accordingly to avoid address conflicts.



PumpDrive ID: 3 Modbus address 3 Modbus gateway Modbus address 247 Modbus gateway Modbus address 246

Drive/gateway output

Each PumpDrive can be addressed directly by the Modbus master by entering the tar-get address (FB address PumpDrive x) in the Modbus telegram. If the address of theModbus module (AddressGateway) is used instead, the Modbus module forwards thetelegram to the master PumpDrive in a multiple pump system. In addition, the Mod-bus module has internal parameters that are also available under the address of theModbus module.

NOTEThe PumpDrive ID of the PumpDrive on which the Modbus module is located mustbe entered in the Modbus module. This setting can be made via the Modbus mod-ule (standard setting 1)(⇨ Section 1.6.5 Page 16) .

Table 6: DIP switch functions

Switch position FunctionON Terminating resistors active1 or 2 (OFF) Terminating resistors not active

The Modbus terminating resistor must be set to ON for the first and last subscribersin the network so that no reflections occur on the bus line. Both DIP switches must beset to ON for this purpose.

The terminating resistors of the Modbus module comply with the following standard:

Profibus standard DP DIN 19245, Part 3, Section 6.3

The terminating resistors only function when voltage is present on the Modbus mod-ule. Both DIP switches must be set identically (both ON or both OFF). The bus must beterminated externally in order to ensure redundancy as the Modbus module cannotbe operated using an external power supply.

When using the PumpDrive in single-pump operation mode without a graphical dis-play, a wire jumper must be fitted between terminals 1 and 2 on the P4 terminal stripof the PumpDrive (see also the PumpDrive operating manual).

The Modbus module has a galvanically isolated bus connection (functional separa-tion, no safety isolation). The earth potential of the bus driver can be connected to aparticular potential. The terminal is provided for this purpose.

1.5 Measured values and parameters via Modbus

Various measured values and parameters are provided as device information on theModbus module.

Table 7: Calling up device information

Function Function codeRead Function code 03

(0x03 Read Holding Registers)Write Function code 16

(0x10 Write Multiple Registers)

Modbus RTU consistently uses 16-bit registers. Two registers must therefore be readfor values that are entered as 32-bit numbers. Their register and length are bothshown as hexadecimal numbers and can be transferred directly to the Modbus RTUprotocol in this format.

1.5.1 Examples of a Modbus telegram

Observe the protocol notation convention according to the Modbus specification.

DIP switches

12

O N

Fig. 7: DIP switches

Modbus module terminat-ing resistor

KSB local bus terminatingresistor on a PumpDrive

without graphical display

Reference earth of theModbus bus driver



Write set value bus to pump 1

Address PumpDrive ID1:1 [hex]

Parameter:4814 [hex]

Set value bus = 1.54 bar => 1.54 bar x 1000 = 1540 [dec] =>06 04 [hex]

CRC = 3017

Table 8: Write set value bus to pump 1

General description Example

Byte Dataformat

Input Value Description

1 UINT8 Address 0x01 Address PumpDrive ID12 UINT8 Function Code 0x10 Write Multiple Registers (0x10)3 UINT8 Index Parameter 0x48 Index Parameter PumpDrive ID14 UINT8 Index Parameter 0x14 Index Parameter PumpDrive ID15 UINT8 Size Registers High 0x00 Size of the register in bytes6 UINT8 Size Registers Low 0x02 Size of the register in bytes7 UINT8 Number of registers 0x04 Number of registers8 UINT8 Value4 0x00 Data High Byte9 UINT8 Value3 0x00 Data10 UINT8 Value2 0x06 Data11 UINT8 Value1 0x04 Data Low Byte12 UINT8 CRC 2 0xA7 CRC Modbus13 UINT8 CRC 1 0x30 CRC Modbus

Read set value bus from the gateway

Address gateway: F7 [Hex]

Parameter: 4814 [Hex]

Table 9: Read set value bus from the gateway


Byte Input1 UINT8 Address 0xF7 Address gateway2 UINT8 Function Code 0x03 Read Holding Registers (0x03)3 UINT8 Index Parameter 0x48 Index Parameter Gateway4 UINT8 Index Parameter 0x14 Index Parameter Gateway5 UINT8 Number of registers 0x00 Number of registers6 UINT8 Number of registers 0x04 Number of registers7 UINT8 CRC 2 0x07 CRC Modbus8 UINT8 CRC 1 0x3B CRC Modbus

Change NMT timeout gateway parameter


Parameter: 1243 [hex]

Timeout 5 seconds => 5s x 1000 = 5000 [dec] =>13 88 [hex]

Table 10: Change NMT timeout gateway parameter


Byte Input1 UINT8 Address 0xF7 Address gateway2 UINT8 Function Code 0x10 Write Multiple Registers (0x10)3 UINT8 Index Parameter 0x12 Index Parameter Gateway4 UINT8 Index Parameter 0x43 Index Parameter Gateway5 UINT8 Size Registers High 0x00 Size of the register in bytes6 UINT8 Size Registers Low 0x02 Size of the register in bytes7 UINT8 Number of registers 0x02 Number of registers8 UINT8 Value2 0x13 Data High Byte9 UINT8 Value1 0x88 Data Low Byte

Write set value bus topump 1

Read set value bus fromthe gateway

Change NMT timeoutgateway parameter




Byte Input10 UINT8 CRC 2 0xB8 CRC Modbus11 UINT8 CRC 1 0x14 CRC Modbus

Change baud rate gateway parameter


Parameter: 1242 [hex]

From 19200 baud to 9600 baud => change 0x01 to 0x00

Table 11: Change baud rate gateway parameter


Byte Input1 UINT8 Address 0xF7 Address gateway2 UINT8 Function Code 0x10 Write Multiple Registers (0x10)3 UINT8 Index Parameter 0x12 Index Parameter Gateway4 UINT8 Index Parameter 0x42 Index Parameter Gateway5 UINT8 Size Registers High 0x00 Size of the register in bytes6 UINT8 Size Registers Low 0x01 Size of the register in bytes7 UINT8 Number of registers 0x02 Number of registers8 UINT8 Value2 0x00 Data High Byte9 UINT8 Value1 0x00 Data Low Byte10 UINT8 CRC 2 0xB4 CRC Modbus11 UINT8 CRC 1 0xD7 CRC Modbus

1.6 Parameter lists

1.6.1 Gateway input

Modbus PumpDrive 1ModbusGateway

KSBLocal-Bus

Fig. 8: Gateway input

Table 12: Gateway input

Var Description Index Value semantics Size[Byte]Bit Description

0 Modbus status 0x4440 0-7 - 128-15 - 1116-23 - 1024 Pump #1 is online. 925 Pump #2 is online. 926 Pump #3 is online. 927 Pump #4 is online. 928 Pump #5 is online. 929 Pump #6 is online. 930-31 - 9

2 0x4444 0-7 - 128 - 119 - 1110 - 1111 - 1112 - 1113 - 1114-15 - 11

Change baud rate gate-way parameter




16-23 - 1024-31 - 9

1.6.2 Gateway output


KSBLocal-Bus

Fig. 9: Gateway output

Table 13: Gateway output


0 Modbus commands 0x4802 0 System start/stop for multiple pump opera-tion(only when field bus is activated, 1 = system start, 0 = system stop)

12

1-7 - 128-15 - 1116-23 - 1024-30 - 931 Reboot Modbus module 9

1 Feedback enable 0x40C8 0 Feedback_bus enable 12

1.6.3 PumpDrive input


KSBLocal-Bus

Fig. 10: PumpDrive input

Table 14: PumpDrive input


0 Set value 0x4448 - 1/1000 unit 12 - 91 Feedback 0x4446 - 1/1000 unit 12 - 92 Motor frequency 0x4404 - 1/100 Hz (e.g. 4582 ≙ 45.82 Hz) 12 - 93 Motor rating 0x4412 - 1/100 kW 12 - 94 Motor current 0x4408 - 1/10 A 12 - 95 Alerts 0x4442 0 Short circuit 12

1 Motor PTC sensor2 24 V (low)3 Excess PumpDrive temperature4 Excess motor temperature5 Undervoltage6 Overvoltage7 Overcurrent8 FATAL 119 Congruence10 Auto setting error11 Excess speed12 Reference < 4 mA




13 Factory default settings loaded14 Killer15 DC-link in start phase16 - 1017 -18 -19 -20 Stop and trip21 CAN initialisation has failed22 Copied CAN ID23 Excess card temperature24 "Bin" file missing 925 Dry run26 Timeout (Q high)27 Timeout (Q low)28 Bit 28 Hydraulic manifold29 -30 -31 -

6 Warnings 0x4444 0 - 121 Overvoltage2 Undervoltage3 Current limitation4 -5 Off low frequency6 Off high frequency7 Off low current8 Off high current 119 Low feedback10 High feedback11 Low reference12 High reference13 Low energy14 High energy15 Analog in 1 (low)16 Analog in 1 (high) 1017 Analog in 2 (low)18 Analog in 2 (high)19 Zero voltage feed (An.In.1)20 Zero voltage feed (An.In.2)21 Controller timeout22 CAN ID assigned23 CAN ID not assigned24 No main pump 925 Network error26 Motor I2t27 IGBT temperature28 Housing temperature29 Timeout (Q high)30 Timeout (Q low)31 Hydraulic manifold

7 Status 0x4440 0 Line on 121 Start activated2 Start/stop status3 Start/stop command4 Direction of rotation

(0 = clockwise, 1 = anti-clockwise)

5 System start6 Warning




7 Alert8 Boot mode 119 Stop and trip10 0 = main mode, 1 = slave mode11 0 = Ramp1 active, 1 = Ramp2 active12 Acceleration subdued13 Braking subdued14 Idle state15 Idle state query16 Stop for voltage feed 0 1017 Minimum speed18 Maximum speed19 Reference standstill20 Pump selected21 AUTO22 MANUAL23 OFF24 Skip DFS 925 Idle state active26 P.I. active27 Field bus active28 Under minimum speed29 1 = Pump in slave mode30 0 = Single-pump operation,

1 = Multiple pump operation31 -



1.6.4 PumpDrive/Gateway output

Modbus ModbusGateway

KSBLocal-Bus

PumpDrive 1

Fig. 11: Drive output

Table 15: PumpDrive/gateway output


0 Commands 0x481C 0 - 121 -2 PumpDrive START/STOP

(1 = START, 0 = STOP)

3 -4 Activate/deactivate IDLE STATE switch5 Activate/deactivate DFS MODE switch6 -7 Reset all PumpDrive alerts8 - 119 Reset kWh10 Reset operating hours11 -12 -13 Increase speed14 Decrease speed15 Activate/deactivate P.I. MODE switch16 -23 - 1024 - 925 -26 Enable blocked parameters

(1=enable, 0=block)

27 -28 -29 Activate/deactivate the pump safe mode

(only works when the PumpDrive is OFF,1 = activate safe mode, 0 = deactivate safemode)

30 -31 Reboot the PumpDrive (only works when

the PumpDrive is OFF)1 Reset

alerts0x4810 0-31 Reset individual pump alerts (0–31) 12 - 9

2 Set pump status 0x4110 0 Operating mode (0 = OFF, 1 = Auto) 12 - 91 Operating mode (1 = MAN)2-31 Operating mode (2 = MAN)

Values higher than 2 are limited to 2 bythe PumpDrive.

3 Set value bus 0x4814 - Set value 1/1000 (unit) 12 - 94 Feedback_bus 0x4812 - Actual value 1/1000 (unit) 12 - 9



1.6.5 Internal gateway

Table 16: Internal gateway

Parame-ter

Description Index Value range Standard Size[Byte]

3-14-1-1 Address GatewayAdressGateway

0x1222 1 - 255 247 (F7hex.)

4

3-14-1-2 Fieldbus Address Drive 1FB Address Drive 1

0x1224 1 - 255 1 (1 hex.) 4

3-14-1-3 PumpDrive ID PumpDrive 1PumpDrive ID PumpDrive 1

0x1226 1 - 6 1 (1 hex.) 4


0x1228 1 - 255 2 (2 hex.) 4


0x122A 1- 6 2 (2 hex.) 4


0x122C 1 - 255 3 (3 hex.) 4


0x122E 1 - 6 3 (3 hex.) 4


0x1230 1 - 255 4 (4 hex.) 4


0x1232 1 - 6 4 (4 hex.) 4


0x1234 1 - 255 5 (5 hex.) 4


0x1236 1 - 6 5 (5 hex.) 4


0x1238 1 - 255 6 (6 hex.) 4


0x123A 1- 6 6 (6 hex.) 4

3-14-2-1 PumpDrive IDPumpDrive ID

0x1240 1 - 6 1 (1 hex.) 4

3-14-2-2 BaudrateBaud rate

0x1242 0 - 1 1 (1 hex.) 2

3-14-2-3 Feedback enabledFeedback enabled

0x40C8 0 - 1 (0 hex.) 4



4070

.87/

02-EN

(01

4567

80)

KSB Aktiengesellschaft67225 Frankenthal • Johann-Klein-Str. 9 • 67227 Frankenthal (Germany)Tel. +49 6233 86-0 • Fax +49 6233 86-3401www.ksb.com

modbus module supplementary operating manual - ksb · modbus rtu consistently uses 16-bit...

Documents