kaeser comp

KAESER KOMPRESSOREN GmbH

P.O. Box 2143 • D-96410 Coburg • Germany • Phone +49 9561 6400 • Fax +49 9561 640130

User Manual Smart_MOD KLink – Protocol converter Klink/Modbus © 2005 KAESER KOMPRESSOREN GmbH

Versions

Documentation: V1.05 Configuration tool, RS-232: V2.03 Firmware version: V1.05 Hardware version: V1.20

Smart_MOD KLink User manual

KAESER KOMPRESSOREN www.kaeser.com 7_6933_MOD_02E.doc 14.11.2005 /34

Contents

1. Notes to obey 4

2. Introduction 5

3. Delivery content 6

4. Hardware specification 7

4.1. Dimensions, connectors, state display 7

4.2. Technical data 8

4.3. Interface signals 8

5. Usage of the hardware 9

5.1. Working scenario 9

5.2. Connection of the hardware 10

6. Configuration 11

6.1. Configuration via code switches 12

6.2. Configuration via the RS-232 interface 13

6.2.1. Installation of the tool 13

6.2.2. Usage of the 'Smart_MOD KLink Serial Configuration-Tool' 13

6.3. Configuration via Modbus register 22

6.3.1. Parameter 23

6.3.2. Protocol 24



7. Field use of the Smart_MOD KLink 27

7.1. General information 27

7.2. The register structure in the overview 28

7.3. Smart_MOD KLink - Communication with SIGMA CONTROL or SIGMA AIR MANAGER 30 1. Establish connection 30 2. Synchronization 30 3. Set password 30 4. Call operational data 31

7.4. Master - communication with Smart_MOD KLink 32

7.5. SIGMA CONTROL operational data 34

7.6. SIGMA AIR MANAGER operational data 34

7.7. KLink password 34

8. Support 34



1. Notes to obey

The usage of hardware and software should only take place after studying this user manual in detail! Generally: 1. Connect the hardware correctly to the power supply. 2. Use the right voltage:

U = +18-36V DC

Voltage out of the defined range can lead to the destruction of the device. SELV Compliance: The safety status of any connections to the Smart_MOD module must comply to the SELV requirements. Copyright: Neither this user manual nor parts of it may be copied or distributed in any way, e.g. on paper or in an electronic form, without the written permission of KAESER KOMPRESSOREN GmbH.



2. Introduction

The manufacturer of Smart_MOD is b-plus GmbH. Smart_MOD Klink is exclusively made for KAESER KOMPRESSOREN GmbH. By means of a Smart_MOD KLink, the KAESER controllers SIGMA CONTROL or SIGMA AIR MANAGER can be easily connected to Modbus. Thereby Smart_MOD takes over the complete communication to the controllers, so that on the side of the Modbus network only the actually relevant process data such as measurement values, set points, device parameters etc. have to be transferred. Generally, the Smart_MOD KLink makes it possible for a Modbus master system (e.g. a PC or a PLC) to call data from a SIGMA AIR MANAGER. Smart_MOD Klink communicates with SIGMA CONTROL or SIGMA AIR MANAGER via KAESER KLink protocol.



3. Delivery content

• Smart_MOD KLink Box Ready-to-operate module, in a strong aluminium housing, including a power supply connector. Power supply: U = +18-36V DC

It is possible to get a KAESER compressor with built in Smart_MOD or to get Smart_MOD as a retrofit kit for KAESER compressors.

• Accessories (optional): Software

• Smart_MOD KLink CD CD with configuration tool for the serial interface, user manual as *.pdf file inclusive description of setting the parameters via the Modbus master.



4. Hardware specification

4.1. Dimensions, connectors, state display



4.2. Technical data Power supply (Smart_MOD Box) Operating voltage +18-36V DC

Power consumption (RS-232 and Modbus in operating state) approximately 2 Watt

Environment conditions (Smart_MOD Box) Operating temperature 0°C ... +50°C

Stock temperature -10°C ... +70°C

Modbus interface RS485 Interface, galvanic separated 9-SUBD female connector Baud rate 9.6, 19.2 kBit/s

RS-232 interface Standard PC RS-232 interface 9-SUBD male connector

Baud rate 0.3, 0.6, 1.2, 2.4, 4.8, 9.6, 14.4, 19.2, 28.8, 38.4, 57.6, 76.8, 115.2 kBit/s

4.3. Interface signals Power supply (PIN) + +18-36V DC GND GND

PE PE (safety ground)

RS-232 (PIN) 9-SUBD male connector 1 DCD

2 RXD

3 TXD 4 DTR

5 GND

6 DSR

7 RTS

8 CTS 9 RI

Modbus interface RS485 (PIN) 9-SUBD female connector 1 n.c.

2 n.c.

3 B+

4 n.c. 5 DGND

6 VP (+5V)

7 n.c.

8 A-

9 n.c.

LED-Signals LED red (CONNECTION) Connection indicator

LED green (OPERATION) Operation state



5. Usage of the hardware

This product is a sensitive electronic device and therefore, special attention has to be paid to the following items.

5.1. Working scenario

