|
|
| (One intermediate revision by the same user not shown) |
| Line 1: |
Line 1: |
| − | The Modbus functionality of CoolMasterNet is fully described in [http://coolautomation.com/lib/doc/CoolMasterNet/manual/CoolMasterNet-Modbus-guidelines.pdf '''Modbus Integration Guidelines'''] document
| + | [[https://support.coolautomation.com/hc/en-us/article_attachments/12455777507485 Modbus Integration Guidelines]] |
| − | | |
| − | == Modbus IP Server Configuration ==
| |
| − | CoolMasterNet Modbus IP Server is activated with below command:
| |
| − | {{Terminal|
| |
| − | >'''modbus IP enable'''<br>
| |
| − | OK, Boot Required!<br>
| |
| − | >}}
| |
| − | CoolMasterNet has to be restarted to run Modbus IP server for the first time. Same way Modbus IP server can be disabled, in this case instead of '''enable''' type '''disable'''<br>
| |
| − | To quire current Modbus IP server configuration use '''modbus''' command without parameters:
| |
| − | {{Terminal|
| |
| − | >'''modbus'''<br>
| |
| − | ModBus IP : enabled<br>
| |
| − | server port : 502<br>
| |
| − | CG4 ignore : none<br>
| |
| − | OK<br>
| |
| − | >}}
| |
| − | Modbus IP default TCP/IP port is 502. This is one of the so called well-known Ethernet ports. If required, port number can be changed with:
| |
| − | {{Terminal|
| |
| − | >'''modbus server port 500'''<br>
| |
| − | OK, Boot Required!<br>
| |
| − | >}}
| |
| − | Again restart required to let port change take effect. Modbus IP Server configurations are persistent over power resets, they are stored in nonvolatile memory.
| |
| − | | |
| − | <div id="ModbusIP_VA"></div>
| |
| − | == Virtual Address (VA) Concept ==
| |
| − | In order to simplify translation of the UID (like '''L5.102''') into Modbus object address, CoolMasterNet uses VA, associated with UID. Each UID can have none, one or a number of associated VA's. VA's are plain numbers starting from 001 (decimal). To let CoolMasterNet automatically associate VA's with existing (visible with '''ls''' command) UID's run:
| |
| − | {{Terminal|
| |
| − | >'''va auto'''<br>
| |
| − | OK<br>
| |
| − | >}}
| |
| − | This command will delete all existing associations and will create new associations one to one (one VA to one UID). At any time VA associations list can be retrieved with plain '''va''' command:
| |
| − | {{Terminal|
| |
| − | >'''va'''<br>
| |
| − | L1.101 --> 001 [Hex: 0x0011 | Dec: 00017]<br>
| |
| − | L1.102 --> 002 [Hex: 0x0021 | Dec: 00033]<br>
| |
| − | L1.103 --> 003 [Hex: 0x0031 | Dec: 00049]<br>
| |
| − | L1.104 --> 004 [Hex: 0x0041 | Dec: 00065]<br>
| |
| − | L1.105 --> 005 [Hex: 0x0051 | Dec: 00081]<br>
| |
| − | OK<br>
| |
| − | >}}
| |
| − | Hex and Dec numbers printed after VA are Base Address used to access Modbus objects related to UID-VA association. Base Address can be calculated as '''''BaseAddress = VA*16 + 1'''''. For example Indoor Unit L1.102 has associated VA = 002, thus Base Address = 2*16+1 = 33.
| |
| − | | |
| − | == VA Command details ==
| |
| − | '''va auto''' - CoolMasterNet will automatically associate VA's with existing UID's. This will delete previous associations<br>
| |
| − | '''va delall''' - delete all VA associations<br>
| |
| − | '''va - <UID>''' - delete all VA associations with specific UID<br>
| |
| − | '''va - <VA>''' - delete specific VA association<br>
| |
| − | '''va + <UID> <VA>''' - add new VA association<br>
| |
| − | | |
| − | Examples:<br>
| |
| − | | |
| − | Associate VA 007 with Indoor Unit L1.100
| |
| − | {{Terminal|
| |
| − | >'''va + L1.100 7'''<br>
| |
| − | OK<br>
| |
| − | >}}
| |
| − | Delete all VA associations of Indoor Unit L1.101
| |
| − | {{Terminal|
| |
| − | >'''va - L1.101'''<br>
| |
| − | OK<br>
| |
| − | >}}
| |
| − | | |
| − | == Discrete Inputs, Coils and Registers ==
| |
| − | Once the Base Address is determined, access to the specific Indoor Unit parameter(s) is done via Modbus objects listed below.
| |
| − | {| class="wikitable"
| |
| − | |-
| |
| − | | Base<br>Address
| |
| − | ! Discrete<br>Inputs
| |
| − | ! Coils
| |
| − | ! Holding<br>Registers
| |
| − | ! Input<br>Registers
| |
| − | |-
| |
| − | | +0
| |
| − | | rowspan="9" | Reserved
| |
| − | | On/Off
| |
| − | | [[#Mode|Operation Mode]]
| |
| − | | [[#UID|UID]]
| |
| − | |-
| |
| − | | +1
| |
| − | | Filter Sign
| |
| − | | [[#Fspeed|Fan Speed]]
| |
| − | | Room Temperature x10
| |
| − | |-
| |
| − | | +2
| |
| − | | Terminals Status<br>0-Open,<br>1-Closed
| |
| − | | Set Temperature x10 °C
| |
| − | | Failure Code String<br> first two characters
| |
| − | |-
| |
| − | | +3
| |
| − | | rowspan="6" | Reserved
| |
| − | | On/Off
| |
| − | | Failure Code String<br> last two characters
| |
| − | |-
| |
| − | | +4
| |
| − | | Filter
| |
| − | | rowspan="9" | Reserved
| |
| − | |-
| |
| − | | +5
| |
| − | | [[#Swing|Swing]]
| |
| − | |-
| |
| − | | +6
| |
| − | | Room Temperature x10 °C (RO)
| |
| − | |-
| |
| − | | +7
| |
| − | | Failure Code (RO)
| |
| − | |-
| |
| − | | +8
| |
| − | | [[#Lockbits|Lock Bits]]
| |
| − | |-
| |
| − | | +9
| |
| − | | Digital Input 1
| |
| − | | Digital Output 1
| |
| − | | [[#STLimits|Set Temperature Limits (v0.4.4)]]
| |
| − | |-
| |
| − | | +10
| |
| − | | Digital Input 2
| |
| − | | Digital Output 2
| |
| − | | rowspan="6" | Reserved
| |
| − | |-
| |
| − | | +11
| |
| − | | Digital Input 3
| |
| − | | Digital Output 3
| |
| − | |-
| |
| − | | +12
| |
| − | | Digital Input 4
| |
| − | | Digital Output 4
| |
| − | |-
| |
| − | | +13
| |
| − | | Digital Input 5
| |
| − | | Digital Output 5
| |
| − | | Analog Input 1
| |
| − | |-
| |
| − | | +14
| |
| − | | Digital Input 6
| |
| − | | Digital Output 6
| |
| − | | Analog Input 2
| |
| − | |-
| |
| − | | +15
| |
| − | | Reserved
| |
| − | | Reserved
| |
| − | | Reserved
| |
| − | |}
| |
| − | | |
| − | <span id="UID">'''UID Encoding'''</span>
| |
| − | {| class="wikitable"
| |
| − | |-
| |
| − | |MSB<br>Bits 15..12
| |
| − | | <br>Bits 11..8
| |
| − | |LSB<br>Bits 7..0
| |
| − | |-
| |
| − | | Ln
| |
| − | | X
| |
| − | | YY
| |
| − | |-
| |
| − | |}
| |
| − | Corresponds to Ln.XYY (like for example L1.102)
| |
| − | | |
| − | <br>
| |
| − | <span id="Mode">'''Operation Mode Encoding'''</span>
| |
| − | {| class="wikitable"
| |
| − | |-
| |
| − | |'''0''' - Cool
| |
| − | |'''1''' - Heat
| |
| − | |'''2''' - Auto
| |
| − | |'''3''' - Dry
| |
| − | |-
| |
| − | |'''4''' - HAUX
| |
| − | |'''5''' - Fan
| |
| − | |'''6''' - HH
| |
| − | |
| |
| − | |-
| |
| − | |'''8''' - VAM Auto
| |
| − | |'''9''' - VAM Bypass
| |
| − | |'''10''' - VAM Heat Exch.
| |
| − | |'''11''' - VAM Normal
| |
| − | |}
| |
| − | | |
| − | <br>
| |
| − | <span id="Fspeed">'''Fan Speed Encoding'''</span>
| |
| − | {| class="wikitable"
| |
| − | |-
| |
| − | |'''0''' - Low
| |
| − | |'''1''' - Medium
| |
| − | |'''2''' - High
| |
| − | |-
| |
| − | |'''3''' - Auto
| |
| − | |'''4''' - Top
| |
| − | |'''5''' - Very Low
| |
| − | |-
| |
| − | |
| |
| − | |'''7''' - VAM Super High
| |
| − | |'''8''' - VAM Low Fresh Up
| |
| − | |-
| |
| − | |'''9''' - VAM High Fresh Up
| |
| − | |
| |
| − | |
| |
| − | |-
| |
| − | |}
| |
| − | | |
| − | <br>
| |
| − | <span id="Swing">'''Swing Encoding'''</span>
| |
| − | {| class="wikitable"
| |
| − | |-
| |
| − | |'''0''' - Vertical
| |
| − | |'''1''' - 30 deg
| |
| − | |'''2''' - 45 deg
| |
| − | |'''3''' - 60 deg
| |
| − | |-
| |
| − | |'''4''' - Horizontal
| |
| − | |'''5''' - Auto
| |
| − | |'''6''' - OFF
| |
| − | |
| |
| − | |}
| |
| − | | |
| − | <span id="STLimits">'''Set Temperature Limits Encoding'''</span>
| |
| − | {| class="wikitable"
| |
| − | |-
| |
| − | |MSB<br>Bits 15..8
| |
| − | |LSB<br>Bits 7..0
| |
| − | |-
| |
| − | | High Limit * 2
| |
| − | | Low Limit * 2
| |
| − | |-
| |
| − | |}
| |
| − | | |
| − | <span id="Lockbits">'''Lock Bits Encoding'''</span>
| |
| − | {| class="wikitable"
| |
| − | |-
| |
| − | |MSB<br>Bit 15..3
| |
| − | |Bit 2
| |
| − | |Bit 1
| |
| − | |LSB<br>Bit 0
| |
| − | |-
| |
| − | |Reserved
| |
| − | |Inhibit Local Wall Thermostat<br> '''Set Temperature''' control
| |
| − | |Inhibit Local Wall Thermostat<br> '''Mode''' control
| |
| − | |Inhibit Local Wall Thermostat<br> '''On/Off''' control
| |
| − | |-
| |
| − | |}
| |
