CoolAutomation CoolMasterNet Quick setup guide

© 2017 CoolAutomation LTD.
Modbus Integration Guidelines
Document Revision 0.5 10/17/2017
www.coolautomation.com
CoolMasterNet
CooLinkNet
CooLinkHub
Modbus Integration
Guidelines

2
Contents
Modbus Integration Guidelines
www.coolautomation.com © 2017 CoolAutomation LTD.
Table of Contents
1 Connection 4
........................................................................................................................................................................ 4
1.1 Modbus RTUConnection
........................................................................................................................................................................ 5
1.2 Modbus IP Connection
2 Configuration 6
........................................................................................................................................................................ 6
2.1 Modbus RTUConfiguration
.......................................................................................................................................................... 6Modbus Slave Address
.......................................................................................................................................................... 7Modbus RTU Frame Format
........................................................................................................................................................................ 7
2.2 Modbus IP Configuration
........................................................................................................................................................................ 7
2.3 VA's Configuration
3Modbus Tables 10
........................................................................................................................................................................ 10
3.1 CoolMasterNet Modbus Tables
.......................................................................................................................................................... 12Special Devices
........................................................................................................................................................................ 12
3.2 CooLinkNet Modbus Tables
........................................................................................................................................................................ 13
3.3 HVAC Malfunction Codes
4PRO Functionality 18
........................................................................................................................................................................ 18
4.1 PRO Modbus Tables.......................................................................................................................................................... 18DK ......................................................................................................................................................... 18DK PRO Indoor Units
......................................................................................................................................................... 18DK PRO Outdoor Systems
......................................................................................................................................................... 20DK PRO Outdoor Units
.......................................................................................................................................................... 27ME ......................................................................................................................................................... 28MEPRO Indoor Units
......................................................................................................................................................... 28MEPRO Outdoor Units
5Commands Reference 39
........................................................................................................................................................................ 39
5.1 line
........................................................................................................................................................................ 39
5.2 modbus
........................................................................................................................................................................ 40
5.3 va
6Legacy CoolGate Mode 41
........................................................................................................................................................................ 41
6.1 DK .......................................................................................................................................................... 41DK PRO via Airnet address
.......................................................................................................................................................... 42DK PRO Outdoor Systems
.......................................................................................................................................................... 42DK PRO Outdoor Units

3
Contents
Modbus Integration Guidelines
www.coolautomation.com © 2017 CoolAutomation LTD.

Connection
Modbus Integration Guidelines Rev 0.5 4
www.coolautomation.com © 2017 CoolAutomation LTD.
1 Connection
CoolAutomation devices support Modbus RTU and Modbus IP protocols with accordance to the Modbus
Organization specifications listed below:
· MODBUS Application Protocol Specification
· MODBUS over Serial Line Specification and Implementation Guide
· MODBUS Messaging on TCP/IP Implementation Guide
Modbus RTU is supported by CoolMasterNet, CooLinkNet and CooLinkHub, Modbus IP is supported by
CoolMasterNet and CooLinkHub.
1.1 Modbus RTU Connection
In Modbus RTU mode physical connection of the CoolAutomation devices is done over “Two-Wire” electrical
interface in accordance with EIA/TIA-485 standard. Connection is made via 485-A and 485-B terminals. Ground
wire connection is not mandatory but highly recommended.
CoolMasterNet Modbus RTU Connection
In CoolMasterNet Line L3 is recommended for Modbus RTU connection, although Lines L4, L5, L6 and L7 can also
be used for that purpose. Picture above shows connection to Line L3.

Connection
Modbus Integration Guidelines Rev 0.5 5
www.coolautomation.com © 2017 CoolAutomation LTD.
CooLinkNet/CooLinkHub Modbus RTU Connection
In CooLinkNet/CooLinkHub only Line L3 can be used for Modbus RTU connection.
1.2 Modbus IP Connection
Modbus IP is supported in CoolMasterNet and CooLinkHub devices. Device acts as a Modbus Server,
communicating on the Ethernet TCP/IP network. Physical connection in this case is made via RJ45 Ethernet
connector.