A possible working scenarios for the Smart_MOD KLink module is shown in the picture below: In order to put the Smart_MOD into operation, the serial interface has to be connected by a standardized RS-232 cable with the RS-232 interface of SIGMA CONTROL or SIGMA AIR MANAGER. The RS-232 interface of Smart_MOD KLink is compatible to the RS-232 of a PC, i.e. it can be connected directly with each standard RS-232 interface of a terminal device. The power supply for the Smart_MOD KLink must provide a stable and interference-free operating voltage of +18-36 Volt DC, whereby the power consumption is about 2 Watt. The Modbus interface of Smart_MOD KLink is equipped with a SUBD female connector. Via this connector the Smart_MOD KLink is connected as a slave to a Modbus master system (master system can be e.g. a PLC or a PC).

Picture 1 – Working scenario

Modbus

Modbus slave

SIGMA CONTROL or

SIGMA AIR MANAGER

RS - 232 Interface

Modbus slave

Modbus slave

Modbus slave

Modbus master (e.g. PC or PLC)

Smart_MOD KLink

Modbus



5.2. Connection of the hardware

The following points have to be considered when connecting the Smart_MOD module: 1. Take care about connecting lines to the power connector. Use the right polarity!

Attention: Wrong polarity of the voltage supply destroy's the module! 2. Connect PE to safety ground. 3. Pay attention to the right operating voltage. The Smart_MOD Box module allows an

operating voltage area between +18-36V DC. Voltage out of the defined range can lead to the distruction of the device!

4. Connect the Smart_MOD module via a norm RS-485 cable to the Modbus network. 5. Connect the Smart_MOD module via a norm RS-232 cable to SIGMA CONTROL or SIGMA

AIR MANAGER. Attention: If you connect the RS-232 of the Smart_MOD module to a serial port of a PC for a full functional test, you have to use a zero-modem-cable (crossed data lines)!

6. After switching on the operating voltage on the module:

• The green and the red LED shine for a periode of two seconds and signal readiness for the configuration with the serial configuration tool (see 6.2 - Configuration via the RS-232 interface).

• Both LEDS expire for approximately one second.

• The red LED indicates the condition of the connection between the Smart_MOD KLink and the attached SIGMA CONTROL or SIGMA AIR MANAGER: - Does the red LED shine, so the connection between the two devices hasn't taken

place yet. - However, doesn't the red LED shine, so a connection exists and data are exchanged

between the two devices.

• The green LED is permanently on and signals 'ready for operation'.

• If an error happens the green LED is blinking: - 1 flash � Error with the Modbus initialization - 2 flashes � Error in the case of the RS232 interface initialization - 3 flashes � Error during the KLink protocol initialization Note: If the green LED flashes more than 15 times, so an EEPROM error exists.



6. Configuration

In order to use the whole function of the Smart_MOD device, some parameters must be set according to the respective working scenario. The user has three possibilities to configure the Modbus/RS-232 interface: Configuration via ...

• Code switches in order to set the bus address

• RS-232 configuration software

• Modbus register

Code

switches RS-232 Modbus

register Factory settings

Description

Modbus parameter Framing n.a. r/w r/w RTU Data framework: RTU or ASCII

Mode n.a. r/w r/w < 10000 Register mode (< 10000 registers, J-bus)

Type n.a. r r Slave Operation mode (only slave)

Address w r/w r/w 8 Hardware address of Smart_MOD Baud rate n.a. r/w r/w 19200 Transmission rate

Parity n.a. r/w r/w No Parity check (only with ASCII)

Character timeout n.a. r/w r/w 1000 ms Timeout for characters (ZVZ)

Read timeout n.a. r/w r/w 3000 ms Timeout when reading (LVZ)

Write timeout n.a. r/w r/w 3000 ms Timeout when writing (SVZ)

Serial interface Baud rate n.a. r/w r/w 192000 Speed

Data bits n.a. r/w r/w 8 Number of data bits

Stop bits n.a. r/w r/w 1 Number of stop bits

Parity n.a. r/w r/w no Parity check

Handshake n.a. r/w r/w no Handshake mode

Control signals DTR, RTS n.a. r/w r/w no Setting the control lines Control signals CD, CTS, RI, DSR

n.a. n.a. r no Reading the control lines

KLink protocol Update time n.a. r/w r/w 1000 ms Update rate for the data update Timeout time n.a. r/w r/w 1000 ms Timeout for the communication between

Smart_MOD KLink and SIGMA CONTROL or SIGMA AIR MANAGER

Password n.a. r/w r/w 000000000000 or ‘000000’

Six digit (hex code 00-FF) or Six digit (ASCII)

Additional parameter Internal S/N n.a. r n.a. Serial number Firmware version n.a. r n.a. Version of the firmware

(Legend: r read, w write, n.a. not available)

The table above shows, which parameters can be read or set by which tool and how the factory setting is. Important note: If the Smart_MOD cannot be found in the Modbus network, the setting of the bus address should in any case first be done by means of the code switches!



6.1. Configuration via code switches

The Modbus address of Smart_MOD KLink can be configured via the code switches (see illustrations from chapter 4.1). This kind of the address assignment has priority before the configuration by software, which can be done by means of a Modbus register or by the afterwards described serial configuration tool. The settings done by software are only active, if the code switches are adjusted to an address equal to 0 or larger than 247 (in hexadecimals: F7). Otherwise, the hardware settings have priority. Example: If you intend to set the address 143, the hexadecimal code switches have to be adjusted as follows:

- The code switch on the left side has to be set to '8', the right switch however to 'F' - Because each of the two code switches represents a nibble, the hexadecimal value

