CoolMaster Programmers Reference Manual (PRM

CoolMaster Programmers Reference Manual (PRM)
CoolMaster
Interface Adapter
for VRV, VRF
Air Conditioning Systems
Cool Master 1000D
Cool Master 2000S
Cool Master 3000T
Cool Master 4000M
Version 3.0
8/12/2009
© 2009 XDIMAX LTD
www.xdimax.com
CoolMaster PRM
Contents
2
Table of Contents
Foreword
0
3
Part I RS232 Interface
1 Mechanical and
...................................................................................................................................
Electrical Specification
3
2 Port Settings ................................................................................................................................... 4
5
Part II General Protocol Definitions
1 Message format
................................................................................................................................... 5
2 Indoor Unit Addressing
................................................................................................................................... 5
7
Part III Commands Reference
1 Cool Master Commands
................................................................................................................................... 7
alloff
allon
boot
cool
dry
heat
fan
filt
fspeed
off
on
set
simul
stat
stat2
stat3
swing
temp
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
..........................................................................................................................................................
Part IV Firmware Update
7
7
8
8
8
9
9
10
10
10
11
11
12
13
13
14
15
16
17
1 Entering bootloader
...................................................................................................................................
mode
17
2 Firmware Download
................................................................................................................................... 17
3 Reboot
www.xdimax.com
................................................................................................................................... 18
© 2009 XDIMAX LTD
2
CoolMaster PRM
Rev 3.0
RS232 Interface
1
RS232 Interface
1.1
Mechanical and Electrical Specification
3
RS232 Interface connector used in Cool Master is D-Type 9-pin DB9 female connector.
Cool Master DB9 Connector front view
DB9 Pin
2
3
5
Signal Lvel
±12V
±12V
GND
Description
TxD (Data from Cool Master)
RxD (Data to Cool Master)
Ground
Connecting Cool Master to Home Automation Equipment
According to RS232 specification cable length should not exceed 25m. RS232 Cable supplied with
Cool Master is 1.5m length suitable for direct connection to PC RS232 serial port.
www.xdimax.com
© 2009 XDIMAX LTD
CoolMaster PRM
1.2
Rev 3.0
RS232 Interface
4
Port Settings
For proper communication with Cool Master RS232 Port should be configured with following
parameters
Baud Rate
Data Bits
Parity Control
Stop Bits
Flow Control
9600
8
None
1
None
Below is an example of COM port setup in HyperTerminal application
www.xdimax.com
© 2009 XDIMAX LTD
CoolMaster PRM
Rev 3.0
General Protocol Definitions
2
General Protocol Definitions
2.1
Message format
5
Communication between PC or Home Automation Controller and CoolMaster via RS232 interface is
based on text messages. Communication example is shown below
>stat 101
101 ON
OK
>
27C 00,00C Auto Dry
OK
command
response
exit code
prompt
PC to CoolMaster
CoolMaster to PC
Command message sent to CoolMaster must be terminated by CR (carriage return 0x0D) LF (line feed
0x0A) sequence or a single CR character. Messages from CoolMaster (except prompt character) are
terminated by 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 character.
In case of wrong command CoolMaster response can be one of the following strings:
Unrecognized command name
Command has missing or wrong parameters
Unknown command
Bad parameters
If command was executed CoolMaster will return optional response and exit code. Detailed information
is provided in topics describing specific commands.
2.2
Indoor Unit Addressing
To address specific indoor unit in CoolMaster command the UID parameter is used. UID format is
three digits. First digit can be hexadecimal in range 1-9 or A-F to represent system numbers 1 to 15
correspondingly.
1
2
3
System Number Unit Number in System
0-9, A-F
00-99
· For CoolMaster 4000M System Number must be 0, Unit Number must be 01-50
· For CoolMaster 1000D System Number must be in range 1-4
· For CoolMaster 2000S and 3000T System Number should not be 0
UID reflects the indoor unit Centralized Address. For proper operation of Cool Master all indoor units
have to be given Centralized Address (depending on specific AC system type this can be done
automatically by system or has to be done manually by integrator). You should refer to specific AC
system manuals to find out how to set and quire Centralized Addresses.
Below are examples of accepted UID's.
UID
100
101
201
310
F99
www.xdimax.com
Centralized Address
1-00
1-01
2-01
3-10
15-99
© 2009 XDIMAX LTD
CoolMaster PRM
Rev 3.0
General Protocol Definitions
6
Note: For backward compatibility Unit number in System can be represented by hexadecimal numbers couple in
range 00-0F equal to decimal 00-15. For example 10A represents Centralized Address 1-15. We recommend not
to use this option in future designs.
www.xdimax.com
© 2009 XDIMAX LTD
CoolMaster PRM
Rev 3.0
3
Commands Reference
3.1
Cool Master Commands
Commands Reference
7
Enter topic text here.
3.1.1
alloff
SYNOPSIS
alloff
DESCRIPTION
Turn off all indoor units
EXAMPLE
>alloff
OK
EXIT CODE
OK Request Successfully Executed
COMPATIBILITY
CoolMaster 1000D v 0.3.0
CoolMaster 2000S v 2.0.9
3.1.2
allon
SYNOPSIS
allon
DESCRIPTION
Turn on all indoor units.
EXAMPLE
>allon
OK
EXIT CODE
OK Request Successfully Executed
COMPATIBILITY
CoolMaster 1000D v 0.3.0
CoolMaster 2000S v 2.0.9
www.xdimax.com
© 2009 XDIMAX LTD
CoolMaster PRM
3.1.3
Rev 3.0
Commands Reference
8
boot
SYNOPSIS
boot
DESCRIPTION
Switch CoolMaster to bootloader mode. Bootloader mode is used for Firmware Update. For details
please see the Firmware Update section.
EXAMPLE
>boot
reboot...
COMPATIBILITY
CoolMaster 1000D v 0.3.0
CoolMaster 2000S v 2.0.9
3.1.4
cool
SYNOPSIS
cool <UID>
DESCRIPTION
Set indoor unit UID mode to COOL.
EXAMPLE
>cool 102
OK
EXIT CODE
OK
ERROR:1
Request Successfully Executed
Unit with specified UID not found
COMPATIBILITY
CoolMaster 1000D v 0.3.0
CoolMaster 2000S v 2.0.9
3.1.5
dry
SYNOPSIS
dry <UID>
DESCRIPTION
Set indoor unit UID mode to DRY.
EXAMPLE
>dry 102
OK
www.xdimax.com
© 2009 XDIMAX LTD
CoolMaster PRM
EXIT CODE
OK
ERROR:1
Rev 3.0
Commands Reference
9
Request Successfully Executed
Unit with specified UID not found
COMPATIBILITY
CoolMaster 1000D v 0.3.0
CoolMaster 2000S v 2.0.9
3.1.6
heat
SYNOPSIS
heat <UID>
DESCRIPTION
Set indoor unit UID mode to HEAT.
EXAMPLE
>heat 102
OK
EXIT CODE
OK
ERROR:1
Request Successfully Executed
Unit with specified UID not found
COMPATIBILITY
CoolMaster 1000D v 0.3.0
CoolMaster 2000S v 2.0.9
3.1.7
fan
SYNOPSIS
fan <UID>
DESCRIPTION
Set indoor unit UID mode to FAN.
EXAMPLE
>fan 102
OK
EXIT CODE
OK
ERROR:1
Request Successfully Executed
Unit with specified UID not found
COMPATIBILITY
CoolMaster 1000D v 0.3.0
CoolMaster 2000S v 2.0.9
www.xdimax.com
© 2009 XDIMAX LTD
CoolMaster PRM
3.1.8
Rev 3.0
Commands Reference
10
filt
SYNOPSIS
filt <UID>
DESCRIPTION
Reset filter sign on indoor unit UID.
EXAMPLE
>filt 102
OK
EXIT CODE
OK
ERROR:1
Request Successfully Executed
Unit with specified UID not found
COMPATIBILITY
CoolMaster 1000D v 0.3.1
CoolMaster 2000S v 2.0.9
3.1.9
fspeed
SYNOPSIS
fspeed <UID> <l|m|h|a>
DESCRIPTION
Set indoor unit UID fan speed to low, medium, high, auto.
EXAMPLE
>fspeed
OK
>fspeed
OK
>fspeed
OK
>fspeed
OK
101 l
Set unit 1-01 fan speed to low
101 m
Set unit 1-01 fan speed to medium
101 h
Set unit 1-01 fan speed to high
101 a
Set unit 1-01 fan speed to auto
EXIT CODE
OK
ERROR:1
Request Successfully Executed
Unit with specified UID not found
COMPATIBILITY
CoolMaster 1000D v 0.3.0
CoolMaster 2000S v 2.0.9
Only l and h options supported
3.1.10 off
SYNOPSIS
offl <UID>
www.xdimax.com
© 2009 XDIMAX LTD
CoolMaster PRM
Rev 3.0
Commands Reference
11
DESCRIPTION
Turn off indoor unit UID.
EXAMPLE
>off 102
OK
EXIT CODE
OK
ERROR:1
Request Successfully Executed
Unit with specified UID not found
COMPATIBILITY
CoolMaster 1000D v 0.3.0
CoolMaster 2000S v 2.0.9
3.1.11 on
SYNOPSIS
on <UID>
DESCRIPTION
Turn on indoor unit UID.
EXAMPLE
>on 102
OK
EXIT CODE
OK
ERROR:1
Request Successfully Executed
Unit with specified UID not found
COMPATIBILITY
CoolMaster 1000D v 0.3.0
CoolMaster 2000S v 2.0.9
3.1.12 set
SYNOPSIS
set [<option> <value>]
DESCRIPTION
Query or set CoolMaster configuration. Without parameters set command will list all supported
configuration options and their values. To change option use format with option and value. Some
options are read only and can not be changed.
Configuration Access Description
Option
Mode
S/N
Read CoolMaster Unit Serial Number
myid
R/W CoolMaster Unit own Centralized Address
www.xdimax.com
© 2009 XDIMAX LTD
CoolMaster PRM
Rev 3.0
version
echo
lcd
simul
Read
R/W
R/W
R/W
CS count
TO count
Read
Read
Commands Reference
12
Firmware Version
0-Disable 1-Enable Commands echo
LCD size
Number of Indoor units permanently simulated. If simul is not zero
CoolMaster will simulate given number of units after reset.
Check Sum errors counter
Timeout errors counter
EXAMPLE
S/N
:
myid
:
version :
echo
:
lcd
:
simul
:
CS count:
TO count:
OK
0041
0A
2.1.4
1
8
0
0
0
Query configuration
>set
OK
0
Set echo option (disable echo)
echo
EXIT CODE
OK
Request Successfully Executed
COMPATIBILITY
CoolMaster 1000D v 0.3.0
CoolMaster 2000S v 2.0.9
3.1.13 simul
SYNOPSIS
simul <N>
DESCRIPTION
Simulate N indoor units. Simulation mode can be used to debug Home Automation Controller software
without connecting CoolMaster to Air Conditioning system line. To exit simulation mode set N to zero or
restart CoolMaster.
EXAMPLE
>simul 20
OK
Simulate 20 Indoor Units
>simul
OK
Terminate simulation mode
0
EXIT CODE
OK
Request Successfully Executed
COMPATIBILITY
CoolMaster 1000D v 0.3.0
CoolMaster 2000S v 2.0.9
www.xdimax.com
© 2009 XDIMAX LTD
CoolMaster PRM
Rev 3.0
Commands Reference
13
3.1.14 stat
SYNOPSIS
stat [UID]
DESCRIPTION
Get Indoor unit(s) status. Specific indoor unit can be addressed by UID. If no UID provided in request,
response will contain information about all units
EXAMPLE
>stat
100 ON 12C
101 OFF 32C
102 ON 07C
103 OFF 01C
104 ON 04C
105 OFF 11C
106 ON 11C
107 ON 27C
OK
>stat 101
101 OFF 32C
OK
12,41C
04,93C
08,27C
26,84C
24,08C
07,23C
14,91C
12,94C
04,93C Low
RESPONSE
Position in String
0-2
4-6
8-10
12-17
20-23
25-28
30-32
EXIT CODE
OK
ERROR:1
High
Low
High
Med
High
Low
Auto
Med
Example
109
ON
23C
24,08C
Auto
Cool
OK
Cool
Dry
Dry
Dry
Dry
Dry
Dry
Cool
OK
OK
OK
OK
OK
OK
OK
OK
Dry
OK
Format
NNN
ON or OFF
NNC
NN,NNC
Low or Med or High or Auto
Cool or Heat or Fan or Dry
OK or XN
Description
Indoor unit Centralized Address
On/Off Status
Set Temperature ºC
Room Temperature ºC
Fan Speed
Operation Mode
OK or Failure code
Request Successfully Executed
Unit with specified UID not found
COMPATIBILITY
CoolMaster 1000D v 0.0.1
CoolMaster 2000S v 2.0.9
This command is obsolete and is supported only for backward compatibility.
3.1.15 stat2
SYNOPSIS
stat2 [UID]
DESCRIPTION
Get Indoor unit(s) status. Specific indoor unit can be addressed by UID. If no UID provided in request,
response will contain information about all units. stat2 compared to stat1 has additional Filter Reset
Sign indication
www.xdimax.com
© 2009 XDIMAX LTD
CoolMaster PRM
Rev 3.0
Commands Reference
14
EXAMPLE
>stat2
100 ON 12C
101 OFF 32C
102 ON 07C
103 OFF 01C
104 ON 04C
105 OFF 11C
106 ON 11C
107 ON 27C
OK
>stat2 101
101 OFF 32C
OK
RESPONSE
Position in String
0-2
4-6
8-10
12-17
20-23
25-28
30-32
34
EXIT CODE
OK
ERROR:1
12,41C
04,93C
08,27C
26,84C
24,08C
07,23C
14,91C
12,94C
High
Low
High
Med
High
Low
Auto
Med
04,93C Low
Cool
Dry
Dry
Dry
Dry
Dry
Dry
Cool
OK
OK
OK
OK
OK
OK
OK
OK
Dry
OK 0
Example
109
ON
23C
24,08C
Auto
Cool
OK
0
0
1
0
0
0
0
0
1
Format
NNN
ON or OFF
NNC
NN,NNC
Low or Med or High or Auto
Cool or Heat or Fan or Dry
OK or XN
0 or 1
Description
Indoor unit Centralized Address
On/Off Status
Set Temperature ºC
Room Temperature ºC
Fan Speed
Operation Mode
OK or Failure code
Filter Reset Sign present
Request Successfully Executed
Unit with specified UID not found
COMPATIBILITY
CoolMaster 1000D v 0.3.1
CoolMaster 2000S v 2.0.9
3.1.16 stat3
SYNOPSIS
stat3 [UID]
DESCRIPTION
Get Indoor unit(s) status. Specific indoor unit can be addressed by UID. If no UID provided in request,
response will contain information about all units. stat3 compared to stat2 has no fractional part in the
room temperature presentation.
EXAMPLE
>stat3
100 ON
101 OFF
102 ON
103 OFF
104 ON
www.xdimax.com
12C
32C
07C
01C
04C
12C
04C
08C
26C
24C
High
Low
High
Med
High
Cool
Dry
Dry
Dry
Dry
OK
OK
OK
OK
OK
0
1
0
0
0
© 2009 XDIMAX LTD
CoolMaster PRM
105 OFF 11C
106 ON 11C
107 ON 27C
OK
>stat3 101
101 OFF 32C
OK
Rev 3.0
15
07C Low Dry OK 0
14C Auto Dry OK 0
12C Med Cool OK 1
04C Low
RESPONSE
Position in String
0-2
4-6
8-10
12-14
16-19
21-24
26-27
29
EXIT CODE
OK
ERROR:1
Commands Reference
Dry
Example
109
ON
23C
24C
Auto
Cool
OK
0
OK 0
Format
NNN
ON or OFF
NNC
NNC
Low or Med or High or Auto
Cool or Heat or Fan or Dry
OK or XN
0 or 1
Description
Indoor unit Centralized Address
On/Off Status
Set Temperature ºC
Room Temperature ºC
Fan Speed
Operation Mode
OK or Failure code
Filter Reset Sign present
Request Successfully Executed
Unit with specified UID not found
COMPATIBILITY
CoolMaster 1000D v 2.0.9
CoolMaster 2000S v 2.0.9
3.1.17 swing
SYNOPSIS
swing <UID> <a|h|3|4|6|v>
DESCRIPTION
Set indoor unit <UID> swing to auto, horizontal, 30º, 45º, 60º or vertical. Not all indoor unit types
support swing.
EXAMPLE
>swing
OK
>swing
OK
>swing
OK
>swing
OK
>swing
OK
>swing
OK
101 a
Set unit 1-01 swing to auto
101 h
Set unit 1-01 swing to horizontal
101 3
Set unit 1-01 swing to 30º
101 4
Set unit 1-01 swing to 45º
101 6
Set unit 1-01 swing to 60º
101 v
Set unit 1-01 swing to vertical
EXIT CODE
www.xdimax.com
© 2009 XDIMAX LTD
CoolMaster PRM
OK
ERROR:1
Rev 3.0
Commands Reference
16
Request Successfully Executed
Unit with specified UID not found
COMPATIBILITY
CoolMaster 1000D
CoolMaster 2000S
CoolMaster 3000T
CoolMaster 4000M
N.A.
v2.3.1
v2.3.1
v2.3.1
3.1.18 temp
SYNOPSIS
temp <UID> [±]<TEMPERATURE>
DESCRIPTION
Set indoor unit temperature. <TEMPERATURE> parameter must be decimal number. Command can
work in relative or absolute manner. If plus '+' or minus '-' sign precede <TEMPERATURE> parameter
it's value will be used as requested delta. It means the set temperature will be increased (+) or
decreased (-) to that delta. Otherwise temperature will be set to the given value.
EXAMPLE
>temp 101 20
OK
Set unit 1-01 temperature to 20ºC
>temp
OK
>temp
OK
101
-1
Decrease unit 1-01 temperature by 1ºC
101
+3
Increase unit 1-01 temperature by 3ºC
EXIT CODE
OK
ERROR:1
Request Successfully Executed
Unit with specified UID not found
COMPATIBILITY
CoolMaster 1000D v 2.0.9
CoolMaster 2000S v 2.0.9
www.xdimax.com
© 2009 XDIMAX LTD
CoolMaster PRM
Rev 3.0
4
Firmware Update
4.1
Entering bootloader mode
Firmware Update
17
The process of updating CoolMatser's firmware is very simple and straightforward. First of all
CoolMaster has be switched into bootloader mode. In order to do so, please connect your PC (Laptop)
to the RS232 port of the CoolMaster. Next open the Hyper Terminal program and run boot command.
This process is described in "User Manual" document. At this point "BOOT" message should appear
on the LCD screen of the CoolMaster. Now it is ready for firmware uploading. Please close Hyper
Terminal program and follow to the next step - Firmware Download.
If for some reason CoolMaster is not responding to boot command or preceding firmware update has
failed and CoolMaster is not functioning at all, follow the next steps in order to enter bootloader mode.
Step1
Step2
4.2
Disconnect power supply from the
CoolMaster
Open CoolMaster top cover
Step3
Open BOOT jumper shown on the
diagram
Step4
Connect power supply to CoolMaster
Firmware Download
Firmware update is supplied as a set of BAT file(s) and firmware image(s). BAT file can be for
example progp-DAIKIN.bat and corresponding image file DAIKIN.INC. Make sure that BAT file and the
image file are located in same directory. In order to start the process, please simply run the BAT file.
After running BAT file, the ComPort selection prompt will appear and the correct port number should be
entered in order to proceed.
www.xdimax.com
© 2009 XDIMAX LTD
CoolMaster PRM
Rev 3.0
Firmware Update
18
CoolMaster will react with running address counter on its LCD screen. The whole process may take
about a few minutes, and it ends with "EOF" and shortly afterwards "READY" messages on the LCD
screen.
4.3
Reboot
After firmware downloading has being finished you need to power reset CoolMaster. If it was entered
bootloader mode with BOOT jumper, please make sure to close BOOT jumper back before power
reset.
www.xdimax.com
© 2009 XDIMAX LTD
Index
Index
-AAirNet
14
-Bboot
8
-Ccool
7, 8
-Ddry
8
-Ffan 9, 10
filt 10
Filter Sign 10, 13, 14
-Hheat
9
-Ooff
on
10
11
-Sset 11
simul 12
stat 13
stat2 13
stat3 14
swing 15
© 2009 XDIMAX LTD
19