Communication Modules SITRANS F M MAG 8000

8/13/2019 Communication Modules SITRANS F M MAG 8000

1/81

SITRANS F

Electromagnetic Flowmeters

Communication Modules

SITRANS F M MAG 8000 Modbus RTU

Operating Instructions • 08/2011


2/81


3/81

1 Introduction2Safety notes3Hardware InstallationSITRANS F 4Connecting

Communication ModulesSITRANS F M MAG 8000Modbus RTU5System integration6Function codes

Operating Instructions 7Technical dataAModbus holding registersBAppendix

Add-on module for use with flowmeter typesSITRANS F M MAG 8000

08/2011A5E03409989-01


4/81

Legal informationWarning notice system

This manual contains notices you have to observe in order to ensure your personal safety, as well as to preventdamage to property. The notices referring to your personal safety are highlighted in the manual by a safety alertsymbol, notices referring only to property damage have no safety alert symbol. These notices shown below aregraded according to the degree of danger.

DANGERindicates that death or severe personal injury will result if proper precautions are not taken.

WARNINGindicates that death or severe personal injury may result if proper precautions are not taken.

CAUTIONwith a safety alert symbol, indicates that minor personal injury can result if proper precautions are not taken.

CAUTIONwithout a safety alert symbol, indicates that property damage can result if proper precautions are not taken.

NOTICEindicates that an unintended result or situation can occur if the relevant information is not taken into account.

If more than one degree of danger is present, the warning notice representing the highest degree of danger willbe used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating toproperty damage.

Qualified PersonnelThe product/system described in this documentation may be operated only by personnel qualified for the specifictask in accordance with the relevant documentation, in particular its warning notices and safety instructions.Qualified personnel are those who, based on their training and experience, are capable of identifying risks andavoiding potential hazards when working with these products/systems.

Proper use of Siemens productsNote the following:

WARNINGSiemens products may only be used for the applications described in the catalog and in the relevant technicaldocumentation. If products and components from other manufacturers are used, these must be recommendedor approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation andmaintenance are required to ensure that the products operate safely and without any problems. The permissibleambient conditions must be complied with. The information in the relevant documentation must be observed.

TrademarksAll names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publicationmay be trademarks whose use by third parties for their own purposes could violate the rights of the owner.

Disclaimer of LiabilityWe have reviewed the contents of this publication to ensure consistency with the hardware and softwaredescribed. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, theinformation in this publication is reviewed regularly and any necessary corrections are included in subsequenteditions.

Siemens AG Order number: A5E03409989 Copyright © Siemens AG 2011.Industry Sector Ⓟ 08/2011 Technical data subject to changePostfach 48 48

90026 NÜRNBERGGERMANY


5/81


Operating Instructions, 08/2011, A5E03409989-01 3

Table of contents

1 Introduction................................................................................................................................................ 51.1 Document history ...........................................................................................................................5

1.2 Modbus RTU technology ...............................................................................................................6

1.3 Further Information ........................................................................................................................8

2 Safety notes............................................................................................................................................... 92.1 Installation in hazardous area ........................................................................................................9

3 Hardware Installation ............................................................................................................................... 114 Connecting .............................................................................................................................................. 13

4.1 Wiring ...........................................................................................................................................13

4.2 Closing the device........................................................................................................................15

5 System integration................................................................................................................................... 175.1 System integration instructions ....................................................................................................17

5.2 Function check.............................................................................................................................17

5.3 Communication parameter settings .............................................................................................18

5.4 Parameter access ........................................................................................................................18

5.5 Commissioning with PDM............................................................................................................195.5.1 General instructions .....................................................................................................................195.5.2 Commissioning steps...................................................................................................................195.5.3 Installing EDD files.......................................................................................................................205.5.4 Adding device to network.............................................................................................................215.5.5 Configuring the device .................................................................................................................225.5.6 Operation .....................................................................................................................................24

6 Function codes ........................................................................................................................................ 256.1 Modbus Commands.....................................................................................................................25

6.2 Read coils ....................................................................................................................................26

6.3 Read multiple registers ................................................................................................................28

6.4 Write single coil ............................................................................................................................30

6.5 Write multiple registers ................................................................................................................31

6.6 Report slave ID command ...........................................................................................................34

6.7 Exception handling.......................................................................................................................35

7 Technical data ......................................................................................................................................... 37


6/81

Table of contents


4 Operating Instructions, 08/2011, A5E03409989-01

A Modbus holding registers......................................................................................................................... 39A.1 Introduction to holding registers.................................................................................................. 39

A.2 MODBUS application settings..................................................................................................... 40

A.3 MODBUS driver settings ............................................................................................................. 41

A.4 Menu control ...............................................................................................................................42

A.5 Sensor characteristics.................................................................................................................43

A.6 Totalization..................................................................................................................................45

A.7 Pulse output ................................................................................................................................45

A.8 Service control ............................................................................................................................47

A.9 Error messages...........................................................................................................................47

A.10 Power control ..............................................................................................................................53A.11 Consumption statistic ..................................................................................................................55

A.12 Consumption profile ....................................................................................................................56

A.13 Leakage statistic .........................................................................................................................57

A.14 Datalog........................................................................................................................................59

A.15 Consumption readings ................................................................................................................68

B Appendix.................................................................................................................................................. 69B.1 Data type mapping ......................................................................................................................69

B.2 CRC calculation ..........................................................................................................................70Glossary .................................................................................................................................................. 75Index........................................................................................................................................................ 77


7/81



Introduction 1

PurposeThe Operating Instructions provide all information necessary for the installation and use ofthe Modbus RTU add-on module (FDK:087L4212 or FDK:087L4213), intended for use withthe electromagnetic transmitter type SITRANS F M MAG 8000.

NOTICEReduced battery lifetimeThe Modbus RTU communication module is designed for use with mains powered deviceversions only.

Use of the Modbus RTU communication module with battery-powered device versions willreduce the expected battery lifetime significantly.

Basic knowledge requiredThe instructions are not intended to be a complete tutorial on the Modbus RTU protocol, andit is assumed the end user already has a general working knowledge of Modbus RTU

communication, especially in respect of master station configuration and operation. Howeveran overview is included in the following section to explain some fundamental aspects of theprotocol.