'8F' results Important note: A changing of the Modbus address via the code switches will only be active, if the Smart_MOD KLink interface is booted again (i.e. the power supply is separated and then connected again). In any case: If you are not sure what address should be used for connecting Smart_MOD to your special Modbus network, please ask the engineer who is responsible for your bus system.



6.2. Configuration via the RS-232 interface

The Smart_MOD KLink module can be configured through a tool via the RS-232 interface. This kind of configuration is an alternative to the configuration via the Modbus master by means of the Modbus registers (see 6.3 - Configuration via Modbus register).

6.2.1. Installation of the tool

Start the program 'setup.exe' from the corresponding directory of the Smart_MOD KLink CD ('...\Configuration\Serial') for the software 'Smart_MOD KLink Serial Configuration' and follow the instructions on the monitor. After successful installation the program 'Smart_MOD KLink Serial Configuration' can be started from the task bar under the program group 'b-plus'.

6.2.2. Usage of the 'Smart_MOD KLink Serial Configuration-Tool' In order to get a connection via the 'Smart_MOD KLink Serial Configuration-Tool' to the Smart_MOD device, the following steps have to be carried out: 1. Connect the Smart_MOD module through a zero-modem-cable (crossed data lines) to a

free RS-232 port of your PC. 2. Start the application 'Smart_MOD KLink Serial Configuration' from the task bar under the

program group 'b-plus'. 3. Choose the COM port to which the Smart_MOD module is connected to your PC. 4. Power up the Smart_MOD module when the starting window of the application is shown

on the screen. 5. After a short moment the buttons ('Read', 'Reboot') aren’t shadowed any more (they are

active now). Further on, the fields 'Firmwareversion' and 'Internal S/N' now contain the corresponding entries. The connection to the Smart_MOD KLink is now established. If setting up a connection to the Smart_MOD module is not possible, the program will finish automatically after 10 seconds.

Important note: As long as Smart_MOD is accessed via the RS-232 interface by the 'Smart_MOD KLink Serial Configuration-Tool', no contact is possible to the Modbus network, because the Modbus interface of the Smart_MOD KLink is not activated in this case!



After the start of the serial configuration tool you see the following application window. Here you can select the COM port of your PC, to which the Smart_MOD KLink module is connected. If in the selection menu the intended COM port does not appear, it is occupied by another application (in this case you select 'cancel'). Finish the application, which uses the COM port and restart the serial configuration tool.

Picture 2 – Configuration tool (select the COM port)

After you pressed OK, the serial configuration tool tries to build up a connection to the Smart_MOD KLink via the selected COM port (a blue bar indicates thereby the progress of the search procedure). Attach now the power connector to the Smart_MOD KLink module, in order to (re)start the device.

Picture 3 – Configuration tool (establish connection)



If after ten seconds no connection to the Smart_MOD KLink module was established, an error message appears:

Picture 4 – Configuration tool (no connection)

Please check the following items:

• Are all connection lines attached correctly (RS-232 zero-modem-cable, power)?

• Did you select the right COM port at your PC?

• Did you keep the correct order? First start the serial configuration tool, then select the COM port, confirm with an OK and attach Smart_MOD KLink to the power supply.

Note: By the Smart_MOD KLink module is checked during the system start, whether a PC with an active 'Smart_MOD KLink Serial Configuration-Tool' is attached.



If a connection to the Smart_MOD module was established, then the buttons are activated and the entries of the fields 'Firmwareversion' and 'Internal S/N' are displayed:

Picture 5 – Configuration tool (connection established)

In the main window the following buttons are shown:

• Read: The actual firmware version and serial number from the Smart_MOD module are read out.

• Reboot: Restarts the module (a contact with the configuration tool is not possible before

the reboot of the Smart_MOD module). By choosing a tab from the tabbed dialog, within the upper window range the respective configuration masks can be accessed (configuration masks are more detailed described on the following pages).



Configuration of the Modbus parameters:

Picture 6 – Configuration tool (Modbus configuration)

• Address: The Modbus address stored in the EEPROM, with which Smart_MOD KLink is

identified in the Modbus network (valid Modbus addresses are in the range from 1 to 247).

Note: The setting of the address with the code switches on the Smart_MOD module (see 4.1 Dimensions, connectors, state display) has in principle priority with regard to the setting from the serial configuration tool. The setting of the address with the serial configuration tool is only valid, if the code switches on the Smart_MOD module are set to an Modbus address equal 0 or higher than 247 (hexadecimal: F7). If this is the case, so the Modbus master is furthermore able to change the address of Smart_MOD KLink during the Modbus operation by accessing its configuration registers (address is stored in the EEPROM).

• Type: Smart_MOD KLink operates as a slave, i.e. it receives the transmitted data, but however sends only after a request by the Modbus master. Smart_MOD KLink stores each data package which it receives via the KLink protocol from the serial interface. These data can afterwards be called up by the Modbus master ('polling procedure').



• Framing: Data are transmitted on the Modbus within a framework ('framing'). For the

Modbus transmission two data frameworks (RTU and ASCII) are possible with Smart_MOD:

If during a certain time period1 no data were transmitted on the Modbus, a RTU framework begins with the address of the slave (for which the new data are intended) and a function code, which specifies the use of the data. Afterwards the data follows and a CRC check sum, with which transfer errors on the bus can be recognized. Only after the pause period1 a new framework with data may then be transferred again.

RTU framing:

Start Address Function Data CRC sum End

pause period 8 Bit 8 Bit n x 8 Bit 16 Bit pause period

