11
www.coolautomation.com
CooLinkHub PRM 1.0
© 2017 CoolAutomation
ASCII I/F
5
ASCII I/F
ASCII I/F is a proprietary CoolAutomation's interface utilized by most of the CoolAutomation devices,
including CooLinkHub. In CooLinkHub ASCII I/F interface is running over RS232 connection and TCP/IP
network connection via
5.1
General Definitions
5.1.1
Messaging
Communication between DTE and CooLinkHub via ASCII I/F protocol is based on text (ASCII) strings.
Communication example is shown 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
CooLinkHub to DTE
OK
Exit Code
>
Prompt
Command string sent to CooLinkHub must be terminated with <CR> (carriage return 0x0D) <LF> (line feed
0x0A) sequence or a single <CR> character. Strings from CooLinkHub (except prompt character) are
always terminated 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
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 unconditionally sent by
CooLinkHub. In case of
prompt transmission is configurable by
aserver prompt
setting.
5.1.2
Exit Code
CooLinkHub can 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
N
Verbose form
Description
0
OK
Command executed successfully
1
No UID
UID not found
2
Not Strict UID
UID must be precise
3
Bad Format
Command format is wrong
4
Failed
Command execution failed
5
Line Unused
Line is unused
6
Unknown Command
Command is unknown
7
Bad HVAC Line
Line number is wrong
