Professional Documents
Culture Documents
Mk5 Gateway Modbus User Guide en 294620700
Mk5 Gateway Modbus User Guide en 294620700
User guide
1. General Information
Persons Required : 1
Special Tools :-
Consumables :-
2. Document Overview
This document covers the following subjects:
1. General Information ............................................. .................................................... .................................................... .1
two. Document Overview................................................ .................................................... .................................................... .1
3. Safety first ................................................ .................................................... .................................................... ................3
4. Copyright Notice................................................. .................................................... .................................................... .......4
5. Document Information and History................................................ .................................................... ...............................4
6. Safety Precautions................................................ .................................................... .................................................... ...5
Safety icons ................................................ .................................................... .................................................... .........5
Safety precautions during installation .............................................. .................................................... ....................5
Safety precautions during operation .............................................. .................................................... ..........................6
Safety precautions during maintenance or repair ........................................ .................................................... ......7
7. Preface.................................................. .................................................... .................................................... ....................8
8. Physical Set-up .............................................. .................................................... .................................................... ..........8
Modbus in the network................................................. .................................................... .............................................8
06/08/2017
PM 2946 2070 00 Page 1 of 27
Machine Translated by Google
12.1.1 Fix Speed compressor equipped with Mk5 unit controller....................................... ..............................................24
12.1.2 Variable Speed Drive (VSD) compressor equipped with Mk5 unit controller................................................ ....................24
12.1.3 Fix Speed compressor equipped with MkIV unit controller....................................... ........................................24
12.1.4 Variable Speed Drive (VSD) compressor equipped with MkIV unit controller................................................ .................25
12.1.5 ZH Turbo compressors................................................. .................................................... ........................................25
12.1.6 ZB Turbo compressors................................................. .................................................... ........................................25
12.1.7 High Pressure compressors/boosters from Crépelle - both fix speed and VSD ................................... ..............26
12.1.8 Dryers.............................................. .................................................... .................................................... ..............26
12.1.9 Vacuum Pumps .............................................. .................................................... .................................................... 26
12.1.10 Gas generators ............................................ .................................................... ...............................................26
12.1.11 Energy Recovery Kit ............................................... .................................................... ....................................26
Central Controllers................................................. .................................................... ...............................................26
12.2.1 ESi and ES6 equipped with Mk5 unit controller....................................... .................................................... ........26
12.2.2 ESi and ES6 of the MkIV generation....................................... .................................................... .....................27
12.2.3 Central Controllers: Old types ES8 and ES130....................................... .................................................... ........27 12.2.4
Central Controllers: New types ES16 and ES360 .............................. .................................................... .............27
06/08/2017
PM 2946 2070 00 Page 2 of 27
Machine Translated by Google
3. Safety first
06/08/2017
PM 2946 2070 00 Page 3 of 27
Machine Translated by Google
4. Copyright Notice
Any unauthorized use or copying of the contents or any part thereof is prohibited.
This applies in particular to trademarks, model denominations, part numbers and drawings.
06/08/2017
PM 2946 2070 00 Page 4 of 27
Machine Translated by Google
6. Safety Precautions
Safety icons
Warning
Important note
All responsibility for any damage or injury resulting from neglecting these precautions, or non-observance of
the normal caution and care required for installation, operation, maintenance and repair, even if not
expressly stated, will be disclaimed by the manufacturer.
General precautions
The operator must employ safe working practices and observe all related work safety requirements and regulations.
If any of the following statements does not comply with the applicable legislation, the stricter of the two shall apply.
Installation, operation, maintenance and repair work must only be performed by authorized, trained, specialized personnel.
Before carrying out any maintenance, repair work, adjustment or any other non-routine checks, stop the device. In addition,
the power isolating switch must be opened and locked.
Also consult following safety precautions: Safety precautions during operation and Safety
precautions during maintenance or repair.
These precautions apply to electrical devices.
For precautions applying to the connected equipment consult the relevant instruction book.
Some precautions are general and cover several machine types and equipment; hence it disappears
statements may not apply to your device.
06/08/2017
PM 2946 2070 00 Page 5 of 27
Machine Translated by Google
06/08/2017
PM 2946 2070 00 Page 6 of 27
Machine Translated by Google
Also consult following safety precautions: Safety precautions during installation and Safety
precautions during operation.
These precautions apply to electrical devices.
For precautions applying to the connected equipment consult the relevant instruction book.
Some precautions are general and cover several machine types and equipment; hence it disappears
statements may not apply to your device.
Units and/or used parts should be disposed of in an environmentally friendly and safe manner and in
line with the local recommendations and legislation.
06/08/2017
PM 2946 2070 00 Page 7 of 27
Machine Translated by Google
7. Preface
This document describes how to implement a Modbus connection to the Elektronikon MkIV and/or Elektronikon Mk5
compressor controller network.
The 0x notation is used in this document for hexadecimal values: eg 0x12 corresponds with decimal value 18.
8. Physical Set-up
This will behave as a Modbus proxy that allows access to all compressors in the network, whereby each compressor has its
own Modbus address (proxy concept).
The module will as well behave as a bridge to access the data stored in the CAN node's Object Dictionary. In order to work
correctly, this bridge module has to be assigned a slave node ID. From the master's point of view, this bridge acts as a way to
access information from the CANBUS network.
CAN
Modbus:
CAN 1 > Node 5
CAN 2 > Node 6
CAN 3 > Node 15
Master
gateway module
For the Modbus connection a so-called “Mk5 Gateway” is used. This is a general purpose serial communication module. By
downloading the correct software, it will perform the proxy and/or bridge function.
The following connections are used:
6x36 24Vac power supply
6x20 Atlas Copco compressor network (CAN)
6x25 ethernet connection to PC for downloading/commissioning the application
6x22 RS485 Modbus line
6x37 Profibus line
6x38 connection is not used by this application.
06/08/2017
PM 2946 2070 00 Page 8 of 27
Machine Translated by Google
Modbus pin-layout
For the Modbus connection, the Gateway module supports RS485A, with the following pin-layout as specified.
Pin Function
1 GND
two Reserved
3 TxD / RxD+
4 Reserved
5 Reserved
6 Reserved
7 Reserved
8 TxD / RxD-
9 Reserved
06/08/2017
PM 2946 2070 00 Page 9 of 27
Machine Translated by Google
Each folder has one or more subfolders which can be accessed using the Enter key on the keyboard. Exiting a folder can be
performed using the Cancel key. Browsing through the different folders is done by pressing the Left and Right button.
Once a setting is reached in a specific folder, the current settings value will be displayed. By pressing Cancel the current
menu will be exited. Pressing Enter however will allow the user to alter the settings (the value will start blinking) by clicking
the Up or Down button. At this point the user will be able to undo the current settings change by clicking Cancel. In this
case the current settings value will be shown again. However, by clicking Enter the settings value will be stored and the
module will behave accordingly.
icon Description
It also offers the possibility to set/change the Ethernet settings. Be aware that this is protected by security codes.
06/08/2017
PM 2946 2070 00 Page 10 of 27
Machine Translated by Google
Modbus Engine
The Modbus Engine can be started/stopped here.
NOTE: In case the Modbus Engine is active, the settings for Modbus Baud rate, Modbus Parity and Modbus Stop bits are not accessible.
Modbus Baud rate
Below table lists the possible Modbus baud rate, indicated as follows:
0 9600 bps
1 19200 bps
two
38400 bps
3 57600 bps
4 115200 bps
5 230400 bps
6 460800 bps
Modbus Parity
Below table lists the possible Modbus parities, indicated as follows:
0 None
1 Even
two Odd
Profibus Engine
The Profibus Engine can be started/stopped here.
NOTE: This manual is about Modbus, so the Profibus engine should be stopped (although technically both engines can be active at the
same time without influencing the functionality and timing). Details about how to setup the Profibus can be found in another user manual.
06/08/2017
PM 2946 2070 00 Page 11 of 27
Machine Translated by Google
Ethernet Engine
The Ethernet Engine can be started/stopped here.
NOTE: the Ethernet port can only be used by PC tools from Atlas Copco, the customer cannot use this connection
Ethernet IP Address
Ethernet Gateway
CAN Engine
The CAN Engine can be started/stopped here.
NOTE: the setup of the CAN channel must be done by Atlas Copco Technician. In case the CAN Engine is active, the setting for CAN
Channel is not accessible.
CAN Channel
1 Primary
two
Secondary
06/08/2017
PM 2946 2070 00 Page 12 of 27
Machine Translated by Google
Every functional data block can be set to low of high priority; disabling functional blocks will not significantly speed up the
CAN update cycle while only present blocks will be scanned (according to the initial creation of the internal structure). Be
aware that only a few blocks can be set to high priority, else the high priority will become slower than normal priority due to
the way of implementation. By default the optimal setting for most cases is implemented.
0 Off
1 Normal
two
High
Program Number
The Program Number folder shows the program number that is associated with the current application.
Program Revision
The Program Revision folder shows the program revision number that is associated with the current application.
Operating System
The Operating System folder shows the operating system number that is associated with the current application.
BootSoftware
The Boot Software folder shows the boot software number that is associated with the current application.
06/08/2017
PM 2946 2070 00 Page 13 of 27
Machine Translated by Google
icon Description
06/08/2017
PM 2946 2070 00 Page 14 of 27
Machine Translated by Google
Icons
icon Description
LEDs
LED Description
NOTE: No other LEDs are used during the operation of the application.
Keyboard
Key Description
Up
Edit settings parameters
Down
Left
Browse through the different menus
Right
ÿ
Start is NOT used in this application
06/08/2017
PM 2946 2070 00 Page 15 of 27
Machine Translated by Google
06/08/2017
PM 2946 2070 00 Page 16 of 27
Machine Translated by Google
Frame synchronization in the RTU mode is done by simulating a synchronous message. The slave device monitors the
elapsed time between receipts of characters. If three character time (referred to as Tx) elapsed without a new character,
then the device assumes that the message is completed and the next byte will be the address.
The message frame format is as follows:
T1 T2 T3 Address Message Body CRC T1 T2 T3
06/08/2017
PM 2946 2070 00 Page 17 of 27
Machine Translated by Google
Example of Illegal Data Address: if the slave device is asked for a parameter which it cannot provide, the slave device
responds with the error code Illegal Data Address. As an example we read the speed from a fixed speed compressor.
Request (function ID 03) of one data record - register 0x0320 (decimal 800 corresponds with register 801 in Modicon
notation) from Modbus slave 05, crc represents the check sum.
Indicated values are hexadecimal: the feedback does not contain an answer and the function ID is replaced by error code 80
and exception code 03
Request 0x 05 03 03 20 00 01 crc
Answer 0x 05 83 03 02 crc
Request (function ID 01) of 10 response coils starting from coil 00 00 from Modbus slave 05. The mirrors the Modbus slave 05
and function ID 01 (check here for error codes) and adds the number of bytes 02 that are returned and the actual bytes
containing the coil data: 00 02
Below you can find another example:
06/08/2017
PM 2946 2070 00 Page 18 of 27
Machine Translated by Google
Request 0x 05 03 03 E8 00 02
Answer 0x 05 03 04 00 01 EB 23
Request (function ID 03) of 02 registers starting from register 1001 (Modicon notation 41001 – always detract 1 and convert to hexadecimal in the actual
protocol, 1000 = 0x03E8) 03 E8 from Modbus slave 05. The response mirrors the Modbus slave
05 and function ID 03 (check here for error codes) and adds the number of bytes 04 that are returned and the actual content of the requested registers: 00
01 EB 23 (first 2 bytes for first register)
• For analog inputs: 2 byte values are in technical units (indicated in column 'Unit') in 'Signed Integer' format
• For analog and digital inputs next to the register containing the actual value also a register is available that indicates some status bits
(marked in blue in the address mappings – see next chapter).
• When a sensor is in error, the value 32767 (Hexadecimal 7FFF) is returned and also the error bit is set in the
corresponding status register
• Counter values are found in two registers: eg 301 (answer is B4 and B3) & 302 (answer is B2 and B1): total value is a Double WORD B4 B3 B2 B1
eg hexadecimal 00 2C 93 45 = 2921285 seconds
• For counter values 2 registers are used eg example given above registers 1001 and 1002 contain 00 01 EB 23;
convert 0x0001EB23 to decimal = 125731 seconds divided by 3600 ÿ 34 hours
1001 B4 B3
1002 B2 B1
• To calculate the % of speed ranges for VSD compressors: the register contains values in seconds, these must be compared with the total
running hours (RH) counter. The following formula converts seconds value into % (as shown on the display of the controller): value [s]
*
100/HR[s]
Example:
Running hours [s] 65 [s]
01– 20 [%] 41 [s]
*
21 – 40 [%] 13 [s] 13 100 / 65 = 20%
*
41 – 60 [%] 03 [s] 3 100 / 65 = 4.61 ÿ 5%
*
61 – 80 [%] 01 [s] 100 / 65 = 1.53 ÿ 2 %
*
81 – 100 [%] 07 [s] 1 7 100 / 65 = 10.76 ÿ 11 %
Total = 38%
Calculate 01 – 20 [%] 100 – 38 = 62%
• To interpret counters of type RTC = number of seconds passed since 1 January 1970 (Epoch Time)
Example: 54E3 29B5 Hex = 1424173493 decimal => 45 years + 58 days + 11 hours + 44 minutes + 53 seconds ÿ
17 February 2015 11:53
Tip: you can use the epoch converter from internet: www.epochconverter.com/
• The interpretation of 1 register for an SPM reading: 2 bytes must be interpreted as 2 separate bytes
06/08/2017
PM 2946 2070 00 Page 19 of 27
Machine Translated by Google
seen on the Mk5 display. So the valid measurement can be an old value. The Mk5 unit controller only measures
SPM when the machine is running loaded.
Bit 8 'valid measurement' = 0 when no valid measurement has been taken (from power on until running stable
speed in loaded condition without a sensor error)
Bit 8 'valid measurement' = 1 when a valid measurement is saved in memory. You should check the time stamp to
see how old this measurement is. It can be that the machine is stopped / unloaded, or even has a sensor error, but
still the protocol provides the last valid measurement that was saved. (Time stamp can be seen on the display of
the controller).
Below you can find an example for function 03 and how to interpret the data
06/08/2017
PM 2946 2070 00 Page 20 of 27
Machine Translated by Google
Write request (function ID 06) of the value 00 02 into register 861 (Modicon notation 40861 – always detract 1 and convert to
hexadecimal in the actual protocol, 860 = 0x035C) 03 5C for Modbus slave 05. The response just mirrors the write request :
Modbus slave 05, function ID 06 (check here for error codes) register 03 5C and value 00 02. This example changes the
active Pressure Band to Pressure Band #2 for a fixed speed compressor.
Another example:
When using the write commands, it is important to understand the external control functionality supported by the different
types of controllers (hardware and software). Consult the chapter 'Functional explanations on external control'
06/08/2017
PM 2946 2070 00 Page 21 of 27
Machine Translated by Google
Trouble Shooting
11.6.1 Introduction
Some easy tips to check the functionality of the Mk5 Gateway:
About the CAN communication: check the icon on the display in section CP
• Select the CAN node (CPxx) and check if 'running loaded'-icon is steady shown
• If this is not, check the commissioning parameters, the CAN cabling and the CAN settings of the connected unit
controller.
• If icon is OK you can press enter and press arrow right until you see info; press enter and down arrows and check the
update cycle of the data and response time on last Modbus request on this CAN channel.
About the Modbus communication, if no valid responses are received:
06/08/2017
PM 2946 2070 00 Page 22 of 27
Machine Translated by Google
11.6.2 PC Tools
It is not always clear to customers or external consultants how to read/write using our Modbus protocol as supported by the Mk5
Gateway based on this manual. Therefore a PC running some test program can be used to demonstrate the proper
functioning of the Mk5 Gateway according to its specification.
Required Hardware: While a PC does not have a RS485 port, we need a USB to RS485 conversion; this can be easily found on
the market. Atlas Copco advises the converters from Easy Sync. It can even be ordered from Atlas Copco (part number 3001
5022 00), this includes the required correct cables to connect the interface to connection 6x22 of the Gateway.
11.6.2.1 ModScan
This is freeware software from Win-Tech. Versions are available for all types of Windows Operating Systems. More info can be
found on the internet.
http://www.win-tech.com/html/modscan32.htm
After installing the drivers for the USB2RS485 interface (to be downloaded from internet)
http://www.easysync-ltd.com/product/542/es-u-3001-m-.html
It is important to check on your PC - Control Panel – Device Manager – Ports and verify the virtual COM port assigned to the
USB2RS485 interface.
Make a connection with correct baud rate/parity/stop bits and see the response on Coil and Holding registers.
06/08/2017
PM 2946 2070 00 Page 23 of 27
Machine Translated by Google
Machines
Stand-alone machines connected by a CAN network to an Mk5 Gateway can be controlled by using the Modbus protocol if
certain conditions are met. The possibilities are based on the type of unit controller installed on the machine and also the
type of machine. This chapter gives some explanations.
12.1.2 Variable Speed Drive (VSD) compressor equipped with Mk5 unit controller
• Only the speed of the main motor can be read, so it is not possible to read the speed of FAN or Dryer motor.
• Two speed values can be read for the main engine: the actual running speed and the speed that is requested from
the unit controller towards the converter.
• It is not possible to overwrite the local Pressure Set Point level. In normal mode it is not possible to steer the speed
externally by Modbus commands. For full external control we advise to install an ES system from Atlas Copco.
Contact Atlas Copco for more details.
• It is however possible to switch from the Active Set Point (Set Point #01 or Set Point #02) that is used by the local
regulation algorithm by remote commands. This is possible both in local and LAN control mode.
• The controller will only accept other remote commands when in LAN control mode. This mode must be activated
using the display/keyboard of the controller.
• In LAN a control mode the controller still uses its local Set Point level versus the outlet pressure to control the
speed (PID loop) in automatic control mode.
After a START command the controller goes to Automatic control mode
After a STOP command the controller reverts to Manual Stopped mode
Only for VSD having a stable 'unload status' the UNLOAD command will steer the machine to manual Unload
running mode.
• LAN b control mode is not supported by the VSD.
06/08/2017
PM 2946 2070 00 Page 24 of 27
Machine Translated by Google
• In LAN a control mode the controller uses its local pressure (Un) Load levels compared to the measured
compressor outlet pressure to start/stop and load/unload the machine.
After a START or LOAD command the controller goes to Automatic control mode
After a STOP command the controller reverts to Manual Stopped mode
After an UNLOAD command the controller goes to Manual Unload mode
• In LAN b control mode the controller will Start, Stop and (Un) Load based on external commands only (all
machine safety functions will still be active). So the compressor will not (Un) Load when the compressor outlet
pressure passes the pressure band levels.
• When the controller switches from 4b to 4a control mode (after a command or after elapsed the CAN
communication timeout), the controller will regulate automatically again, so based on the outlet pressure and the
local pressure band settings, so the machine can Start, Stop, Load or Unload.
12.1.4 Variable Speed Drive (VSD) compressor equipped with MkIV unit controller
• Only the speed of the main motor can be read, so it is not possible to read the speed of FAN or Dryer motor.
• Two speed values can be read for the main engine: the actual running speed and the speed that is requested from
the unit controller towards the converter.
• It is possible to overwrite the local pressure Set Point. This can be done in the different control modes: Local,
Remote and LAN control mode.
o So next to switching from the Active Set Point (Set Point #01 or Set Point #02) that is used in local control
mode, it is also possible to change the Set Point pressure levels.
• The controller will only accept other remote commands when in LAN control mode. This mode must be activated
using the display/keyboard of the controller.
• In LAN a control mode the controller still uses its local Set Point level versus the outlet pressure to control the
speed (PID loop) in automatic control mode.
After a START command the controller goes to Automatic control mode
After a STOP command the controller reverts to Manual Stopped mode
Only for VSD having a stable 'unload status' the UNLOAD command will steer the machine to manual Unload
running mode.
• LAN b control mode is not supported by the VSD.
06/08/2017
PM 2946 2070 00 Page 25 of 27
Machine Translated by Google
12.1.7 High Pressure compressors/boosters from Crépelle - both fix speed and VSD
• While this machines deliver high pressurized air, higher than 32 bar (32000 mbar), another type of Pressure unit is
introduced to be able to keep all algorithms working with two byte values. The technical unit for some pressure will
be [cbar] is steady of [mbar], so values can vary from -1 bar to 320 bar; 32767 centibar is the maximal signed integer
value in Hexadecimal format 7FFF)
• These machines can be equipped with controllers of the Mk5 or MkIV generation and also exist in both Fixed Speed
and Variable Speed versions. The external control possibilities are exactly the same as for the standard Fix speed
and VSD. Off course be aware of the difference used technical unit for high pressure values.
• About the fix speed Piston Compressors some types have parallel pistons and can be used for delivering half the
flow, this is called the 50 % regulation. So in this case next to the external Unload and Load command also the 50
% Load command exists.
12.1.8 Dryers
• A lot of different types of dryers exist, so the list of measurements, counters, digital outputs and special protections can
vary a lot. Always consult the detailed address mapping generated by the Atlas Copco Technician.
• The external control possibilities are very limited. Only a Start and Stop command is available:
o Start ÿ the unit controller will regulate automatically
o Stop ÿ the unit controller will no longer regulate, the machine is in complete stopped condition
Central Controllers
Atlas Copco has a wide range of Central controllers. These controllers take over the full control of all integrated machines.
These controllers are also connected to the CAN network, in that way the Mk5 Gateway can also provide some data and
even external control via Modbus.
• The controller will only accept remote commands when in LAN control mode. This mode must be activated using
the display/keyboard of the controller.
• It is possible to select the Active ES regulation band #01 or #02, this can be changed by an external Modbus
command; this command can be given in local or LAN control mode.
• It is not possible to overwrite the local ES Pressure Band (Un) Load levels. Contact Atlas Copco for more details.
• In LAN a control mode the controller still uses its local ES pressure (Un) Load levels to steer the connected 'slave'
machines.
After an ES START CONTROLLING command the ES will switch to Central Automatic Regulating control mode.
06/08/2017
PM 2946 2070 00 Page 26 of 27
Machine Translated by Google
After an ES CENTRAL STOP command the ES will stop all connected machines in a controlled way resulting in a de-pressurized air net. This
function can be disabled by a setting in the ES Controller.
After an ES TO LOCAL CONTROL command the controller will switch to ES Local control mode resulting in switching
all connected machines in local control in a controlled way.
In the analog and calculated data, also measurement points which are 'aggregated' can be listed. While there is no time period reference these values
cannot be used (the values are only supported for upload towards SMARTLINK). In the near future a new release (2.0) will support these values properly.
The Atlas Copco Technician will be able to define the time frame for the accumulated calculated data. By default it will be every 60 seconds, so it is up to the
customer to read the value every minute and do its own accumulation.
• The ES will only control the integrated machines, isolated machine can be manually stopped (eg for maintenance) or run 'locally' automatic – based
on their own settings
• Writing the value 1 (isolate) or value 2 (integrate) in the register matching with the CAN Node of the connected
machine will change its integration status.
• It is not possible to read the integration status of the connected machines from the ES
• The integration status of connected machines can be read from the individual machines (use other Modbus slave
addresses)
o Read register 702 / low byte; values 0, 1 or 2 indicate “isolated” and values 18, 34 or 50 “integrated”
o Before actually changing the levels, all individual levels can be overwritten and afterwards if all conditions are met (high alarm level >
high warning level > Unload level > Set Point level > Load level > low warning level > low alarm level) the command < apply
changes> can be sent
o It is recommended to read the SPS levels after changing them to verify if the operation was successful.
06/08/2017
PM 2946 2070 00 Page 27 of 27