mas base unit - modbus protocol revision 3 · 2 the modbus rtu protocol ... 3.4 modbus protocol...

Water & Wastewater

Engineered for Life

Technical Information MAS 711 Modbus Protocol Revision 3

MAS 711 Base Unit Modbus communication (Scope of this document)

2 Technical Information, MAS 711 Modbus Protocol, Revision 3

Table of contents

1 General.....................................................................................................................................3

2 The Modbus RTU Protocol - General .......................................................................................3

3 Communicating with MAS 711 Base Unit.................................................................................4

3.1 Master / Slave relation...........................................................................................................4

3.2 Activation ...............................................................................................................................4

3.3 Configuration .........................................................................................................................5

3.4 Modbus protocol revision.......................................................................................................5

3.5 Terminating resistor solutions................................................................................................5

3.6 Alternative communication protocols.....................................................................................6

4 Protocol Implementation...........................................................................................................7

4.1 Exception handling ................................................................................................................7

4.2 Implemented Modbus Commands.........................................................................................8

4.3 MAS 711 Parameter definitions.............................................................................................9 4.3.1 Data types and dimensions .................................................................................................9 4.3.2 Parameter examples............................................................................................................9 4.3.3 Channel parameters ..........................................................................................................10

4.4 MAS 711 Parameter implementation...................................................................................11 4.4.1 Table of Channels..............................................................................................................11 4.4.2 VALUE – Measured value .................................................................................................12 4.4.3 DECIMALS - Number of decimals for measured value (VALUE) .....................................12 4.4.4 ALARMARRAY – Channel related events (alarms)...........................................................13

5 MAS 711 Base Unit - MODBUS virtual memory map.............................................................14