The ASCII framework uses in difference to the RTU framework as start identifier a colon (hexadecimal: 3A). Afterwards follows the address of the slave, the function code and the data. After a LRC check sum, with which transfer errors on the bus can be recognized, the framework ends with a combination of the two characters 'carriage return' and 'line feed' (hexadecimal: 0D and 0A). Immediately after it a new framework can follow, which is introduced again with a colon. Apart from the starting and the ending character, all other characters may only be the ASCII values 0 to 9 or A to F.

ASCII framing:

Start Address Function Data LRC sum End

1 Character (hex: 3A)

2 Characters 2 Characters n Characters 2 Characters 2 Characters (hex: 0D 0A)

• MODE: Accessing the register structure can be managed on two different ways

<10000: This method is often only used by older Modbus systems (e.g. older masters devices). The access on the needed registers follows in context with the operating function, i.e. only relative address areas are used here. For example if register 40001 is needed, then only the start address 0 has to be used.

J-Bus: Usually only the newer Modbus systems use this method. The access to the

needed register is managed by means of an absolute address specification. For example if register 40001 is needed, then the value 40001 must be actually selected as start address.

• Baudrate: Transmission rate of the Modbus.

1 Pause period: The pause period depends on the baud rate and lasts in principle as long as the transmission of 3,5 characters.



• Parity: The setting of a parity bit for an error detection is only of importance with an ASCII

framework. With an ASCII framework each character is transmitted in the following format:

1 Character (10 Bits) Start ASCII value Parity Stop

1 Bit 7 Bits 0 or 1 Bit 1 or 2 Bits

In the case of an ASCII framework, the number of stop bits results automatically from the setting of the parity check and does therefore not have to be specially adjusted:

Parity Stop bits None 2 Odd 1 Even 1

With RTU framing neither the parity nor the number of stop bits have to be set. All characters are here transmitted according to standard format 8-N-1 (so with eight data bits, without parity bit and with one stop bit).

• ZVZ (Character timeout): Smart_MOD KLink expects data frameworks from Modbus as a

data stream, i.e. matching characters of a data framework also have to be recognizable as such. If after a character has been received Smart_MOD has to wait longer than the here given time for the next character, this is interpreted as an abort of a data framework and the already received characters are rejected. Values between 0 and 65500 milliseconds can be set.

• LVZ (Read timeout): After a request by the Modbus master, Smart_MOD KLink tries to

read data from the serial terminal device. If the device does not permit a reading access within the time specified here, Smart_MOD KLink stops reading and sends a negative receipt to the master. Values between 500 und 65500 milliseconds can be set.

• SVZ (Write timeout): After Smart_MOD KLink has received data from the Modbus master,

it accesses the serial interface via the KLink protocol by writing. If the terminal device at the serial interface does not confirm within the time specified here the taking over of the data, Smart_MOD KLink stops the writing procedure and sends a negative receipt to the master. When using the block check with the KLink protocol on the serial interface, values between 13000 and 65500 milliseconds can be set. Without the use of the block check, values from 4000 to 65500 milliseconds are possible.

• Read: Reads in the parameter values, stored in the EEPROM of the Smart_MOD KLink.

• Write: Writes the settings into the EEPROM of Smart_MOD KLink - the values are used after the next reboot of the Smart_MOD module.

Important note: If you are not sure which values should be used, please ask the engineer who is responsible for your Modbus master system.



Configuration of the parameters for the KLink protocol:

Picture 7 – Configuration tool (Configuration of the KLink protocol)

• Baudrate: Transmission rate of the RS-232 interface. • Parity: Adjustment of the parity check for the serial interface (error detection procedure). • Databits: Defines the width of a data word.

• Stopbits: Number of stop bits.

• Handshake: Handshake mode.

• DTR, RTS: Specifies if the control lines DTR and/or RTS are set at the start-up process ('boot') of Smart_MOD KLink (the serial interfaces of many terminal devices require a certain setting of the control lines, in order to be able to communicate). After the start-up process the Modbus master is able to read out and change again the conditions of the serial control lines from the Smart_MOD KLink by an access to the Modbus registers.

• Update: With the help of this field the update time can be adjusted with which the Smart_MOD KLink permanently calls up data from the SIGMA AIR MANAGER (i.e. the pause periode from one data acquisition to the next is set here - values between 0 and 65500 milliseconds).

• Timeout: With the timeout field the maximum waiting period of the Smart_MOD KLink, concerning the data collection, can be adjusted (values between 500 and 65500 milliseconds).



• Password Button: By pressing this button the input menu for the password, needed by

the SIGMA AIR MANAGER, is displayed (password length: 6 characters). See chapter 7.7 for more information about the password.

• Read: Reads the parameter values, stored in the EEPROM of Smart_MOD KLink. • Write: Writes the set values into the EEPROM of Smart_MOD KLink - the values are used

after the next reboot of the Smart_MOD module. Configuration of the password, needed by SIGMA CONTROL or SIGMA AIR MANAGER:

Picture 8 – Password input (configuration of the KLink protocol)

• Accept: Checking and taking over of the password inputs. • Cancel: Abort of the password input.

• Hex-Checkbox: By activating this checkbox the normaly ascii shown charakters can be displayed in hex notation. It has to be recommended that these hex charakters have to delared in 2 nibble notation.

For example : The ascii char “A” has to declared as hex value “41”. With this option it is also possible to insert non printable characters, such as “0” (hexvalue). In this case switching back to ascii mode is not possible. For example : If the passwort should be a “000000” hex-value, the inserted string in hex mode has to be “000000000000”.

