MODBUS OPTION USER GUIDE

Chiller Control

Document number ECG-UG-19-004

This document is the property of Manufacturer and is delivered on the express condition that it is not
to be disclosed, reproduced in whole or in part, or used for manufacture by anyone other than
Manufacturer without its written consent, and that no right is granted to disclose or so use any
information contained in said document.

Manufacturer reserves the right to change any product specifications without notice.
 IMPORTANT INFORMATION

PURPOSE This document aims to provide an overview on the MODBUS option implemented
on chiller controller.
Document Name Document ID Publication Date
MODBUS User Guide ECG-UG-19-004 July 2019

REFERENCES The following list includes all documents that may be the source of reference for
material discussed in this publication.
   IOM Control
 IOM Machine
 Service Guide

CONVENTIONS The following symbols are used to highlight important information in this
document.
CAUTION
This symbol is used to indicate potentially hazardous situations and
conditions.
IMPORTANT
This symbol is used to present information relevant to the topic.
INFORMATION
This symbol is used to provide some useful information.
 REVISIONS HISTORY

DATE
REV DESCRIPTION DONE BY
(yyy-mm-dd)
Original 2019-07-02  Original ER

A 2020-03-12  Remove mapping to make the document generic to all chillers ER

 ABBREVIATIONS

Abbreviation Description
DI Discrete Input
EXV Expansion Valve
FC Free Cooling
HR Holding Register
IEEE Institute of Electrical and Electronics Engineers
IP Internet Protocol
IR Input Register
Net Network
OAT Outside Air Temperature
RTU Remote Terminal Unit
SCT Saturated Condensing Temperature
SST Saturated Suction Temperature
TCP Transmission Control Protocol
xxLS ..Low Speed
xxHS ..High Speed
 CONTENTS

1 INTRODUCTION ............................................................................................................ 6
1.1 Purpose ............................................................................................................................... 6
1.2 Modbus ................................................................................................................................ 6
2 HOW TO TRANSFORM A NON-MODBUS CHILLER TO A MODBUS CHILLER ........ 7
2.1 Prerequisites ........................................................................................................................ 7
2.2 Software activation key ........................................................................................................ 7
2.3 List of available software options ......................................................................................... 8
3 MODBUS FOR CHILLER............................................................................................... 9
3.1 Modbus RTU........................................................................................................................ 9
3.1.1 Modbus Settings ............................................................................................................................ 9
3.2 Modbus TCP/IP.................................................................................................................. 11
3.2.1 Modbus Settings .......................................................................................................................... 11
3.2.2 ModbusMODBUSRS ................................................................................................................... 12
4 CONNECTION CHANNELS ..........................................................................................13
4.1 RS485 socket details (ModBus RTU) ................................................................................. 13
4.2 RJ45 socket details (ModBus TCP).................................................................................... 14
5 MODBUS FUNCTIONS .................................................................................................15
6 MAPPING INTERFACE ................................................................................................16
 ECG–UG–19-004 REVISION DATE PAGE
Modbus option A July 2019 6 OF 16

1 INTRODUCTION

1.1 Purpose
This guide describes the Modbus option for chillers. It is intended for Building Management System (BMS)
engineers.
All information already provided in the product IOM are not available in this document.

1.2 Modbus
Modbus is a data communication protocol for building automation and control networks. It is based on a
client-server model.
 ECG–UG–19-004 REVISION DATE PAGE
Modbus option A July 2019 7 OF 16

2 HOW TO TRANSFORM A NON-MODBUS CHILLER TO A

MODBUS CHILLER

2.1 Prerequisites
Modbus (option 149B) may be an option which requires a Software Activation Key to be activated. This
software-protected option can be factory-installed or installed on-site by a service technician. See section 2.3
to know if a software option key is required.

2.2 Software activation key

The Software Activation Key is an individual license key based on machine MAC address.

To obtain the Software Activation Key

1. Please contact your local Service representative.
2. Please beware that the controller eth0/J15 MAC address will be requested in order to provide the correct
Software Activation Key.
o A sticker is present on the back of the controller panel (top right location) with J15 MAC. The
address is coded using 12 digits: XX-XX-XX-XX-XX-XX
o You may check the MAC address via the controller user interface.
Go to the Configuration menu and select the Add Options menu (ADD_OPT).
The MAC address will be displayed.
 ECG–UG–19-004 REVISION DATE PAGE
Modbus option A July 2019 8 OF 16

2.3 List of available software options

The list of currently available software options can be verified via the controller user interface.

To verify available software options

1. Go to the Main menu.
2. Select the Software Options menu (OPT_STA).
o The menu can be accessed when logged in (at least user-access level required).
3. If the status of the specific option is set to “Yes”, it means that the Software Activation Key for this option
is installed.
4. Verify the status of the “OPT149B: Modbus” parameter.
o If the status of Modbus option is set to “No”, please go to section 2.2 Software activation key

