Cool Automation CooLinkHub, Manual

Page 1: ... 2017 CooLinkHub PRM CooLinkHub Universal Interface Adapter for HVAC Split Systems Document Revision 1 0 23 09 2017 www coolautomatiom com ...

Page 2: ...3 1 CoolRemote Cloud Connection 10 4 3 2 5 ASCII I F 11 5 1 General Definitions 11 Messaging 11 5 1 1 Exit Code 11 5 1 2 UID 13 5 1 3 5 2 Configuration Commands 14 set 14 5 2 1 ifconfig 16 5 2 2 props 17 5 2 3 5 3 HVAC Status and Control Commands 18 on 19 5 3 1 allon 19 5 3 2 off 19 5 3 3 alloff 20 5 3 4 cool 20 5 3 5 heat 20 5 3 6 fan 21 5 3 7 dry 21 5 3 8 auto 21 5 3 9 haux 22 5 3 10 temp 22 5 3...

Page 3: ...3 www coolautomation com CooLinkHub PRM 1 0 2017 CoolAutomation Contents ls 26 5 3 16 ls2 27 5 3 17 query 28 5 3 18 ...

Page 4: ...4 www coolautomation com CooLinkHub PRM 1 0 2017 CoolAutomation Revision History 1 Revision History Revision Changes 1 0 0 Initial ...

Page 5: ...lAutomation ACRONYMS 2 ACRONYMS DC Digital Current DTE Data Terminal Equipment ETH Ethernet GPIO General Purpose Input Output HVAC Heating Ventilation Air Conditioning MAC Media Access Control LCD Liquid Crystal Display PRM Programmer s Reference Manual ...

Page 6: ...32 2 IO Connector Pin Number Pin Name Function 1 RS232 TX RS232 Transmit 2 RS232 RX RS232 Receive 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 ...

Page 7: ...ters LCD screen 3 1 LCD Screen CooLinkHub is equipped with an alphanumeric 8x2 characters LCD that presents most of the important device parametric and status information 1 ETH network connection status Disconnected Connected 2 CoolRmote cloud connection status Not connected Connected Connected communication in progress 3 HVAC line communication status RX TX 4 Every one minute IP address if acquir...

Page 8: ...topology PBUS is intended for connection of CoolPlug and ThermoPad devices to CooLinkHub PBUS is a solution for complete integration of multi split HVAC units with Home Automation and BMS systems 4 2 RS232 Port RS232 Interface in CooLinkHub is available from the RS232 IO connector RS232 harness provided with CooLinkHub routes RS232 signals to DB9 connector as shown below RS232 IO Pin DB9 Pin Signa...

Page 9: ... for Tx Rx Activity Ethernet interface is used by a number of protocol modules available in CooLinkHub ASCII I F via ASCII I F IP Server Modbus IP see Modbus Integration Guidlines document HDL buspro IP SDDP CoolRemote Network setting of the CooLinkHub are controlled with ifconfig command 4 3 1 ASCII I F IP Server ASCII I F IP Server referenced as Aserver is a classic row TCP IP socket server Aser...

Page 10: ...nnection CooLinkHub is constantly maintaining connection with CoolRemote cloud server once TCP IP networking with internet access is established Connection is made via TCP port 10101 on CoolRemote cloud server side Unless firewall is involved no special network configuration are required on client side ...

Page 11: ...d with CR LF Commands are case sensitive and should not contain leading or trailing spaces The only allowed separator between command name and command parameter s is space 0x20 character Configuration setting echo see set command defines whether characters sent to CooLinkHub via RS232 interface are echoed back or not If ASCII I F protocol is running over RS232 interface prompt character is uncondi...

Page 12: ...rror 80 No response from slave device ModBus Error 81 Frame Timeout in received message ModBus Error 82 Character Timeout in received message ModBus Error 83 Incomplete message received ModBus Error 84 Received message is too big ModBus Error 85 CRC error in received message ModBus Error EXC 0 Generic Modbus exception ModBus Error EXC 1 Modbus exception Illegal Function ModBus Error EXC 2 Modbus e...

Page 13: ... full 205 VA DB Overflow Virtual address Data Base is full 206 FDB5 Overflow Properties Data Base is full 207 Incorrect Unit Class Wrong class of the HVAC unit 250 Link DB Overflow Link Data Base is full 251 No CoolLinkHub Line CoolLinkHub line is not defined 252 Auto Visibility Failed There was an error of visibility during link creation 253 Link already exists Device already linked 307 KNX DB Ov...

Page 14: ...use UID_STRICT format Ln XYY where usage is prohibited and 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 supported settings and their values To change setting use format with SETTING and VALUE Some settings are read only RO and can not be change...

Page 15: ...s only to LCD 1 visibility filter applies to LCD and status control commands 0 visibility logic is inverted and filter is applied to LCD and status control commands HVAC lines RO HVAC lines 0 8 Maximal allowed number of HVAC lines max indoors RO max indoors 1 256 Maximal number of supported indoor units reset on assert RO rst on assert 0 or 1 Determines whether CooLinkHub will restart or halt if a...

Page 16: ...C RO MAC address of the CooLinkHub ETH port Link RO Indicates whether Ethernet link is Up or Down IP R W Static fixed IP address or DHCP Netmask R W Netmask address in case of static IP Gateway R W Default Gateway address in case of static IP DNS1 R W Primary DNS address DNS2 R W Alternative DNS address Parameter IP can be set to DHCP to work as DHCP client or IP number for static fixed IP In case...