See alsoFor more information about SITRANS F M transmitters and sensors, please refer to theappropriate Operating Instructions available on the flowdocumentation homepage(http://www.siemens.com/flowdocumentation) or on the SITRANS F literature CD-ROM.

1.1 Document historyThe contents of these instructions are regularly reviewed and corrections are included insubsequent editions. We welcome all suggestions for improvement.

The following table shows the most important changes in the documentation compared toeach previous edition.

Edition Remarks12/2010 1. edition

http://www.siemens.com/flowdocumentationhttp://www.siemens.com/flowdocumentation


8/81

Introduction

1.2 Modbus RTU technology



1.2 Modbus RTU technologyModbus RTU is an open, serial (RS-232 or RS-485) protocol based on master/slave orclient/server architecture. The protocol interconnects field equipment such as sensors,actuators, and controllers and is widely used in both process and manufacturing automation.The fieldbus environment is the base level group of digital networks in the hierarchy of plantnetworks.

FeaturesThe SITRANS F Modbus RTU Communication modules comply with the Modbus Serial LineProtocol. Among other things this implies a Master-Slave protocol at level 2 of the OSImodel. A node (the master) issues explicit commands to one of the slave nodes andprocesses responses. Slave nodes will not transmit data without a request from the masternode, and do not communicate with other slaves.

Modbus is a mono Master system, which means that only one Master can be connected atthe time.


9/81

Introduction

1.2 Modbus RTU technology



Communication modesTwo modes of communication are possible, Unicast and Broadcast.

● In unicast mode the Master sends a request to a specific Slave device, and waits aspecified time for a response.

Slave Slave Slave

Master

r e s p o n s e

r e q u e s t

Figure 1-1 Unicast Mode

● In Broadcast mode the master sends out a request to address "0", which means that theinformation is for all Slave devices on the network. In Broadcast mode there is noresponse from the Slave devices.

Slave Slave Slave

Master

r e q u e s t

Figure 1-2 Broadcast Mode

Modbus FrameThe Modbus frame is shown below, and is valid for both requests and responses.

Table 1- 1 Modbus Frame

SLAVE ADDRESS FUNCTION MODE DATA CRC

1 Byte 1 Byte 0 ... 252 Bytes 2 Bytes


10/81

Introduction

1.3 Further Information



ReferencesFor further information, please refer to the following specification and guidelines available at

the Modbus Organisation (http://www.modbus.org/) Website1. Serial Line Specification & Implementation guide v. 1.02. Application Protocol Specification v. 1.1

1.3 Further InformationThe contents of these operating instructions shall not become part of or modify any prior orexisting agreement, commitment or legal relationship. All obligations on the part of SiemensAG are contained in the respective sales contract which also contains the complete andsolely applicable warranty conditions. Any statements contained herein do not create newwarranties or modify the existing warranty.

Product information on the InternetThe Operating Instructions are available on the CD-ROM shipped with the device, and onthe Internet on the Siemens homepage, where further information on the range of SITRANSF flowmeters may also be found:

Product information on the internet (http://www.siemens.com/flow)

Worldwide contact personIf you need more information or have particular problems not covered sufficiently by theoperating instructions, please get in touch with your contact person. You can find contactinformation for your local contact person on the Internet:

Local contact person (http://www.automation.siemens.com/partner )

http://www.modbus.org/http://www.siemens.com/flowhttp://www.automation.siemens.com/partnerhttp://www.automation.siemens.com/partnerhttp://www.siemens.com/flowhttp://www.modbus.org/


11/81



Safety notes 2

CAUTIONCorrect, reliable operation of the product requires proper transport, storage, positioning andassembly as well as careful operation and maintenance. Only qualified personnel shouldinstall or operate this instrument.

NoteAlterations to the product, including opening or improper repairs of the product, are notpermitted.

If this requirement is not observed, the CE mark and the manufacturer's warranty will expire.

2.1 Installation in hazardous areaWARNING

NOT allowed for use in hazardous areasEquipment used in hazardous areas must be Ex-approved and marked accordingly!

This device is NOT approved for use in hazardous areas!


12/81

Safety notes

2.1 Installation in hazardous area




13/81



3ardware InstallationThe installation procedure for an add-on module to a MAG 8000 transmitter is as follows:

1. Loosen screws on transmitter top.2. Remove transmitter top using a screwdriver.3. Dispose of silica gel bag.4. Mount the modules on the backside of the MAG 8000 electronics.

Figure 3-1 Hardware installation

5. Use the two supplied 3mm screws and washers to fix the module to the MAG 8000electronics.


14/81

Hardware Installation




15/81



4onnectingNoteShieldingAlways shield a Modbus over Serial Line Cable. At one end of each cable its shield must beconnected to protective ground. If a connector is used at this end, the shell of the connectoris connected to the shield of the cable.

NoteCable specificationsA RS485-Modbus must use a balanced pair (for D0-D1) and a third wire (for the Common).For the balanced pairs used in an RS485-system, a Characteristic Impedance with a valuebetween 100 and 120 Ohms must be used.

4.1 Wiring● Connect shield to MAG 8000 enclosure using the cable clamp

Figure 4-1 Cable shield connection


16/81

Connecting

4.1 Wiring



RS232 connection diagram

① Common② Connect shield to enclosure③ Shield connected to protective ground

① Common

RS485 connection diagram

① Common② Connect shield to enclosure③ Shield connected to protective ground


17/81

Connecting

4.2 Closing the device



① Common② Termination

Bus terminationAll RS485-based networks must be terminated correctly to function properly. A terminationmust be placed at each end of segment.

The Modbus RTU module can add a 120 ohm termination if a jumper is placed besideterminals in position "ON".

● Termination is set to "ON" from factory.

4.2 Closing the device1. Replace O-ring to ensure continued IP68 enclosure rating.

– Check O-ring for damage or deformity. – Smear O-ring with acid-free lubricating gel.

2. Add new Silica gel bag – Remove plastic bag from new silica gel bag.

– Place new silica gel bag on top of battery pack to prevent condensation within meter.

– To maintain IP68 enclosure the silica gel bag may not be in contact with the Sylgard.3. Mount top lid.4. Fasten screws to reassemble meter completely.

NoteAll sealed MAG 8000 CT meters have to be re-verified when sealings (marked "A") havebeen broken.


18/81

Connecting

4.2 Closing the device



NOTICELoss of degree of protectionDamage to device if the enclosure is open or not properly closed. The degree of protectionspecified on the nameplate or in "Technical data" is no longer guaranteed.

• Make sure that the device is securely closed.

See alsoTechnical data (Page 37)


19/81


20/81

System integration

5.3 Communication parameter settings



5.3 Communication parameter settingsEffect of changing baudrate or framing

Changing baudrate or framing has effect on the communication as follows:

When changed from the Modbus master, the new settings only have effect after a reset(PowerUp) of the device– or after writing to the "ResetCommunication" coil.

Table 5- 1 Communication parameters

Item Value DescriptionDevice Communication Address 1-247 Device address [Factory setting: 1]

Baud rate 1200, 2400, 4800, 9600, 19200, 38400 Communication speed

[Factory setting: 19200]

Parity • Even, 1 stop bit• Odd, 1 stop bit• None, 2 stop bit• None, 1 stop bit

Communication parameters

[Factory setting: Even, 1 stopbit ]

Interframe Space 35-255 chars The minimum interframe spacebetween two Modbus RTU messagesin sequence (specified as 3.5characters) is configurable. Range: 3.5 – 25 character times. Specified in bytestimes ten.

[Factory setting: 35 ]

Response Delay 0-255 msec. The minimum time from when a slavereceives a request and until it returns aresponse. This makes it possible tosend data to slow masters.

[Factory setting: 5 ]

5.4 Parameter accessWrite protection

Writable parameters in the MAG 8000 are protected by a software password. Someparameters with influence on the accuracy or identity of the flowmeter are furthermoreprotected by a hardware lock.

For information on how to unlock parameters protected by a hardware lock, refer to the MAG8000 Operating Instructions.


21/81

System integration

5.5 Commissioning with PDM



Parameter accessWhen attempting to write a parameter without a password, MAG 8000 will return "Illegal data

address" exception code.To successfully change a parameter, use the following routine:

1. Write the password to parameter "Meter Access Code" at address 2007. Defaultpassword is "1000"

2. Change the parameter.When the correct password has been entered, the flowmeter remains "unlocked" for 10minutes after last communication.

If a parameter is write-protected by a hardware lock, the MAG 8000 will return "Illegal dataaddress".


5.5.1 General instructionsSIMATIC PDM (Process Device Manager) is a software package for configuring,parameterizing, commissioning and maintaining devices (e.g. transducers) and forconfiguring networks and PCs.

Among other features, SIMATIC PDM contains a simple process monitoring of processvalues, interrupts and status/diagnosis signals of device.

NoteFor instructions on installation and operation of SIMATIC PDM, please refer to the SIMATICPDM Getting Started

NOTICEInfrared communicationActivated infrared communication blocks all communication with a wired Modbus master.

• Ensure that no infrared communication is activated before communicating with the wiredModbus master.

5.5.2 Commissioning stepsIn the following it is described how to commission the device with SIMATIC PDM.

The steps are divided into the following sections:


22/81

System integration




1. Install the EDD files (Page 20)2. Add the device to the communication network (Page 21)3. Configure the device (Page 22).

Describes the setup of the basic parameters of the flowmeter.

4. Operation (Page 24).Describes how to view all available process values.

5.5.3 Installing EDD filesInstalling EDD files

Procedure for installing PDM device driver consists of the following steps:

● Download update from the Internet on MAG 8000 Downloads(http://support.automation.siemens.com/WW/view/en/19701862/133100) , or copy it fromsupplied CD into envisaged folder and unzip file. It is recommended to check that theEDD is the version valid for the device.

● Open "Manage Device Catalog" from Start > SIMATIC > SIMATIC PDM.

● Navigate to PDM device driver, select device and click "OK" and driver is installed on PC.

http://support.automation.siemens.com/WW/view/en/19701862/133100http://support.automation.siemens.com/WW/view/en/19701862/133100


23/81

System integration




5.5.4 Adding device to networkBefore setting the parameters, it is necessary to configure the MAG 8000 project in PDM.

1. Add the device to SIMATIC Modbus network: – Select "File"->"New"

Type in a project name, e.g. MAG 8000

– Right click on "Net" and select "Insert New Object"->"Modbus Net".Your PC is now added to the Modbus Net, e.g. NOG0482D

– Right click on "Modbus Net" and select "Insert New Object"->"Modbus Device".

– Click on "Assign" and assign the Modbus device to MAG8000 Advanced or Basic(Sensors->Flow->Electromagnetic->SIEMENS AG->MAG8000) and click "ok".

Figure 5-1 Assigning Modbus device to network

– Rename the device according to the application requirements (max. 32 characters).

2. Set up the communication parameters for SIMATIC Modbus network. – Select "Net"->"Modbus net", right click on "Modbus net" and select "Object Properties" – Select "Connection" and set "data transmission rate" to "19200 Baud" and "Vertical

parity position" to "0 - even"


24/81

System integration




Figure 5-2 MODBUS net Object properties

5.5.5 Configuring the deviceRead all parameters

Before any parameterization is done it is necessary to read all parameters from the deviceinto the offline table of SIMATIC PDM. The offline table merely contains default data.

1. Open the PDM device driver.2. Select "Device->Upload to PC/PG .." Select "Execute even if the device TAG does not

match the project data TAG." and click "OK" to read all parameters to the offline table.After closing the dialog all loaded parameters should show "Loaded" in the status of thePDM table.


25/81

System integration




Setting basic parametersIn the following it is shown by example how to set the following basic flow parameters:

● Low flow cut-off

● Filter time constant

NOTICEChange of other parametersAll parameters are described in chapter "holding registers (Page 39)".

Change of parameters is always carried out as described in the following example

Download settings to device1. Select: "Device->Download to device...".2. Enter password (Default factory password is "1000").


26/81

System integration




5.5.6 OperationThe system is now ready for normal operation.

1. Select "View->Display" to see all process values.2. Verify that the process values show the expected values.

Figure 5-3 View all process values


27/81



Function codes 66.1 Modbus CommandsModbus addressing model

The module allows R/W access to the following standard Modbus data register blocks:

● Coils (ref. 0x address range)

● Holding Registers (ref. 4x address range)

I.e. the module will not support the other standard data register blocks:

● "Discrete Input" (ref. 1x address range)

● "Input Registers"(ref. 3x address range)

CommandsBroadcast communication from master to slave(s) through device address 0 is supported. Noresponse from the slave is generated in that case. Broadcast communication is not securedby the normal check mechanisms and shall be limited to very few uses.

A SITRANS F Modbus slave only recognizes (and accepts) few Modbus RTU

commands/function codes.Supported function codes are listed in the table below.

Table 6- 1 Function codes

Function code Command text Description01 hex Read coils Reads the status of single bit(s) in a slave

03 hex Read multiple registers Reads the binary content of multiple 16-bit registers in the slave.The maximum number of registers is 26

05 hex Write single coil Writes a single on/off bit

10 hex Write multiple registers Preset values into a sequence of 16-bit registers. The maximum

number of registers is 2511 hex Report Slave ID The SITRANS F slave will respond to a Report Slave ID command

(Command 17) request from the master by giving informationabout device type, vendor, revision level etc. in a format as shown


28/81

Function codes

6.2 Read coils



6.2 Read coilsCommand messages

The read coils functions (01 hex) allow the master to request information from the slave. Thecommand message of a coil read is structured as shown below. Each row in the tablecompares to a byte in the message – top byte (Slave address) is transmitted first.

The initial slave address is 1. Address 0 (broadcast) and other values between 1 and 255can be used.

The function code of this message is 01 hex (read coil) .

The starting coil is the first binary data to be read.

The quantity indicates how many consecutive bits are to be read. The quantity may range

from 1 to 432 bits.A CRC value is generated from a calculation using the values of the slave address, functioncode, and data sections of the message. When the slave receives the command message itcalculates a CRC-16 value and compares it to the one in the CRC-16 field of the commandmessage. If these two CRC-16 values are the same the slave has received the propercommand message. If the two CRC-16 values are not the same the slave will not respond.

Table 6- 2 Read coil command messages

Message byte ExampleSlave address xx hex

Function code 01 hexStarting coil Upper 00 hex

Lower 00 hex

Quantity Upper 00 hex

Lower xx hex

CRC-16 Lower xx hex

Upper xx hex

Normal responseIf the command message has a valid slave address, function code, starting coil and quantityvalue, the slave will respond with a normal response message. If the command messagehas an invalid slave address, function code, starting coil and/or quantity, the slave willrespond with an exception response message.

The normal response message contains the same slave address and function code as thecommand message.

The Bit count is the number of status bits returned in the response message. The numberequals the quantity in the command message.

The data section of the response message contains a number of bits representing the statusof the coils(s) that has been read from the device. The LSB of the coil status byte indicatesthe status of the coil.


29/81

Function codes

6.2 Read coils



Table 6- 3 Read coil normal response messages


Function code 01 hex

Bit count xx hex

Coil status byte(s) xx hex

xx hex

Next coil status byte(s) xx hex

xx hex

Last coil status byte(s) xx hex

xx hex

CRC-16 Lower xx hex

Upper xx hex

Exception responseThe exception response message contains the same slave address as the commandmessage.

The function code of the exception message is actually a value of 80 hex plus the originalfunction code of 01 hex.

The exception code indicates where the error occurred in the command message. Acomplete listing of exception codes is shown in a later chapter.

Table 6- 4 Read coil exception response messages



Exception code 02 hex

CRC-16 Lower xx hex

Upper xx hex

ExampleRead Coil Customer Totalizer (0:00018):

● Query: 1,1,0,18,0,1,93,207 (Hex 01,01,00,12,00,01,5D,CF)

● Response: 1,1,1,0,81,136 (Hex 01,01,01,00,51,88)


30/81

Function codes

6.3 Read multiple registers



6.3 Read multiple registersCommand messages

The multiple register read functions (03 hex) allows the master to request information fromthe slave. The command message of a multiple register read is structured as shown below.Each row in the table compares to byte in the message – top byte (Slave address) istransmitted first.


The function code of this message is 03 hex (read multiple registers)

The starting register is the first register to be read.

The quantity indicates how many consecutive 16-bit registers are to be read. The quantitymay range from 1 to 26 registers. If the quantity is greater than 26 an error code of 03 hex isreturned in the exception response message.

A CRC value is generated from a calculation using the values of the slave address, functioncode, and data sections of the message. When the slave receives the command message itcalculates a CRC-16 value and compares it to the one in the CRC-16 field of the commandmessage. If these two CRC-16 values are the same the slave has received the propercommand message. If the two CRC-16 values are not the same the slave will not respond.

If the command message has a valid slave address, function code, starting register andquantity value, the slave will respond with a normal response message. If the commandmessage has an invalid function code, starting register and/or quantity, the slave will

respond with an exception response message.

Table 6- 5 Read multiple registers command messages



Starting register Upper 00 hex

Lower 20 hex


Lower 04 hex

CRC-16 Lower xx hexUpper xx hex

Normal responseThe normal response message contains the same slave address and function code as thecommand message.

The Byte count is the number of data bytes returned in the response message. The numberis actually the quantity (in the command message) times 2, since there are two bytes of datain each register.


31/81

Function codes

6.3 Read multiple registers



The data section of the response message contains 8 upper and 8 lower bits of data for eachregister that has been read from the device.

Table 6- 6 Read multiple registers normal response messages



Byte count xx hex

Starting register Upper xx hex

Lower xx hex

Next register Upper xx hex

Lower xx hex

Last register Upper xx hexLower xx hex

CRC-16 Lower xx hex

Upper xx hex


The function code of the exception message is actually a value of 80 hex plus the originalfunction code of 03 hex. The exception code indicates where the error occurred in thecommand message. A complete listing of exception codes is shown in chapter "exceptionhandling (Page 35)".

Table 6- 7 Read multiple registers exception response messages



Exception code 01 hex to 06 hex

CRC-16 Lower xx hex

Upper xx hex

ExampleRead actual velocity (4:03001)

● Query: 1,3,11,184,0,2,70,10 (Hex 01,03,0B,B8,00,02,46,0A)

● Response: 1,3,4,64,195,82,139,98,200 (Hex 01,03,04,40,C3,52,8B,62,C8)

● Actual velocity = 6.10383 mm/s.


32/81

Function codes

6.4 Write single coil



6.4 Write single coilCommand messages

The write coil functions (05 hex) allow the master to control single bits in the slave. Thecommand message of a coil write is structured as shown below.


The function code of this message is 05 hex (write coil).

The coil address is the coil to be written to.

The requested coil status is specified by a constant in the query data field. A value of FF hex, 00 hex (upper, lower) requests the coil/bit to be set. A value of 00 hex , 00 hex requests it

to be reset. All other values are illegal and will not affect the coil.CRC check and exception handling is performed as described for command ‘Read multipleregisters’.

Table 6- 8 Write coil command messages



Coil address Upper xx hex

Lower xx hex

New coil value Upper FF hex or 00 hex

Lower 00 hex

CRC-16 Lower xx hex

Upper xx hex


The coil address is the coil that was written to.

The new coil value is the value written to the coil.

Table 6- 9 Write coil normal response messages



Coil address Upper xx hex

Lower xx hex

New coil value Upper FF hex or 00 hex


33/81

Function codes

6.5 Write multiple registers



Message byte ExampleLower 00 hex



The function code of the exception message is actually a value of 80 hex plus the originalfunction code of 05 hex. The exception code indicates where the error occurred in thecommand message. A complete listing of exception codes is shown in chapter "Exceptionhandling (Page 35)".

Table 6- 10 Write coil exception response messages




CRC-16 Lower xx hex

Upper xx hex

ExamplesCoil 0 (Restart Modbus communication)

To activate a new baudrate and parity/framing the coil 0 (restart Modbus communication)must be sent. Otherwise a power down/up initiate a new baudrate and parity/framing:

● Query: 1,5,0,0,255,0,140,58 (Hex 01,05,00,00,FF,00,8C,3A) (Set coil 0 to 0xFF00)

● Receive: 1,5,0,0,255,0,140,58 (Hex 01,05,00,00,FF,00,8C,3A) (Restart Modbuscommunication)

6.5 Write multiple registersCommand messages

The multiple register write functions (10 hex) allow the master to write data to the slavesregisters. The command message of a multiple register write is structured as shown below.


The function code of this message is 10 hex (write multiple registers).

The starting register is the first register to be written to.


34/81

Function codes




The quantity indicates how many consecutive 16-bit registers are to be written to. Thequantity may range from 1 to 25 registers. If the quantity is greater than 25, an error code of03 hex is returned in the exception response message.

The Byte count is the number of bytes of data to be written to the device. The number ofbytes is actually the quantity times 2, since there are two bytes of data in each register.

The data section of the command message contains 8 upper and 8 lower bits of data foreach register that is being written to.

CRC check and exception handling is performed as described for command ‘Read multipleregisters’.

Table 6- 11 Write multiple coil command messages

Message byte ExampleSlave address xx hexFunction code 10 hex

Starting register Upper 00 hex

Lower 20 hex


Lower 04 hex

Byte count xx hex

Starting register value Upper xx hex

Lower xx hex

Next register value Upper xx hex

Lower xx hexLast register value Upper xx hex

Lower xx hex

CRC-16 Lower xx hex

Upper xx hex


The starting register is the first register that was written to.

The quantity value indicates how many consecutive registers were written to.

Table 6- 12 Write multiple coil normal response messages



Starting register Upper xx hex

Lower xx hex

Quantity Upper xx hex


35/81

Function codes




Message byte ExampleLower xx hex


Exception responsesThe exception response message contains the same slave address as the commandmessage.

The function code of the exception message is actually a value of 80 hex plus the originalfunction code of 10 hex.

The exception code indicates where the error occurred in the command message. A

complete listing of exception codes is shown in chapter "Exception handling (Page 35)".

Table 6- 13 Write multiple coil exception response messages




CRC-16 Lower xx hex

Upper xx hex

ExampleSet baud rate to 38400 baud

● Query: 1,16,2,17,0,1,2,0,5,70,210 (38400 = value 5) (Hex01,10,02,11,00,01,02,00,05,46,D2)

● Receive: 1,16,2,17,0,1,80,116 (Hex 01,10,02,11,00,01,50,74)

To activate a new baudrate and parity/framing the coil 0 (Restart Modbus communication)must be sent.

Otherwise a power down/up initiate a new baudrate and parity/framing:

● Query: 1,5,0,0,255,0,140,58 (Hex 01,05,00,00,FF,00,8C,3A) (Set coil 0 to 0xFF00)

● Receive: 1,5,0,0,255,0,140,58 (Hex 01,05,00,00,FF,00,8C,3A) (Restart Modbuscommunication)


36/81

Function codes

6.6 Report slave ID command



6.6 Report slave ID commandAll MAG 8000 will respond to a Report Slave ID command (Command 17) request from themaster by giving information about device type, vendor, revision level etc. in a format asshown:

Table 6- 14 Report slave ID command messages

Message byte ExampleSlave address xxhex

Function code 11hex

Lower xxhexCRC-16

Upper xxhex

Table 6- 15 Report slave ID messages

Message byte Description LengthSlave address 1 byte

Function code 1 byte

Byte count 1 byte

Slave ID 1 byte

Run Indicator 0=Off; FF=Running 1 byte

Product code 0x1B = MAG8000 1 byte

Software code no "087C4054" for MAG8000Null terminator included

9 bytes

Capability bits Bits describing the capabilities of thismodule.

1.2, 2.4, 4.8, 9.6, 19.2, 38.4 kB/s

3 bytes

Manufacturer name "Siemens" (Read from EEPROM) Nullterminator included

12 bytes

Product name "MAG 8000"

Null terminator included

12 bytes

Product major revision 1 byte

Product minor revision 1 byte

Comm option name Not used in MAG 8000 11 bytes

Comm option code Not used in MAG 8000 1 byte

Comm option Major revision Not used in MAG 8000 1 byte

CRC-16 2 bytes


37/81

Function codes

6.7 Exception handling



6.7 Exception handlingThere is a defined set of exception codes to be returned by slaves in the event of problems.All exceptions are signalled in the response from the slave by adding 80 hex to the functioncode of the request and following this byte by an exception code.

Table 6- 16 Exception codes

Exception code(dec)

Exception text Description01 Illegal function The function code received in the query is not an allowable action for

the slave

02 Illegal data address The data address received in the query is not an allowable address forthe slave.

03 Illegal data value A value contained in the query data field is not an allowable value forthe addressed location. This may indicate a fault in the structure of theremainder of a complex request, such that the implied length isincorrect.

04 Slave device failure The request is by some other reason not acceptable. It may e.g.indicate that the data value to write is evaluated to be beyond limits.

06 BUSY-acknowledge The slave is processing a long-duration command. The master shouldretransmit the message later when the slave is free.

If an exception code 04 is received, further requests have to be done to narrow down theexact problem.

If any doubts about the address that failed, "Last Coil/HoldReg ErrorAddr" can be read. Thiswill return the faulty address.

Table 6- 17 Last Coil/HoldReg ErrorAddr

MODBUSregister

MODBUSaddress

No. ofbytes

Data type Description Read/write

4:00681 680 2 Word Last Coil ErrorAddr (MODBUS cmd: 1 or 5) R

4:00682 681 2 Word Last Coil ErrorNo (127 = No error) R

4:00683 682 2 Word Last HoldReg ErrorAddr (MODBUS cmd: 3 or 16) R

4:00684 683 2 Word Last HoldReg ErrorNo (127 = No error) R

Reading "Last Coil/HoldReg ErrorNo" will return a detailed error reason. A list of error

numbers can be seen below.

Table 6- 18 Error numbers

Error Number(Dec)

Error Number(Hex)

Error name Reason3 3 Write access

deniedThis parameter is in a state where it is notwritable

4 4 Max. limit The value was greater than the allowedmaximum value


38/81

Function codes

6.7 Exception handling



Error Number(Dec)

Error Number(Hex)

Error name Reason

5 5 Min. limit The value was less than the allowedminimum value

127 7F No error No problem


39/81



Technical data 7

Table 7- 1 Technical data

Device type Slave

Baud rates 1200, 2400, 4800, 9600, 19200, 38400 bits/sec

Number of stations Recommended: max. 31 per segment withoutrepeaters

Device address range 1-247

Protocol RTU (Other Modbus protocols like ASCII, Plus orTCP/IP are not supported.)

Electrical interface • RS485, 3-wire• RS232, 3-wire

Connecter type Screw terminals

Supported function codes • 1 Read coils• 3 Read holding registers• 5 Write single coil• 16 Write multiple registers• 17 Report slave ID

Broadcast YesMaximum cable length 1200 meters (@ 38400 bits/sec)

Standard Modbus over serial line v1.0*

Certified No

Device Profile None

According to the Specification & Implementation guide v. 1.0 available at the Modbus Organisationwebsite.


40/81

Technical data




41/81



Modbus holding registers AA.1 Introduction to holding registers

In the following the holding registers for the MAG 8000 Modbus RTU module are described.

Figure A-1 Modbus Holding Registers Memory Map

● The minimum value of a writable "holding register" value can be read by adding 10000 tothe address of the value.

● The maximum value of a writable "holding register" value can be read by adding 20000 to

the address of the value.If the value is not directly applicable, the min./max. limit shown will be based on the data type- e.g. a "WORD-type" value will show the limits 0-65535 - even though some of these valuesare not allowed.

NoteReading min./max. valuesMin./max. values do not apply to all datatypes (e.g. strings). Reading min./max. value forsuch "holding registers" will return zero-values.

NoteFirmware version 3.00Registers and addresses are valid for MAG 8000 firmware 3.00 or newer.


42/81

Modbus holding registers

A.2 MODBUS application settings



A.2 MODBUS application settingsTable A- 1 Customer profile

MODBUSregister

MODBUSaddress

No. ofbytes

Data type Label Description Read /write

4:02008 2007 6 string Meter accesscode

Password to change parameters in thewater meter

W

4:00009 8 6 string New accesscode

Downloaded password is protected andcan not be read.

New password can be changed when oldpassword is entered or if hardware key ismounted.

W

4:00656 655 16 string Application

identifier

Customer application identification

information (max 15 characters)

R/W

4:00664 663 16 string Applicationlocation

Customer application location information(max 15 characters)

R/W

Table A- 2 Measurement

MODBUSregister

MODBUSaddress

No. ofbytes


4:03000 2999 4 float32 Actual velocity Actual velocity in mm/s R

4:03002 3001 4 float32 Flow rate Actual flow value R

4:03004 3003 4 float32 Insulationvalue

Insulation value from last insulation test R

4:03006 3005 4 uint32 Insulation testsfulfilled

Number of insulation tests since last powerup

R

4:03047 3046 6 date Insulation testdate

Date of last insulation test R

4:03008 3007 4 sint32 Electrodeimpedance A

Electrode impedance A for empty pipedetection

R

4:03010 3009 4 sint32 Electrodeimpedance B

Electrode impedance B for empty pipedetection

R

4:03012 3011 4 float32 Flowratepercent value

Flowrate as percent of Qn R

Table A- 3 Totalization

MODBUSregister

MODBUSaddress

No. ofbytes


4:03017 3016 8 totaltype Totalizer 1 Volume for totalization register 1 R/W

4:03021 3020 8 totaltype Totalizer 2 Volume for totalization register 2 R/W

4:03025 3024 8 totaltype Customer

totalizer 3

Customer totalizer 3 based on totalizer 1set up

R


43/81


A.3 MODBUS driver settings



A.3 MODBUS driver settingsTable A- 4 MODBUS driver settings

MODBUSregister

MODBUSaddress

No. ofbytes


4:00528 527 2 uint16 DeviceCommunicationAddress

Meter has default address value "1" withselectable address up to 247

R

4:00529 528 2 uint16 Baudrate Communication port speed

• 0 = 1200• 1 = 2400• 2 = 4800• 3 = 9600• 4 = 19200• 5 = 38400

R

4:00530 529 2 uint16 Parity Communication port parity

• 0 = Even 1 stop• 1 = Odd 1 stop• 2 = None 2 stop• 3 = None 1 stop

R

4:00079 78 2 uint16 Device

Product ID

Siemens MAG 8000 product ID 10779 R

4:00531 530 2 uint16 Interframespace

Minimum space between two messages given intenth bytes

R

4:00372 371 2 uint16 Responsedelay

Minimum time from receiving a request to itsresponse

R

0:00000 0 1 coil Resetcommunication driver

Warning! Check settings before reset andaccept new communications settings - otherwisecommunication will be interrupted!

• 0 =No• 1 = Yes

R


44/81


A.4 Menu control



A.4 Menu controlTable A- 5 Menu control

MODBUSregister

MODBUSaddress

No. ofbytes


4:00234 233 1 uint8 Menu active 1 byte describing which menus are enabled

• Bit 1: Operator menu,• Bit 2: Meter info menu,• Bit 3: Service menu,• Bit 4: Log menu,• Bit 5: Statistic menu,•

Bit 6: Revenue menu,• Bit 7: Not Used• Bit 8: Not UsedExample

• Menu active = 15 :• Operator; Meter info and Service menu

enabled

R

4:00402 401 1 uint8 Defaultoperatormenu index

Default menu index. Automatically selectedafter 10 minutes of no operation of displaykey.

• 0 =Totalizer 1• 1 =Totalizer 2• 2 = Actual Flow rate• 3 = Fault codes• 4 = Customer Totalizer

R

4:00406 405 1 uint8 Decimal point Decimal point for displayed totalized value

• 0 = No point• 1 = One digit after point• 2 = Two digits after point• 3 = Three digits after point• 4 = Automatic point adjust

R/W

4:00222 221 1 uint8 Displayedunit

Displayed m3 unit or an arrow indication for aunit label

• 0 = m3 unit not displayed• 1 = Use m3 unit

R


45/81


A.5 Sensor characteristics



A.5 Sensor characteristicsTable A- 6 Sensor characteristics

MODBUSregister

MODBUSaddress

No. ofbytes


4:00206 205 4 float32 Flow unit factor Flow unit correction factor from m3/s toother flow unit

R

4:00208 207 4 float32 Totalizer volumeunit factor

Totalizer unit correction factor from m3to other volume unit

R

4:00210 209 12 string Flowrate unit Meter unit text for flowrate R

4:00216 215 12 string Totalizer unit Meter unit text for totalized volume R

4:00223 222 2 uint16 Pipe size Pipe diameter size in mm R

4:00224 223 4 float32 Sensor offset Sensor calibration offset in mm/s R4:00226 225 4 float32 Qn Nominal flow R

4:00793 792 4 float32 Flow alarm limit Selectable flow limit for generating aflow alarm

R/W

4:00228 227 4 float32 Calibration factor Calibration factor R

4:00230 229 6 date Calibration date Date of calibration R

4:00233 232 1 uint8 Verification modeenable

Select 'Yes' to enable verification mode.High resolution for calibration orverification. Automatically stopped after4 hours.

• 0 = No• 1 = Yes

R/W

4:00117 116 4 float32 Gain correction Electronic calibration factor R

4:00236 235 4 float32 Adjustment Factor Meter correction factor for customeradjustment of the calculated flow value.

R

4:00247 246 1 uint8 Excitationfrequency sensorlimit

Maximum possible sensor excitationfrequency.

• 0 = 1/15Hz• 1 = 1/5Hz• 2 = 1.5625Hz• 3 = 3.125Hz• 4 = 6.25Hz• 5 = 1/30Hz• 6 = 1/60Hz

R


46/81


A.5 Sensor characteristics



MODBUSregister

MODBUSaddress

No. ofbytes


4:00048 47 1 uint8 Excitationfrequency limit

Maximum selectable excitationfrequency

• 0 = 1/15Hz• 1 = 1/5Hz• 2 = 1.5625Hz• 3 = 3.125Hz• 4 = 6.25Hz• 5 = 1/30Hz• 6 = 1/60Hz

R

4:00238 237 1 uint8 Excitation

frequency

Actual selected excitation frequency

• 0 = 1/15Hz• 1 = 1/5Hz• 2 = 1.5625Hz• 3 = 3.125Hz• 4 = 6.25Hz• 5 = 1/30Hz• 6 = 1/60Hz

R

4:00239 238 4 float32 Low flow cut-off If the flow subceeds this percentage ofQn, then the flowvalue is set to zero.n.

R

4:00241 240 2 uint16 Filter time constant Generel filter for flow measurement.Filter constant is the number ofexcitations the filtering will take placeover. Higher number gives a slower andmore stable flow signal.

R

4:00242 241 1 uint8 Empty pipedetection enable

Select 'Yes' to enable empty pipedetection.

• 0 = No• 1 = Yes

R

4:00243 242 4 sint32 Empty pipe limit Electrode impedance in ohm for activeempty pipe detection

R

4:00254 253 4 sint32 Low mediumimpedance alarm

Electrode impedance in ohm for activelow impedance alarm detection

R/W

4:00245 244 1 uint8 Insulation testenable

Select 'Yes' for enabling insulation test

• 0 = No• 1 = Yes

R/W

4:00246 245 2 uint16 Insulation testinterval

Number of days between insulationtests

R/W

4:00820 819 4 float32 Reverse flowalarm limit

Selectable reverse flow limit forgenerating a reverse flow alarm

R/W


47/81


A.6 Totalization



A.6 TotalizationTable A- 7 Totalization

MODBUSregister

MODBUSaddress

No. ofbytes


4:00400 399 1 uint8 Flow direction totalizer 1 Calculation principle on flowdirection for forward - reverseor net flow

• 0 = Forward• 1 = Reverse• 2 = Net

R/W

4:00073 72 6 date Totalizer 1 changes date Date and time when totalizer

1 has been changed

R

4:00401 400 1 uint8 Flow direction totalizer 2 Calculation principle on flowdirection for forward - reverseor net flow

• 0 = Forward• 1 = Reverse• 2 = Net

R/W

4:00076 75 6 date Totalizer 2 changes date Date and time when totalizer2 has been changed

R

A.7 Pulse outputTable A- 8 Pulse output

MODBUSregister

MODBUSaddress

No. ofbytes


4:00373 372 1 uint8 Output Aenable

Select 'Yes' to enable output A

• 0 = No• 1 = Yes

R/W

4:00374 373 1 uint8 Pulse Afunction

Pulse output calculation on pure forward orreverse flow - or net flow for forward and reversepulse flow

• 0 = Forward• 1 = Reverse• 2 = Forward net• 3 = Reverse net

R/W

4:00375 374 4 float32 Amountper pulseA

Volume per pulse. Output A R/W


48/81


A.7 Pulse output



MODBUSregister

MODBUSaddress

No. ofbytes


4:00377 376 1 uint8 Pulsewidth forpulse A

Pulse length when the pulse is active• 0 = 10 ms• 1 = 50 ms• 2 = 100 ms• 3 = 500 ms• 4 = 5 ms

R/W

4:00378 377 1 uint8 Output Benable

Select 'Yes' to enable output B

• 0 = No• 1 = Yes

R/W

4:00379 378 1 uint8 Pulse B

function

Configuration of output B as pulse - alarm or call

up function

• 0 = Pulse• 1 = Alarm• 2 = Call up

R/W

4:00380 379 1 uint8 Pulse Bdirection

Pulse output calculation on pure forward orreverse flow - or net flow for forward and reversepulse flow

• 0 = Forward• 1 = Reverse• 2 = Forward net• 3 = Reverse net

R/W

4:00381 380 4 float32 Amountper pulseB

Volume per pulse. Output B R/W

4:00383 382 1 uint8 Pulsewidth forpulse B

Pulse length when the pulse is active

• 0 = 10 ms• 1 = 50 ms• 2 = 100 ms• 3 = 500 ms

R/W


49/81


A.8 Service control



A.8 Service controlTable A- 9 Service control

MODBUSregister

MODBUSaddress

No. ofbytes


0:00000 15 1 coil Coil currentdisable

Select 'Yes' to disable coil current formagnetic field

• 0 = No• 1 = Yes

R

0:00000 16 1 coil Fixed flowmode enable

Select 'Yes' to enable fixed flow value

• 0 = No• 1 = Yes

R

4:00361 360 4 float32 Fixed flowvalue

Fixed flow value for enabled fixed flow R

4:00363 362 6 date Latest servicedate

Latest service date (can also be used fordate of installation)

R/W

4:00080 79 4 uint32 Operatinghours sincepower up

Total operation hours since first power up R

4:00366 365 2 uint16 Numbers ofpower up

Total number of power up since first timepower up.

R

4:03033 3032 6 date Actual dateand time

Actual date and time of day-month-year andhours:minutes:seconds

R/W

A.9 Error messagesTable A- 10 Error messages

MODBUSregister

MODBUSaddress

No. ofbytes


0:00000 2 - coil Insulation alarm

output enable

Select 'Yes' to enable current alarm on

alarm output / call-up• 0 = No• 1 = Yes

R/W

4:00272 271 2 uint16 Insulation faulthours

Total hours fault active R

4:00273 272 1 uint8 Insulation faultcounter

Total number of faults R

4:00274 273 6 date Insulation faultappears

First time the fault appeared R

4:00277 276 6 date Insulation faultdisappears

Last time the fault disappeared R


50/81


A.9 Error messages



MODBUSregister

MODBUSaddress

No. ofbytes


0:00000 3 - coil Coil currentalarm outputenable

Select 'Yes' to enable active alarm onalarm output / call-up

• 0 = No• 1 = Yes

R/W

4:00281 280 1 uint8 Coil current faultcounter


4:00282 281 6 date Coil current faultappears


0:00000 2 - coil Insulation alarmoutput enable

Select 'Yes' to enable current alarm onalarm output / call-up

• 0 = No• 1 = Yes

R

4:00285 284 6 date Coil current faultdisappears


0:00000 4 - coil Amplifier alarmoutput enable


• 0 = No• 1 = Yes

R/W

4:00288 287 2 uint16 Amplifier faulthours


4:00289 288 1 uint8 Amplifier faultcounter


4:00290 289 6 date Amplifier faultappears


4:00293 292 6 date Amplifier faultdisappears


0:00000 5 - coil Parameterchecksum alarmoutput enable


• 0 = No• 1 = Yes

R/W

4:00296 295 2 uint16 Parameterchecksum faulthours


4:00297 296 1 uint8 Parameterchecksum faultcounter


4:00298 297 6 date Parameterchecksum faultappears


4:00301 300 6 date Parameterchecksum faultdisappears

Password to change parameters in thewater meter

R


51/81


A.9 Error messages



MODBUSregister

MODBUSaddress

No. ofbytes


0:00000 6 - coil Low power alarmoutput enable


• 0 = No• 1 = Yes

R/W

4:00304 303 2 uint16 Low power faulthours


4:00305 304 1 uint8 Low power faultcounter


4:00306 305 6 date Low power faultappears


4:00309 308 6 date Low power fault

disappears


0:00000 7 - coil Flow overflowalarm outputenable


• 0 = No• 1 = Yes

R/W

4:00312 311 2 uint16 Overflow faulthours


4:00313 312 1 uint8 Overflow faultcounter


4:00314 313 6 date Overflow faultappears


4:00317 316 6 date Overflow faultdisappears Last time the fault disappeared R

0:00000 8 - coil Pulse A overloadalarm outputenable


• 0= no• 1 = Yes

R/W

4:00320 319 2 uint16 Pulse A overloadfault hours


4:00321 320 1 uint8 Pulse A overloadfault counter


4:00322 321 6 date Pulse A overloadfault appears


4:00325 324 6 date Pulse A overloadfault disappears


0:00000 9 - coil Pulse B overloadalarm outputenable


• 0 = No• 1 = Yes

R/W

4:00328 327 2 uint16 Pulse B overloadfault hours


4:00329 328 1 uint8 Pulse B overloadfault counter



52/81


A.9 Error messages



MODBUSregister

MODBUSaddress

No. ofbytes


4:00330 329 6 date Pulse B overloadfault appears


4:00333 332 6 date Pulse B overloadfault disappears


0:00000 10 - coil Consumptionalarm outputenable


• 0 = No• 1 = Yes

R/W

4:00336 335 2 uint16 Consumptionfault hours


4:00337 336 1 uint8 Consumption

fault counter


4:00338 337 6 date Consumptionfault appears


4:00341 340 6 date Consumptionfault disappears


0:00000 11 - coil Leakage alarmoutput enable


• 0 = No• 1 = Yes

R/W

4:00344 343 2 uint16 Leakage faulthours


4:00345 344 1 uint8 Leakage faultcounter Total number of faults R

4:00346 345 6 date Leakage faultappears


4:00349 348 6 date Leakage faultdisappears


0:00000 12 - coil Empty pipealarm outputenable


• 0 = No• 1 = Yes

R/W

4:00352 351 2 uint16 Empty pipe faulttimer


4:00353 352 1 uint8 Empty pipe faultcounter


4:00354 353 6 date Empty pipe faultappears


4:00357 356 6 date Empty pipe faultdisappears


0:00000 26 - coil Low impedancealarm outputenable


• 0 = No• 1 = Yes

R/W


53/81


A.9 Error messages



MODBUSregister

MODBUSaddress

No. ofbytes


4:00795 794 2 uint16 Low impedancefault timer


4:00796 795 1 uint8 Low impedancefault counter


4:00797 796 6 date Low impedancefault appears


4:00800 799 6 date Low impedancefault disappears


0:00000 27 - coil Flow alarmoutput enable


• 0 = No• 1 = Yes

R/W

4:00803 802 2 uint16 Flow alarm faulttimer


4:00804 803 1 uint8 Flow alarm faultcounter


4:00805 804 6 date Flow alarm faultappears


4:00808 807 6 date Flow alarm faultdisappears


0:00000 28 - coil Reverse flowalarm outputenable


• 0 = No• 1 = Yes

R/W

4:00811 810 2 uint16 Reverse flowfault timer


4:00812 811 1 uint8 Reverse flowfault counter


4:00813 812 6 date Reverse flowfault appears


4:00816 815 6 date Reverse flowfault disappears



54/81


A.9 Error messages



MODBUSregister

MODBUSaddress

No. ofbytes


4:00360 359 2 uint16 Alarmconfiguration list

2 bytes describing which errors/warningshould generate an alarm or call up onoutput B

• Bit 1: Insulation error• Bit 2: Coil current error• Bit 3: Preamplifier overload• Bit 4: Database checksum error• Bit 5: Low power warning• Bit 6: Flow overload warning• Bit 7: Pulse A overload warning• Bit 8: Pulse B overload warning• Bit 9: Consumption interval warning• Bit 10/L: Leakage warning• Bit 11/E: Empty pipe warning• Bit 12/C: Low impedance warning• Bit 13/d: Flow limit warning• Bit 14/A: Reverse flow warning• Bit 15: Not used• Bit 16: Not used

R/W

4:00052 51 2 uint16 Non optimalmeasure time

Total hours of non optimal measurementconditions

R

4:03016 3015 2 uint16 Fault status 2 bytes describing which errors/warningsare active

• Bit 1: Insulation error• Bit 2: Coil current error• Bit 3: Preamplifier overload• Bit 4: Database checksum error• Bit 5: Low power warning• Bit 6: Flow overload warning• Bit 7: Pulse A overload warning• Bit 8: Pulse B overload warning• Bit 9: Consumption interval warning• Bit 10/L: Leakage warning• Bit 11/E: Empty pipe warning• Bit 12/C: Low impedance warning• Bit 13/d: Flow limit warning• Bit 14/A: Reverse flow warning• Bit 15: Not used• Bit 16: Not used

R


55/81


A.10 Power control



MODBUSregister

MODBUSaddress

No. ofbytes


0:00000 14 - coil Call upacknowledge

Select 'Yes' to reset active call-up• 0 = No• 1 = Yes

R/W

4:00049 48 6 date Date of fault logreset

Date of fault log reset R

0:00000 13 - coil Reset the faultlog and faults

Reset the fault log and faults

• 0 = No• 1 = Reset

R/W

A.10 Power controlTable A- 11 Power control

MODBUSregister

MODBUSaddress

No. ofbytes


4:00367 366 1 uint8 Mains frequency Country related mains power frequencyfor enabling correct noise filtering

• 0 = 50 Hz• 1 = 60 Hz

R

4:03029 3028 1 uint8 Power supply Meter power supply source• 0 = Battery• 1 = Mains supply

R

4:00368 367 1 uint8 Battery power Number of installed batteries (Internalbatterypack has 2 batteries and externalbatterypack has 4 batteries)

R

4:03014 3013 4 uint32 Excitations no. Numbers of excitations since last batteryreset

R

4:03030 3029 1 uint8 Actual batterycapacity

Actual remaining battery power capacityas a percentage of max capacity

R

4:00089 88 4 uint32 Battery operating

time

Operating time since installation of

batteries (last battery reset)

R


56/81


A.10 Power control



MODBUSregister

MODBUSaddress

No. ofbytes


4:03031 3030 1 uint8 Power status • 0 = Normal operation• 1 = Battery alarm. Actual battery

capacity is below battery alarm level(% of max capacity)

• 2 = Too low power (enters stand bymode)

• 3 = As value 1 and 2 together• 4 = External power gone• 5 = As value 1 and 4 together• 6 = As value 2 and 4 together• 7 = As value 1 and 2 and 4 together

R

4:00369 368 1 uint8 Battery alarmlimit

Battery capacity level (%) where lowpower alarm will be activated.

R/W

4:03042 3041 4 float32 Transmittertemperature

Temperature inside the transmitter (°C) R

4:00091 90 6 date Batteryinstallation date

Latest installation date of batteries R

0:00000 17 - coil Battery changeenable

Select 'Yes' to set battery installation dateto current date and reset remainingbattery operation capacity to maximum.

• 0 = No• 1 = Yes

R/W

4:00822 821 1 uint8 Communicationmodule type

Communication module type - forcalculating correct power use.

• 0 = No module• 1 = RS485• 2 = RS232• 3 = RS232 always connected

R


57/81


A.11 Consumption statistic



A.11 Consumption statisticTable A- 12 Consumption statistic

MODBUSregister

MODBUSaddress

No. ofbytes


0:00000 18 - coil Reset customertotalizer 3

Reset of customer totalizer

• 0 = No• 1 = Yes

R/W

4:00098 97 6 date Customertotalizer 3 resetdate

Date when customer totalizer has beenreset

R

4:00407 406 4 float32 Highest flowrate Value of highest measured flow rate R

4:00409 408 6 date Date of highestflowrate

Date where highest flow rate occured R

4:00412 411 4 float32 Lowest flowrate Value of lowest measured flow rate R

4:00414 413 6 date Date of lowestflowrate

Date where lowest flow rate occured R

4:00417 416 4 float32 Highest dayconsumption

Value of highest measured dailyconsumption. Calculation based ontotalizer 1

R

4:00419 418 6 date Date of highestday consumption

Date when highest measured dailyconsumption occured

R

4:00422 421 4 float32 Lowest dayconsumption

Value of lowest measured dailyconsumption. Calculation based ontotalizer 1

R

4:00424 423 6 date Date of lowestday consumption

Date when lowest measured dailyconsumption occured

R

4:00164 163 4 float32 Latest weekconsumption

Latest week consumption (based ontotalizer 1 for the last 7 days)

R

4:00162 161 4 float32 Day 1(yesterday) oflast weekconsumption

Latest day consumption (based ontotalizer 1)

R

4:00101 100 4 float32 Day 2 of lastweekconsumption

Latest day-1 consumption (based ontotalizer 1)

R



R



R



R



R


58/81


A.12 Consumption profile



MODBUSregister

MODBUSaddress

No. ofbytes


4:00041 40 4 float32 Day 7 (7 daysago) of last weekconsumption


R

4:03044 3043 4 float32 Actual monthconsumption

Actual month consumption (based ontotalizer 1 from the first in the month)

R

4:00166 165 4 float32 Latest monthconsumption

Latest month consumption (based ontotalizer 1 from the first in the month)

R

4:00427 426 6 date Reset date ofstatistic inf.

Date of log reset of statistic information R

0:00000 19 - coil Reset statisticinformation

Reset the statistic information log

• 0 = No• 1 = Yes

R/W

A.12 Consumption profileTable A- 13 Consumption profile

MODBUSregister

MODBUSaddress

No. ofbytes


4:00430 429 1 uint8 Upper limit in CPrange 1

Consumption flow range 1 - from 0 toupper limit 1 as a percent of Qn

R/W

4:00431 430 4 float32 Total time in CPrange 1

Total hours of flow rate in flow range 1 R


Consumption flow range 2 - from previousflow range to upper limit 2 as a percent ofQn

R/W





R/W





R/W





R/W




59/81


A.13 Leakage statistic



MODBUSregister

MODBUSaddress

No. ofbytes



Total hours of flow rate in the last flowrange 6 (from previous flow range up toQn)

R

4:00447 446 6 date Reset date ofconsumptionprofile

Date of log reset of consumption profileinformation

R

0:00000 20 - coil Resetconsumptionprofile

Reset the consumption profile informationlog

• 0 = No• 1 = Yes

R/W

A.13 Leakage statisticTable A- 14 Leakage statistic

MODBUSregister

MODBUSaddress

No. ofbytes


4:00450 449 1 uint8 Leakagedetection mode

Leakage detection can be controlled by afixed leakage limit or the lowest measuredvalue added the leakage limit

• 0 = Off• 1 = Fixed limit• 2 = Lowest added fixed limit

R/W

4:00451 450 1 uint8 Leakageexcitationfrequency

Selected excitation frequency in leakagedetection period

• 0 = 1/15Hz• 1 = 1/5Hz• 2 = 1.5625Hz• 3 = 3.125Hz• 4 = 6.25Hz• 5 = 1/30Hz• 6 = 1/60Hz

R/W

4:00452 451 4 float32 Leakage limit If measured leakage value is above thislimit, a possible leakage is detected

R/W

4:03036 3035 12 string Leakage valueunit

The actual text of unit choice (flowrate orvolume)

R

4:00454 453 1 uint8 Leakage source The source value for leakage can beflowrate or volume

• 0 = Flowrate• 1 = Volume

R/W


60/81


A.13 Leakage statistic



MODBUSregister

MODBUSaddress

No. ofbytes


4:00455 454 2 uint16 Start period forleakagedetection

Time of day to start the leakage detectionperiod

R/W

4:00456 455 1 uint8 Duration leakagedetection

Leakage detection duration in 10 minutesresolution

R/W

4:00457 456 1 uint8 Periods withpossible leakage

Actual days/periods where measuredleakage value is above leakage limit

R

4:00458 457 1 uint8 Leakage periodsbefore alarm

Number of days / periods before leakagefault/alarm appears

R/W

4:00459 458 4 float32 Lowestmeasuredleakage value

Lowest measured value in leakage period R

4:00461 460 6 date Date of lowestleakage value

Date of lowest measured value R

4:00464 463 4 float32 Highestmeasuredleakage value

Highest measured value in leakageperiod

R

4:00466 465 6 date Date of highestleakage value

Date of highest measured value R

4:00469 468 4 float32 Latest leakageperiod flowrate

Communication Modules SITRANS F M MAG 8000

Documents

Transcript of Communication Modules SITRANS F M MAG 8000