CoolAutomation CooLinkHub User manual

©2017
CooLinkHubPRM
CooLinkHub
Universal Interface Adapter
for HVAC Split Systems
Document Revision 1.0 23/09/2017
www.coolautomatiom.com

2
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
Contents
Table of Contents
1Revision History ................................................................................................................................. 4
2ACRONYMS ........................................................................................................................................ 5
3LAYOUT ............................................................................................................................................... 6
3.1 LCDScreen .................................................................................................................................................................................7
4CONNECTIONS .................................................................................................................................. 8
4.1 Communication Lines ..........................................................................................................................................................8
PBUS .......................................................................................................................................................................................... 84.1.1
4.2 RS232Port ...................................................................................................................................................................................8
4.3 Ethernet ........................................................................................................................................................................................9
ASCII I/FIP Server ................................................................................................................................................................ 94.3.1 CoolRemote CloudConnection ......................................................................................................................................... 104.3.2
5ASCII I/F ............................................................................................................................................ 11
5.1 General Definitions .............................................................................................................................................................11
Messaging .............................................................................................................................................................................. 115.1.1 Exit Code ................................................................................................................................................................................. 115.1.2 UID ........................................................................................................................................................................................... 135.1.3
5.2 Configuration Commands ...............................................................................................................................................14
set ............................................................................................................................................................................................. 145.2.1 ifconfig..................................................................................................................................................................................... 165.2.2 props ........................................................................................................................................................................................ 175.2.3
5.3 HVACStatusand Control Commands ......................................................................................................................18
on .............................................................................................................................................................................................. 195.3.1 allon.......................................................................................................................................................................................... 195.3.2 off .............................................................................................................................................................................................. 195.3.3 alloff ......................................................................................................................................................................................... 205.3.4 cool ........................................................................................................................................................................................... 205.3.5 heat .......................................................................................................................................................................................... 205.3.6 fan............................................................................................................................................................................................. 215.3.7 dry ............................................................................................................................................................................................. 215.3.8 auto .......................................................................................................................................................................................... 215.3.9 haux .......................................................................................................................................................................................... 225.3.10 temp ......................................................................................................................................................................................... 225.3.11 feed .......................................................................................................................................................................................... 235.3.12 fspeed ...................................................................................................................................................................................... 245.3.13 swing ........................................................................................................................................................................................ 255.3.14 filt .............................................................................................................................................................................................. 255.3.15

3
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
Contents
ls................................................................................................................................................................................................ 265.3.16 ls2 ............................................................................................................................................................................................. 275.3.17 query ........................................................................................................................................................................................ 285.3.18

4
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
Revision History
1Revision History
Revision
Changes
1.0.0
Initial

5
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
ACRONYMS
2 ACRONYMS
DC
Digital Current
DTE
Data Terminal Equipment
ETH
Ethernet
GPIO
General Purpose Input/Output
HVAC
HeatingVentilationAir Conditioning
MAC
Media AccessControl
LCD
Liquid Crystal Display
PRM
Programmer's Reference Manual

6
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
LAYOUT
3 LAYOUT
(1) RS232, (2) IO Connector
Pin Number
Pin Name
Function
1
RS232TX
RS232Transmit
2
RS232RX
RS232Receive
3
VDC -
Ground
4
GPIO2
General Purpose I/O
5
GPIO1
General Purpose I/O
(3) Power, (4) PBUS,(5) Modbus Connector
Pin Number
Pin Name
Function
1
VDC +
Input Voltage
2
VDC -
Ground
3
PBUS 1
PBUS 1(+) Terminal