• Hide-Checkbox: With this check box, the normally hidden characters can be displayed (and vice versa), i.e. is the field activated, all inputs are hidden.



6.3. Configuration via Modbus register

Via some registers, which Smart_MOD KLink supplies on the side of the Modbus, the configuration can be changed. For this the Modbus master sends to the address of Smart_MOD KLink a Modbus data framework with the function code 'write multiple register' (hexadecimal: 10), the number of the register and the new parameters. If the data are valid, Smart_MOD KLink stores the configuration in the EEPROM (see examples 1 to 3 on the following pages). The changed configuration however first takes effect, as soon as the module is started again ('reboot'). A restart can be carried out, among other things2, by the fact that the Modbus master writes to register 65000 of Smart_MOD KLink the hexadecimal value 'AAAA' (see example 4 on the following pages). With a broadcast it is also possible to send configuration data together to all slaves in the Modbus network. For this the configuration data has to be sent to the hexadecimal address 00 (broadcast address) with the respective register indication. As well as all other Modbus Slaves Smart_MOD KLink receives then the configuration data and stores the new data (as described above) in the EEPROM. For example in this way several Smart_MOD modules in one Modbus network can be configured with the same values and rebooted together afterwards. Via a Modbus data framework the Modbus master is also able to read out the configuration from the same registers with the function code 'read holding registers' (hexadecimal: 03) - see example 5 and 6 on the following pages. Note: The Modbus specification however shows the use of further functions, but there are only two functions implemented because the remaining function are not needed. These two functions are:

- Write multiple registers: Write to one or more registers - Read holding registers: Read out one or more registers

2 A restart can be carried out from the PC by the serial configuration tool or manually - as the module is separated

for a short time from the power supply.



6.3.1. Parameter

Via the following registers the configuration of Smart_MOD KLink can be read and/or changed by the Modbus data framework. Each register contains two byte, the configuration parameters are one or two byte long. Therefore over the access to a single register up to two parameters can be changed. For each parameter is given in each case, whether it is contained in the byte with high order (MSB: most significant byte) or in the byte with low order (LSB: least significant byte) of a register. Particularly has to be considered, when doing the configuration of the two byte large parameters, that register contents on Modbus are transferred with the low order byte at first (Intel format: LSB first) - see example 3. Register Parameter Valid values Byte Access

Configuration of the serial interface:

Baud rate 0=300; 1=600; 2=1200; 3=2400; 4=4800; 5=9600; 6=14400; 7=19200; 8=28800; 9=38400; 10=57600; 11=76800; 12=115200 kBit/s

LSB r/w 43000

Parity Check 0=None; 1=Odd; 2=Even MSB r/w

Number of stop bits 0=1 Bit; 1=2 Bits LSB r/w 43001 Data word width 0=5Bits; 1=6Bits; 2=7Bits; 3=8Bits MSB r/w

Handshake 0=None LSB r/w 43002

DTR/RTS Bit 0=DTR; Bit1=RTS MSB r/w

CD/CTS/RI/DSR Bit 0=CD; Bit1=CTS; Bit2=RI; Bit3=DSR LSB r 43003

n.a. MSB r/w

Modbus configuration: Baud rate 5=9600; 7=19200 kBit/s LSB r/w 43100

Parity Check 0=None; 1=Odd; 2=Even MSB r/w

Data framework 0=RTU; 1=ASCII LSB r/w 43101

Operation mode 0=Slave MSB r/w Address 1 to 247 LSB r/w 43102

Mode 0=<10000; 1=J-Bus MSB r/w

43103 Character timeout 0 to 65500 r/w

43104 Read timeout 500 to 65500 r/w

43105 Write timeout 500 to 65500 r/w

KLink configuration:

43200 Update time 0 to 65500 r/w

43201 Timeout 500 to 65500 r/w

00-FF (hex values) or ASCII-Character LSB 43202

00-FF (hex values) or ASCII-Character MSB

r/w


00-FF (hex values) or ASCII-Character MSB

r/w


Password

00-FF (hex values) or ASCII-Character MSB r/w

Reset:

44000 Reboot hexadecimal: AAAA w


Factory settings see 6 Configuration. All not specified values are invalid and ignored by the Smart_MOD KLink. As well as an access to the not available bytes does not have an influence on the configuration of Smart_MOD KLink.



6.3.2. Protocol

In the following one you will find some examples for the configuration of Smart_MOD KLink by access to its Modbus registers. In all examples Smart_MOD KLink is adjusted to address 8. For better understanding the starting register is represented in decimal and all other fields are given in hexadecimal way of writing. At first the low order bytes, afterwards the bytes with high order are written into the registers. Example 1: The baud rate and the parity check of the serial interface should be set to 9600 kBit/s and/or even parity. For that the Modbus master sends the following telegram with the function code 'write multiple register' (hexadecimal: 10):

Start

identifier

Address

1 Byte

Function

1 Byte

Start register

2 Byte

Number of

registers

2 Byte

Number of Bytes

1 Byte

Parameter

2 Byte

Check

2 Byte

End

identifier

... 08hex 10hex 43000dez 00hex 01hex 02hex 05hex 02hex … …

The access takes place on register 43000 exclusively. There the hexadecimal value 0205 is registered. Smart_MOD KLink stores the new configuration in the EEPROM and acknowledges the change with regard to the Modbus master with the following telegram:

