H1 interface developers manual

H1 interface developers manual
Firmware version 17.01
©2013-2017, Husdata.se, Arandis AB
Norra Pitholmsvägen 14, 941 46 Piteå, SWEDEN
support@arandis.se
H1 Interface developers manual. © 2013-2017 Arandis AB
_______________________________________________________________________________________
1
Overview of solution
The H1 interface bridges the often complex communication methods with a heat pump
controllers and provides access through a simple standard interface over RS-232.
The interfacing on the computer side is the same even if connected to different heat pump
models.
For example, reading the radiator return temperature or setting the room temp will use the
same method on IVT, NIBE, Thermia heat pumps and their different models.
The interface has hardware and software support for different connectivity with heat pumps.
When interfaces are manufactured, the interfacing circuit for the relevant heat pump is
implemented and the specific firmware is loaded into the controller.
Features summary












Available in two versions. The standard using the H1-protocol or the optional using
the Modbus protocol. The H1-protocol is easier to use and provides more functionality
but the Modbus protocol is compatible with PLC:s and commercial equipment.
Available with USB (standard) or RS-232 interface.
Available in Standard cable connected model, or Raspberry PI PCB formats to fit
directly on GPIO connector.
Interface provides a generic platform to communicate with different heat pumps using
the same standard protocol and parameters.
Provides a secure and convenient way to read and write information to and from heat
pump controllers.
Interface is provided in different hardware configuration, supporting the majority of
all popular heat pump models.
Features galvanic insulation (RS-232 version), electrically separating the heat pump
from the connected equipment.
Firmware upgradable via the serial interface and Windows based upgrade program.
A LED indicator shows status and enables for troubleshooting.
Has support for Dallas 1-wire sensors. Up to 16 can be connected. (not supported)
Has support for Electrical meter S0 or Led-eye connection. Up to 2 electrical meters
can be connected.
Easy clear text based protocol in clear text manageable directly from serial terminal
H1 Interface developers manual. © 2013-2017 Arandis AB
_______________________________________________________________________________________
2
H1-Protocol interface type (standard)
Serial interface specifications
Interface:
Baud rate:
Bits:
Stop bits:
Flow control
Protocol:
RS-232 or USB(serial), Modbus with RS-232 or RS-485
19200
8
1
none
H1-Proprietary as described in this manual.
Communication structure
All communication is made in plain text and all numbers are in hexadecimal format. Tests of
communications can be managed from standard terminal software, such as Putty.
Data received from the interface has a two letter command structure + data and always end
with chr 13 + chr 10 (Carriage Return + New Line, \r\n).
The command sent to the interface is always two capital letters followed by optional data and
an ending (cr).
H1 Interface developers manual. © 2013-2017 Arandis AB
_______________________________________________________________________________________
3
When powering up the interface (getting power from the heat pump) it first displays copyright
information like below, followed by version information. This information is also shown at
reset. You can manually reset the interface by sending the letter "!".
(C)2013-2017 Arandis AB, Pitea Sweden.
http://www.husdata.se
XV401028
The version information start with XV followed by three hexadecimal bytes.
1. Firmware/Interface variant for different heat pump types.
Rego600, Rego400, Rego80, Rego1000, NIBE EB100, NIBE Styr2002,
Thermia Diplomat, Thermia Villa.
2. Version
3. Revision
After this message is displayed, the communication with the heat pump will initialize. It can
take up to 30 seconds depending on heat pump model.
The registers on the heat pump is then automatically acquired by the interface and will be
output continuously via the serial interface. After all registers are read once, the interface will
only output data if something changes. For example if a temperature is changed on a sensor, it
will output the new value.
If all values need to be refreshed the Re-sync command can be called by the command XR.
Registers
The interface firmware has a common set of pre-programmed heat pump registers to be read
and written to. These registers are listed at the end of this document.
The register data format is a 2 byte number, ex 0101. The leftmost number (4 bits)
representing the data type and the rest is the actual index number. For example on 0001, the
left 0 indicating that this is a temperature. 001 indicating the Radiator return sensor index
number. And likewise 1A01, 1 is indicating that this is a bool on/off device. and A01
indicating index for the Compressor.
No
0
1
2
3
4
5
6
7
8
9
A
Unit / Data type
Degrees
On/off bool
Number
Percent
Ampere
kWh
Hours
Minutes
Degree minutes
kw
Pulses
Additional info
Divide by 10
0 or 1
Divide by 10
Divide by 10
Divide by 10
Divide by 10
As is
As is
As is
As is
As is (For S0 El-meter pulse counter)
H1 Interface developers manual. © 2013-2017 Arandis AB
_______________________________________________________________________________________
4
There are two types of registers. The "Common" and the "HP-Specfic" registers.
The interface is continuously syncing with the Common registers and will output any change.
A Common register consists of sensor information, status of devices (compressor, pumps,
valves), a few standard settings and a some other controller parameter such as Degree
minutes. The Common registers has a common structure and id's for all heat pump models.
With the "XL" command will get a list of all available registers for to connected heatpump
and with the "XP" command you have the option to turn on clear text register names and
values shown in decimal. This feature is convenient for test and debug.
The HP-Specific registers will only be read and output if the "XS" command is sent. These
registers are unique for every heat pump model. You can set/write to some of the HP-Specific
registers using the "XW" command. Please see tables in the end of this document for details.
Example of register data output from the interface
XR00010106(cr)
0x0001=reg Radiator return of temp type (0)
0x0106=data (0x01*256)+0x06 = 262 = 26.2 deg C
XR00030198(cr)
0x0003=reg Heat carrier return of temp type (0)
0x0198=data (0x01*256)+0x98 = 408 = 40.8 deg C
XR0006FFE6(cr)
0x0001=reg Cold carrier out of temp type (0)
0xFFE6 and 0x8000 = true (left most bit set=negative)
0xFFE6=data ((0xFF*256)+0xE9)-65536 = -2.3 deg C
XR1A040001(cr)
0x1A04=reg Radiator return of on/off type (1)
0x0001=data ON
Example of data output from the interface with clear text output turned on (XP)
XR000200ED
XR0003018A
XR000400E9
XR00050075
XR00060057
XR0007FF6A
XR0008DEAD
XR000901D3
XR000B024A
XR000E0000
XR002000D9
XR00210000
XR1A010001
XR1A040001
XR1A050001
XR1A060001
XR1A070000
XR1A090000
XR1A0A0001
XR1A0B0001
XR1A0C0000
XR1A0D0000
XR1A200000
002
003
004
005
006
007
008
009
00B
00E
020
021
A01
A04
A05
A06
A07
A09
A0A
A0B
A0C
A0D
A20
Radiator Forward (23.7c)
Heat carrier Return (39.4c)
Heat carrier Forwrd (23.3c)
Brine in/Evaporator (11.7c)
Brine out/Condenser (8.7c)
Outdoor (-15.0c)
Indoor (-853.1c)
Hot water 1 / Top (46.7c)
Hot gas / Compr. (58.6c)
Air intake (0.0c)
Radiator Forward 2 (21.7c)
Indoor 2 (0.0c)
Compressor (1.0 )
Pump Cold circuit (1.0 )
Pump Heat circuit (1.0 )
Pump Radiator (1.0 )
Switch valve 1 (0.0 )
Fan (0.0 )
High Pressostat (1.0 )
Low Pressostat (1.0 )
Heating cable (0.0 )
Crank case heater (0.0 )
Alarm (0.0 )
H1 Interface developers manual. © 2013-2017 Arandis AB
_______________________________________________________________________________________
5
Commands for the H1 Interface.
Data to interface
Command
Function
XV
Request version number
XR
Request read and dump of Real-time
registers
XS
Request read and dump of heat pump
specific registers
XWrrrrdddd
Set a register value on HP.
rrrr=register, dddd=data.
XL
Request list of register names
XP
Toggle clear text register names print
out
XM
Enable auto refresh of all registers
every second minute. default=off
XA
Disable auto read registers and output
change.
XO
Enable auto read registers and output
on change. default = on
XU
Enable simulator mode. Will output
random data every second.
RP1, RP0
Enable/disable Can bus activity
printout
SA
SP
SS
WE
WR
XBxx
Toggle OFF/ON to printout collected
pulses every 10 sec. Default=on
Print out collected pulses and reset
counter.
Set S0 port 1 to Input port instead to
detect an on/off state.
Scan for 1-wire temp sensors and
return all ID's
Read all 1-wire temp sensors and dump
result.
Read alarm logs XB=Last log, XB05 = 5
last logs, etc. Max 20.
Support only for Rego 600 and
Rego2000.
Data from interface
Input
Description
XRrrrrdddd(cr)
Receive new data from a register.
rrrr= Reg ID, dddd=data.
XV040304
Interface version
WRxxxxxxxxpptt(cr)
XE002
XE005
XE006
Example / Returns
XV010304(cr)
XR(cr)
XS(cr)
XW010600AA(cr)
XW01(ok)
XL(cr)
XP(cr)
Warmwater (35.2c)
Only available on
rego600 firmware.
Only rego800/1000
XB010E0B1B0D3130
Or
XB1540 (R2000)
See below for desc.
Usage Example
Return DS temp: x=8 bytes DS-ID,
pp=00=+ FF=Info. Rego1000 interface was
moved to other Rego version, resynchronizing.
Can bus communication error,
Check cables (Rego 800/1000 only)
Fatal error identifying Rego1000
version. Contact Husdata.se
H1 Interface developers manual. © 2013-2017 Arandis AB
_______________________________________________________________________________________
6
XE007
XI024
XI025
XB010E0B1B0D3130
XB1540
XB1541
XB1542
Unsupported Rego800 version
detected, switching to
compatibility mode.
NIBE EB100 detected comm alarm,
will be reset in 10 minutes
NIBE EB100 alarm has been reset
XB 01 0E0B1B 0D3130
01 = Alarm Code
Next part is date YYMMDD
Last part is Time HHMMSS
Rego 600 only
XB 1540
1540 = alarmcode
1540h= 5440 HP Alarm
Command XB always answers with 3
rows of alarmcodes. 0000= no
alarm.
For Rego 600 Only
For Rego 2000 Only
H1 Interface developers manual. © 2013-2017 Arandis AB
_______________________________________________________________________________________
7
Modbus protocol interface type (optional)
Serial interface specification (Modbus)
Interface:
RS-232 or RS-485
Baud rate: 19200 but can special ordered for other baudrate
ID:
8 but can be special ordered for other ID:s
Protocol:
Modbus
Modbus command implementation