7
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
LAYOUT
4
PBUS 2
PBUS 2(-) Terminal
5
MODA
ModbusA(+) Terminal
6
MODB
ModbusB(-) Terminal
(6) Power Connector
Used to connect 12-24V DC power supply adapter.
(7) ETH Connector
RJ45connector for ETH network.
(8) Mini USB Device Connector
Used to connect CooLinkHubtoPC USB Host for configurationand firmware updates.
(9) LCD
Alphanumeric 8x2 charactersLCDscreen.
3.1 LCD Screen
CooLinkHub is equippedwithan alphanumeric 8x2characters LCD that presents most of the important
device parametric andstatus information.
(1) ETH network connection status
Disconnected, Connected
(2) CoolRmote cloudconnectionstatus
Not connected, Connected, Connected, communication in
progress
(3) HVAC line communication status
RX, TX
(4) Every one minute IP address(if acquired) and S/N are
displayed
(5) Indoor unit UID (L2.001on this picture)
(6) Indoor unit status
ON, OFF
(7) Set temperature
(8) Fanspeed
High, Medium, Low, Auto
(9) Operationmode
CL - Cool, HT - Heat, FA - Fan, DR - Dry, AU- Auto

8
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
CONNECTIONS
4 CONNECTIONS
4.1 Communication Lines
CooLinkHubsupportsa number of communicationlinesintendedfor connectiontoPBUS interface aswell
as integration withHome Automation and BMS control systems.
Line Type
Acronym
L1
L2
L3
L4
L5
HVAC
PBUS Master (PBM )
CH
Rolbit Zone Controller
RLBT
Home Automation / BMS
KNX
KNX
ModbusRTU
CG5
HDL
HDL
4.1.1 PBUS
PBUS isa CoolAutomation’sproprietary bus interface, based on shielded2-wiredcable (AWG24). It utilizes
free network topology.
PBUS is intendedfor connection of CoolPlug andThermoPaddevicestoCooLinkHub. PBUS isa solution
for complete integration of (multi) split HVAC unitswithHome AutomationandBMS systems.
4.2 RS232 Port
RS232 Interface in CooLinkHubisavailable from the RS232/IO connector. RS232harness, providedwith
CooLinkHub, routesRS232signalstoDB9 connector asshownbelow.
RS232/IO Pin
DB9 Pin
Signal Level
Description
1
2
±12V
TxD Data from CooLinkHub
2
3
±12V
RxD Data toCooLinkHub
3
5
GND
Ground
Maximal length of the RS232Cable should not exceed25m. The default CooLinkHubRS232Port settings
are:
Baud Rate
9600
Data Bits
8
Parity Control
None
StopBits
1
Flow Control
None
By default RS232 Interface is dedicated for ASCII I/Fprotocol.

9
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
CONNECTIONS
4.3 Ethernet
CooLinkHub incorporatesan IEEE 802.3compatible 10/100 Mb/s Ethernet port available via RJ45
connector. Ethernet port hasa following features:
Parameter
Value
Notes
Max Ethernet Cable Length
137m
CAT5twistedpair cable
SupportedBit Rate
10/100 Mb/s
SupportedEthernet Protocols
10BASE-T/100BASE-TX
Protocol Auto-Negotiation
Enabled
Against Link Partner
RJ45connector comprises Link and Activity indication LEDsusedasspecifiedbelow.
LED
Color
Function
Link Led
Green
ON for goodlink, OFFfor no link
Activity Led
Orange
BLINKING for Tx/Rx Activity
Ethernet interface isusedby a number of protocol modulesavailable inCooLinkHub
·
ASCII I/F(via ASCII I/FIP Server)
·
ModbusIP (see ModbusIntegrationGuidlinesdocument)
·
HDLbusproIP
·
SDDP
·
CoolRemote
Network setting of the CooLinkHub are controlledwith ifconfigcommand.
4.3.1 ASCII I/F IP Server
ASCII I/FIP Server referencedasAserver isa classic row TCP/IP socket server. Aserver isstartedby
CooLinkHubonce the Ethernet link is establishedandIP address isacquired. Aserver has following default
characteristics:
Maximal number of simultaneous connections
4
Default TCP/IP listening port
10102
Prompt character >
enabled
Aserver can be configured withset command.
The screenshoot below illustratesthe connection toAserver withPuTTY utility (CooLinkHubIP address in
this example is192.168.1.110).