Start identifier

Address 1 Byte

Function 1 Byte

Start register 2 Byte

Number of registers 2 Byte

Check 2 Byte

End identifier

... 08hex 10 hex 43000dez 00 hex 01 hex … …

Example 2: The serial control line RTS should be set and the control line DTR should be reset. Therefore the Modbus master sends the following telegram with the function code 'write multiple registers' (hexadecimal: 10):

Start

identifier

Address

1 Byte

Function

1 Byte

Start register

2 Byte

Number of

registers

2 Byte

Number of Bytes

1 Byte

Parameter

2 Byte

Check

2 Byte

End

identifier


The access takes place on register 43002 exclusively. There the hexadecimal value 0200 is registered. Smart_MOD KLink stores the new configuration in the EEPROM and acknowledges the change with regard to the Modbus master with the following telegram:

Start identifier

Address 1 Byte

Function 1 Byte



Check 2 Byte

End identifier




Example 3: The characters timeout should be set to the value 1024 milliseconds (hexadecimal: 0400). Therefore the Modbus master sends the following telegram with the function code 'write multiple registers' (hexadecimal: 10). Since on Modbus as mentioned above the register contents are transferred with the low order byte at first, within the data framework the value for the character timeout appears with exchanged bytes (00hex 04 hex):

Start

identifier

Address

1 Byte

Function

1 Byte

Start register

2 Byte

Number of

registers

2 Byte

Number of Bytes

1 Byte

Parameter

2 Byte

Check

2 Byte

End

identifier


The access exclusively takes place on register 43103. There the hexadecimal value 0400 is going to be registered. Smart_MOD KLink stores the new configuration in the EEPROM and acknowledges the change with regard to the Modbus master with the following telegram:

Start identifier

Address 1 Byte

Function 1 Byte



Check 2 Byte

End identifier


Example 4: After some configuration parameters were changed, Smart_MOD KLink should be restarted, in order to make the changes become effective. Therefore the Modbus master sends the following telegram with the function code 'write multiple registers' (hexadecimal: 10):

Start

identifier

Address

1 Byte

Function

1 Byte

Start register

2 Byte

Number of

registers

2 Byte

Number of Bytes

1 Byte

Parameter

4 Byte

Check

2 Byte

End

identifier

... 08hex 10hex 44000dez 00hex 01hex 02hex AAhex AAhex … …

After that Smart_MOD KLink is restarted (a receipt does not take place). Example 5: The configuration for update time and timeout of the KLink protocol should be read out. Therefore the Modbus master sends the following telegram with the function code 'read holding registers' (hexadecimal: 03):

Start identifier

Address 1 Byte

Function 1 Byte



Check 2 Byte

End identifier


Smart_MOD KLink sends back the requested configuration parameters in the following telegram:

Start identifier

Address 1 Byte

Function 1 Byte

Number of Byte 1 Byte

Parameter 4 Byte

Check 2 Byte

End identifier

... 08hex 03 hex 04hex D0 hex 07 hex E8 hex 03 hex … …

In this example the update time is equal 2000 ms (hexadecimal: 07D0) and the timeout is equal 1000 ms (hexadecimal: 03E8).



Example 6: The control lines CD, CTS, RI and DSR should be read out. Therefore the Modbus master sends the following telegram with the function code 'read holding register' (hexadecimals: 03):

Start identifier

Address 1 Byte

Function 1 Byte



Check 2 Byte

End identifier


Smart_MOD KLink sends back the state of the control lines in the following telegram:

Start identifier

Address 1 Byte

Function 1 Byte

Number of Byte 1 Byte

Parameter 2 Byte

Check 2 Byte

End identifier

... 08hex 03 hex 02hex 09 hex 00 hex … …

The value 0009hex = 1001bin signals that CD and DSR are set and/or that CTS and RI are not set.



7. Field use of the Smart_MOD KLink

If the Smart_MOD is integrated ready-for-operation in a Modbus network, then the master system is able to access the SIGMA AIR MANAGER, which is connected to the serial interface of Smart_MOD KLink.

7.1. General information

Smart_MOD is delivered with the KLink protocol on the RS-232 interface. General description:

• Smart_MOD is a Modbus slave.

• A master system is able to call data from a Smart_MOD KLink, which was received before over the serial interface and the KLink protocol.

• Smart_MOD packs the data from the serial interface into the Modbus framing and holds it for call of the Modbus master.

• As interface to the Modbus, Smart_MOD KLink makes a register structure available, which a Modbus master is able to access by reading and writing. These registers serve on the one hand for the datentransfer between bus and SIGMA CONTROL or SIGMA AIR MANAGER, on the other hand for the configuration of Smart_MOD KLink by the Modbus master.



7.2. The register structure in the overview

Every in the following specified register contains two bytes. All not specified register numbers aren't implemented and therefore neither write able nor readable. First the low bytes and then the higher bytes are written into the registers. Register Parameter Valid values Access

Serial number of the SIGMA CONTROL or the SIGMA AIR MANAGER: 40001 ... 40002

Serial number Arbitrary r

Part number of the SIGMA CONTROL or the SIGMA AIR MANAGER: 40004 ... 40019

Part number + reserve

Arbitrary r

Operational data of the SIGMA CONTROL or the SIGMA AIR MANAGER: (for details see 7.5)

40021 ... 40084 40085 … 41044

Operational data reserved

Arbitrary r

