Modbus Integration Guidelines

CoolMasterNet CooLinkNet Modbus Integration Guidelines

Document Revision 0.1

12/5/2016

© 2016 CoolAutomation LTD. www.coolautomation.com

Modbus Integration Guidelines

Contents

2

Table of Contents 3

1 Connection

1.1 Modbus RTU ........................................................................................................................................................................ 3 Connection 1.2 Modbus IP Connection ........................................................................................................................................................................ 4

5

2 Configuration

2.1 Modbus RTU ........................................................................................................................................................................ 5 Configuration Modbus Slave Address .......................................................................................................................................................... Modbus RTU Frame .......................................................................................................................................................... Format

5 5

2.2 Modbus IP Configuration ........................................................................................................................................................................ 6 2.3 VA's Configuration ........................................................................................................................................................................ 6

8

3 Modbus Tables

3.1 CoolMasterNet ........................................................................................................................................................................ 8 Modbus Tables Special Devices

..........................................................................................................................................................

10

3.2 CooLinkNet Modbus ........................................................................................................................................................................ 10 Tables 3.3 HVAC Malfunction ........................................................................................................................................................................ 11 Codes

15

4 Commands Reference 4.1 line

........................................................................................................................................................................

15

4.2 modbus

........................................................................................................................................................................

15

4.3 va

........................................................................................................................................................................

16

5 Legacy CoolGate Mode

www.coolautomation.com

17

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

1

Rev 0.1

Connection

3

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 and CooLinkNet, Modbus IP is supported only by CoolMasterNet.

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.

www.coolautomation.com

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

Rev 0.1

Connection

4

CooLinkNet Modbus RTU Connection

In CooLinkNet only Line L3 can be used for Modbus RTU connection.

1.2 Modbus IP Connection Modbus IP is supported only in CoolMasterNet device. CoolMasterNet acts as a Modbus Server, communicating on the Ethernet TCP/IP network. Physical connection in this case is made via RJ45 Ethernet connector.

www.coolautomation.com

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

2

Rev 0.1

Configuration

5

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 in the same CoolMasterNet 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 Line L3 usage for Modbus RTU is mandatory. CoolMasterNet Modbus RTU activation:

CooLinkNet 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: >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 L2: Unused Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 L3: CLMB Address:0x50(80) 9600_8N1 Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 L4: M1M2 Slave U00/G00 Not Connected Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 L5: Unused Tx:0/0 Rx:0/0 TO:0/0 CS:0/0 Col:0/0 OK

NAK:0/0 NAK:0/0 NAK:0/0 NAK:0/0 NAK:0/0

Next: For CoolMasterNet 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. Modbus Slave Address can be changed with line myid command. In the example below new Slave Address will become 0x51/81dec after power reset: >line myid L3 51 OK, Boot Required!

The default (factory set) Modbus Slave Address for CoolAutomation devices is 0x50 (80dec).

2.1.2 Modbus RTU Frame Format The default Modbus RTU frame format in CoolAutomation devices is 9600_8N1: Baud Rate Data Bits Parity Stop Bits

www.coolautomation.com

9600 bps 8 None 1

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

Rev 0.1

Configuration

6

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 device only. 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 CoolMasterNet only after it establishes an Ethernet link and gets proper IP address (dynamic via DHC 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 server port CG4/5 ignore OK

: enabled : 502 : none

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 only in CoolMasterNet device. 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 CoolMasterNet can be retrieved with ls command. >ls L1.100 ON 19C 30C High Fan OK L1.101 OFF 28C 23C High Cool OK

# 0 - 0

Each UID can have none, one or a number of associated VA's. VA's are plain numbers starting from 1 (decimal). CoolMasterNet 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]

www.coolautomation.com

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

Rev 0.1

Configuration

7

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

Discrete Inputs

Modbus Objects Block Coils Input Registers

Holding Registers

L1.100

0001

0x0011 ---> 0x0011 ... 0x0020

0x0011 ... 0x0020

0x0011 ... 0x0020

0x0011 ... 0x0020

L1.101

0002

0x0021 ---> 0x0021 ... 0x0030

0x0021 ... 0x0030

0x0021 ... 0x0030

0x0021 ... 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 CoolMasterNet 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: >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.