10
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
CONNECTIONS
4.3.2 CoolRemote Cloud Connection
CooLinkHubisconstantly maintaining connectionwithCoolRemote cloudserver once TCP/IP networking
with internet accessisestablished. Connectionis made via TCP port 10101 on CoolRemote cloud server
side. Unless firewall is involved no special network configurationare required on client side.

11
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
ASCII I/F
5ASCII I/F
ASCII I/Fisa proprietary CoolAutomation's interface utilized by most of the CoolAutomation devices,
including CooLinkHub. In CooLinkHubASCII I/F interface isrunningover RS232 connectionand TCP/IP
network connectionvia Aserver.
5.1 General Definitions
5.1.1 Messaging
CommunicationbetweenDTE and CooLinkHubvia ASCII I/F protocol is based on text (ASCII) strings.
Communicationexample isshown below:
>ls L2
Command
DTE to CooLinkHub
L2.102 OFF 20C 27C Auto Cool OK - 0
L2.103 OFF 20C 24C Low Auto OK - 0
Response
CooLinkHubtoDTE
OK
Exit Code
>
Prompt
Commandstring sent toCooLinkHub must be terminatedwith <CR> (carriage return 0x0D) <LF> (line feed
0x0A) sequence or a single <CR> character. Stringsfrom CooLinkHub(except prompt character) are
alwaysterminatedwith<CR> <LF>. Commandsare case sensitive and shouldnot containleading or trailing
spaces. The only allowed separator betweencommand name andcommand parameter(s) isspace (0x20)
character.
Configuration settingecho (see set command), defineswhether characters sent toCooLinkHub via RS232
interface are echoed back or not.
If ASCII I/Fprotocolisrunning over RS232interface, prompt character '>' is unconditionally sent by
CooLinkHub. In case of ASCII I/FIP Server prompt transmissionis configurable by aserver prompt
setting.
5.1.2 Exit Code
CooLinkHubcan provide Exit Code in verbose (default) or numeric forms. Numeric form format is:
ERROR:N, where N is a number in range 0...999. Exit Code format can be configured with verbose
setting (see set command).
N
Verbose form
Description
0
OK
Commandexecutedsuccessfully
1
No UID
UID not found
2
Not Strict UID
UID must be precise
3
BadFormat
Commandformat iswrong
4
Failed
Commandexecutionfailed
5
Line Unused
Line is unused
6
UnknownCommand
Commandisunknown
7
BadHVAC Line
Line number is wrong

12
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
ASCII I/F
8
BadFunction
Wrongfunction
9
BadLine Type
Wrong line type definition
10
BadParameter
Commandparameter iswrong
11
OK, Boot Required!
Commandexecution will be effective after reboot
12
BadGPIO
WrongGPIO
13
SDDP Disabled
SDDP module is disabled, command can not be executed
14
Virtual Address In Use
Virtual address already in use
15
BadProperty
Wrongproperty
16
Number of linesexceeded
Can't define more line types
17
Warning! DipSwitchState
Incorrect
DIP switchstate isincorrect for definedline type
18
SDDP Not Initialized
SDDP is enabled, but Ethernet link isstill down
19
Response not full
Incomplete response received
20
L1& L5 can't be activated
simultaneously
Lines L1 and L5can not be activated simultaneously
ModBusError:80
No response from slave device
ModBusError:81
Frame Timeout in receivedmessage
ModBusError:82
Character Timeout in receivedmessage
ModBusError:83
Incomplete message received
ModBusError:84
Receivedmessage is too big
ModBusError:85
CRC error inreceivedmessage
ModBusError:EXC(0)
Generic Modbus exception
ModBusError:EXC(1)
Modbusexception: Illegal Function
ModBusError:EXC(2)
Modbusexception: Illegal Address
ModBusError:EXC(3)
Modbusexception: Illegal Data
ModBusError:EXC(4)
Modbusexception: Device Failure
ModBusError:EXC(5)
Modbusexception: ACK
ModBusError:EXC(6)
Modbusexception: Busy
ModBusError:EXC(10)
ModBusexception: Wrongpath
100
Collision
CollisiononHVAC line
101
UnsupportedFeature
Unsupportedcommand or parameter
102
Incorrect Indoor Type
Indoor unit doesn't support thiscommand or parameter
103
No ACK From Indoor
Indoor unit didn't acknowledge the command
104
Time Out on Receive
No response from indoor unit
105
CS Error InReceivedMessage
Check sum error in receivedmessage