Reserved area: 42000 … 42005

Reserved Arbitrary r/w

Error message concerning the SIGMA CONTROL or the SIGMA AIR MANAGER:

42999 Error number Only low byte is valid: 00(hex) = no error 01(hex) = invalid message 02(hex) = invalid checksum 03(hex) = unknown function code 10(hex) = terminal device is not ready

r/w


Example:

SIGMA AIR MANAGER with the Part number 7.7702.00124 and Serial number 00300239: Register

MSB LSB MSB LSB

40001 57 02 39 02

40002 48 00 30 00

Register

MSB LSB MSB LSB

40004 52 50 ' 4 ' ' 2 '

40005 49 48 ' 1 ' ' 0 '

40006 48 46 ' 0 ' ' . '

40007 50 48 '2' ' 0 '

40008 55 55 ' 7 ' ' 7 '

40009 46 55 ' . ' ' 7 '

40010 32 32 ' SP ' ' SP '

40011 32 32 ' SP ' ' SP '

40012 00 00

40013 00 00

40014 00 00

40015 00 00

40016 00 00

40017 00 00

40018 20 53 ' SP ' ' S '

40019 41 4D ' A' ' M '

[decimal] [packed BCD]

Se

ria

l

nu

mb

er

[decimal] [ASCII]

P

art

nu

mb

er

r.

f.u

.

Identifier



Register Parameter Valid values Access Factory

settings HEX

Configuration of the serial interface:

Baud rate 0=300; 1=600; 2=1200; 3=2400; 4=4800; 5=9600; 6=14400; 7=19200; 8=28800; 9=38400; 10=57600; 11=76800; 12=115200 kBit/s

r/w 07 43000

Parity check 0=None; 1=Odd; 2=Even r/w 00

Number of stop bits 0=1 Bit; 1=2 Bits r/w 00 43001

Data word width 0=5Bits; 1=6Bits; 2=7Bits; 3=8Bits r/w 03

Handshake 0=None r/w 00 43002

DTR/RTS Bit 0 = DTR; Bit 1 = RTS r/w 00

CD/CTS/RI/DSR Bit 0 = CD; Bit 1 = CTS; Bit2 = RI; Bit 3 = DSR r 02 43003

n.a. r/w 00

Modbus configuration: Baud rate 5=9600; 7=19200 kBit/s r/w 07 43100

Parity check 0=No; 1=Odd; 2=Even r/w 00

Data framing 0=RTU; 1=ASCII r/w 00 43101

Operation mode 0=Slave r/w 00

Address 1 to 247 r/w 08 43102

Mode 0=<10000; 1=J-Bus r/w 00

43103 Character timeout 0 to 65500 r/w E803

43104 Read timeout 500 to 65500 r/w B80B

43105 Write timeout 500 to 65500 r/w B80B

KLink configuration:

43200 Update time 0 to 65500 r/w E803

43201 Timeout 500 to 65500 r/w E803

00-FF (hex values) or ASCII-Character r/w 00h or ‘0’ 43202

00-FF (hex values) or ASCII-Character 00h or ‘0’




Password


Reset:

44000 Reboot hexadecimal: AAAA w




7.3. Smart_MOD KLink - Communication with SIGMA CONTROL or SIGMA AIR MANAGER

In order to be able to communicate with the SIGMA CONTROL or the SIGMA AIR MANAGER, first some steps have to be taken (see illustration on page 33, for this see also KLink protocol):

• Establish connection

• Synchronization

• Set password

• Call operational data

1. Establish connection

If the SIGMA CONTROL or the SIGMA AIR MANAGER is switched on operating voltage, it sends cyclic AT instructions to the serial interface. Herewith is tried to recognize a possibly existing modem and to set it into operation. The character sequences '+++', 'ATZ' and 'ATExxxxxx' are confirmed by an 'OK', sent from the Smart_MOD KLink. If the character sequence '+++' was confirmed with an 'OK', so permanently the character sequence 'RING' is sent to the SIGMA CONTROL or the SIGMA AIR MANAGER, in order to signal a call and to establish the connection. The character sequence 'ATA' is confirmed with 'CONNECT', in order to finish the connection establishment.

2. Synchronization

In order to be able to communicate with the SIGMA CONTROL or the SIGMA AIR MANAGER, first a 'SYNC' telegram has to be sent. If this is confirmed, so with the next step - the password setting - can be continued. If the telegram is not confirmed - the configured timeout has been running out or an error occurred - then a 'SYNC' telegram is sent again. If after the 5. attempt this (wait for '+++').

3. Set password

After a successful synchronization the password has to be sent to the SIGMA CONTROL or the SIGMA AIR MANAGER (by default “KAESER”). If the password is not confirmed - the configured timeout has been running out or an error occurred - so the synchronization is started again. If however the telegram is confirmed without any errors, then from the answer telegram the serial number, the part number and the reserved number are read out and stored into the particular for it intended Modbus registers. See chapter 7.7 for more information about the password.



4. Call operational data

After the synchronization and the password setting has been successfully finished, the data capture can now be started (read out of the operational data). For this a special telegram is sent to the SIGMA CONTROL or the SIGMA AIR MANAGER. If this telegram is not confirmed - the configured timeout has been running out or an error occurred - so the synchronization is started again. If however the telegram is confirmed without any errors, then from the answer telegram the operational data are read out and stored into the particular for it intended Modbus registers.