The Software Options menu is read-only. Once the Software Activation Key is installed, the
status of the option that was installed will change to “yes”.
Depending on Chiller type more or less option may be available

In case the controller is replaced, the Software Activation Key must be installed
again.
Please contact your local Service representative for more information.
 ECG–UG–19-004 REVISION DATE PAGE
Modbus option A July 2019 9 OF 16

3 MODBUS FOR CHILLER

The Modbus communication option can be set for ModBus RTU or for ModbUs TCP/IP.
To modify Modbus parameters:
 the user must be logged in with a user access level.
 Modbus option must be activated

3.1 Modbus RTU

3.1.1 Modbus Settings

In order to enable/disable the Modbus RTU option

 Go to the Main menu.
 Navigate to the Configuration menu, and then the Network menu.
 Select the MODBUSRS menu for Modbus over RS485
 Set the "RTU Server Enable" parameter to "Yes".

Available ModBus parameters:

Table Name: PIC Table Type: Instance:
//MAINMENU/CONFIG/Network
MODBUSRS 13H depends on equipment
Point Name Displayed text* Status Default Unit
1 modrt_en RTU Server Enable No / Yes No -
2 ser_UID Server UID 1 to 247 1 -
3 metric Metric Unit No / Yes Yes -
4 swap_b Swap Bytes 0 to 1 0 -
5 0 = Big Endian -
6 1= Little Endian -
7 baudrate Baudrate 0 to 2 0 -
8 0 = 9600 -
9 1 = 19200 -
10 2 = 38400
11 parity Parity 0 to 4 0
12 0 = No Parity
13 1 = Odd Parity
14 2 = Even Parity
15 stop_bit Stop bit 0 to 1 1
16 0 = One Stop Bit
17 1 = two Stop Bits
18 real_typ Real type management 0 to 1 1
19 0 = Float X10
20 1 = IEEE 754
21 reg32bit Enable 32 bits registers 0 to 1 1
22 0 = IR/HR in 16 bit mode
23 1 = IR/HR in 32 bit mode
*Displayed text may differ depending on the language selected. See also section 0
Modbus.
 ECG–UG–19-004 REVISION DATE PAGE
Modbus option A July 2019 10 OF 16

Please note that changing parameters in the Modbus table will require/cause a
software reboot.

Use a Modbus device discovery tool, e.g. ModbusDoctor, to verify communication

with Modbus devices – Chiller must be discovered.

ModbusMODBUSRS
MODBUSMODBUSRS

After a power up, “RTU Server Enable” parameter MUST BE enabled (default configuration
is Disable) to start the Modbus RTU driver. This parameter is available in the Configuration
menu, inside Modbus RTU Config menu.
RTU Server
If the conditions is met then the Modbus stack is built and chiller objects are created from
Enable
the existing configuration file variables_mobus.txt.
An easy way to verify that the chiller became a Modbus device is to use a free and easy to
use software like “ModbusDoctor
The Modbus server UID value can be modified from 1 to 247. The default value is equal to
Server UID
1
Metric units and Imperial units are supported. By default, Modbus data will be in metric
Metric Unit
units. Default value = YES
The Swap Bytes value can be set to 0 for Big Endian or 1 for Little Endian. The default
Swap Bytes
value is equal to 0 for Big Endian.
The Modbus Baudrate can be set to:
 0 for 9600 bauds,
Baudrate  1 for 19200 bauds or
 2 for 38400 bauds.
The default value is 0 for 9600 bauds.
The Modbus parity can be set to:
 0 for No parity
 1 for Odd parity
Parity
 2 for Even parity.
When No parity is selected the configuration is set with 1 stop bits. The default value is 0 for
No parity.
One (set 0) or Two (set 1) stop bits can be selected. When no parity is selected, stop bit is
Stop bit
forced to 1 for Two stop bits. The default value is 1 for Two stop bits
Due to no native floating point representation for the Modbus communication protocol,
IEEE754 representation has been integrated. As the opposite, float handled as integer is
also available (i.e. float x 10) depending on setup.
Real type The Real Type Management can be set to:
management
 0 for Float X10 configuration or
 1 for IEEE 754 configuration.
The default value is 1 for IEEE 754 configuration
Inputs Registers and Holding Registers can be set over 16 bits or over 32 bits.
Set Enable 32 bits registers to:
Enable 32 bits
registers  0 for 16 bits mode
 1 for 32 bits mode
The default value is 1 for 32 bits mode

The Chiller Conrtroller MUST BE in "Network" mode to be controlled from Modbus.

Occupancy status from Modbus is ignored in "Local" mode.
 ECG–UG–19-004 REVISION DATE PAGE
Modbus option A July 2019 11 OF 16

