CoolAutomation CoolMasterNet - ASCII I;F; General Protocol Definitions

ASCII I/F
CoolMasterNet PRM Rev 0.7
16
www.coolautomation.com
© 2017 CoolAutomation
6
ASCII I/F
CoolMasterNet provides a simple and comprehensive ASCII I/F Protocol, based on text (ASCII) strings,
representing verbal commands and responses . ASCII I/F implemented in CoolMasterNet is fully backward
compatible with previous versions of CoolAutomation products, but has a number of significant extensions and
improvements mainly aimed to support additional CoolMasterNet functionality. ASCII I/F can be utilized via
RS232 interface (see RS232 Port) or TCP/IP Server.
6.1
General Protocol Definitions
6.1.1 Messaging
Communication between DTE and CooLinkNet via ASCII I/F is based on text (ASCII) strings. Communication
example is shown below
>ls L2
çcommand
DTE to CooLinkNet
L2.102 OFF 20C 27C Auto Cool OK - 0
L2.103 OFF 20C 24C Low Auto OK - 0
çresponse
CooLinkNet to DTE
OK
çexit code
>
çprompt
Command string sent to CooLinkNet must be terminated with <CR> (carriage return 0x0D) <LF> (line feed
0x0A) sequence or a single <CR> character. Strings from CooLinkNet (except prompt character) are always
terminated with <CR> <LF>. Commands are case sensitive and should not contain leading or trailing spaces.
The only separator between command name and command parameter(s) is space (0x20) character.
Configuration parameter echo (see set command), defines if characters sent to CooLinkNet via RS232 interface
are echoed back or not. If echo is not zero - characters are echoed.
In case of RS232 interface, prompt character '>' is unconditionally sent by CooLinkNet. In case of ASCII Server
prompt sending is configurable.
6.1.2 Exit Code
CoolMasterNet provides Exit Code in verbose or numeric form. Numeric form format is
ERROR:N
where N is a number in range 0...999. If verbose format is not specified in table below it means error has only
numeric format.
Numeric
Verbose
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
8
Bad Function
Wrong function
9
Bad Line Type
Wrong line type definition
10
Bad Parameter
Command parameter is wrong
11
OK, Boot Required!
Command execution will be effective after reboot
12
Bad GPIO
Wrong GPIO
13
SDDP Disabled
SDDP module is disabled, enable it to proceed