13
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
ASCII I/F
106
Line Init In Progress...
Line initialization isinprocess
107
Line Error
Error(s) onthe HVAC line
108
FeedDisabled
Indoor unit can't receive ambient temperature from
CooLinkHub
109
Line Queue Full
Commands queue of the Line isfull
150
HDL Not Initialized
HDL line was not definedor Ethernet link isdown
151
HDL DB Overflow
HDL Data Base isfull, can't add new configuration
152
HDLEthDisabled
HDL over Ethernet is disabled
200
UID Not Found
Specifiedindoor unit not found inData Base
201
Strict UID Not Found
Specifiedindoor unit by not foundinData Base
202
Indoor Removed
Indoor unit removedfrom Data Base
203
DB Overflow
Indoor unitsData Base is full
204
Group DB Overflow
Group Data Base is full
205
VA DB Overflow
Virtual address Data Base is full
206
FDB5Overflow
PropertiesData Base is full
207
Incorrect Unit Class
Wrong class of the HVAC unit
250
Link DB Overflow
Link Data Base isfull
251
No CoolLinkHubLine
CoolLinkHub line isnot defined
252
Auto Visibility Failed
There was anerror of visibility during link creation
253
Link already exists
Device already linked
307
KNX DB Overflow
KNX Data Base is full
309
KNX Not Connected
No communicationwithKNX extender
310
KNX Line Not Started
KNX line not defined
450
Luxom Disabled
Luxom module not enabled
451
Luxom DB Overflow
Luxom Data Base is full
452
Luxom Not Initialized
Luxom module not initialized
5.1.3 UID
UID isusedtoidentify indoor unitor a set of indoor units. UIDhasthe followingformat:
Line
dot
Indoor number
L<n>
.
X
YY
·
Line is a CooLinkHub HVAC Line number like L1, L2, ... L* - means "any line". To provide backward
compatibility withCoolMaster andCooLink devices, Line number can be omitted from the UID.

14
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
ASCII I/F
·
Dotisa separator betweenLine number andIndoor number. If Line number isomittedor hasa L*form,
dot must also be omitted.
·
Indoor number isanindoor unitnumber inHVAC system. Indoor number canbe*, that means "any"
UID Examples:
L1.102
Indoor Unit 102online L1
L2.003
Indoor Unit 003online L2
L*100
Set of Indoor Units 100 on all lines
L3.1*
Set of Indoor Units1xxonline L3(L3.100, L3.101, ... )
L4
All Indoors on line L4
L*
All Indoors on all lines
203
Similar toL*203(for backwardcompatibility only)
UID_STRICT
Insome casesonly specific indoor unit hasto be referencedby UID. Inthis case it is required to use
UID_STRICT format: Ln.XYY, where *usage isprohibitedand Line number can not be omitted.
5.2 Configuration Commands
5.2.1 set
SYNOPSIS
set [<SETTING> <VALUE>]
set defaults
DESCRIPTION
Query or change CooLinkHub settings. Without parameters set command will list all supportedsettings
and their values. To change setting use format with<SETTING> and <VALUE>. Some settings are readonly
(RO) and can not be changed. set defaults command will load default valuesto all settings
<SETTING>
Mode
Printed as
Value
Description*
S/N
RO
S/N
CooLinkHub Serial Number
version
RO
version
X.Y.Z
CooLinkHubFirmware Version
baud
R/W
baud rate
1200...
115200
RS232 Interface baud rate. Default is
9600
echo
R/W
echo
0or 1
RS232 Interface echocontrol:
0- echodisabled
1- echo enabled
verbose
R/W
verbose
00r 1
Exit Code format:
0- numeric
1- verbose
aserver port
R/W
aserver port
integer
Aserver TCP port. Default is: 10102