5.1 Bit addressing area (#01: Read "coil"-parameters) .............................................................14

5.2 Bit addressing area (#02 - "input" parameters)....................................................................15

5.3 Register addressing area (#03, #06, #16 - read/write "holding register" parameters).......16

5.4 Register addressing area (#04 - read "input register" parameters) .....................................23

6 Query and Response examples .............................................................................................24

6.1 Modbus Command table excerpt.........................................................................................24

6.2 Read ModNr parameter from MAS 1 which has MAS modbus id 14...................................25

6.3 Read Main Bearing Temp parameter from MAS with modbus id 15 ...................................25

6.4 Check Leakage alarm parameter from MAS with MAS Modbus ID 15................................26

6.5 Check Temp stator alarm parameter from MAS with Modbus ID 15 ...................................26

7 MAS Base Unit - Modbus Revision history.............................................................................27

8 Document Revision history.....................................................................................................28

Technical Information, MAS 711 Modbus Protocol, Revision 3 3

1 General This document contains information about the Modbus protocol such as commands and parameters and how to communicate with the MAS base unit. Knowledge of how communication protocols work and how to implement a protocol in a system is recommended to fully understand this document.

2 The Modbus RTU Protocol - General Modbus was originally developed by Modicon (now part of Schneider) and today, it is managed by the Modbus User Organization. Modbus is an open Master/Slave application protocol, that can be used on several different physical Layers. Modbus is an application-layer messaging protocol, positioned at level 7 of the OSI model. It provides client/server communication between devices connected on different types of buses or networks. Modbus RTU (Remote Terminal Unit) means that the Modbus protocol is used on top of a serial line with an RS-232, RS-485 or similar physical interface. Numerous automation systems have Modbus-RTU interfaces for communication. When devices communicate on a Modbus serial line using the RTU mode, each 8–bit byte in a message contains two 4–bit hexadecimal characters. The main advantage of this mode is that its greater character density allows better data throughput than ASCII mode for the same baud rate. Each message must be transmitted in a continuous stream of characters.

MODBUS is a request/reply protocol and offers services specified by function codes. MODBUS function codes are elements of MODBUS request/reply protocol data units (PDUs). Modbus provides a set of functions to read and write data in the field devices. Modbus supports bit or word data transfers. In RS-485 based Modbus networks, the Address Field in the telegram frame is used to address a single device in the network. Network Type: Simple Master/Slave communication system

Topology: RS-485: line topology with segments of up to 32 devices. Each segment shall be terminated at

the Beginning and End.

Installation: Shielded twisted pair cables.

Line length depending on physical media and baudrate: Data Rate : User selectable; depending on physical media max. Stations : 1 Master and up to 246 Slaves Data: 0 - 252 Byte per telegram frame Network Features : Multidrop (RS-485) communication

A multidrop bus (MDB) is a bus in which all components are connected to the same set of electrical wires. A process of arbitration determines which device gets the right to be the sender of information at any point in time. The other devices must listen for the data that is intended to be received by them.


3 Communicating with MAS 711 Base Unit The MAS 711 can communicate with a “higher level system” meaning for instance a Flygt APP7xx series pump controller or a standard PLC (Programmable Logic Controller) via ModBus protocol available on Ext 1 (Modbus/RS-485). Multiple MAS 711 units can be connected to the same set of wires, a so called multidrop bus.

3.1 Master / Slave relation In a network where MAS711 communicates with a “higher level system” via Ext1 the MAS711 acts as a slave.

(The MAS 711 acts as a master when communicating via Ext2 or Local towards power analyzer, pump memory and operator panel, not covered in this document)

3.2 Activation Modbus communication is activated by activating the port, setting the address and selecting MAS Modbus protocol revision. This is done in the general settings through the web interface.


3.3 Configuration Any higher level communicator that wishes to communicate with the MAS 711 via the Modbus protocol has to configure the communication link according to the following. Physical Standard = RS485 Not configurable options (hard coded in MAS): Data bits = 8. Stop bit = 1. Parity = none.

Configurable options (all via web pages, or some via op-panel): Activate = no, yes*. Baud rate = 9600*, 19200. Modbus protocol = revision1, revision 2, revision 3*. Answer timeout = none, 1 ... 10 s (2* s). Exception code when busy = no*, yes. Address (Modbus Id) = 1...247 (1*).

(* = default setting).

3.4 Modbus protocol revision The difference between the revisons are mainly the memory maps and the number of implemented commands. The memory maps for the other Modbus revisions are described in separate documents in order not to confuse the reader. The revisions are not compatible with each other. All MAS-units in a multidrop network must have the same revision set and different addresses. This document describes the implementation and memory map of: Revision 3 (Firmware 2.06 +) That is, firmware greater than version 2.06 has this MAS Modbus revision available for selection.

3.5 Terminating resistor solutions MAS-units, produced before 2007-11, and with a serial number below 4274, has a terminating resistor (R205) mounted with a value of 120 ohm. This terminating resistor will in multiple MAS-units systems cause signal damping and hence cause communication problems if many MAS-units (more than 4) are connected to the same RS485 network. Bias resistors R204 and R206 has the value of 560 ohm. MAS-units, produced after 2007-11, and with a serial number above 4274, does not have a terminating resistor (R205). Bias resistors R204 and R206 has the value of 1200 ohm. This solution offers a connection of up to 15 MAS-units on the same RS485 network without signal amplification. Earlier MAS-units may be modified by replacing R204 and R206 to a 1200 ohm resistors and removal of R205. Your system should have a terminating resistor after the last MAS-unit in order to avoid reflection. The value of the termination resistor should be equal to the cable impedance (typically, 120 ohms for twisted pairs)


3.6 Alternative communication protocols Since the MAS 711 Modbus/RS485 implementation supports multidrop, the MAS Modbus protocol can easily be converted to almost any other protocol by making use of only one external protocol converter, also called ‘serial gateway’ or ‘gateway’. A protocol converter is hardware that translates the Modbus communication to the desired protocol, for instance to Profibus, DeviceNet or ControlNet.


4 Protocol Implementation A selection from the available MAS 711 parameters are mapped into two separate virtual memory areas for Modbus access. Which area used for each parameter is dependent on parameter type. One area is dedicated for bit addressing ("input/coil"-parameters), and the other area for register addressing ("holding register"-parameters). Each area starts at addresses that are dependent on the command used for data access. Some parameters are left out due to limitations in the protocol, or because they are considered relevant only for the web interface. (E.g. no voluminous text parameters are included, except data plate).

All holding registers are implemented with 16 bit address resolution. "Register" (as in "number of registers") is handled and counted as words (2 bytes). The smallest parameter element size in the register addressing area is one word (2 bytes).

However, text parameters (data plate) have 2 characters per word, but each line is considered as a single parameter element. It is not allowed to begin or end reading or writing in the middle of a parameter element that consist of multiple words (long, fix, string etc.). Exception code "illegal data address" is then given, but it is allowed to begin or end reading or writing between parameter elements (including different string lines) within a parameter. Parameter elements in a text (string) parameter, i.e. lines, should be padded with SPACE (20h) to full length when writing. When reading, each line is padded with SPACE (20h) to full length. Numeric parameter elements (int, long etc.) are sent with MSB first (big endian). The Modbus command itself (start address, number of registers etc.) is also sent with MSB first (big endian), except for the CRC-checksum, which is sent with LSB first (little endian), according to the Modbus standard.

4.1 Exception handling Reading from an unmapped area gives 0-values (no exception code is generated). Writing to

an unmapped area is ignored (no exception code is generated). Reading from a non-readable parameter gives 0-values (no exception code is generated). Writing to a non-writeable parameter is ignored (no exception code is generated).

If a parameter is readable, but the read fails for some other reason (internal error?), exception

code “illegal data value” is generated (should not happen).

If a parameter is writeable, but the write fails for some other reason (e.g. syntax error), exception code “illegal data value” is generated.

Reading or writing outside the 64k Modbus address area gives exception code "illegal data

address".

For register addressing, specifying "number of registers" < 1 or "number of registers" >122 gives exception code "illegal data address".

For bit addressing, specifying "number of bits" < 1 or "number of bits" > 1960 (i.e. 245 bytes)

gives exception code "illegal data address".


4.2 Implemented Modbus Commands Only a subset of the general Modbus commands and exception codes are currently supported: Commands dedicated for bit addressing area ("input/coil"-parameters)

#01 = "Read coils". #02 = "Read discrete inputs" 1. Commands dedicated for register addressing area ("holding register"-parameters)

#03 = "Read holding registers". #04 = "Read input registers" 2. #06 = "Write single register". #16 = "Write multiple registers". The following exception codes can be generated 01 = "Illegal function". 02 = "Illegal data address". 03 = "Illegal data value". 06 = "Slave device busy" (configurable usage).

1 Identical functionality as command #01 but with a different memory mapping. 2 Identical functionality as command #03 but with a different memory mapping.


4.3 MAS 711 Parameter definitions MAS 711 parameters are of different type and dimensions. This part of the document is your guide to the returned data from the commands.

4.3.1 Data types and dimensions A MAS 711 parameter element can have one of the following data types: bool : 1 bit data, Boolean (range = 0 .. 1). uchar : 1 byte data, unsigned character (range = 0 .. 255). schar : 1 byte data, signed character (range = -128 .. 127). uint : 2 byte data, unsigned integer (range = 0 .. 65535). sint : 2 byte data, signed integer (range = -32768 .. 32767). ulong : 4 byte data, unsigned long integer (range = 0 .. 4294967295). slong : 4 byte data, signed long integer (range = -2147483648 .. 2147483647). fixN : 4 byte data, signed long integer * 10N (real, with a fixed number of decimals = N). string : N byte data, unsigned character (string, padded with SPACE to full length = N). Parameter elements can then be grouped into 0, 1, 2 or 3 dimensions, hence called "simple", "array", "asymmetric matrix" or "asymmetric cube" 3. Module parameters (e.g. CLOCK) are either 0 or 1 dimensional. Channeltype parameters are either 1 or 2 dimensional. Channel parameters (e.g. ALARMLIMIT) are either 2 or 3 dimensional. 0 dimensional parameters consist of data. 1 dimensional parameters consist of elements of data. 2 dimensional parameters consist of channeltypes of channels of data. 3 dimensional parameters consist of channeltypes of channels of elements of data.

4.3.2 Parameter examples PMACTIVE (0 dimensional, "simple"): 1 word 1 word. NUMCLOCK (1 dimensional, "array"): 6 elements * 1 word 6 words. MINSETVALUE (2 dimensional, "asymmetric matrix") : 3 channels (according to AI Current DC, AI Current AC, AO Current DC) * 2 word 6 words. ALARMLIMIT (3 dimensional, "asymmetric cube"): 17 channels (according to AI Leakage .. AO Current DC) * 6 alarmlimits * 2 word 204 words.

3 Asymmetric because the number of channels varies between 1..5 for different channeltypes.


4.3.3 Channel parameters So called channel parameters consists of one or several channeltypes with corresponding channels and elements(s) of data, dependent on the parameter. (Undefined channeltypes for a certain parameter does not leave "holes" in the memory map). Some channeltypes are currently not used but still defined for some parameters, since they may come to use in the future. Those are crossed over in the memory map. Multiple elements of data in a channel parameter are always symmetrical distributed between the included channeltypes and channels, even if some of them do not make use of all the elements (unused elements does leave "holes" in the memory map). As an example, for the 3 dimensional alarm parameters ALARMACTION, ALARMLIMIT, ALARMRESET and ALARMDELAY the data elements are defined as: Short circuit (ohm) / Broken circuit (mA). Very low. Low. High. Very high. Broken circuit (ohm) / Short circuit (mA). Some of these elements are not used for all of the channeltypes, but still defined. e.g. ALARMLIMIT Low and Very low for channel type AI Pt are not used.


4.4 MAS 711 Parameter implementation

4.4.1 Table of Channels The MAS 711 channeltypes and channels are named and grouped as follows. Some channel names are fixed, while others are either automatically changed dependent on parameter FUNCTION settings or freely configurable. Name Meaning Ch Channel name AI Leakage Leakage sensor (3 input channels) 1 Leak. stator housing. 2 Leak. junction box 3 Leak. insp. chamber / Leak. water in oil AI TcPtc Thermo Contact/PTC (1 input channel) 1 Temp stator ph 1-3. AI TcPtcPt Thermo Contact/PTC/PT100. (3 input

channels) 1 Temp stator ph 1.

2 Temp stator ph 2. 3 Temp stator ph 3. AI Pt PT100 (2 input channels,) 1 Temp main bearing. 2 Temp support bearing. AI Current DC 4-20 mADC. (1 input channel) 1 "Vibration" 4. AI Current AC 0-1 AAC. (1 input channel) 1 Pump current 5 / Pump current 6 /

Pump running 7. XI Reserve Reserved. (5 input channels, 1 Temp pump memory. 2 Current unbalance. 3 System voltage / Voltage unbalance. 4 System power. 5 System power factor. AO Current DC 0-20 mADC.( 1 output channel,) 1 Temp stator max 1-3 /

Temp stator ph 1 / Temp stator ph 2 / Temp stator ph 3 / Temp main bearing / Temp support bearing /"Vibration" / Temp stator max 1-3

4 Configurable from webpages or display. 5 If “Pump current input (MAS)” selected from modbus, webpages or display (parameter FUNCTION = 0). 6 If “Pump current power analyzer” selected from modbus, webpages or display (parameter FUNCTION = 1). 7 If “Run input (MAS)” selected from modbus, webpages or display (parameter FUNCTION = 2).


4.4.2 VALUE – Measured value All VALUE elements consists of 2 registers each, and the formula to convert a VALUE element to a floating point number is:

D

xgDataxgDatanumber

10

1Re65536*Re

Where x is the Modbus address for the element you want to read, and D is the number of decimals according to parameter DECIMALS.

4.4.3 DECIMALS - Number of decimals for measured value (VALUE) The number of decimals (0 - 2) can be read from parameter DECIMALS. Currently there are no menus in the web interface or the display where the number of decimals can be changed, so you may assume the following default values as "hard coded" (this may change in future program versions) 45050 (17) DECIMALS - Number of decimals for

measured value (VALUE) DEFAULT

+0 AI Leakage [3 channels] 0 decimals (all channels) +3 AI TcPtc [1 channel] 1 decimal +4 AI TcPtcPt [3 channels] 1 decimals (all channels) +7 AI Pt [2 channels] 1 decimals (all channels) +9 AI Current DC [1 channel] 1 decimal +10 AI Current AC [1 channel] 1 decimal +11 XI Reserve [5 channels] 1,1,1,1,2 decimals (channel 1-5) +16 AO Current DC [1 channel] 1 decimal


4.4.4 ALARMARRAY – Channel related events (alarms) By reading alarm status from parameter ALARMARRAY, you can get a bit value indicating alarm status. Use Modbus command #01 or #02, since this is a bit-mapped (boolean) parameter. 09000 (136) ALARMARRAY - Channel related events (alarm)

element[0]: Short circuit (ohm) / Broken circuit (mA) element[1]: Very low element[2]: Low element[3]: High element[4]: Very high element[5]: Broken circuit (ohm) / Short circuit (mA) element[6]: - element[7]: - 0 = Not active 1 = Active

R bool 0..1

+0 AI Leakage [3 channels][8 elements] +24 AI TcPtc [1 channel] [8 elements] +32 AI TcPtcPt [3 channels] [8 elements] +56 AI Pt [2 channels] [8 elements] +72 AI Current DC [1 channel] [8 elements] +80 AI Current AC [1 channel] [8 elements] +88 XI Reserve [5 channels] [8 elements] +128 AO Current DC [1 channel] [8 elements]

AI Leakage, channel 1-3 (Leakage stator housing, Leakage junction box, etc…): element[0] = 0 or 1 (1 = Broken circuit). element[1] = 0 (Not used). element[2] = 0 (Not used). element[3] = 0 (Not used). element[4] = 0 or 1 (1 = Leakage). element[5] = 0 or 1 (1 = Short circuit).

AI TcPtc, channel 1 (Temp stator ph1-3): element[0] = 0 or 1 / 0 (PTC: 1 = Short circuit / TC: Not used). element[1] = 0 (Not used). element[2] = 0 (Not used). element[3] = 0 (Not used). element[4] = 0 or 1 (1 = Very High). element[5] = 0 (Not used).

PTC = Sensor: Thermistor. TC = Sensor: Thermal switch.

Only one of these can be 1 simultaneously

Only one of these can be 1 simultaneously


5 MAS 711 Base Unit - MODBUS virtual memory map

5.1 Bit addressing area (#01: Read "coil"-parameters)

Note that addr, size and offs are given in bits for these tables. 8 bits of data are packed into each byte in the answer, starting from initial bit address in the request, and any additional bits to fill up the last answer byte are set to zero. Bit addr

(Size) +Offs

MODULE PARAMETERS (1 dimensional) data[element] (array)

RW

Type Value (Unit)

02000 (23)

MODEVENT - Module related events 0 = Not active 1 = Active

R bool 0..1

+0 - +1 Reset (event) +2 Watchdog reset (B alarm) +3 FLASH error (B alarm) +4 EEPROM error (B alarm) +5 EEPROM init (event) +6 RAM error (B alarm) +7 Ethernet error (B alarm) +8 Program error (B alarm) +9 Clock error (B alarm) +10 File upload error (B alarm) +11 New program (event) +12 Email error (reserved) (B alarm) +13 Email test (reserved) (event) +14 Pump memory communication error (B alarm) +15 Pump memory EEPROM error (B alarm) +16 Pump memory different dataplate (B alarm) +17 Power analyzer communication error (B alarm) +18 - +19 - +20 Operator panel communication error (B alarm) +21 Service request (B alarm) +22 Database erased (event) 02050 (2) DIRELAY - DI relay status

0 = Off 1 = On

R bool 0..1

+0 Pump running indication (RUN) +1 Acknowledge/Reset alarm and module events

(RESET)

02060 (3) DORELAY - DO relay status

0 = Off 1 = On

R bool 0..1

+0 Pump blocked +1 A alarm +2 B alarm


Bit addr

(Size) +Offs

CHANNEL PARAMETERS (3 dimensional) data[channeltype][channel] [element] (asymmetric cube)

RW

Type Value (Unit)

09000 (136) ALARMARRAY - Channel related events (alarm)

element[0]: Short circuit (ohm) / Broken circuit (mA) element[1]: Very low element[2]: Low element[3]: High element[4]: Very high element[5]: Broken circuit (ohm) / Short circuit (mA) element[6]: - element[7]: - 0 = Not active 1 = Active

R bool 0..1

+0 AI Leakage [3 channels][8 elements] +24 AI TcPtc [1 channel] [8 elements] +32 AI TcPtcPt [3 channels] [8 elements] +56 AI Pt [2 channels] [8 elements] +72 AI Current DC [1 channel] [8 elements] +80 AI Current AC [1 channel] [8 elements] +88 XI Reserve [5 channels] [8 elements] +128 AO Current DC [1 channel] [8 elements]

5.2 Bit addressing area (#02 - "input" parameters)

Accessible via Modbus command #02. Identical to command #01, except that the memory map starts at 10000 instead of 0. E.g. MODEVENT is located at address 12000 instead of 2000.


5.3 Register addressing area (#03, #06, #16 - read/write "holding register" parameters)

Accessible via Modbus commands #03, #06, #16. Note that addr, size and offs are given in words (16 bits) for these tables. word addr

(size) +Offs

MODULE PARAMETERS (0 dimensional) data (simple)

RW

Type Value (Unit)

40100 (1) RESETEVENT - Acknowledge/reset events

Gives same function as pressing the acknowledge button (RESET) 1 = Acknowledge/Reset alarms and module events

W uint 1

40101 (1) MODNR - MAS 711 module number RW uint 0..255 40102 (1) LANGUAGEIDX - Selected language

If firmware and webpages for language group A is loaded: 0 = English 1 = French 2 = German 3 = Italian 4 = Spanish

If firmware and webpages for language group B is loaded: 0 = English 1 = Chinese

RW uint grpA: 0..4 grpB: 0..1

41000 (1) PMACTIVE - Pump memory activation, RS485-LOC

(master) 0 = No 1 = Yes

RW uint 0..1

41001 (1) PMNR - Pump memory number (com address) R uint 1 41002 (2) PMBAUDRATE - Pump memory baudrate R ulong 19200 41100 (1) EMACTIVE - Power analyzer activation, RS485-1


RW uint 0..1

41101 (1) EMNR - Power analyzer number (com address) RW uint 0..255 41102 (2) EMBAUDRATE - Power analyzer baudrate

RW ulong 2400, 4800, 9600, 19200

41104 (1) EMTYPE - Power analyzer type

0 = PAN311/WM14 1 = WM22

RW uint 0..1


41200 (1) DMACTIVE - Operator panel activation, RS485-LOC


RW uint 0..1

41201 (1) DMNR - Operator panel number (com address) R uint 2 41202 (2) DMBAUDRATE - Operator panel baudrate R ulong 19200 41300 (1) FMACTIVE - Higher level controller activation, RS485-

2 (slave) 0 = No 1 = Yes

RW uint 0..1

41301 (1) FMNR - Higher level controller number

(NOTE: This is the MAS 711 com address for the RS485-2 slave port)

RW uint 0..247

41302 (2) FMBAUDRATE - Higher level controller baudrate RW ulong 2400,

4800, 9600, 19200

Word addr

(Size) +Offs

MODULE PARAMETERS (1 dimensional)

data[element] (array)

RW

Type Value (Unit)

42000 (6) NUMCLOCK - Real-time clock RW uint +0 Year (update entire clock to memory when reading

year) 0..99

+1 Month 1..12 +2 Day 1..31 +3 Hour 0..59 +4 Minute 0..59 +5 Second (set entire clock from memory when writing

second) 0..59

42010 (2) DIRELAYFUNCTION - DI relay function RW uint 0..1 +0 Pump running indication (RUN)

0 = Open is On (running) 1 = Close is On (running)

+1 Acknowledge/reset alarm and module events (RESET) 0 = Open is On (acknowledge/reset) 1 = Close is On (acknowledge/reset)

42020 (3) DORELAYFUNCTION - DO relay function RW uint 0..1 +0 Pump blocking

0 = Open is On (blocked) 1 = Close is On (blocked)

+1 A alarm 0 = Open is On (alarm) 1 = Close is On (alarm)


+2 B alarm 0 = Open is On (alarm) 1 = Close is On (alarm)

43000 (400) PMDATAPLATE1 - Pump memory dataplate (default) RW string ASCII +0 Line 1 (40 characters, padded with SPACE to full

length)

+20 Line 2 (40 characters, padded with SPACE to full length)


: +380 Line 20 (40 characters, padded with SPACE to full

length)

43400 (400) PMDATAPLATE2 - Pump memory dataplate (custom) RW string ASCII +0 Line 1 (40 characters, padded with SPACE to full

length)



: +380 Line 20 (40 characters, padded with SPACE to full

length)

43996 (2) PMPUMPTOTALSTARTS - Pump total starts R ulong 43998 (2) PMPUMPTOTALTIME - Pump total running time (h) R fix1 44000 (86) EMVALUE - Power analyzer values +0 PM TEMP Pump memory temperature

8 R fix2

9

+2 V L1 Pump voltage ph 1 +4 V L2 Pump voltage ph 2 +6 V L3 Pump voltage ph 3 +8 A L1 Pump current ph 1 +10 A L2 Pump current ph 2 +12 A L3 Pump current ph 3 +14 W L1 +16 W L2 +18 W L3 +20 VAR L1 +22 VAR L2 +24 VAR L3 +26 VA L1 +28 VA L2 +30 VA L3 +32 PF L1

8 Not really a power analyzer value (this value is used internally in MAS, for FUNCTION index compliance). 9 The 2nd decimal is always zero for all values, except for power factors (PF).


+34 PF L2 +36 PF L3 +38 V SYS System voltage +40 W SYS System power +42 VAR SYS +44 VA SYS +46 PF SYS System power factor +48 VA DMD +50 W DMD +52 HZ +54 THD V1

10

+56 THD V2 +58 THD V3 +60 THD A1 +62 THD A2 +64 THD A3 +66 KWH TOT Total energy +68 KVARH TOT +70 KWH PAR +72 KVARH PAR +74 THDMAX V +76 THDMAX A +78 A MEAN Pump current mean

11

+80 A UNBALANCE Current unbalance +82 V MEAN Pump voltage mean +84 V UNBALANCE Voltage unbalance Word addr

(Size) +Offs

CHANNEL PARAMETERS (2 dimensional) data[channeltype][channel] (asymmetric matrix)

RW

Type Value (Unit)

45000 (34) ALARMHYSTERESIS - Alarm hysteresis RW fix5 +0 AI Leakage [3 channels] +6 AI TcPtc [1 channel] +8 AI TcPtcPt [3 channels] +14 AI Pt [2 channels] +18 AI Current DC [1 channel] +20 AI Current AC [1 channel] +22 XI Reserve [5 channels] +32 AO Current DC [1 channel] 45050 (17) DECIMALS - Number of decimals for measured value

(VALUE) RW uint

+0 AI Leakage [3 channels] +3 AI TcPtc [1 channel] +4 AI TcPtcPt [3 channels] +7 AI Pt [2 channels] +9 AI Current DC [1 channel]

10 THD and PAR values are only available for power analyzer WM22, else they are not updated. 11 MEAN and UNBALANCE are calculated values in MAS.


+10 AI Current AC [1 channel] +11 XI Reserve [5 channels] +16 AO Current DC [1 channel] 45080 (17) SENSOR - Type of sensor RW uint +0 AI Leakage [3 channels]

0 = None 1 = FLS 2 = FLS10 3 = FLS20 4 = CLS

0..4

+3 AI TcPtc [1 channel] 0 = None 1 = TC 2 = PTC

0..2

+4 AI TcPtcPt [3 channels] 0 = None 1 = TC 2 = PTC 3 = PT100

0..3

+7 AI Pt [2 channels] 0 = None 3 = PT100

0,3

+9 AI Current DC [1 channel] 0 = None 1 = Input value according to FUNCTION

0..1

+10 AI Current AC [1 channel] 0 = None 1 = Input value according to FUNCTION

0..1

+11 XI Reserve [5 channels] 0 = None 1 = Input value according to FUNCTION

0..1

+16 AO Current DC [1 channel] 0 = None 1 = Output value according to FUNCTION

0..1

45110 (17) FUNCTION - Channel function RW uint +0 AI Leakage [3 channels]

0 = Leak. stator housing (fixed for channel 1) 12 1 = Leak. junction box (fixed for channel 2)

2 = Leak. insp. chamber (default for channel 3) 3 = Leak. water in oil

chn1: 0 chn2: 1 chn3: 2,3

+3 AI TcPtc [1 channel] 0 = Temp stator ph 1-3 (fixed for channel 1)

0

+4 AI TcPtcPt [3 channels] 0 = Temp stator ph 1 (fixed for channel 1) 1 = Temp stator ph 2 (fixed for channel 2) 2 = Temp stator ph 3 (fixed for channel 3)

chn1: 1 chn2: 2 chn3: 3

+7 AI Pt [2 channels] 0 = Temp main bearing (fixed for channel 1)

chn1: 0

12 ”fixed for channel…” = The default value should never be changed for these channels, (no menu item to change parameter FUNCTION in webpages or display).


1 = Temp support bearing (fixed for channel 2) chn2: 1 +9 AI Current DC [1 channel]

0 = Input 4-20 mA ("Vibration")(fixed for channel 1)

0 +10 AI Current AC [1 channel]

0 = Pump current input (MAS 711) 1 = Pump current power analyzer 2 = Run input (MAS 711)

0..2

+11 XI Reserve [5 channels] 0 = Temp pump memory (fixed for channel 1) 19 = System voltage 20 = System power (fixed for channel 4)

23 = System power factor (fixed for channel 5) 40 = Current unbalance (fixed for channel 2) 42 = Voltage unbalance (default for channel 3)

chn1: 0 chn2: 40chn3: 19, 42 chn4: 20chn5: 23

+16 AO Current DC [1 channel] 0 = Temp stator max 1-3 1 = Temp stator ph 1 2 = Temp stator ph 2 3 = Temp stator ph 3 4 = Temp main bearing 5 = Temp support bearing 6 = Input 4-20 mA ("Vibration")

0..6

45140 (10) COMPENSATION - Compensation for sensor

resistance Only valid if PT100 sensor is selected

RW fix0 0..100

+0 AI TcPtcPt [3 channels] +6 AI Pt [2 channels] 45160 (6) MINSETVALUE - Min limit for measured value

(VALUE) RW fix0

+0 AI Current DC [1 channel] x = 4 mA

0..99999

+2 AI Current AC [1 channel] x = 0 A

0..999

+4 AO Current DC [1 channel] x = 0 mA

0..99999

45170 (6) MAXSETVALUE - Max limit for measured value

(VALUE) RW fix0

+0 AI Current DC [1 channel] x = 20 mA

0..99999

+2 AI Current AC [1 channel] x = 1 A

0..999

+4 AO Current DC [1 channel] x = 20 mA

0..99999

45180 (34) VALUE - Measured value R fixN

13

13 ”fixN” = Number of decimals according to parameter DECIMALS.


+0 AI Leakage [3 channels] +6 AI TcPtc [1 channel] +8 AI TcPtcPt [3 channels] +14 AI Pt [2 channels] +18 AI Current DC [1 channel] +20 AI Current AC [1 channel] +22 XI Reserve [5 channels] +32 AO Current DC [1 channel] 45230 (24) DAYVALUE - Frozen 24h value, mean

Updated at midnight R fixN

+0 AI TcPtcPt [3 channels] +6 AI Pt [2 channels] +10 AI Current DC [1 channel] +12 AI Current AC [1 channel] +14 XI Reserve [5 channels] 45260 (24) DAYMINVALUE - Frozen 24h value, min


+0… (Cp. DAYVALUE) 45290 (24) DAYMAXVALUE - Frozen 24h value, max


+0… (Cp. DAYVALUE) Word Addr

(Size) +Offs

CHANNEL PARAMETERS (3 dimensional) data[channeltype][channel][element] (asymmetric cube)

RW

Type Value (Unit)

49000 (102) ALARMACTION - Alarm action (alarm priority)

element [0]: Short circuit (ohm) / Broken circuit (mA) element [1]: Very low element [2]: Low element [3]: High element [4]: Very high element [5]: Broken circuit (ohm) / Short circuit (mA) 0 = None 1 = A alarm 2 = B alarm

RW uint 0..2

+0 AI Leakage [3 channels] [6 elements] +18 AI TcPtc [1 channel] [6 elements] +24 AI TcPtcPt [3 channels] [6 elements] +42 AI Pt [2 channels] [6 elements] +54 AI Current DC [1 channel] [6 elements] +60 AI Current AC [1 channel] [6 elements] +66 XI Reserve [5 channels] [6 elements] +96 AO Current DC [1 channel] [6 elements] 49130 (204) ALARMLIMIT - Alarm limit

element [0]: Short circuit (ohm) / Broken circuit (mA) element [1]: Very low element [2]: Low

RW fix3


element [3]: High element [4]: Very high element [5]: Broken circuit (ohm) / Short circuit (mA)

+0 AI Leakage [3 channels] [6 elements] +36 AI TcPtc [1 channel] [6 elements] +48 AI TcPtcPt [3 channels] [6 elements] +84 AI Pt [2 channels] [6 elements] +108 AI Current DC [1 channel] [6 elements] +120 AI Current AC [1 channel] [6 elements] +132 XI Reserve [5 channels] [6 elements] +192 AO Current DC [1 channel] [6 elements] 49390 (102) ALARMRESET- Alarm reset, mode

element [0]: Short circuit (ohm) / Broken circuit (mA) element [1]: Very low element [2]: Low element [3]: High element [4]: Very high element [5]: Broken circuit (ohm) / Short circuit (mA) 0 = Auto 1 = Manual

RW uint 0..1

+0… (Cp. ALARMACTION) 49520 (204) ALARMDELAY - Alarm delay

element [0]: Short circuit (ohm) / Broken circuit (mA) element [1]: Very low element [2]: Low element [3]: High element [4]: Very high element [5]: Broken circuit (ohm) / Short circuit (mA)

RW fix0 0..25 (s)

+0… (Cp. ALARMLIMIT)

5.4 Register addressing area (#04 - read "input register" parameters)

Accessible via Modbus command #04. Identical to command #03, except that the memory map starts at 30000 instead of 40000. E.g. RESETEVENT is located at address 30100 instead of 40100. (See chapter 5.3).


6 Query and Response examples

6.1 Modbus Command table excerpt

#01: "Read coils" N = size according to bytes = (bits + 7) div 8 Q: <id:1>,<0x01>,<addr:2>,<bits:2>,<crc:2> A: <id:1>,<0x01>,<bytes:1>,<mask:N>,<crc:2> Exc: <id:1>,<0x81>,<exc:1>,<crc:2> #02: "Read discrete inputs" N = size according to bytes = (bits + 7) div 8 Q: <id:1>,<0x02>,<addr:2>,<bits:2>,<crc:2> A: <id:1>,<0x02>,<bytes:1>,<mask:N>,<crc:2> Exc: <id:1>,<0x82>,<exc:1>,<crc:2> #03: "Read holding registers" N = size according to bytes = regs * 2 Q: <id:1>,<0x03>,<addr:2>,<regs:2>,<crc:2> A: <id:1>,<0x03>,<bytes:1>,<value:N>,<crc:2> Exc: <id:1>,<0x83>,<exc:1>,<crc:2> #04: "Read input registers" N = size according to bytes = regs * 2

Q: <id:1>,<0x04>,<addr:2>,<regs:2>,<crc:2> A: <id:1>,<0x04>,<bytes:1>,<value:N>,<crc:2> Exc: <id:1>,<0x84>,<exc:1>,<crc:2> #06: "Write single register" Q: <id:1>,<0x06>,<addr:2>,<value:2>,<crc:2> A: <id:1>,<0x06>,<addr:2>,<value:2>,<crc:2> Exc: <id:1>,<0x86>,<exc:1>,<crc:2> #16: "Write multiple registers" N = size according to bytes Q: <id:1>,<0x10>,<addr:2>,<regs:2>,<bytes:1>,<value:N>,<crc:2> A: <id:1>,<0x10>,<addr:2>,<regs:2>,<crc:2> Exc: <id:1>,<0x90>,<exc:1>,<crc:2> Q = Query. A = Answer. Exc = Exception code. id = MAS communication address (slave). addr = Start address (big endian). regs = Number of registers (big endian). bits = Number of bits (big endian). bytes = Byte count.

value = Data value (big endian). mask = Data bitmask. crc = Cyclic redundancy checksum (little endian). <:1> = Item size is 1 byte. <:2> = Item size is 2 byte. <:N> = Item size in number of bytes, according to the content of bytes.


Below follows a few examples of MAS 711 base unit modbus communication, i.e. how to build up a query as well as how to interpret the answer.

6.2 Read ModNr parameter from MAS 1 which has MAS modbus id 14 Slave (ModBus ID) 0x0E (14) Function 0x03 Read Holding register Start address 0x9CA5 MODNR (40101) Number of regs 0x0001 Checksum 0xBA86 Query: <0x0E>,<0x03>,<0x9CA5>,<0x0001>,<0xBA86> Response: <0x0E>,<0x03>,<0x02>,<0x0001>,<0x2D85> Slave (ModBus ID) 0x0E (14) Function 0x03 (Read Holding register) Bytes count 0x02 (Size of answer) Register value 0x0001 Checksum 0x2D85 The MODNR hence equals 1.

6.3 Read Main Bearing Temp parameter from MAS with modbus id 15 Slave (ModBus ID) 0x0F (15) Function 0x03 Read Holding register Start address 0xB08A VALUE(AI Pt) (45180+14) Number of regs 0x0002 Checksum 0xC20F Query: <0x0F>,<0x03>,<0xB08A>,<0x0001>,<0xC20F> Response: <0x0F>,<0x03>,<0x04>,<0x000000FE>,<0x9473> Slave (ModBus ID) 0x0F (15) Function 0x03 (Read Holding register) Bytes count 0x04 (Size of answer) Register value 0x000000FE (254) Checksum 0x9473 The result should be interpreted that the temperature is 25,4 degrees. Divide the actual value by 10 since the the number of decimals for this channel is 1. See chapter 4.4.2 Main bearing temp equals 254/10 = 25,4 degrees


6.4 Check Leakage alarm parameter from MAS with MAS Modbus ID 15 Slave (ModBus ID) 0x0F (15) Function 0x01 Read Coils Start address 0x2328 ALARMARRAY AI Leakage

(9000) Number of regs 0x0018 24 bits Checksum 0xB6A2 Query: <0x0F>,<0x01>,<0x2328>,<0x0018>,<0xB6A2> Response: <0x0F>,<0x01>,<0x03>,<0x000000>,<0x6196> Slave (ModBus ID) 0x0F (15) Function 0x01 Read Coils Bytes count 0x03 24 bits, 8 bytes Register value 0x000000 (0) Checksum 0x6196 No leakage detected. AI Leakage has 3 channels and 8 elements. See also chapter 4.4.4

6.5 Check Temp stator alarm parameter from MAS with Modbus ID 15 Slave (ModBus ID) 0x0F (15) Function 0x01 Read Coils Start address 0x2348 ALARMARRAY AI TcPtcPt

(9000+32) Number of regs 0x0018 24 bits Checksum 0xB6BC Query: <0x0F>,<0x01>,<0x2348>,<0x0018>,<0xB6BC> Response: <0x0F>,<0x01>,<0x03>,<0x080000>,<0xBCA2> Slave (ModBus ID) 0x0F (15) Function 0x01 Read Coils Bytes count 0x03 24 bits, 8 bytes Register value 0x080000 Checksum 0xBCA2 3 channels, 8 elements in each. Channel 1 (0x08), Channel 2 (0x00) Channel 3 (0x00) Channel 1 indicates 0x08 => 00001000b => element[3] is set to 1 Temp stator phase 1 (channel 1) indicates high temperature (element[3]) See also chapter 4.4.4


7 MAS Base Unit - Modbus Revision history Revision 3.15 changes: Differentiated memory map, for command #01: 00000..01999 = 0-dimensional parameters (simple). 2000 bits available. 02000..04999 = 1-dimensional parameters (array). 3000 bits available. 05000..08999 = 2-dimensional parameters (matrix). 4000 bits available. 09000..17055 = 3-dimensional parameters (cube). 8056 bits available. Differentiated memory map, for command #02: 10000..11999 = 0-dimensional parameters (simple). 2000 bits available. 12000..04999 = 1-dimensional parameters (array). 3000 bits available. 15000..08999 = 2-dimensional parameters (matrix). 4000 bits available. 19000..27055 = 3-dimensional parameters (cube). 8056 bits available. Differentiated memory map, for command #03, #06, #16: 40000..41999 = 0-dimensional parameters (simple). 2000 registers available. 42000..44999 = 1-dimensional parameters (array). 3000 registers available. 45000..48999 = 2-dimensional parameters (matrix). 4000 registers available. 49000..57055 = 3-dimensional parameters (cube). 8056 registers available. Differentiated memory map, for command #04: 30000..31999 = 0-dimensional parameters (simple). 2000 registers available. 32000..34999 = 1-dimensional parameters (array). 3000 registers available. 35000..38999 = 2-dimensional parameters (matrix). 4000 registers available. 39000..47055 = 3-dimensional parameters (cube). 8056 registers available.


Revision 2.15 changes:

Compressed memory map to allow better PLC compatibility (for Koyo PLC etc.). 00000..01999 = 0-dimensional parameters (simple). 2000 registers available. 02000..04999 = 1-dimensional parameters (array). 3000 registers available. 05000..08999 = 2-dimensional parameters (matrix). 4000 registers available. 09000..17055 = 3-dimensional parameters (cube). 8056 registers available.

Channel parameters now have room to add about 2..4 new channels in the future.

New parameters added: PMPUMPTOTALSTART, PMPUMPTOTALTIME, EMTYPE, EMVALUE.

Register address resolution changed from byte to word.

Registers now in 'big endian' format (MSB first).

Register addressing memory map changed.

Now 2 separate memory maps, one for register addressing and one for bit addressing.

New commands #01 and #02 implemented, dedicated for bit addressing ("coil" / "discrete inputs").

Old functionality and memory mapping (Modbus revision 1) can be selected via special compatibility parameter, available from web interface. Modbus revision 1 is compatible with older firmware releases, but not Modbus revision 2. (Default: new functionality = Modbus revision 2 selected).

Modbus “delayed reply flush timeout” now configurable via web interface (default: 2 s). (Previously hard-coded to 3 s).

Return exception code 0x06 ("slave device busy") during backup or when busy, if predictable. Configurable via web interface. (Default: off).

8 Document Revision history Revision Date Comment By 1.0 (v8) 2009-07-09 Issued Fas859 V9 2010-05-17 Updated chapter 3.5. Changed serial number

for terminating resistor Fas859


Intentionally left blank for printing as booklet

What can ITT Water & Wastewater do for you? Integrated solutions for fluid handling are offered by ITT Water & Wastewater as a world leader in transport and treatment of wastewater. We provide a complete range of water, wastewater and drainage pumps, equipment for monitoring and control, units for primary and secondary biological treatment, products for filtration and disinfection, and related services. ITT Water & Wastewater, headquartered in Sweden, operates in some 140 countries across the world, with own plants in Europe, China and North and South America. The company is wholly owned by the ITT Corporation of White Plains, New York, supplier of advanced technology products and services.

Visit our Web site for the latest version of this document and more information www.ittwww.com

ITT Water & Wastewater AB SE-174 87 Sundbyberg Sweden

Visiting address: Gesällvägen 33 Sundbyberg

Sweden Tel. +46–8–475 60 00 Fax +46–8–475 69 00

© ITT Water & Wastewater AB. Original instructions. 898595_1.0_en.US_2009–06_TI.MAS

mas base unit - modbus protocol revision 3 · 2 the modbus rtu protocol ... 3.4 modbus protocol...

Documents