www.coolautomation.com

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

3

Rev 0.1

Modbus Tables

8

Modbus Tables

Supported Modbus Exception Codes

Exception Code 0x01 (01) 0x02 (02) 0x03 (03) 0x04 (04) 0x05 (05) 0x06 (06) 0x0A (10)

Exception Name Illegal Function Illegal Data Address Illegal Data Value Server Devise Failure Acknowledgment Server Device Busy Gateway Path Unavailable

3.1 CoolMasterNet Modbus Tables Supported Modbus functions

Function Code Dec 1 2 3 4 5 6 15 16

www.coolautomation.com

Function Definition Hex 0x01 0x02 0x03 0x04 0x05 0x06 0x0F 0x10

Read Coils Read Discrete Inputs Read Holding Registers Read Input Register Write Single Coil Write Single Register Write Single Coil Write Multiple Registers

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

Rev 0.1

Modbus Tables

9

Indoor Unit Modbus objects block Base Address +0 0-Cool 1-Heat 2-Auto 3-Dry

Holding Registers

Input Registers

Coils

Operation Mode

UID Ln.XYY

On/Off

4-HAUX 5-Fan 6-HH

+1

Fan Speed 0-Low 1-Med 2-High

+2

8-VAM Auto 9-VAM Bypass 10-VAM Heat Exc 11-VAM Normal

4-Auto 5-Top

Bits 15..12 Ln

Bits 11..8 X

Bits 7..0 YY

Discrete Inputs

0-OFF 1-ON

Room Temperature x10

Filter Sign

HVAC Malfunction Code String** First two characters

External Terminals Status

8-VAM Super Hi 9-VAM Lo FreshUp 10-VAM Hi FreshUp

Set Temperature x10

0-Open 1-Closed (short)

+3

On/Off

HVAC Malfunction Code String** Last two characters

0-OFF 1-ON

+4 +5 0-Vertical 4-Horizontal

+6 +7 +8

Reserved

Filter Sign Swing 1-30 deg 2-45 deg 3-60 deg

5-Auto 6-OFF

Room Temperature x10 (Read Only) HVAC Malfunction Code (Read Only) Local Wall Controller Lock Bits

Reserved

Reserved

LSB Bit 0 - Inhibit On/Off control Bit 1 - Inhibit Mode control Bit 2 - Inhibit Set Temperature control

+9

Set Temperature Limits* v0.4.4

+10 0xA +11 0xB +12 0xC +13 0xD +14 0xE +15 0xF

Reserved

Analog Input 1 Analog Input 2 Reserved

Digital Output 1

Digital Input 1

Digital Output 2 Digital Output 3 Digital Output 4 Digital Output 5 Digital Output 6 Reserved

Digital Input 2 Digital Input 3 Digital Input 4 Digital Input 5 Digital Input 6 Reserved

*Set Temperature Limits Encoding MSB LSB Bits 15..8 Bits 7..0 High Limit x2 Low Limit x2 For example, 0x4020 means High Limit = 0x40/2 = 32(decimal) Low Limit = 0x20/2 = 16(decimal) Zero value of High Limit or Low Limit means that corresponding limit is not in use.

www.coolautomation.com

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

Rev 0.1

Modbus Tables

10

** HVAC Malfunction Code String Encoding This parameter is a HVAC malfunction code in string format, same as reported by ls command. Here are some examples: Malfunction Code String Input Register Values 0 0x4F4B, 0x2020 "OKVV" 6608 "6608" 0x3636, 0x3038

3.1.1 Special Devices · PAC YG66 This device supports Digital Inputs 1..6 and Digital Outputs 1..6 accessed via corresponding Coils and Discrete Inputs listed in "Indoor Unit Modbus objects block" table. · PAC YG63 This device supports Analog Inputs 1,2 accessed via corresponding Inputs Registers listed in "Indoor Unit Modbus objects block" table. The actual Analog Input value should be calculated as Analog Input Value = Input Register Value / 10

For example if temperature sensor is connected to Analog Input 1 of PAC YG63 and Analog Input 1 Input Register is read as 275 the temperature is 275/10 = 27.5

3.2 CooLinkNet Modbus Tables Supported Modbus functions

Function Code Dec 3 6 16

