Siemens SITRANS F User manual

Operating Instructions
SITRANS F
Communication Modules
SITRANS F M MAG 8000 Modbus RTU
Answers for industry.
04/2016
Edition

SITRANS F
Communication Modules
MAG 8000 Modbus RTU
Operating Instructions
Add-on module for use with flowmeter types
SITRANS F M MAG 8000
04/2016
A5E03409989
-AB
Introduction
1
Safety notes
2
Hardware Installation
3
Connecting
4
System integration
5
Function codes
6
Technical data
7
Sensor dimension
dependent default settings
8
Modbus coil registers
9
Modbus holding registers
A
Appendix
B

Siemens AG
Division Process Industries and Drives
Postfach 48 48
90026 NÜRNBERG
GERMANY
Document order number: A5E03409989
Ⓟ
06/2016 Subject to change
Copyright © Siemens AG 2011 - 2016.
All rights reserved
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent
damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert
symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are
graded according to the degree of danger.
DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.
WARNING
indicates that death or severe personal injury
may
result if proper precautions are not taken.
CAUTION
indicates that minor personal injury can result if proper precautions are not taken.
NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will
be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to
property damage.
Qualified Personnel
The product/system described in this documentation may be operated only by
personnel qualified
for the specific
task 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 and
avoiding potential hazards when working with these products/systems.
Proper use of Siemens products
Note the following:
WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended
or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and
maintenance are required to ensure that the products operate safely and without any problems. The permissible
ambient conditions must be complied with. The information in the relevant documentation must be observed.
Trademarks
All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication
may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software
described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the
information in this publication is reviewed regularly and any necessary corrections are included in subsequent
editions.

MAG 8000 Modbus RTU
Operating Instructions, 04/2016, A5E03409989-AB 3
Table of contents
1 Introduction............................................................................................................................................. 5
1.1 Revision history.........................................................................................................................5
1.2 Modbus RTU technology ..........................................................................................................6
1.3 Further Information ...................................................................................................................8
2 Safety notes............................................................................................................................................ 9
2.1 Installation in hazardous area...................................................................................................9
3 Hardware Installation ............................................................................................................................ 11
4 Connecting ........................................................................................................................................... 13
4.1 Wiring......................................................................................................................................13
4.2 Closing the device...................................................................................................................15
5 System integration ................................................................................................................................ 17
5.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.......................................................................................................19
5.5.1 General instructions ................................................................................................................19
5.5.2 Commissioning steps..............................................................................................................19
5.5.3 Install EDD files.......................................................................................................................20
5.5.4 Adding device to network........................................................................................................22
5.5.5 Configuring the device ............................................................................................................23
5.5.6 Operation ................................................................................................................................24
6 Function codes ..................................................................................................................................... 25
6.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 ...........................................................................................................32
6.6 Report slave ID command ......................................................................................................34
6.7 Exception handling..................................................................................................................35
7 Technical data ...................................................................................................................................... 37
8 Sensor dimension dependent default settings ....................................................................................... 39
9 Modbus coil registers ............................................................................................................................ 41

Table of contents
MAG 8000 Modbus RTU
4Operating Instructions, 04/2016, A5E03409989-AB
A Modbus holding registers ...................................................................................................................... 43
A.1 Introduction to holding registers............................................................................................. 43
A.2 MODBUS application settings................................................................................................ 44
A.3 MODBUS driver settings........................................................................................................ 45
A.4 Menu control .......................................................................................................................... 46
A.5 Sensor characteristics............................................................................................................ 47
A.6 Totalization............................................................................................................................. 49
A.7 Pulse output ........................................................................................................................... 50
A.8 Service control ....................................................................................................................... 51
A.9 Error messages...................................................................................................................... 52
A.10 Power control ......................................................................................................................... 56
A.11 Consumption statistic............................................................................................................. 58
A.12 Consumption profile ............................................................................................................... 59
A.13 Leakage statistic .................................................................................................................... 60
A.14 Datalog................................................................................................................................... 62
A.15 Consumption readings ........................................................................................................... 70
B Appendix .............................................................................................................................................. 73
B.1 Data type mapping................................................................................................................. 73
B.2 CRC calculation ..................................................................................................................... 74
Index .................................................................................................................................................... 77