Note: If during the communication with the SIGMA CONTOL or the SIGMA AIR MANAGER any error occurred, then these errors are put in the Modbus register 42999 and can be read out by Modbus communication. With the first correctly received answer telegram the errors in the Modbus register will be set back.



7.4. Master - communication with Smart_MOD KLink

If the SIGMA CONTOL or the SIGMA AIR MANAGER has established a connection to Smart_MOD KLink, Smart_MOD receives the sent data and stores those in registers, which the Modbus master is able to access by reading (see illustration on page 33). In order to be able to read out the operational data of the SIGMA CONTOL or the SIGMA AIR MANAGER, a master system first has to set off a Modbus specific request telegram to the respective slave (Smart_MOD KLink), i.e. it takes place a read call for certain Modbus registers. The data buffer of the Smart_MOD KLink begins with register 40021 and ends with register 41044 (1024 words; 2 kByte data). With a single data call, up to 254 bytes can be selected. The operational data can be called up at any time by the Modbus master. In order to guarantee that the selected data are consistent, register 42999 must be evaluated, since here possible errors are put down.

Sm

art_

MO

D K

Lin

k U

se

r ma

nu

al

K

AE

SE

R K

OM

PR

ES

SO

RE

N

w

ww

.ka

ese

r.com

7_

69

33

_M

OD

_0

2E

.do

c

14

.11

.20

05

P

ag

e 3

3/3

4

Sc

he

ma

tic re

pre

se

nta

tion

of th

e c

om

mu

nic

atio

n v

ia M

od

bu

s a

nd

/or v

ia th

e K

Lin

k

pro

toc

ol o

n th

e R

S-2

32

inte

rfac

e

(De

vic

e =

SIG

MA

CO

NT

RO

L o

r SIG

MA

AIR

MA

NA

GE

R):

Modbus

Modbus slave

Smart_MOD KLinkModbus master

(e.g. PC or PLC)

serial (KLink protocol) Device

Device with serial

Interface (RS-232)

xx xx xx hexFEhex03hex08hex

DataNo. of byteFunctionAddress

Read out the registers 40021 to 40147

Send register contents

2. Step: Smart_MOD KLink

evaluates register 40021

1. Step: Master fetches data

at any time

xx xx……...

xx xx40021

ContentRegister

40147 xx xx

Po

lling

pro

ce

du

re

3. Step: Smart_MOD KLink takes

over the operational data, if no

error is present

2. Step: Synchronization with

terminal device (sigma unit)

1. Step: Smart_MOD KLink waits

until connection established

3. Step: Password transmission

to terminal device (sigma unit)

4. Step: Place Serial No. and

Part No. into the registers

5. Step: Read out the operational

data of the terminal device

6. Step: Place the operational

data into the registers

Attempts > 5

Timeout

no

yes

Timeout

Timeout

7Fhex40021dez03hex08hex

No. of registersFunctionAddress Start register

Modbus

Modbus slave


(e.g. PC or PLC)


Device with serial

Interface (RS-232)

ModbusModbus

Modbus slave


(e.g. PC or PLC)


Device with serial

Interface (RS-232)





Read out the registers 40021 to 40147

Send register contents

2. Step: Smart_MOD KLink

evaluates register 40021

1. Step: Master fetches data

at any time

xx xx……...

xx xx40021

ContentRegister

40147 xx xx

xx xx……...

xx xx40021

ContentRegister

40147 xx xx

Po

lling

pro

ce

du

re

3. Step: Smart_MOD KLink takes

over the operational data, if no

error is present

2. Step: Synchronization with

terminal device (sigma unit)

1. Step: Smart_MOD KLink waits

until connection established

3. Step: Password transmission

to terminal device (sigma unit)

4. Step: Place Serial No. and

Part No. into the registers

5. Step: Read out the operational

data of the terminal device

6. Step: Place the operational

data into the registers

Attempts > 5

Timeout

no

yes

Timeout

Timeout







7.5. SIGMA CONTROL operational data Via Smart_MOD KLink a Modbus master can read the SIGMA CONTROL Process data of 128 Bytes. There are differences in data depending on SIGMA CONTROL software version. For every software version a Process data list “7_7000_PAMOD_*” is available.

7.6. SIGMA AIR MANAGER operational data Via Smart_MOD KLink a Modbus master can read the SIGMA AIR MANAGER Process data of 256Bytes. There are differences in data depending on SIGMA AIR MANAGER software version. For every software version a Process data list “7_7725_PAMOD_*” is available.

7.7. KLink password The KLink password of SIGMA CONTROL is:

• SIGMA CONTROL software up to 0.70: 000000 or in hex mode “000000000000”.

• SIGMA CONTROL software 0.71 an higher: “serial number read backward” for example serial number 000313833 � password 338313

The KLink password of the SIGMA AIR MANGER is fixed to ‘KAESER’ . Note: If the password is not correct all operational data (register 40021 – 41044) are set to “00”. An software-update of the SIGMA CONTROL or the SIGMA AIR MANAGER does not change the password.

8. Support

KAESER KOMPRESSOREN GmbH P.O. Box 2143 D-96410 Coburg Germany Phone +49 9561 640 0 FAX +49 9561 640 130 Email [email protected] Internet www.kaeser.com

Support Hotline +49 171 8 63 70 00

kaeser comp

Documents

mod klink communication

user manual smart

kaeser klink protocol

manufacturer of smart

mod module

klink password

delivery content smart

sigma control operational