Configuration
Modbus Integration Guidelines Rev 0.5 6
www.coolautomation.com © 2017 CoolAutomation LTD.
2 Configuration
CoolAutomation device must be properly configured to support Modbus functionality. Configuration is made via
CoolAutomation's proprietary ASCII_IF interface described in details in Programmer Reference Manual (PRM)
document for the corresponding device.
It is allowed to have a number of simultaneous Modbus RTU and Modbus IP connections to the same device.
2.1 Modbus RTU Configuration
Modbus RTU interface module of the CoolAutomation device has to be activated by assigning appropriate
communication Line. In CoolMasterNet it is highly recommended to use Line L3, although it is possible to use any
of the L4, L5, L6, L7 lines. In CooLinkNet and CooLinkHub Line L3 usage for Modbus RTU is mandatory.
CoolMasterNet Modbus RTU activation:
CooLinkNet/CooLinkHub Modbus RTU activation:
>line type L3 CG5
OK, Boot Required!
>line type L3 CLMB
OK, Boot Required!
To check if Modbus RTU module is already activated and read it 's parameters, including Slave Address, line
command should be used:
CoolMasterNet:
CooLinkNet/CooLinkHub:
>line
L1: DK Master U00/G00 myid:0B
Tx:2/2 Rx:2/2 TO:0/0 CS:0/0 Col:0/0 NAK:0/0
L2: Unused
Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 NAK:0/0
L3: CG5 Modbus Address:0x50(80) 9600_8N1
Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 NAK:0/0
L4: Unused
Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 NAK:0/0
L5: Unused
Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 NAK:0/0
L6: Unused
Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 NAK:0/0
L7: Unused
Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 NAK:0/0
L8: Unused
Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 NAK:0/0
OK
>line
L1: Unused
Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 NAK:0/0
L2: Unused
Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 NAK:0/0
L3: CLMB Address:0x50(80) 9600_8N1
Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 NAK:0/0
L4: M1M2 Slave U00/G00 Not Connected
Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 NAK:0/0
L5: Unused
Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 NAK:0/0
OK
Next: For CoolMasterNet and CooLinkHub VA's have to be configured to use Modbus RTU module. See: VA's
Configuration.
2.1.1 Modbus Slave Address
Modbus Slave Address can be queried with line command or changed with line myid command. In the example
below the new Slave Address will become 0x51 (81 decimal) after power reset:
>line myid L3 51
OK, Boot Required!
The default (factory set) Modbus Slave Address for CoolAutomation devices is 0x50 hexadecimal (80 decimal).

Configuration
Modbus Integration Guidelines Rev 0.5 7
www.coolautomation.com © 2017 CoolAutomation LTD.
2.1.2 Modbus RTU Frame Format
The default Modbus RTU frame format in CoolAutomation devices is 9600_8N1:
Baud Rate
9600 bps
Data Bits
8
Parity
None
Stop Bits
1
Frame format parameters are configurable with line baud command:
>line baud L3 19200_8N2
OK, Boot Required!
New frame format will be 19200 bps, 8 data bits, no parity, 2 stop bits.
2.2 Modbus IP Configuration
Modbus IP is supported in CoolMasterNet and CooLinkHub devices. CooLinkNet has no Modbus IP support.
Modbus IP module is activated with below command:
>modbus IP enable
OK, Boot Required!
Modbus IP server is started by device only after it establishes an Ethernet link and gets proper IP address
(dynamic via DHCP or static). Ethernet and IP management is done with ifconfig command that is out of the spec
of this document.
To query Modbus IP status use modbus command without parameters:
>modbus
ModBus IP : enabled
server port : 502
CG4/5 ignore : none
OK
The default TCP/IP port number used by Modbus IP Server is 502. This is "well-known" Ethernet port assigned for
the Modbus TCP/IP protocol. If required port number can be changed (new port number will be 503):
>modbus server port 503
OK, Boot Required!
Next: VA's have to be configured to use Modbus IP Server. See: VA's Configuration.
2.3 VA's Configuration
VA's are used in CoolMasterNet and CooLinkHub devices. For CooLinkNet device this chapter is not applicable.
VA's -Virtual Addresses are used in order to simplify translation of the Indoor Unit identifier/number - UID into
addresses of related Modbus objects: holding registers, input registers, coils and discrete inputs.
UID is a string in format Ln.XYY. For Example:
L1.102 - Indoor Unit 102 on line L1
L2.003 - Indoor Unit 003 on line L2
List of UID's detected (visible) by CoolAutomation device can be retrieved with ls command.