3.2 Modbus TCP/IP

3.2.1 Modbus Settings
In order to enable/disable the Modbus TCP/IP option,
 Navigate to the Configuration menu and
 Select MODBUSIP menu
 For Modbus over TCP/IP Set the "TCP/IP Server Enable" parameter to "Yes".

Available ModBus TCP/IP parameters:

Table Name: PIC Table Type: Instance:

//MAINMENU/CONFIG/Network
MODBUSIP 13H depends on equipment
Point Name Displayed text* Status Default Unit
1 modip_en TCP/IP Server Enable No / Yes No -
2 ser_UID Server UID 1 to 247 1 -
3 port_nbr Port Number 0 to 65535 Yes -
4 metric Metric Unit No / Yes 0 -
5 swap_b Swap Bytes 0 to 1 -
6 0 = Big Endian -
7 1 = Little Endian 1 -
8 real_typ Real type management 0 to 1 -
9 0 = Float X10 -
10 1 = IEEE 754
11 reg32bit Enable 32 bits registers 0 to 1 1
12 0 = IR/HR in 16 bit mode
13 1 = IR/HR in 32 bit mode
14 conifnam IP port interface name 0 to 1 0
0=J5/J15
1=J16
15 timeout Com. timeout (s) 60 to 600 120 sec
16 idle Keepalive idle delay(s) 0 to 30 10 sec
17 intrvl Keepalive interval(s) 0 to 2 1 sec
18 probes Keepalive probes nb 0 to 10 10
*Displayed text may differ depending on the language selected. See also section 0
Modbus.

Please note that changing parameters in the Modbus table will require/cause a
software reboot.

Use a Modbus device discovery tool, e.g. ModbusDoctor, to verify communication

with Modbus devices – Chiller must be discovered.

Updating controller configuration, including Network IP address, mask address.

gateway address parameters MUST be followed by a user power cycle – in order to
makes these changes effective in Modbus stack.
 ECG–UG–19-004 REVISION DATE PAGE
Modbus option A July 2019 12 OF 16

3.2.2 ModbusMODBUSRS

MODBUSMODBUSRS

After a power up, “TCP/IP Server Enable” parameter MUST BE enabled (default configuration is
TCP/IP Server
Disable) to start the Modbus IP driver. This parameter is available in the Configuration menu,
Enable
inside Modbus IP Config menu.
If the conditions are met then the Modbus stack is built and chiller objects are created from the
existing configuration file variables_mobus.txt.
An easy way to verify that the chiller became a Modbus device is to use a free and easy to use
software like “ModbusDoctor”.
The Modbus server UID value can be modified from 1 to 247. The default value is equal to 1
Server UID

The Transfer Control Protocol port number for Modbus can be modified from 0 to 65535. The
Port Number
default value is equal to 502.
Metric units and Imperial units are supported. By default, Modbus data will be in metric units.
Metric Unit
Default value = YES
The Swap Bytes value can be set to 0 for Big Endian or 1 for Little Endian.
Swap Bytes
The default value is equal to 0 for Big Endian.
Due to no native floating point representation for the Modbus communication protocol, IEEE754
Real type
representation has been integrated. As the opposite, float handled as integer is also available
management
(i.e. float x 10) depending on setup.
The Real Type Management can be set to:
 0 for Float X10 configuration or
 1 for IEEE 754 configuration.
The default value is 1 for IEEE 754 configuration
Inputs Registers and Holding Registers can be set over 16 bits or over 32 bits.
Enable 32 bits
registers Set Enable 32 bits registers to:
 0 for 16 bits mode
 1 for 32 bits mode
The default value is 1 for 32 bits mode
IP port can be selected:.
IP port interface
name For 7 inches display, Ttwo interfaces are available, default value is 1 (J16). For J15, it shall be
set it to 0.
For 4.3 inches display, only one interface is available, default value is 0 (J5).
This is the number of seconds to wait to disconnect the TCP Connection when there is no
Com. timeout (s)
response from client.
It can be configured between 60 and 600 seconds
If user didn’t select the time within in the range, default value of 120 secs will enable to
disconnect the TCP connection in case of no communication from the client.
The number of seconds to keep idle the modbus connection before to start sending keep alive
Keepalive idle
packets can be configured using the idle value set between 0 and 30 seconds
delay(s)
If user wants to disable this feature, the points should be set to zero.
This value defined the intermediate seconds between each keep alive packet. It can be
Keepalive
configured between 0 and 2 seconds.
interval(s)
If user wants to disable this feature, the points should be set to zero.
This is the number of counts to check before disconnecting the connection if there is no
Keepalive
acknowledge packets from client. Value can bet set between 0 and 10.
probes nb
If user wants to disable this feature, the points should be set to zero

The Chiller Controller MUST BE in "Network" mode to be controlled from Modbus.