15
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
ASCII I/F
aserver prompt
R/W
aserver prompt
0or 1
Aserver prompt control:
0 - prompt disabled
1 - prompt enabled
deg
R/W
degC/F
C or F
Temperature scale Celsius or Fahrenheit
melody
R/W
melody
string
Power-upmelody. The value is printedas
melody name, to change the melody its
number shouldbe provided.
set melody commandlistssupported
melodiesandtheir numbers.
filter of visi
R/W
filter
visi_0or
visi_1or
"-"
Indoor unitsvisibility according toprops.
"-" - visibility filter appliesonly to LCD
1- visibility filter applies to LCD and
status/control commands
0 - visibility logic isinvertedand filter is
appliedtoLCDandstatus/control
commands
HVAC lines
RO
HVAC lines
0...8
Maximal allowednumber of HVAC lines.
max indoors
RO
max indoors
1..256
Maximalnumber of supportedindoor units
reset on assert
RO
rst onassert
0or 1
Determineswhether CooLinkHubwill
restart or halt if assertiondetected
0- halt
1- restart
* - Boldfont emphasizes default values.
EXAMPLE
Disable echo
>set echo 0
OK
Change Aserver TCP port
>set aserver port 12345
OK
Load defaults
>set defaults
OK
Apply props visibility filter to status/control commands
>set filter visi 1
OK, Boot Required!
Set RS232Interface to19200, 8data bits, evenparity, 1stop bit

16
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
ASCII I/F
>set baud 19200 8E1
OK
Set temperature scale toFahrenheit
>set deg f
OK
Set power-up melody to 3
>set melody 3
OK
5.2.2 ifconfig
SYNOPSIS
ifconfig
ifconfig <PARAMETER> <VALUE>
ifconfig enable|disable
DESCRIPTION
Query or configure Ethernet network settings. Without parameters, ifconfig command will list current
network configuration. To change configurationuse format with <PARAMETER> and<VALUE>.
Parameter
Mode
Description
MAC
RO
MAC address of the CooLinkHub ETH port
Link
RO
Indicateswhether Ethernet link is "Up" or "Down"
IP
R/W
Static (fixed) IP addressor DHCP
Netmask
R/W
Netmask addressin case of static IP
Gateway
R/W
Default Gateway address incase of static IP
DNS1
R/W
Primary DNS address
DNS2
R/W
Alternative DNS address
Parameter IP canbe set to DHCP,towork as DHCP client, or IP number for static(fixed) IP. Incase of
DHCP, Netmask andGateway valuesare provided by DHCP server. By default CooLinkHubis configured
tooperate as DHCP client.
EXAMPLE
Query network settings
>ifconfig
MAC : 28:3B:96:00:02:0F
Link : Up
IP : 192.168.16.108 (DHCP)
Netmask: 255.255.255.0
Gateway: 192.168.16.254
DNS1 : 8.8.8.8
DNS2 : 8.8.4.4
OK