www.coolautomation.com

Function Definition Hex 0x03 0x06 0x10

Read Holding Registers Write Single Register Write Multiple Registers

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

Holding Reg Address*

Rev 0.1

Modbus Tables

Read Write

Description

Hex

Dec

0001 0002 0003 0004

1 2 3 4

CooLinkNet Internals CooLinkNet Version CooLinkNet S/N CooLinkNet Model Modbus Address

0005

5

Reset

W

0010

16

R

0011 0021

17 33

0100 0101

256 257

Internal State · 0 - Not Connected to RC line · 1 - Connecting · 2 - Connected as single RC · 3 - Connected as Master RC. Detected Slave RC · 4 - Connected as Slave RC 0 - Master Mode (default) 1 - Slave Mode UID Indoor Status and Control On/Off 0-Off, 1-On Operation Mode 0-Cool 1-Heat 2-Auto

0102

258

Required**

Notes

Version Model

R R R RW

RW

11

Major*100 + Minor*10 + SubMinor Lower 16 bit Two ASCII characters Modbus Address change is effective only after reset 1 - Enter Boot mode CooLinkNet does not respond to the write request to this register 2 - Reset

0.0.4

R

MSB - X, LSB - YY

RW RW

3-Dry 4-HAUX 5-Fan RW

Fan Speed 0-Low 1-Med 2-High

3-Auto 4-Top

0103

259

Set Point °C

0104 0105

260 261

Failure Code Indoor Ambient Temperature °C

0110

272

Feed Temperature °C

RW R R

RW

MSB - Integer Part LSB - Fraction Part * 0.01 0.2.4

0xFFFF - disable feed

* If Version or Model is not specified, it means that register is supported in any CooLinkNet version and/or model.

3.3 HVAC Malfunction Codes The value read from "HVAC Malfunction Code" holding register can be translated into native malfunction code applicable for specific HVAC manufacturer. In most cases that value and native code are equal but for some HVAC models translation to alphanumeric representation required. Following tables can be used for such translation. Zero value (0x00) means that there are no HVAC malfunctions. HVAC Type DK PN, SA, TO ME GR LG MG,TR,KT,CG

www.coolautomation.com

Native Malfunction Code Format XX (see DK type HVAC malfunction codes translation table) Xnn (see PN, SA, TO type HVAC malfunction codes translation table) nnnn decimal HH hexadecimal (low nibble or high nibble) nn decimal EH if code == 0x1H

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

Rev 0.1

Modbus Tables

12

PH if code == 0x2H H# if code == 0x3H nnn decimal HH hexadecimal

SM Others

DK type HVAC malfunction codes translation table 000 004 008 012

(0x00) (0x04) (0x08) (0x0C)

-

OK 04 08 0C

001 005 009 013

(0x01) (0x05) (0x09) (0x0D)

-

01 05 09 0J

002 006 010 014

(0x02) (0x06) (0x0A) (0x0E)

-

02 06 0A 0E

003 007 011 015

(0x03) (0x07) (0x0B) (0x0F)

-

03 07 0H 0F

016 020 024 028

(0x10) (0x14) (0x18) (0x1C)

-

A0 A4 A8 AC

017 021 025 029

(0x11) (0x15) (0x19) (0x1D)

-

A1 A5 A9 AJ

018 022 026 030

(0x12) (0x16) (0x1A) (0x1E)

-

A2 A6 AA AE

019 023 027 031

(0x13) (0x17) (0x1B) (0x1F)

-

A3 A7 AH AF

032 036 040 044

(0x20) (0x24) (0x28) (0x2C)

-

C0 C4 C8 CC

033 037 041 045

(0x21) (0x25) (0x29) (0x2D)

-

C1 C5 C9 CJ

034 038 042 046

(0x22) (0x26) (0x2A) (0x2E)

-

C2 C6 CA CE

035 039 043 047

(0x23) (0x27) (0x2B) (0x2F)

-

C3 C7 CH CF

048 052 056 060

(0x30) (0x34) (0x38) (0x3C)

-

E0 E4 E8 EC

049 053 057 061

(0x31) (0x35) (0x39) (0x3D)

-

E1 E5 E9 EJ

050 054 058 062