MAG 8000 Modbus RTU
Operating Instructions, 04/2016, A5E03409989-AB 5
Introduction
1
Purpose
The Operating Instructions provide all information necessary for the installation and use of
the Modbus RTU add-on module (FDK:087L4212 or FDK:087L4213), intended for use with
the electromagnetic transmitter type SITRANS F M MAG 8000.
Note
Reduced battery lifetime
The Modbus RTU communication module is designed for use with mains powered device
versions only.
Use of the Modbus RTU communication module with battery
-powered device versions will
reduce the expected battery lifetime significantly.
Basic knowledge required
The instructions are not intended to be a complete tutorial on the Modbus RTU protocol, and
it is assumed the end user already has a general working knowledge of Modbus RTU
communication, especially in respect of master station configuration and operation. However
an overview is included in the following section to explain some fundamental aspects of the
protocol.
See also
For more information about SITRANS F M transmitters and sensors, please refer to the
appropriate Operating Instructions available on the flowdocumentation homepage
(http://www.siemens.com/flowdocumentation) or on the SITRANS F literature CD-ROM.
1.1
Revision history
The contents of these instructions are regularly reviewed and corrections are included in
subsequent editions. We welcome all suggestions for improvement.
The following table shows the most important changes in the documentation compared to
each previous edition.
Edition
Remarks
08/2011
1. edition
03/2015
General update - correction of Modbus application settings (appendix A2)
04/2016
Update of Modbus holding registers appendix

Introduction
1.2 Modbus RTU technology
MAG 8000 Modbus RTU
6Operating Instructions, 04/2016, A5E03409989-AB
1.2
Modbus RTU technology
Modbus RTU is an open, serial (RS 232 or RS 485) protocol based on master/slave or
client/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 plant
networks.
Features
The SITRANS F Modbus RTU Communication modules comply with the Modbus Serial Line
Protocol. Among other things this implies a Master-Slave protocol at level 2 of the OSI
model. A node (the master) issues explicit commands to one of the slave nodes and
processes responses. Slave nodes will not transmit data without a request from the master
node, and do not communicate with other slaves.
Modbus is a mono Master system, which means that only one Master can be connected at
the time.

Introduction
1.2 Modbus RTU technology
MAG 8000 Modbus RTU
Operating Instructions, 04/2016, A5E03409989-AB 7
Communication modes
Two modes of communication are possible, Unicast and Broadcast.
●In unicast mode the Master sends a request to a specific Slave device, and waits a
specified time for a response.
Image 1-1 Unicast Mode
●In Broadcast mode the master sends out a request to address "0", which means that the
information is for all Slave devices on the network. In Broadcast mode there is no
response from the Slave devices.
Image 1-2 Broadcast Mode
Modbus Frame
The 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

Introduction
1.3 Further Information
MAG 8000 Modbus RTU
8Operating Instructions, 04/2016, A5E03409989-AB
References
For further information, please refer to the following specification and guidelines available at
the Modbus Organisation (http://www.modbus.org/) Website
1. Serial Line Specification & Implementation guide v. 1.0
2. Application Protocol Specification v. 1.1
1.3
Further Information
The contents of these operating instructions shall not become part of or modify any prior or
existing agreement, commitment or legal relationship. All obligations on the part of Siemens
AG are contained in the respective sales contract which also contains the complete and
solely applicable warranty conditions. Any statements contained herein do not create new
warranties or modify the existing warranty.
Product information on the Internet
The Operating Instructions are available on the CD-ROM shipped with the device, and on
the Internet on the Siemens homepage, where further information on the range of SITRANS
F flowmeters may also be found:
Product information on the internet (http://www.siemens.com/flow)
Worldwide contact person
If you need more information or have particular problems not covered sufficiently by the
operating instructions, please get in touch with your contact person. You can find contact
information for your local contact person on the Internet:
Local contact person (http://www.automation.siemens.com/partner)

MAG 8000 Modbus RTU
Operating Instructions, 04/2016, A5E03409989-AB 9
Safety notes
2
CAUTION
Correct, reliable operation of the product requires proper transport, storage, positioning and
assembly as well as careful operation and maintenance. Only qualified personnel should
install or operate this instrument.
Note
Alterations to the product, including opening or improper repairs of the product, are not
permitted.
If this requirement is not observed, the CE mark and the manufacturer's warr
anty will expire.
2.1
Installation in hazardous area
WARNING
NOT allowed for use in hazardous areas!
Equipment used in hazardous areas must be Ex-approved and marked accordingly!
This device is NOT approved for use in hazardous areas!

Safety notes
2.1 Installation in hazardous area
MAG 8000 Modbus RTU
10 Operating Instructions, 04/2016, A5E03409989-AB

MAG 8000 Modbus RTU
Operating Instructions, 04/2016, A5E03409989-AB 11
Hardware Installation
3
The 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.
Image 3-1 Hardware installation
5. Use the two supplied 3 mm screws and washers to fix the module to the MAG 8000
electronics.

Hardware Installation
MAG 8000 Modbus RTU
12 Operating Instructions, 04/2016, A5E03409989-AB

MAG 8000 Modbus RTU
Operating Instructions, 04/2016, A5E03409989-AB 13
Connecting
4
Note
Shielding
Always shield a Modbus over Serial Line Cable. At one end of each cable its shield must be
connected to protective ground. If a connector is use
d at this end, the shell of the connector
is connected to the shield of the cable.
Note
Cable specifications
A RS 485
-Modbus must use a balanced pair (for D0-D1) and a third wire (for the Common).
For the balanced pairs used in an RS 485
-system, a Characteristic Impedance with a value
between 100 and 120 Ohms must be used.
4.1
Wiring
●Connect shield to MAG 8000 enclosure using the cable clamp
Image 4-1 Cable shield connection

Connecting
4.1 Wiring
MAG 8000 Modbus RTU
14 Operating Instructions, 04/2016, A5E03409989-AB
RS 232 connection diagram
①
Common
②
Connect shield to enclosure
③
Shield connected to protective ground
①
Common
RS 485 connection diagram
①
Common
②
Connect shield to enclosure
③
Shield connected to protective ground

Connecting
4.2 Closing the device
MAG 8000 Modbus RTU
Operating Instructions, 04/2016, A5E03409989-AB 15
①
Common
②
Termination
Bus termination
All RS 485-based networks must be terminated correctly to function properly. A termination
must be placed at each end of segment.
The Modbus RTU module can add a 120 ohm termination if a jumper is placed beside
terminals in position "ON".
●Termination is set to "ON" from factory.
4.2
Closing the device
1. 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.
CAUTION
Loss of type of protection
Damage to device if the enclosure is open or not properly closed. The type of protection
specified on the nameplate or in Technical data (Page 37) is no longer guaranteed.
•Make sure that the device is securely closed.

Connecting
4.2 Closing the device
MAG 8000 Modbus RTU
16 Operating Instructions, 04/2016, A5E03409989-AB

MAG 8000 Modbus RTU
Operating Instructions, 04/2016, A5E03409989-AB 17
System integration
5
5.1
System integration instructions
This chapter provides information on how to integrate the flowmeter in a Modbus RTU
automation and control system.
The chapter shows the necessary steps in order to put the system into operation. After
finishing the steps, the system is ready to go into normal operation in the Modbus RTU
automation control system.
Note
Storage location
All Modbus settings of the transmitter are stored in the transmitte
r in a non-volatile memory.
Device name and address
The transmitter is shipped with a default device name and serial number.
All devices are shipped with a temporary address that allows the host to automatically
commission the transmitter. The network address is the current device address used by the
fieldbus.
Note
It is recommended NOT to use the default address in a multi
-slave network. It is of great
importance to ensure that no devices have the same addr
ess. Otherwise an abnormal
behaviour of the whole serial bus can occur, the master being unable to communicate with
all present slaves on the bus.
5.2
Function check
Before proceeding further, make sure that installation and connection have been performed
successfully.
●See Hardware Installation (Page 11) for installation verification.
●See Connecting (Page 13) for connection verification.
When the function check has been successfully carried out, the device can be switched on.

System integration
5.3 Communication parameter settings
MAG 8000 Modbus RTU
18 Operating Instructions, 04/2016, A5E03409989-AB
5.3
Communication parameter settings
Effect 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
Description
Device 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 characters The minimum interframe space be-
tween two Modbus RTU messages in
sequence (specified as 3.5 characters)
is configurable. Range: 3.5 – 25 character
times. Specified in bytes times ten.
[Factory setting: 35 ]
Response Delay 0-255 ms The minimum time from when a slave
receives a request and until it returns a
response. This makes it possible to
send data to slow masters.
[Factory setting: 5 ]
5.4
Parameter access
Write protection
Writable parameters in the MAG 8000 are protected by a software password. Some
parameters with influence on the accuracy or identity of the flowmeter are furthermore
protected by a hardware lock.
For information on how to unlock parameters protected by a hardware lock, refer to the MAG
8000 Operating Instructions.
Parameter access
When attempting to write a parameter without a password, MAG 8000 will return "Illegal data
address" exception code.