17
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
ASCII I/F
Configure fixedIP, Gateway andNetmask
>ifconfig IP 192.168.1.102
OK, Boot Required!
>ifconfig Gateway 192.168.1.0
OK, Boot Required!
>ifconfig Netmask 255.255.0.0
OK, Boot Required!
Configure DHCP client operation
>ifconfig IP DHCP
OK, Boot Required!
Disable Ethernet
>ifconfig disable
OK, Boot Required!
Change primary DNS address
>ifconfig DNS1 208.67.222.222
OK, Boot Required!
5.2.3 props
SYNOPSIS
props
props <UID_STRICT> <PROPERTY> <VAL>
props delall
DESCRIPTION
Query or change CooLinkHubinternal database of indoor unit properties. Changes made inthis database
have no impact onphysical capabilities of relatedindoor units. Indoor unit propertiesrecordiscreated only
upon first update made indatabase for this unit.
Informat without parameters props command will list all storedproperties in a table view.
<PROPERTY>
Mode
Value
Description*
Notes
visible
R/W
0or 1
Definesindoor unit visibility.
0- invisible
1- visible
Alsodependsonfilter
setting (see set command).
Effective after reboot
fspeed
R/W
<+|->v, l, m, h, t, a
Definesindoor unit fan speeds
for commandsto/from KNX
bus.
+ allow, - forbid,
v - very low/quiet,
l - low,
m - medium,
A number of properties
can be combined in one
command(see
examplesbelow)

18
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
ASCII I/F
h - high,
t - top,
a - auto.
mode
R/W
<+|->c, d, f, h, hx, hh, a
Definesindoor unit operation
modes for control commands
to/from KNX bus.
+ allow, - forbid,
c - cool,
d - dry,
f - fan,
h - heat,
hx - haux,
hh - heat & haux,
a - auto
* Bold values represent defaults.
Commandprops delall will totally erase props database, returning all properties to their default
state.
EXAMPLE
Make indoor unit 102online L1 invisible
>props L1.102 visible 0
OK, Boot Required!
Forbid medium and auto fan speeds toindoor unit 107 online L2
>props L1.102 fspeed -m-a
OK
Allow only cool, fan and haux modes to indoor unit 101 on line L1
>props L1.101 mode +c+f+hx-h-d-hh-a
OK
List all storedproperties
>props
UID | Name | Visi | Modes | Fspeeds |
------- ---------------- ------ ----------------- -------------
L6.204 | Kitchen | 1 | c d f h a | l m h a |
L1.102 | - | 0 | c d f h a | l m h a |
L2.107 | - | 1 | c d f h a | l h |
L1.101 | - | 1 | c f hx | l m h a |
OK
5.3 HVAC Status and Control Commands

19
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
ASCII I/F
5.3.1 on
SYNOPSIS
on [UID]
DESCRIPTION
Turnonindoor unit(s).
EXAMPLE
Turn on indoor unit 102 on Line L1
>on L1.102
OK
Turn on all indoor units on Line L2
>on L2*
OK
Turn on all indoor units
>on
OK
5.3.2 allon
SYNOPSIS
allon
DESCRIPTION
Turn on all indoor units.
5.3.3 off
SYNOPSIS
off [UID]
DESCRIPTION
Turnoff indoor unit(s).
EXAMPLE
Turn off indoor unit 102onLine L1
>off L1.102
OK
Turn on all indoor units on Line L2
>off L2*
OK
Turn on all indoor units
>off
OK

20
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
ASCII I/F
5.3.4 alloff
SYNOPSIS
allon
DESCRIPTION
Turn on all indoor units.
5.3.5 cool
SYNOPSIS
cool [UID]
DESCRIPTION
Set indoor unit(s) operation mode to cool.
EXAMPLE
Set operation mode of the indoor unit 102 on Line L1 to cool
>cool L1.102
OK
Set operation mode of all indoor unitsonLine L2 tocool
>cool L2*
OK
Set operationmode of all indoor unitstocool
>cool
OK
5.3.6 heat
SYNOPSIS
heat [UID]
DESCRIPTION
Set indoor unit(s) operation mode to heat.
EXAMPLE
Set operation mode of the indoor unit 102 on Line L1 to heat
>heat L1.102
OK
Set operation mode of all indoor unitsonLine L2 toheat
>heat L2*
OK
Set operationmode of all indoor unitstoheat
>heat
OK
Other manuals for CooLinkHub
1
Table of contents
Other CoolAutomation Adapter manuals