(0x32) (0x36) (0x3A) (0x3E)

-

E2 E6 EA EE

051 055 059 063

(0x33) (0x37) (0x3B) (0x3F)

-

E3 E7 EH EF

064 068 072 076

(0x40) (0x44) (0x48) (0x4C)

-

H0 H4 H8 HC

065 069 073 077

(0x41) (0x45) (0x49) (0x4D)

-

H1 H5 H9 HJ

066 070 074 078

(0x42) (0x46) (0x4A) (0x4E)

-

H2 H6 HA HE

067 071 075 079

(0x43) (0x47) (0x4B) (0x4F)

-

H3 H7 HH HF

080 084 088 092

(0x50) (0x54) (0x58) (0x5C)

-

F0 F4 F8 FC

081 085 089 093

(0x51) (0x55) (0x59) (0x5D)

-

F1 F5 F9 FJ

082 086 090 094

(0x52) (0x56) (0x5A) (0x5E)

-

F2 F6 FA FE

083 087 091 095

(0x53) (0x57) (0x5B) (0x5F)

-

F3 F7 FH FF

096 100 104 108

(0x60) (0x64) (0x68) (0x6C)

-

J0 J4 J8 JC

097 101 105 109

(0x61) (0x65) (0x69) (0x6D)

-

J1 J5 J9 JJ

098 102 106 110

(0x62) (0x66) (0x6A) (0x6E)

-

J2 J6 JA JE

099 103 107 111

(0x63) (0x67) (0x6B) (0x6F)

-

J3 J7 JH JF

112 116 120 124

(0x70) (0x74) (0x78) (0x7C)

-

L0 L4 L8 LC

113 117 121 125

(0x71) (0x75) (0x79) (0x7D)

-

L1 L5 L9 LJ

114 118 122 126

(0x72) (0x76) (0x7A) (0x7E)

-

L2 L6 LA LE

115 119 123 127

(0x73) (0x77) (0x7B) (0x7F)

-

L3 L7 LH LF

128 132 136 140

(0x80) (0x84) (0x88) (0x8C)

-

P0 P4 P8 PC

129 133 137 141

(0x81) (0x85) (0x89) (0x8D)

-

P1 P5 P9 PJ

130 134 138 142

(0x82) (0x86) (0x8A) (0x8E)

-

P2 P6 PA PE

131 135 139 143

(0x83) (0x87) (0x8B) (0x8F)

-

P3 P7 PH PF

144 148 152 156

(0x90) (0x94) (0x98) (0x9C)

-

U0 U4 U8 UC

145 149 153 157

(0x91) (0x95) (0x99) (0x9D)

-

U1 U5 U9 UJ

146 150 154 158

(0x92) (0x96) (0x9A) (0x9E)

-

U2 U6 UA UE

147 151 155 159

(0x93) (0x97) (0x9B) (0x9F)

-

U3 U7 UH UF

160 (0xA0) - M0 164 (0xA4) - M4

www.coolautomation.com

161 (0xA1) - M1 165 (0xA5) - M5

162 (0xA2) - M2 166 (0xA6) - M6

163 (0xA3) - M3 167 (0xA7) - M7

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

Rev 0.1

Modbus Tables

168 (0xA8) - M8 172 (0xAC) - MC

169 (0xA9) - M9 173 (0xAD) - MJ

170 (0xAA) - MA 174 (0xAE) - ME

171 (0xAB) - MH 175 (0xAF) - MF

176 180 184 188

(0xB0) (0xB4) (0xB8) (0xBC)

-

30 34 38 3C

177 181 185 189

(0xB1) (0xB5) (0xB9) (0xBD)

-

31 35 39 3J

178 182 186 190

(0xB2) (0xB6) (0xBA) (0xBE)

-

32 36 3A 3E

179 183 187 191

(0xB3) (0xB7) (0xBB) (0xBF)

-

33 37 3H 3F

192 196 200 204

(0xC0) (0xC4) (0xC8) (0xCC)

-

40 44 48 4C

193 197 201 205

(0xC1) (0xC5) (0xC9) (0xCD)

-

41 45 49 4J

194 198 202 206

(0xC2) (0xC6) (0xCA) (0xCE)

-

42 46 4A 4E

195 199 203 207