COIL_STATUS, Read one or many. First register: 1, 0x0001
Used for compressor, pumps, valves, etc.
INPUT_REGISTERS, read one or many. First register: 30001, 0x7501
Used for temp sensors
HOLDING_REGISTERS, read one or many. First register: 40001, 0x9C01
Read settings like heat curve or temp set.
SET_REGISTERS, Set heat curve or indoor temp. First register: 40001, 0x9C01
H1 Interface developers manual. © 2013-2017 Arandis AB
_______________________________________________________________________________________
8
General information
Supported heat pump models
Type
A
B
C
D
E
F
G
H
I
SW
00
05
35
30
40
50
60
70
10
HW
R
I
C
C
N
N
D
D
E
Heat pump models
IVT Greenline / Optima 900
IVT 490
IVT Premiumline X, Optima/290-AW
IVT Greenline HE/HC/HA+Prem HQ/EQ
NIBE xx45
NIBE Fighter series
Thermia Diplomat series
Thermia Villa series *
IVT AirX, Geo312, Vent202
Technical
Rego 600 Serial
Rego 400 Serial
Rego 800, Can bus
Rego 1000, Can bus
EB100, RS-485
Styr 2002, RS-485
901510, i2c
901353, i2c
Rego 2000
* Not released yet
Common registers
H1-ID
(hex)
0001
0002
0003
0004
0005
0006
0007
0008
0009
000A
000B
000C
000D
000E
000F
0010
0011
0012
Temperatures
Unit
System availability
Radiator Return
Radiator Forward
Heat carrier Return
Heat carrier Forward
Brine In / Evaporator
Brine Out / Condenser
Outdoor
Indoor
Hot water 1 / Top
Hot water 2 / Mid
Hot gas / Compressor
Suction gas
Liquid flow
Air intake
Exhaust air
Air outlet
Pool
Pressure tube
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
ABCDEFG
B
G
ABCDE
ABCDEF
A CDEFG
A CDEFG
ABCDEFG
ABCDEFG
ABCDEFG
ABCDEF
ABCDEF
EF
EF
A CD
A C EF
A
EF
C EF
G
0020
0021
HC2: Radiator Forward
HC2: Indoor
Degrees
Degrees
D
ID
4101
4102
4103
x104
2105
Other registers
Load L1
Load L2
Load L3
Add heat status
Degree minutes/integral
Unit
Ampere
Ampere
Ampere
kW or %
Number
System availability
EF
EF
EF
A CD-%, E-kW
EFG
Heating Setpoint
Compressor speed
Circ. pump speed
Brine pump speed
Degrees
%
%
%
ABCDEFG
CD
G I
G
0107
3108
3109
3110
Modbus
(hex)
7531
7532
7533
7534
7535
7536
7537
7538
7539
753A
753B
753C
753D
753E
753F
7540
7541
7542
I
I
I
I
I
I
I
I
I
I
I
GT3x on A
I
H1 Interface developers manual. © 2013-2017 Arandis AB
_______________________________________________________________________________________
9
0111
0208
0120
Hot water Setpoint
Hot water Stoptemp
HC2: Heating Setpoint
Degrees
Degrees
Degrees
AFF1
AFF2
Collected Pulses meter 1
Collected Pulses meter 2
Pulses
Pulses
ID
2201
2202
0203
2204
x205
x206
x207
X208
Settings
Operating mode 1
Operating mode 2
Room temp target
Room sensor influence
Heat set 1, Curve Left
Heat set 2, Curve Right
Heat set 3, Curve Parallel
Hot Water Stop temp
Unit
Number
Number
Degrees
Number
Num/Degr
Num/Degr
Num/Degr
A CDEF
A CDEF
A CDEF
CD
A
EF
HC2:
HC2:
HC2:
HC2:
Degrees
Num/Degr
Num/Degr
Num/Degr
D F
D
F
9C41
9C42
9C43
9C44
0220
0222
0223
0224
ID
1A01
1A02
1A03
1A04
1A05
1A06
1A07
1A08
1A09
1A0A
1A0B
1A0C
1A0D
1A0E
1A0F
1A19
2A20
0001
0002
0003
0004
0005
0006
0007
0008
0009
000A
000B
000C
000D
000E
Room temp target
Curve Left
Curve Right
Curve Parallel
Status
Compressor
Add heat step 1
Add heat step 2
Pump Cold circuit
Pump Heat circuit
Pump Radiator
Switch valve 1
Switch valve 2
Fan
High Pressostat
Low Pressostat
Heating cable
Crank shaft heater
Shunt open
Shunt close
Add Heat step 3
Alarm
Unit
On/Off
On/Off
On/Off
On/Off
On/Off
On/Off
On/Off
On/Off
On/Off
On/Off
On/Off
On/Off
On/Off
On/Off
On/Off
On/Off
Number
B D
G
FG
D
<all>
<all>
E
System availability
ABCDEFG I
AB
FG I
AB
FG I
A CDEFG
A CDEF I
AB
G
A CDEFG I
BCD
BCD
BCD
CD
CD
B
B
I
F
ABCDEF
I
I
I
IVT Rego 1000 specific registers
ID(hex)
Settings writable
Unit
2F00
2F01
2F02
Program Generation
Program Version
Program Revision
Number
Number
Number
Min/Max
Rego 800 specific registers
ID(hex)
0F50
0F51
0F52
0F53
Read
Adj.
Adj.
Adj.
Adj.
only registers
curve at 20° out
curve at 15° out
curve at 10° out
curve at 5° out
Unit
Degrees
Degrees
Degrees
Degrees
Min/Max Comment
Only Optima
Only Optima
Only Optima
Only Optima
H1 Interface developers manual. © 2013-2017 Arandis AB
_______________________________________________________________________________________
10
0F54
0F55
0F56
0F57
0F58
0F59
0F5A
0F5B
Adj.
Adj.
Adj.
Adj.
Adj.
Adj.
Adj.
Adj.
curve
curve
curve
curve
curve
curve
curve
curve
at
at
at
at
at
at
at
at
0° out
-5° out
-10° out
-15° out
-20° out
-25° out
-30° out
-35° out
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Only
Only
Only
Only
Only
Only
Only
Only
Optima
Optima
Optima
Optima
Optima
Optima
Optima
Optima
0F60
0F61
0F62
6F63
6F64
6F65
6F66
6F67
Additional power
VV GT3 Start temp
VV GT9 Stopp temp
Runtime Comp rad
Runtime Comp vv
Runtime controller
Runtime additional rad
Runtime additional
Degrees
Degrees
Degrees
Hours
Hours
Hours
Hours
Hours
Only
Only
Only
Only
Only
on
on
on
on
on
Min/Max
some
some
some
some
some
reg
reg
reg
reg
reg
ver
ver
ver
ver
ver
Rego 600 specific registers
ID(hex)
Settings writable
Unit
0F50
0F51
0F52
0F53
0F54
0F55
0F56
0F57
0F58
0F59
0F5a
0F5b
Adj.
Adj.
Adj.
Adj.
Adj.
Adj.
Adj.
Adj.
Adj.
Adj.
Adj.
Adj.
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
0F61
0F62
0F63
0F64
0F65
0F66
0F67
0F68
GT1 On value
GT1 On EL value
GT1 Off EL value
GT1 Off value
GT3 On value
GT3 Off value
GT4 Target value
Heat curve coupling
curve
curve
curve
curve
curve
curve
curve
curve
curve
curve
curve
curve
at
at
at
at
at
at
at
at
at
at
at
at
20° out
15° out
10° out
5° out
0° out
-5° out
-10° out
-15° out
-20° out
-25° out
-30° out
-35° out
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Degrees
Rego600 Alarm codes
Alarm no
0
1
Description
No Alarm
Sensor radiator return (GT1)
H1 Interface developers manual. © 2013-2017 Arandis AB
_______________________________________________________________________________________
11
2
1
2
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Outdoor sensor (GT2)
Sensor hot water (GT3)
Mixing valve sensor (GT4)
Room sensor (GT5)
Sensor compressor (GT6)
Sensor heat tran fluid out (GT8)
Sensor heat tran fluid in (GT9)
Sensor cold tran fluid in (GT10)
Sensor cold tran fluid in (GT11)
Compresor circuit switch
Electrical cassette
HTF C=pump switch (MB2)
Low pressure switch (LP)
High pressure switch (HP)
High return HP (GT9)
HTF out max (GT8)
HTF in under limit (GT10)
HTF out under limit (GT11)
Compressor superhear (GT6)
3-phase incorrect order
Power failure
Thermia Alarm codes
Bit mask
0
8
4
2
Description
No Alarm
Warm water sensor failure
Return sensor failure
Forward sensor failure
H1 Interface developers manual. © 2013-2017 Arandis AB
_______________________________________________________________________________________
12
Styr2002 NIBE 1245 specific registers (not verified, use at own risk)
ID(hex)
0F08
0F09
0F0A
0F0B
0F0C
Settings writable
M1.6 : Stopp extra varmvatten
M1.7 : Stopp kpr extra varmvatten
M1.8 : Intervall periodiskt XVV
M1.10 : Drifttid varmvatten (min)
M1.10 : Drifttid varmvatten (h)
0F0D
0F0E
0F0F
0F11
M2.3
M2.4
M2.5
M2.7
:
:
:
:
Mintemp. framledning
Maxtemp. framledning
Kompensering yttre
Max returtemperatur
0F14
0F17
0F18
0F19
0F1A
M3.0
M3.3
M3.4
M3.5
M3.7
:
:
:
:
:
Beräknad framledningstemp 2
Mintemp. framledning 2
Maxtemp. framledning 2
Kompensering yttre 2
Returledningstemperatur 2
Unit
Min/Max
Disclaimer
The information in this document is valid for a specific interface firmware and is subject to be
changed on later releases. We reserve us from incorrect information in this
document.
H1 Interface developers manual. © 2013-2017 Arandis AB
_______________________________________________________________________________________
13