Occupancy status from Modbus is ignored in "Local" mode.
ModBus RS and ModBus TCP/IP cannot run in the same time.
 ECG–UG–19-004 REVISION DATE PAGE
Modbus option A July 2019 13 OF 16

4 CONNECTION CHANNELS
Here below sockets available for communication purposes with external devices.

Sockets available for communication on a 4.3inch interface

Sockets available for communication on a 7inch interface

4.1 RS485 socket details (ModBus RTU)

Port J10 is intended for Modbus RTU with RS485 (i.e. no control flow)

Transmission mode:
Used for Local area network communication type by external devices.
 With twisted shielded pair
 distance up to 1000m without amplifier
 Normally configurable at 9600, 19200 or 38400 baud in half duplex.
 Parity bit may be active or deactivated. If parity is disabled, additional stop bits are automatically
set for frame timing considerations. Otherwise, parity may be odd or even according to the
settings chosen.
Exclusively RTU mode operates with configurable combination (No ASCII mode permission)
1 start, 8 data, even parity, 1 stop bit
1 start, 8 data, odd parity, 1 stop bit
1 start, 8 data, 2 stop bit
1 start, 8 data, no parity , 1 stop bit (EXCLUDED)
 ECG–UG–19-004 REVISION DATE PAGE
Modbus option A July 2019 14 OF 16

 RTU protocol is compatible with both Little/ Big Endian for data field (i.e. either most significant
byte is sent first or Least significant byte is sent first)

 Unit identifier must be declared from 1 to 247 as slave product number setup (i.e. station number)

 Cyclic Redundancy Check is made by the RTU protocol layer as defined in Appendix A of
“Modbus over serial line” specification available at modbus.org

 Due to floating no native floating point representation for the Modbus communication protocol,
IEEE754 representation has been integrated. As the opposite, float handled as integer is also
available (i.e. float X 10) depending on setup.

4.2 RJ45 socket details (ModBus TCP)

RJ45 Ethernet port J5 (4.3”) or RJ45 ethernet port J15/J16 (7”) is/are intended to Modbus IP.
For a 7” display, the default port value is 1 (J16).
For a 4”3 display, the port value is 0 (J5)

Used for wide area network communication type by external devices (building management system tool or
maintenance tool and so on…)

 Cross pair wired cable shall be used for nominal configuration.

 distance up to 100m without amplifier
 Speed communication at 10 Mega baud not configurable
 IPv4 address configurable for class address with DHCP NOT active for
Class A (0.xxx.xxx.xxx to 127.xxx.xxx.xxx)
Class B (128.0.xxx.xxx to 191. 255.xxx.xxx)
Class C (192.0.0.xxx to 223.255.255.xxx)
(IP address declared on the control unit needed to set up connection with external device)
 All requests are sent via Transfer Control Protocol on registered port 502 by default but other port
number may be set as calibrate value.
 TCP/IP Modbus protocol is compatible with both Little/ Big Endian for data field (i.e. either most
significant byte is sent first or Least significant byte is sent first)
 Unit identifier must be declared from 1 to 247 as slave product number setup (i.e. station number)
 ECG–UG–19-004 REVISION DATE PAGE
Modbus option A July 2019 15 OF 16

5 MODBUS FUNCTIONS
The following standard functions are supported:

Address
Code Modbus function Application
register range
01 with quantity 1 READ COIL STATUS None
READ MULTIPLE COIL STATUS (from 1 to
01 with quantity N None
2000max. contiguous) 0 to 9999
15 with quantity 1 WRITE COIL (decimal) None
WRITE MULTIPLE COILS (from 1 to
15 with quantity N None
2000max. contiguous)
02 with quantity 1 READ DISCRETE INPUT
0 to 9999
READ MULTIPLE DISCRETE INPUTS Alarms
02 with quantity N (decimal)
(from 1 to 2000max. contiguous)
Useful user
04 with quantity 2 READ INPUT REGISTER
0 to 9999 parameters
04 with quantity READ MULTIPLE INPUT REGISTERS (decimal) Useful user
NX2 (from 1 to 123 max. contiguous) parameters
Configuration or
03 with quantity 2 READ HOLDING REGISTER
service dataset
03 with quantity READ MULTIPLE HOLDING REGISTERS Configuration or
NX2 (from 1 to 123 max. contiguous) 0 to 9999 service dataset
(decimal) Configuration or
16 with quantity 2 WRITE HOLDING REGISTER
service dataset
16 with quantity WRITE MULTIPLE HOLDING REGISTERS Configuration or
NX2 (from 1 to 123 max. contiguous) service dataset
 ECG–UG–19-004 REVISION DATE PAGE
Modbus option A July 2019 16 OF 16

6 MAPPING INTERFACE
The point list description is available on demand in an Excel format type.