(0xC3) (0xC7) (0xCB) (0xCF)

-

43 47 4H 4F

208 212 216 220

(0xD0) (0xD4) (0xD8) (0xDC)

-

50 54 58 5C

209 213 217 221

(0xD1) (0xD5) (0xD9) (0xDD)

-

51 55 59 5J

210 214 218 222

(0xD2) (0xD6) (0xDA) (0xDE)

-

52 56 5A 5E

211 215 219 223

(0xD3) (0xD7) (0xDB) (0xDF)

-

53 57 5H 5F

224 228 232 236

(0xE0) (0xE4) (0xE8) (0xEC)

-

60 64 68 6C

225 229 233 237

(0xE1) (0xE5) (0xE9) (0xED)

-

61 65 69 6J

226 230 234 238

(0xE2) (0xE6) (0xEA) (0xEE)

-

62 66 6A 6E

227 231 235 239

(0xE3) (0xE7) (0xEB) (0xEF)

-

63 67 6H 6F

240 244 248 252

(0xF0) (0xF4) (0xF8) (0xFC)

-

?0 ?4 ?8 ?C

241 245 249 253

(0xF1) (0xF5) (0xF9) (0xFD)

-

?1 ?5 ?9 ?J

242 246 250 254

(0xF2) (0xF6) (0xFA) (0xFE)

-

?2 ?6 ?A ?E

243 247 251 255

(0xF3) (0xF7) (0xFB) (0xFF)

-

?3 ?7 ?H ?F

13

PN, SA, TO type HVAC malfunction codes translation table 000 004 008 012

(0x00) (0x04) (0x08) (0x0C)

-

OK A04 A08 A12

001 005 009 013

(0x01) (0x05) (0x09) (0x0D)

-

A01 A05 A09 A13

002 006 010 014

(0x02) (0x06) (0x0A) (0x0E)

-

A02 A06 A10 A14

003 007 011 015

(0x03) (0x07) (0x0B) (0x0F)

-

A03 A07 A11 A15

016 020 024 028

(0x10) (0x14) (0x18) (0x1C)

-

A16 A20 A24 A28

017 021 025 029

(0x11) (0x15) (0x19) (0x1D)

-

A17 A21 A25 A29

018 022 026 030

(0x12) (0x16) (0x1A) (0x1E)

-

A18 A22 A26 A30

019 023 027 031

(0x13) (0x17) (0x1B) (0x1F)

-

A19 A23 A27 A31

032 036 040 044

(0x20) (0x24) (0x28) (0x2C)

-

C00 C04 C08 C12

033 037 041 045

(0x21) (0x25) (0x29) (0x2D)

-

C01 C05 C09 C13

034 038 042 046

(0x22) (0x26) (0x2A) (0x2E)

-

C02 C06 C10 C14

035 039 043 047

(0x23) (0x27) (0x2B) (0x2F)

-

C03 C07 C11 C15

048 052 056 060

(0x30) (0x34) (0x38) (0x3C)

-

C16 C20 C24 C28

049 053 057 061

(0x31) (0x35) (0x39) (0x3D)

-

C17 C21 C25 C29

050 054 058 062

(0x32) (0x36) (0x3A) (0x3E)

-

C18 C22 C26 C30

051 055 059 063

(0x33) (0x37) (0x3B) (0x3F)

-

C19 C23 C27 C31

064 068 072 076

(0x40) (0x44) (0x48) (0x4C)

-

E00 E04 E08 E12

065 069 073 077

(0x41) (0x45) (0x49) (0x4D)

-

E01 E05 E09 E13

066 070 074 078

(0x42) (0x46) (0x4A) (0x4E)

-

E02 E06 E10 E14

067 071 075 079

(0x43) (0x47) (0x4B) (0x4F)

-

E03 E07 E11 E15

080 (0x50) - E16 084 (0x54) - E20 088 (0x58) - E24

www.coolautomation.com

081 (0x51) - E17 085 (0x55) - E21 089 (0x59) - E25

082 (0x52) - E18 086 (0x56) - E22 090 (0x5A) - E26

083 (0x53) - E19 087 (0x57) - E23 091 (0x5B) - E27

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

Rev 0.1

Modbus Tables

092 (0x5C) - E28