Configuration
Modbus Integration Guidelines Rev 0.5 8
www.coolautomation.com © 2017 CoolAutomation LTD.
>ls
L1.100 ON 19C 30C High Fan OK # 0
L1.101 OFF 28C 23C High Cool OK - 0
Each UID can have none, one or a number of associated VA's. VA's are plain numbers starting from 1. Device can
automatically allocate and associate VA's with existing (visible by ls command) UID's:
>va auto
OK
To query allocated VA's use va command without parameters:
>va
INDOORS
L1.100 --> 0001 [Hex: 0x0011 | Dec: 00017]
L1.101 --> 0002 [Hex: 0x0021 | Dec: 00033]
OK
VA reporting string has following fields:
UID
Associated
VA
Base Address
Hex
Base Address
Decimal
L1.100
0001
0x0011
00017
Base Address is a starting address of the Modbus objects block related to VA and it's UID. Any operations with
Indoor Unit referenced by UID (query or change status) are made with Modbus objects from that block. Size of the
Modbus objects block for Indoor Unit is 16 adresses. Content of the Modbus objects block is described in
CoolMasterNet Tables.
Base Address is calculated as: Base Address = VA*16 +1
Below example shows relation between UID, VA, Base Address and Modbus objects
UID
VA
Base
Address
Modbus Objects Block
Discrete
Inputs
Coils
Input
Registers
Holding
Registers
L1.100
0001
0x0011 --->
0x0011
0x0011
0x0011
0x0011
...
...
...
...
0x0020
0x0020
0x0020
0x0020
L1.101
0002
0x0021 --->
0x0021
0x0021
0x0021
0x0021
...
...
...
...
0x0030
0x0030
0x0030
0x0030
VA's can be allocated or deallocated (deleted) all together or separately. As shown above for automatic VA's
allocation va auto command is used. It is possible to allocate VA for specific UID. For example, allocate VA 0004
for UID L1.102:
>va + L1.102 0004
OK
In this case UID does not have to be detected (visible) by CoolAutomation device at the VA allocation time. It is
allowed to allocate a number of VA's for any given UID.
To delete all allocated VA's:

Configuration
Modbus Integration Guidelines Rev 0.5 9
www.coolautomation.com © 2017 CoolAutomation LTD.
>va delall
OK
Specific VA can also be deleted (below command will delete VA 0004):
>va - 0004
OK
Alternatively all VA's associated with specific UID can be deleted (below command will delete all VA's associated
with UID L1.102):
>va - L1.102
OK
Once VA's are allocated Modbus RTU and Modbus IP can be properly used to access Indoor Unit parameters via
associated VA's.

Modbus Tables
Modbus Integration Guidelines Rev 0.5 10
www.coolautomation.com © 2017 CoolAutomation LTD.
3 Modbus Tables
Supported Modbus Exception Codes
Exception Code
Exception Name
0x01 (01)
Illegal Function
0x02 (02)
Illegal Data Address
0x03 (03)
Illegal Data Value
0x04 (04)
Server Device Failure
0x05 (05)
Acknowledgment
0x06 (06)
Server Device Busy
0x0A (10)
Gateway Path Unavailable
3.1 CoolMasterNet Modbus Tables
Supported Modbus functions
Function Code
Function Definition
Dec
Hex
1
0x01
Read Coils
2
0x02
Read Discrete Inputs
3
0x03
Read Holding Registers
4
0x04
Read Input Register
5
0x05
Write Single Coil
6
0x06
Write Single Register
15
0x0F
Write Single Coil
16
0x10
Write Multiple Registers