Siemens Atc5300 User manual

ATC5300

Automatic Transfer Controller

Modbus® Communication Protocol

Edition 03/2011

A5E02469001-02

General Information 1

Data Library 2

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.

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 for the specific task, 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:

Trademarks

All names identified by ® are registered trademarks of the 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.

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

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

CAUTION

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

NOTICE

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

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 adhered to. The information in the relevant documentation must be observed.

Siemens AG

Industry Sector

Postfach 48 48

90026 NÜRNBERG

GERMANY

® 03.2011

Technical data subject to change

ATC5300

Modbus Communication Protocol, Edition 03/2011, A5E02469001-02 3

Table of Contents

1 General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.1 Modbus® Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.2 Parameter Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

1.3 Menu P7 - Serial Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1.4 Modbus® RTU Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

1.5 Modbus® Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

1.6 Function 04: Read Input Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

1.7 Function 06: Preset Single Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

1.8 Function 07: Read Exception Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

1.9 Function 17: Report Slave ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

1.10 Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

1.11 Function 16: Preset Multiple Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

1.12 Modbus® ASCII Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

1.13 CRC Calculation (CHECKSUM for RTU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

1.14 Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

2 Data Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

2.1 Data Provided . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

2.2 Status Bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

2.3 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

2.4 Parameter Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

2.5 Setup Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

2.6 Real Time Clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

2.7 Event Log Reading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

2.8 Event Log Pointers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

2.9 Event Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

2.10 PC-ATC Connection via RS 232 Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

2.11 PC-ATC5300 Connection via RS 485 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Table of Co ntents

ATC5300

4Modbus Communication Protocol, Edition 03/2011, A5E02469001-02

ATC5300

Modbus Communication Protocol, Edition 03/2011, A5E02469001-02 5

General Information 1

General Information

1.1 Modbus®Protocol

The ATC series of automatic transfer controllers support the communication protocols Modbus

RTU® and Modbus ASCII® on the RS 232 and RS 485 serial ports. Using this function it is

possible to read the device status and to control the units through the dedicated remote control

software (SENTRON SOFTWARE ATC), third-party supervision software (SCADA) or through

other intelligent devices supporting Modbus®, like PLCs.

General Information

1.2 Parameter Setting

ATC5300

6Modbus Communication Protocol, Edition 03/2011, A5E02469001-02

1.2 Parameter Setting

To configure the Modbus® protocol, enter P7 menu – Serial communication using the following

procedure:

• Set the unit to the OFF-RESET mode by pressing the Hand Akeys simultaneously for five

consecutive seconds.

• The line 1 display will show the code of the first parameter. The first digit of the code is the

menu number which blinks alternating with a P, while the two following digits indicate the

number of the parameter within the menu. The first parameter is P1.01, i.e. menu P1,

parameter 01.

• Press keys Aor Cto scroll the parameters of the same menu.

• Press keys Eor Fto browse the different menus.

• The digit identifying the parameter is shown on LINE 1 display, while the current setting is

shown on LINE 2 display.

• Press keys Bor Dto change the setting of the selected parameter.

• By moving to another parameter or quitting, the menu the setting will be stored

automatically.

• Press key Hto quit parameters setup.

• If no keys are pressed for more than 2 minutes, the unit exits setup automatically without

storing the changes.

& '

(

)

General Information

1.3 Menu P7 - Serial Communication

ATC5300

Modbus Communication Protocol, Edition 03/2011, A5E02469001-02 7

1.3 Menu P7 - Serial Communication

¿Only for ATC5300

PAR Function Range Default

P7.01 RS 232 Address 1 …245 1

P7.02 RS 232 Baud Rate 2400

4800

9600

19200

38400

9600 baud

P7.03 RS 232 Protocol Rtu

ASC - ASCII

Mod - ASCII

+ modem

rtu

P7.04 RS 232 Parity Non - None

Odd

EvE - Even

non

P7.05 ¿RS 485 Baud Rate 1 …245 1

P7.06 ¿RS 485 Baud Rate 2400

4800

9600

19200

38400

9600 baud

P7.07 ¿RS 485 Protocol Rtu

ASC - ASCII

Mod - ASCII

+ modem

rtu

P7.08 ¿RS 485 Parity Non - None

Odd

EvE - Even

non

General Information

1.4 Modbus® RTU Protocol

ATC5300

8Modbus Communication Protocol, Edition 03/2011, A5E02469001-02

1.4 Modbus®RTU Protocol

If one selects the Modbus® RTU protocol, the communication message has the following

structure:

• The Address field holds the serial address of the slave destination device.

• The Function field holds the code of the function that must be executed by the slave.

• The Data field contains data sent to the slave or data received from the slave in response

to a query.

• For the ATC, the maximum length for the data field is of 60 16-bit registers (120 bytes).

• The CRC field allows the master and slave devices to check the message integrity. If a

message has been corrupted by electrical noise or interference, the CRC field allows the

devices to recognize the error and thereby to ignore the message.

• The T1 T2 T3 sequence corresponds to a time, in which data must not be exchanged on

the communication bus to allow the connected devices to recognize the end of one

message and the beginning of another. This time must be at least 3.5 times the time

required to send one character.

The ATC measures the time that elapse from the reception of one character and the following.

If this time exceeds the time necessary to send 3.5 characters at the selected baudrate, then

the next character will be considered as the first of a new message.

1.5 Modbus®Functions

The available functions are:

For instance, to read the value of the battery voltage, which resides at location 30 (1E Hex)

from the ATC with serial address 01 the message to send is the following:

Whereas:

01= slave address

04 = Modbus® function "Read input register"

00 1D = Address of the required register (battery voltage) decreased by one

00 02 = Number of registers to be read beginning from address 30

E1 CD = CRC Checksum

Address

(8 bit)

Function

(8 bit)

Data

(N x 8 bit) CRC (16 bit)

04 = Read input register Allows to read the ATC measures.

06 = Preset single register Allows writing parameters.

07 = Read exception Allows to read the device status.

10 = Preset multiple register Allows writing several parameters.

17 = Report slave ID Allows to read information about the ATC.

01 04 00 1D 00 02 E1 CD

General Information

1.6 Function 04: Read Input Register

ATC5300

Modbus Communication Protocol, Edition 03/2011, A5E02469001-02 9

The ATC answer is the following:

Where:

01 = ATC address (Slave 01)

04 = Function requested by the master

04 = Number of bytes sent by the ATC

00 00 00 7C = Hex value of the battery voltage = 124 = 12.4 VDC

FA 65 = CRC checksum

1.6 Function 04: Read Input Register

The Modbus® function 04 allows to read one or more consecutive registers from the slave

memory. The address of each measure is given in the chapter "Data Library" of this manual.

As for Modbus® standard, the address in the query message must be decreased by one from

the effective address reported in the table. If the measure address is not included in the table

or the number of requested registers exceeds 60, the ATC will return an error code (see error

table).

Master query:

In the above example slave 08 is requested for 8 consecutive registers beginning with address

10h. Thus, registers from 10h to 17h will be returned. As usual, the message ends with the

CRC checksum.

Slave response:

The response is always composed of the slave address, the function code requested by the

master and the contents of the requested registers. The answer ends with the CRC.

01 04 04 00 00 00 7C 65

Slave address 08h

Function 04h

MSB address 00h

LSB address 0Fh

MSB register number 00h

LSB register number 08h

MSB CRC 21h

LSB CRC 57h

Slave address 08h

Function 04h

Byte number 10h

MSB register 10h 00h

LSB register 10h 00h

——

MSB register 17h 00h

LSB register 17h 00h

MSB CRC 5Eh

LSB CRC 83h

General Information

1.7 Function 06: Preset Single Register

ATC5300

10 Modbus Communication Protocol, Edition 03/2011, A5E02469001-02

1.7 Function 06: Preset Single Register

This function allows to write in the registers. It can be used only with registers with address

higher than 1000 Hex. For instance it is possible to change setup parameters. If the value is

not in the correct range, the ATC will answer with an error message. In the same way, if the

parameter address is not recognised, the ATC will send an error response.

The address and the valid range for each parameter are indicated in Tables 5, 6 and 7. With

function 06, some commands (like passing from MAN to AUT and vice versa) can be possibly

executed sending the addresses and the values reported in Table 4.

Master message:

Slave response:

The slave response is an echo to the query, that is the slave sends back to the master the

address and the new value of the variable.

1.8 Function 07: Read Exception Status

This function allows to read the status of the automatic transfer switch.

Master query:

The following table gives the meaning of the status byte sent by the ATC as answer:

Slave address 08h

Function 06h

MSB register address 16h

LSB register address 03h

MSB data 00h

LSB data 1Eh

MSB CRC FDh

LSB CRC 13h

Slave address 08h

Function 07h

MSB CRC 47h

LSB CRC B2h

BIT MEANING

0 Operative mode OFF / Reset

1 Operative mode MAN

2 Operative mode AUT

3 Operative mode TEST

4Erroron

5 AC power supply present

6 DC power supply present

7 Global alarm on

General Information

1.9 Function 17: Report Slave ID

ATC5300

Modbus Communication Protocol, Edition 03/2011, A5E02469001-02 11

1.9 Function 17: Report Slave ID

This function allows to identify the controller type.

Master query:

Slave response:

¿61h = ATC5300

1.10 Errors

In case the slave receives an incorrect message, it answers with a message composed by the

queried function ORed with 80 Hex, followed by an error code byte.

The following table shows the error codes sent by the slave to the master:

Table 1: Error Codes

Slave address 08h

Function 11h

MSB CRC C6h

LSB CRC 7Ch

Slave address 08h

Function 11h

Byte count 04h

Data 01 - Device type ¿61h

Data 02 - (SW revision) 04h

Data 03 - (Hardware revision) 00h

Data 04 - (Parameter revision) 01h

MSB CRC ..h

LSB CRC ..h

CODE ERROR

01 Invalid function

02 Invalid address

03 Parameter out of range

04 Function execution impossible

06 Slave busy, function momentarily not

available

General Information

1.11 Function 16: Preset Multiple Register

ATC5300

12 Modbus Communication Protocol, Edition 03/2011, A5E02469001-02

1.11 Function 16: Preset Multiple Register

This function allows to modify multiple parameters with a single message, or to preset a value

longer than one register. The address and the valid range for each parameter are stated in

Table 3.

Master message:

Slave response:

1.12 Modbus®ASCII Protocol

The Modbus® ASCII protocol is normally used in application that require to communicate

through a couple of modems. The functions and addresses available are the same as for the

RTU version, but the transmitted characters are in ASCII and the message end is delimited by

carriage return / line feed instead of a transmission pause.

If one selects the parameter P7.04 and / or P7.07 as Modbus® ASCII protocol, the

communication message on the correspondent communication port has the following

structure:

• The Address field holds the serial address of the slave destination device.

• The Function field holds the code of the function that must be executed by the slave.

• The Data field contains data sent to the slave or data received from the slave in response

to a query. The maximum allowable length is of 60 consecutive registers.

• The LRC field allows the master and slave devices to check the message integrity. If a

message has been corrupted by electrical noise or interference, the LRC field allows the

devices to recognize the error and thereby ignore the message.

• The message terminates always with CRLF control character (0D 0A).

Slave address 08h

Function 10h

MSB register address 20h

LSB register address 01h

MSB register number 00h

LSB register number 02h

MSB data 06h

LSB data F4h

MSB data 06h

LSB data 83h

MSB CRC 55h

LSB CRC 3Ah

Slave address 08h

Function 10h

MSB register address 20h

LSB register address 01h

MSB byte number 00h

LSB byte number 04h

MSB CRC 9Bh

LSB CRC 53h

:Address

(2 chars)

Function

(2 chars)

Dates

(N chars) LRC (2 chars) CR LF

General Information

1.12 Modbus® ASCII Protocol

ATC5300

Modbus Communication Protocol, Edition 03/2011, A5E02469001-02 13

Example:

For instance, to read the value of the phase-to-phase voltage, which resides at location 04

(04 Hex) from the slave with serial address 08, the message to send is the following:

Whereas:

: = ASCII 3Ah message start delimiter

08 = slave address

04 = Modbus® function "Read input register"

00 03 = Address of the required register (L2 voltage of line 1) decreased by one

00 02 = Number of registers to be read beginning from address 04

EF = LRC Checksum

CRLF = ASCII 0Dh 0Ah = Message end delimiter

The ATC answer is the following:

Whereas:

: = ASCII 3Ah message start delimiter

08 = Multimeter address (Slave 08)

04 = Function requested by the master

04 = Number of bytes sent by the multimeter

00 00 01 A0 = Hex value of the phase-to-phase voltage (416 V)

4F = LRC checksum

CRLF = ASCII 0Dh 0Ah = Message end delimiter

: 080400030002EFCRLF

: 080400000001A04FCRLF

General Information

1.13 CRC Calculation (CHECKSUM for RTU)

ATC5300

14 Modbus Communication Protocol, Edition 03/2011, A5E02469001-02

1.13 CRC Calculation (CHECKSUM for RTU)

CRC Calculation Workflow

XOR = exclusive or

n = number of information bits

POLY = calculation polynomial of the CRC 16 = 1010 0000 0000 0001

(Generating polynomial = 1 + x 2+ x 15 + x 16)

In the CRC 16, the 1st byte transmitted is the least significant one.

CRC xor BYTE = CRC

n = 0

CRC right shift

carry over

CRC xor POLY = CRC

n = n + 1

next BYTE

end message

End

n > 7

Hex FFFF = CRC

yes

General Information

1.13 CRC Calculation (CHECKSUM for RTU)

ATC5300

Modbus Communication Protocol, Edition 03/2011, A5E02469001-02 15

Example of CRC calculation:

Frame = 0207h

CRC initialization 1111 1111 1111 1111

Load the first byte 0000 0010

Execute xor with the first 1111 1111 1111 1101

Byte of the frame

Execute 1st right shift 0111 1111 1111 1110 1