093 (0x5D) - E29

094 (0x5E) - E30

095 (0x5F) - E31

096 100 104 108

(0x60) (0x64) (0x68) (0x6C)

-

F00 F04 F08 F12

097 101 105 109

(0x61) (0x65) (0x69) (0x6D)

-

F01 F05 F09 F13

098 102 106 110

(0x62) (0x66) (0x6A) (0x6E)

-

F02 F06 F10 F14

099 103 107 111

(0x63) (0x67) (0x6B) (0x6F)

-

F03 F07 F11 F15

112 116 120 124

(0x70) (0x74) (0x78) (0x7C)

-

F16 F20 F24 F28

113 117 121 125

(0x71) (0x75) (0x79) (0x7D)

-

F17 F21 F25 F29

114 118 122 126

(0x72) (0x76) (0x7A) (0x7E)

-

F18 F22 F26 F30

115 119 123 127

(0x73) (0x77) (0x7B) (0x7F)

-

F19 F23 F27 F31

128 132 136 140

(0x80) (0x84) (0x88) (0x8C)

-

H00 H04 H08 H12

129 133 137 141

(0x81) (0x85) (0x89) (0x8D)

-

H01 H05 H09 H13

130 134 138 142

(0x82) (0x86) (0x8A) (0x8E)

-

H02 H06 H10 H14

131 135 139 143

(0x83) (0x87) (0x8B) (0x8F)

-

H03 H07 H11 H15

144 148 152 156

(0x90) (0x94) (0x98) (0x9C)

-

H16 H20 H24 H28

145 149 153 157

(0x91) (0x95) (0x99) (0x9D)

-

H17 H21 H25 H29

146 150 154 158

(0x92) (0x96) (0x9A) (0x9E)

-

H18 H22 H26 H30

147 151 155 159

(0x93) (0x97) (0x9B) (0x9F)

-

H19 H23 H27 H31

160 164 168 172

(0xA0) (0xA4) (0xA8) (0xAC)

-

J00 J04 J08 J12

161 165 169 173

(0xA1) (0xA5) (0xA9) (0xAD)

-

J01 J05 J09 J13

162 166 170 174

(0xA2) (0xA6) (0xAA) (0xAE)

-

J02 J06 J10 J14

163 167 171 175

(0xA3) (0xA7) (0xAB) (0xAF)

-

J03 J07 J11 J15

176 180 184 188

(0xB0) (0xB4) (0xB8) (0xBC)

-

J16 J20 J24 J28

177 181 185 189

(0xB1) (0xB5) (0xB9) (0xBD)

-

J17 J21 J25 J29

178 182 186 190

(0xB2) (0xB6) (0xBA) (0xBE)

-

J18 J22 J26 J30

179 183 187 191

(0xB3) (0xB7) (0xBB) (0xBF)

-

J19 J23 J27 J31

192 196 200 204

(0xC0) (0xC4) (0xC8) (0xCC)

-

L00 L04 L08 L12

193 197 201 205

(0xC1) (0xC5) (0xC9) (0xCD)

-

L01 L05 L09 L13

194 198 202 206

(0xC2) (0xC6) (0xCA) (0xCE)

-

L02 L06 L10 L14

195 199 203 207

(0xC3) (0xC7) (0xCB) (0xCF)

-

L03 L07 L11 L15

208 212 216 220

(0xD0) (0xD4) (0xD8) (0xDC)

-

L16 L20 L24 L28

209 213 217 221

(0xD1) (0xD5) (0xD9) (0xDD)

-

L17 L21 L25 L29

210 214 218 222

(0xD2) (0xD6) (0xDA) (0xDE)

-

L18 L22 L26 L30

211 215 219 223

(0xD3) (0xD7) (0xDB) (0xDF)

-

L19 L23 L27 L31

224 228 232 236

(0xE0) (0xE4) (0xE8) (0xEC)

-

P00 P04 P08 P12

225 229 233 237

(0xE1) (0xE5) (0xE9) (0xED)

-

P01 P05 P09 P13

226 230 234 238

(0xE2) (0xE6) (0xEA) (0xEE)

-

P02 P06 P10 P14

227 231 235 239

(0xE3) (0xE7) (0xEB) (0xEF)