Page 17: ...y or change CooLinkHub internal database of indoor unit properties Changes made in this database have no impact on physical capabilities of related indoor units Indoor unit properties record is created only upon first update made in database for this unit In format without parameters props command will list all stored properties in a table view PROPERTY Mode Value Description Notes visible R W 0 o...

Page 18: ...ase returning all properties to their default state EXAMPLE Make indoor unit 102 on line L1 invisible props L1 102 visible 0 OK Boot Required Forbid medium and auto fan speeds to indoor unit 107 on line 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 stored properties props UID Name Visi Modes Fspeeds L6 2...

Page 19: ...02 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 Turn off indoor unit s EXAMPLE Turn off indoor unit 102 on Line L1 off L1 102 OK Turn on all indoor units on Line L2 off L2 OK Turn on all indoor units off OK ...

Page 20: ...oor unit 102 on Line L1 to cool cool L1 102 OK Set operation mode of all indoor units on Line L2 to cool cool L2 OK Set operation mode of all indoor units to cool 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 units on Line L2 to heat heat ...

Page 21: ...all indoor units on Line L2 to fan fan L2 OK Set operation mode of all indoor units to fan fan OK 5 3 8 dry SYNOPSIS dry UID DESCRIPTION Set indoor unit s operation mode to dry EXAMPLE Set operation mode of the indoor unit 102 on Line L1 to dry dry L1 102 OK Set operation mode of all indoor units on Line L2 to dry dry L2 OK Set operation mode of all indoor units to dry dry OK 5 3 9 auto SYNOPSIS a...

Page 22: ... all ThermoPad devices on Line L2 to haux haux L2 OK 5 3 11 temp SYNOPSIS temp UID TEMP temp UID TEMP d DESCRIPTION Change indoor unit s Set Temperature In form temp UID TEMP TEMP parameter must be decimal natural number Command can work in relative or absolute manner If plus or minus sign precedes TEMP parameter it s value will be added to or substituted from the current Set Temperature value Oth...

Page 23: ...ture by 2ºC temp L2 2 OK Set all indoor units on line L2 Set Temperature to 24 5ºC temp L2 24 5 OK Set all indoor units Set Temperature to 22ºC temp 22 OK 5 3 12 feed SYNOPSIS feed UID TEMP feed UID TEMP d DESCRIPTION Provides Ambient Temperature suggestion for given indoor unit s If TEMP is zero CooLinkHub will stop suggesting Ambient Temperature Suggested Ambient Temperature is not persistent an...

Page 24: ...g setting see set command defines which temperature scale Celsius or Fahrenheit is used for TEMP and TEMP d parameters value Examples below assume that temperature scale is Celsius EXAMPLE Suggest Ambient Temperature of 23 5ºC for indoor unit L2 102 feed L2 102 23 5 OK Decrease suggested Ambient Temperature for all indoor units on line L2 by 2ºC feed L2 2 OK 5 3 13 fspeed SYNOPSIS fspeed UID v V l...

Page 25: ...ion to h horizontal v vertical a auto swing 3 30º 4 45º 6 60º x turn off louver swing Not all indoor units support louver position options listed above or have louver position control at all Louver control is a capability of the specific indoor unit type If requested louver position is not supported by indoor unit swing command may have no effect EXAMPLE Set indoor unit 102 on Line L2 louver to ho...

Page 26: ...0123456 L2 102 OFF 20C 27C High Cool OK 0 Indoor unit status line layout with Fahrenheit temperature scale 012345678901234567890123456789012345678 L2 102 OFF 120F 127F High Cool OK 0 Field Position in string Value format Celsius Fahrenheit UID 0 5 Ln XYY On Off 7 9 ON or OFF Set Temperature 11 12 11 13 nnC or nnnF Room Temperature 15 16 16 18 nnC or nnnF Fan Speed 19 22 21 24 VLow Low_ Med_ High T...

Page 27: ...e 0123456789012345678901234567890123456789012 L1 102 ON 062 4F 080 6F High Cool OK 0 Field Position in string Values Celsius Fahrenheit UID 0 5 Ln XYY On Off 7 9 ON or OFF Set Temperature 11 14 11 15 nnC or nnnF Room Temperature 17 20 18 22 nnC or nnnF Fan Speed 23 26 25 28 VLow Low_ Med_ High Top_ Auto Operation Mode 28 31 30 33 Cool Heat Fan_ Dry_ Auto Indoor Failure Code 33 36 35 38 OK no failu...

Page 28: ...t Query result is printed as alpha numeric value according to the table below Query parameter Status parameter Value o On Off 0 Off 1 On m Operation Mode 0 Cool 1 Heat 2 Auto 3 Dry 4 Haux 5 Fan f Fan Speed 0 Low 1 Medium 2 High 3 Auto 4 Top t Set Temperature Natural number e Failure Code 0 No failure otherwise failure code a Ambient Temperature Natural number h Set Temperature with 0 01º Precision...

Page 29: ...n com CooLinkHub PRM 1 0 2017 CoolAutomation ASCII I F query L1 100 o 1 OK query L1 100 m 0 OK query L1 100 t 25 OK query L1 100 a 27 OK query L1 100 f 2 OK query L1 100 e U4 OK query L1 100 e 0 OK query L1 100 h 20 50 OK ...