-

P03 P07 P11 P15

240 244 248 252

(0xF0) (0xF4) (0xF8) (0xFC)

-

P16 P20 P24 P28

241 245 249 253

(0xF1) (0xF5) (0xF9) (0xFD)

-

P17 P21 P25 P29

242 246 250 254

(0xF2) (0xF6) (0xFA) (0xFE)

-

P18 P22 P26 P30

243 247 251 255

(0xF3) (0xF7) (0xFB) (0xFF)

-

P19 P23 P27 P31

www.coolautomation.com

14

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

4

Rev 0.1

Commands Reference

15

Commands Reference

line modbus va

4.1 line SYNOPSIS line line type line myid line baud DESCRIPTION parameter denotes communication line number like for example: L3 or L4. · Without parameters line command prints status of all communication lines available in specific device. · line type command is used to activate Modbus RTU module on line . parameter can be CG5 or CG4 (see Legacy CoolGate Mode) for CoolMasterNet device and CLMB for CooLinkNet device. · line myid command will change Modbus Slave Address of the Modbus RTU module running on line . Parameter is a new Modbus Slave Address in hexadecimal format. Accepted range of addresses is 01..F7 . New address will be in use after power reset. · line baud command is used to change Modbus RTU frame format for line . parameter format is _. Supported baud rates for parameter are: 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200. Frame format change is effective only after power reset. EXAMPLE See examples in Modbus RTU Configuration chapter.

4.2 modbus SYNOPSIS modbus modbus modbus modbus modbus

IP server port ignore r cg4

DESCRIPTION This command is available only in CoolMasterNet device. · Without parameters modbus command prints status of the Modbus IP Server. · modbus IP command is used to enable or disable Modbus IP activation. · modbus server port command will change Modbus IP Server TCPI/IP port number. New port number will be effective only after power reset. · modbus ignore r command will toggle ignore flag used by Modbus RTU module in attempt to access non implemented holding or input register. If ignore flag is set, attempt to access non existing register(s) will not cause the "Illegal Data Address" Modbus exception. This feature enables accessing of the multiple registers block with gap(s).

www.coolautomation.com

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

Rev 0.1

Commands Reference

16

· modbus cg4 command is used for legacy CoolGate Modbus RTU operation mode (see Legacy CoolGate Mode). It prints relation between detected UID's and CoolGate Modbus objects Base Addresses. EXAMPLE See examples in Modbus IP Configuration chapter.

4.3 va SYNOPSIS va va auto va + va delall va - | va ram DESCRIPTION This command is available only in CoolMasterNet device. parameter denotes Indoor Unit identifier/number like for example: L1.100 or L2.003. parameter denotes VA number in decimal format. · Without parameters va command prints status of all allocated VA's. · va auto command is used to automatically distribute VA's for all detected UID's one to one. Previously allocated VA's will be deleted · va + command will allocate VA for given UID. Number of VA's allocated for UID is not limited. · va delall command will delete all allocated VA's. · va - will delete all allocated VA's for given UID. · va - will delete specific VA. · va ram resizes RAM memory used for VA's. Parameter denotes a desired total number of VA's that can be allocated. By default N=170. VA's memory resize is effective only after power reset. EXAMPLE See examples in VA's Configuration chapter.

www.coolautomation.com

© 2016 CoolAutomation LTD.

Modbus Integration Guidelines

5

Rev 0.1

Legacy CoolGate Mode

17

Legacy CoolGate Mode

CoolMasterNet Modbus RTU module can be configured to work in legacy CoolGate mode. This is done for backward compatibility with CoolAutomation's CoolGate devices. This mode is not recommended for use in new projects. Activation of legacy CoolGate mode is made with below command: >line type L3 CG4 OK, Boot Required!

In this case a number of critical limitations should be taken in account: · HVAC communication lines are not distinguished. I.e. for example, UID's L1.101 and L2.101 are treated as a single Indoor Unit. · UID's range is limited · Features available in CoolMasterNet that were not implemented in CoolGate devices are not accessible via Modbus RTU module in CoolGate mode. Details of the CoolGate Modbus implementation can be found in CoolGate Programmer Reference Manual.

www.coolautomation.com

© 2016 CoolAutomation LTD.