ComfoAir Binding modified

Expanded ComfoAir binding v.1x for openHAB based on original org.openhab.binding.comfoair v. 1.3.0 written by Holger Hees.

This binding was tested with the Zehnder ComfoAir 350 device. Most commands should work with: ComfoAir 550, WHR930 of StorkAir, G90-380 by Wernig and Santos 370 DC to Paul.

What's new in this binding ?

Many new commands (read and write) have been added in this binding. The program code was also changed so the sending of the write commands is possible and did not cause problems with the operation of the device.
Original binding provided 22 commands, including 5 write commands only (eg it allowed to control ventilation levels and reset errors). This new binding provides 160 commands, including 71 write commands. This gives you the ability to control all ComfoAir settings, available in menus 10 - 90, and even more. This allows for full control of the device.

List of commands (original and new ones).

Command	Read / Write	Possible value	Description
activate	read - write	0, 1	ComfoAir control: 0 – controled by CC Ease, 1 – controled by PC (CC Ease is turned off)
Commands that take over the CC Ease functions
fan_level	read - write	1, 2, 3, 4	Ventilation level: 1 – level A (absence state) 2 – level 1 (low) 3 – level 2 (medium) 4 – level 3 (high)
target_temperatur	read - write	15 ÷ 25 °C step 0,5	Controlling the comfort temperature
filter_error	read	0, 1	Exceed filter replacement time (depends on the filter replacement period set in ComfoAir): 0 – time has not been exceeded 1 – time out
filter_error_intern	read	0, 1	Contamination of internal filters inside ComfoAir: 0 – filters clean 1 – filters dirty
filter_error_extern	read	0, 1	Contamination of external filters (on the ventilation duct): 0 – filters clear 1 – filters dirty
filter_reset	write	1	Reset the number of filter operating hours
error_message	read	string	Current errors: A, A-high, E, EA
bypass_mode	read	0, 1	Bypass 0 – closed 1 – opened
ewt_mode	read	0, 1	Geothermal heat exchanger – EWT 0 – off 1 – on
preheater_mode	read	0, 1	Preheater 0 – off 1 – on
enthalpy_mode	read	0, 1, 2	Enthalpy exchanger 0 – off 1 – on 2 - on with sensor
freeze_mode	read	0, 1	Frozen ComfoAir 0 – normal work 1 – frozen
cookerhood_mode	read	0, 1	Cooker hood 0 – off 1 – on
Menu 10
menu20_mode	read	0, 1	Menu 20 (P10) 0 – off 1 – on
menu21_mode	read	0, 1	Menu 21 (P11) 0 – off 1 – on
menu22_mode	read	0, 1	Menu 22 (P12) 0 – off 1 – on
menu23_mode	read	0, 1	Menu 23 (P13) 0 – off 1 – on
menu24_mode	read	0, 1	Menu 24 (P14) 0 – off 1 – on
menu25_mode	read	0, 1	Menu 25 (P15) 0 – off 1 – on
menu26_mode	read	0, 1	Menu 26 (P16) 0 – off 1 – on
menu27_mode	read	0, 1	Menu 27 (P17) 0 – off 1 – on
menu28_mode	read	0, 1	Menu 28 (P18) 0 – off 1 – on
menu29_mode	read	0, 1	Menu 29 (P19) 0 – off 1 – on
Menu 20
cookerhood_delay	read - write	0 ÷ 180 min	Overrun timer for the extractor hood programme. (P20)
bathroom_start_delay	read - write	0 ÷ 15 min	Delay timer for the start position of the bathroom switch (to switch to high position). (P21)
bathroom_end_delay	read - write	0 ÷ 120 min	Overrun timer for the bathroom switch (to switch to normal position). (P22)
level3_delay	read - write	0 ÷ 120 min	Overrun timer for ventilation position 3 (using a wired 3-position switch). (P23)
filter_period	read - write	10 ÷ 26 weeks	Filter replacement counter (P24)
RF_low_delay	read - write	1 ÷ 20 min	RF high – short time (< 2 s) (P25)
RF_high_delay	read - write	1 ÷ 120 min	RF high – logn time (> 2 s) (P26)
L1_end_delay	read - write	0 ÷ 120 min	Time for the Boost setting (3 level ventilation e.g. PARTY PROGRAM) (P27)
cookerhood_speed	read - write	%	Setting the extractor hood ventilation levels (P29)
Menu 30
fan_out_0	read - write	0 ÷ 97 %	Capacity of the exhaust fan – level A (P30)
fan_out_1	read - write	16 ÷ 98 %	Capacity of the exhaust fan – level 1 (P31)
fan_out_2	read - write	17 ÷ 99 %	Capacity of the exhaust fan – level 2 (P32)
fan_out_3	read - write	18 ÷ 100 %	Capacity of the exhaust fan – level 3 (P33)
fan_in_0	read - write	0 ÷ 97 %	Capacity of the supply fan – level A (P34)
fan_in_1	read - write	16 ÷ 98 %	Capacity of the supply fan – level 1 (P35)
fan_in_2	read - write	17 ÷ 99 %	Capacity of the supply fan – level 2 (P36)
fan_in_3	read - write	18 ÷ 100 %	Capacity of the supply fan – level 3 (P37)
outgoing_fan	read	0 ÷ 100 %	Current capacity of the exhaust fan (P38)
incomming_fan	read	0 ÷ 100 %	Current capacity of the supply fan (P39)
Menu 40
heater_temperatur	read	°C	Afterheater temperature (P40)
target_temperatur	read - write	15 ÷ 25 °C step 0,5	Comfort temperature (P41) look at CC Ease commands
cookerhood_temperatur	read	°C	Extractor hood temperature (P44)
outdoor_incomming_temperatur	read	°C	Incomming (outside) air temperature (P45)
indoor_incomming_temperatur	read	°C	Incomming (supply) air temperature (P46)
indoor_outgoing_temperatur	read	°C	Outgoing (return) air temperature (P47)
outdoor_outgoing_temperatur	read	°C	Outgoing (exhaust) air temperature (P48)
ewt_temperatur	read	°C	EWT sensor temperature (P49)
Menu 50
is_chimney	read - write	0, 1	Fire programme (P50) 0 – off 1 – on
is_preheater	read - write	0, 1	Preheater (P51) 0 – not installed 1 – installed
preheater_option	read - write	0, 1, 2, 3	Setting of the preheater (P52) 0 – guaranteed protection 1 – high protection 2 – nominal protection 3 – economy
is_cookerhood	read - write	0, 1	Extractor hood (P53) 0 – not installed 1 – installed
is_bypass	read - write	0, 1	Bypass (P54) 0 – not installed 1 – installed
is_heater	read - write	0, 1, 2	Afterheater (P55) 0 – not installed 1 – installed 2 – installed and regulated by a pulse width modulation signal (PWM)
recu_level	read - write	0, 1, 2	Required air volume (P56) 0 – normal (nL) 1 – high (HL) 2 – normal (nL)
recu_type	read - write	1, 2	ComfoAir type (P57) 1 – left-hand version (Li) 2 – right-hand version (Re)
analog_mode	read - write	0, 1	Controller priorities (P58) 0 – with analogue inputs 1 – without analogue inputs
is_enthalpy	read - write	0, 1, 2	Enthalpy exchanger (P59) 0 – not installed 1 – installed with RH sensor 2 – installed without RH sensor
Menu 60
is_ewt	read - write	0, 1, 2	Geothermal heat exchanger – EWT (P60) 0 – uninstalled 1 – installed 2 – installed, unregulated
ewt_speed	read - write	0 ÷ 99 %	Setting the percentage by which the supply fan must increase its speed when the valve of the EWT is opened. (P61)
ewt_temperatur_low	read - write	0 ÷ 15 °C	EWT temperaturę low (below which EWT will turned on) (P62)
ewt_temperatur_high	read - write	10 ÷ 25 °C	EWT temperaturę high (above which EWT will turned on) (P63)
heater_target_temperatur	read - write	5 ÷ 40 °C	Afterheater temperature required (P64)
Menu 70
software_main_version	read		Current software – major version (P70)
software_minor_version	read		Current software – minor version (P70)
software_beta_version	read		Current software – beta version
errorA_current	read	1, 2, 4, 8, 16, 32, 64, 128	Current error A 1 – A1 … 128 – A8
errorAhigh_current	read	1, 2, 4, 8, 16, 32, 64, 128	Current error A high 1 – A9 … 64 – A15 128 – A0
errorE_current	read	1, 2, 4, 8, 16, 32, 64, 128	Current error E 1 – E1 … 128 – E8
errorEA_current	read	1, 2, 4, 8, 16, 32, 64, 128	Current error EA 1 – EA1 … 128 – EA8
errorA_last	read	1, 2, 4, 8, 16, 32, 64, 128	Last error A (P71) 1 – A1 … 128 – A8
errorAhigh_last	read	1, 2, 4, 8, 16, 32, 64, 128	Last error A high (P71) 1 – A9 … 64 – A15 128 – A0
errorE_last	read	1, 2, 4, 8, 16, 32, 64, 128	Last error E (P71) 1 – E1 … 128 – E8
errorEA_last	read	1, 2, 4, 8, 16, 32, 64, 128	Last error EA (P71) 1 – EA1 … 128 – EA8
errorA_prelast	read	1, 2, 4, 8, 16, 32, 64, 128	Prelast error A (P72) 1 – A1 … 128 – A8
errorAhigh_prelast	read	1, 2, 4, 8, 16, 32, 64, 128	Prelast error A high (P72) 1 – A9 … 64 – A15 128 – A0
errorE_prelast	read	1, 2, 4, 8, 16, 32, 64, 128	Prelast error E (P72) 1 – E1 … 128 – E8
errorEA_prelast	read	1, 2, 4, 8, 16, 32, 64, 128	Prelast error EA (P72) 1 – EA1 … 128 – EA8
errorA_preprelast	read	1, 2, 4, 8, 16, 32, 64, 128	Pre-prelast error A (P73) 1 – A1 … 128 – A8
errorAhigh_preprelast	read	1, 2, 4, 8, 16, 32, 64, 128	Pre-prelast error A high (P73) 1 – A9 … 64 – A15 128 – A0
errorE_preprelast	read	1, 2, 4, 8, 16, 32, 64, 128	Pre-prelast error E (P73) 1 – E1 … 128 – E8
errorEA_preprelast	read	1, 2, 4, 8, 16, 32, 64, 128	Pre-prelast error EA (P73) 1 – EA1 … 128 – EA8
error_reset	write	1	Resseting errors (P74)
recu_reset	write	1	General reset (P75)
recu_autotest	write	1	Self test (P76)
filter_reset	write	1	Resseting filter counter (P77) look at CC Ease commands
Menu 80
analog1_mode	read - write	0, 1	Analogue input 1 (P80) 0 – controlling 1 – programing
analog2_mode	read - write	0, 1	Analogue input 2 (P81) 0 – controlling 1 – programing
analog1_min	read - write	0 ÷ 100 %	Analogue input 1 – min. setting (P82)
analog1_max	read - write	0 ÷ 100 %	Analogue input 1 – max. setting (P83)
analog2_min	read - write	0 ÷ 100 %	Analogue input 2 – min. setting (P84)
analog2_max	read - write	0 ÷ 100 %	Analogue input 2 – max. setting (P85)
is_analog1	read - write	0, 1	Analogue input 1 (P86) 0 – not installed 1 – installed
is_analog2	read - write	0, 1	Analogue input 2 (P87) 0 – not installed 1 – installed
analog1_value	read - write	0 ÷ 100 %	Analogue input 1 – set point (P88)
analog2_value	read - write	0 ÷ 100 %	Analogue input 2 – set point (P89)
analog3_mode	read - write	0, 1	Analogue input 3 (P180) 0 – controlling 1 – programing
analog4_mode	read - write	0, 1	Analogue input 4 (P181) 0 – controlling 1 – programing
analog3_min	read - write	0 ÷ 100 %	Analogue input 3 – min. setting (P182)
analog3_max	read - write	0 ÷ 100 %	Analogue input 3 – max. setting (P183)
analog4_min	read - write	0 ÷ 100 %	Analogue input 4 – min. setting (P184)
analog4_max	read - write	0 ÷ 100 %	Analogue input 4 – max. setting (P185)
is_analog3	read - write	0, 1	Analogue input 3 (P186) 0 – not installed 1 – installed
is_analog4	read - write	0, 1	Analogue input 4 (P187) 0 – not installed 1 – installed
analog3_value	read - write	0 ÷ 100 %	Analogue input 3 – set point (P188)
analog4_value	read - write	0 ÷ 100 %	Analogue input 4 – set point (P189)
Menu 90
chimney_mode	read	0, 1	Fire programme (P90) 0 – off 1 – on
bypass_mode	read	0, 1	Bypass (P91) look at CC Ease commands 0 – closed 1 – opened
ewt_mode	read	0, 1	Geothermal heat excharger – EWT (P92) look at CC Ease commands 0 – off 1 – on
heater_mode	read	0, 1	Afterheater (P93) 0 – off 1 – on
control_mode	read	0, 1	Analogue inputs (P94) 0 – off 1 – on
preheater_mode	read	0, 1	Preheater (P95) look at CC Ease commands 0 – off 1 – on
cookerhood_mode	read	0, 1	Extractor hood (P96) look at CC Ease commands 0 – off 1 – on
enthalpy_mode	read	0, 1, 2	Enthalpy (P97) look at CC Ease commands 0 – off 1 – on 2 - on with sensor
Additional commands
filter_running	read	h	Counter of filter hours (from resseting)
fan_out_efficiency	read	0 ÷ 100 %	Efficiency of the exhaust fan
fan_in_efficiency	read	0 ÷ 100 %	Efficiency of the supply fan
fan_out_speed	read	RPM	Speed of the exhaust fan
fan_in_speed	read	RPM	Speed of the supply fan
is_T1_sensor	read	0, 1	Inlet temperature sensor 0 – not installed 1 – installed
is_T2_sensor	read	0, 1	Supply temperature sensor 0 – not installed 1 – installed
is_T3_sensor	read	0, 1	Return temperature sensor 0 – not installed 1 – installed
is_T4_sensor	read	0, 1	Exhaust temperature sensor 0 – not installed 1 – installed
is_EWT_sensor	read	0, 1	EWT temperature sensor 0 – not installed 1 – installed
is_heater_sensor	read	0, 1	Afterheater temperature sensor 0 – not installed 1 – installed
is_cookerhood_sensor	read	0, 1	Extractor hood temperature sensor 0 – not installed 1 – installed
is_L1_switch	read	0, 1	Switch L1 0 – not installed 1 – installed
is_L2_switch	read	0, 1	Switch L2 0 – not installed 1 – installed
is_bathroom_switch	read	0, 1	Bathroom switch 0 – not installed 1 – installed
is_bathroom2_switch	read	0, 1	Bathroom switch 2 (luxe) 0 – not installed 1 – installed
is_cookerhood_switch	read	0, 1	Extractor hood switch 0 – not installed 1 – installed
is_external_filter	read	0, 1	External filter 0 – not installed 1 – installed
is_WTW	read	0, 1	Heat recovery (WTW) 0 – not installed 1 – installed
bypass_season	read	0, 1	Bypass summer mode 0 – winter 1 – summer
preheater_valve	read	0, 1, 2	Preheater – valve state 0 – opened 1 – closed 2 – unknown
preheater_frost_protect	read	0, 1	Preheater – freezing protection 0 – off 1 – on
preheater_heating	read	0, 1	Preheater – heating 0 – off 1 – on
preheater_frost_time	read	min	Preheater – freezing time
heater_efficiency	read - write		Afterheater – efficiency
heater_power	read - write		Afterheater power (I – parameter)
level0_time	read	h	Absent level working hours
level1_time	read	h	Low level working hours
level2_time	read	h	Medium level working hours
level3_time	read	h	High level working hours
preaheater_time	read	h	Preheater working hours
bypass_time	read	h	Bypass opening hours
enthalpy_temperatur	read	°C	Enthalpy temperature sensor
enthalpy_humidity	read	0 ÷ 100 %	Enthalpy humidity sensor
enthalpy_level	read	%	Enthalpy coefficient
enthalpy_time	read	0 ÷ 240	Enthalpy timer 0 = 0 min … 240 = 2880 min
freeze_time	read	h	ComfoAir freezing hours
analog1_negative	read - write	0, 1	Analogue input 1 0 – positive 1 – negative
analog2_negative	read - write	0, 1	Analogue input 2 0 – positive 1 – negative
analog3_negative	read - write	0, 1	Analogue input 3 0 – positive 1 – negative
analog4_negative	read - write	0, 1	Analogue input 4 0 – positive 1 – negative
analog1_volt	read	0 ÷ 10 V	Voltage on Analog input 1
analog2_volt	read	0 ÷ 10 V	Voltage on Analog input 2
analog3_volt	read	0 ÷ 10 V	Voltage on Analog input 3
analog4_volt	read	0 ÷ 10 V	Voltage on Analog input 4
RF_mode	read - write	0, 1	Radio control RF 0 – controlling 1 – programing
RF_min	read - write	0 ÷ 100 %	Radio control RF – min. setting
RF_max	read - write	0 ÷ 100 %	Radio control RF – max. setting
is_RF	read - write	0, 1	Radio control RF 0 – not installed 1 – installed
RF_value	read - write	0 ÷ 100 %	Radio control RF – set point
RF_negative	read - write	0, 1	Radio control RF 0 – positive 1 – negative

Prerequisites

Computer communication with the ComfoAir unit is carried out via the RS232 port on the device. You can use the PC port:

• raspberry pi: UART port with converter RS232 to UART (3.3V)
• raspberry pi: USB port with converter RS232 to USB
• PC: RS232 port
• PC: USB port with converter RS232 to USB

The connection should be made with a 3-wire cable connecting pins: GND, TX, RX of RS232 sockets, but RX and TX pins should be crossed (TX of ComfoAir to RX of PC, RX of ComfoAir to TX of PC).

How to install.

Download org.openhab.binding.comfoair-1.13.0.jar file from this repository.

Important ! If you use the original binding.comfoair, you must uninstall it before substituting the new .jar file (Paper UI > Add-ons > Bindings > ComfoAir - uninstall).

The binding.comfoair installation can be done in two ways:

1. Upload the org.openhab.binding.comfoair-1.13.0.jar file to the openhab\addons directory.

• openhab: \openHAB\addons
• openhabian: /usr/share/openhab2/addons

2. Copy the org.openhab.binding.comfoair-1.13.0.jar file to the directory in which the original binding.comfoair is located:

• openhab: \openHAB\userdata\tmp\mvn\org\openhab\binding\org.openhab.binding.comfoair
• openhabian: /var/lib/openhab2/tmp/mvn/org/openhab/binding/org.openhab.binding.comfoair/1.13.0
  
  Confirm overwriting of the original file.
  If the original file is in a version other than 1.13.0, the name of the copied file should be renamed to the original binding.comfoair .jar file name.

Now you can install ComfoAir binding (Paper UI > Add-ons > Bindings > ComfoAir - install).

Binding Configuration

You can configure this binding in the file services/comfoair.cfg.

Property	Default	Required	Description
port		Yes	Serial port which is connected to the Zehnder ComfoAir system, for example /dev/ttyS0 on Linux or COM1 on Windows
refresh	60000	No	refresh interval in milliseconds

Example

port=/dev/ttyS0

Item Configuration

The syntax of the binding configuration strings accepted is the following:

comfoair="<command>"

where <command> should be replaced with the ComfoAir command from the list above.

Limitations

• Either the ComfoAir binding or the CCEase Comfocontrol can be active, but not together.
• You must implement auto mode by yourself with rules. But it is more powerful.

Rights to access the serial port

• Take care that the user that runs openHAB has rights to access the serial port
• On Ubuntu systems that usually means adding the user to the group "dialout", i.e.

sudo usermod -a -G dialout openhab

if openhab is your user.

Examples

items/comfoair.items:

// Comfo Air
Group	ComfoAir				"ComfoAir"					<recu>		(devices)

// Temperatures chart
Group	comfoairTemps_Chart									<temperature>	(ComfoAir)
Number	comfoairTemps_Chart_Period		"Period"

// Delay
Switch	Delayed_Start

// Summer - Winter energy switch
Switch	EnergySummerTime

// External temperature, this parameter is read by other sensor or by weather station
Number	weatherN_Temperature			"External temperature [%.1f °C]"		<temperature>

// Control
Number	comfoairControl				"Activate"					<computer>	(ComfoAir)			{comfoair="activate"}
Number	comfoairFanLevel			"Ventilation level [%d]"			<chart>		(ComfoAir)			{comfoair="fan_level"}
Number	comfoairFanLevel_Message		"Ventilation level [%d]"			<chart>		(ComfoAir)
Number	comfoairFanMode				"Supply / Exhaust"				<fan_in>	(ComfoAir)
Number	comfoairFanMode_Message			"Supply / Exhaust [%d]"				<fan_in>	(ComfoAir)
Number	comfoairTargetTemperature_Message	"Comfort temperature [%.1f °C]"			<temperature>	(ComfoAir)
Number	comfoairErrorReset			"Error reset"					<service>	(ComfoAir)			{comfoair="error_reset"}
Number	comfoairFilterReset			"Filter reset"					<service>	(ComfoAir)			{comfoair="filter_reset"}
Number	comfoairReset				"Reset"						<reset>		(ComfoAir)
Number	comfoairMode				"Manual - Auto [%d]"				<controlMode>	(ComfoAir)
Switch	comfoairControl_Switch			"Activate"					<control>	(ComfoAir)
Number	comfoairFilterPeriod			"Filter period [%d weeks]"			<clock>		(ComfoAir)			{comfoair="filter_period"}
Number	comfoairChimney				"Fire programme [%d]"				<climate>	(ComfoAir)			{comfoair="is_chimney"}
Number	comfoairPreheater			"Preheater [MAP(comfoair_is-not.map):%s]"	<climate>	(ComfoAir)			{comfoair="is_preheater"}
Number	comfoairCookerHood			"Extractor hood [MAP(comfoair_is-not.map):%s]"	<climate>	(ComfoAir)			{comfoair="is_cookerhood"}
Number	comfoairBypass				"Bypass [%d]"					<climate>	(ComfoAir)			{comfoair="is_bypass"}
Number	comfoairEWT				"EWT [%d]"					<climate>	(ComfoAir)			{comfoair="is_ewt"}
Number	comfoairEnthalpy			"Enthalpy [MAP(comfoair_enthalpy.map):%s]"	<climate>	(ComfoAir)			{comfoair="is_enthalpy"}

// Messages
String	comfoairError												(ComfoAir)			{comfoair="error_message"}
String	comfoairError_Message			"Messages [%s]"					<attention>	(ComfoAir)
Number	comfoairFilterRuntime											(ComfoAir)			{comfoair="filter_running"}
String	comfoairFilterRuntime_Message		"Filter time [%s]"				<clock>		(ComfoAir)
Number	comfoairFilterErrorI											(ComfoAir)			{comfoair="filter_error_intern"}
Number	comfoairFilterErrorE											(ComfoAir)			{comfoair="filter_error_extern"}
String	comfoairFrozenError
String	comfoairInletError

// State
Number	comfoairTargetTemperature		"Comfort temperature [%.1f °C]"			<temperature>	(ComfoAir)			{comfoair="target_temperatur"}
Number	comfoairOutdoorIncomingTemperature	"Inlet air temperature [%.1f °C]"		<temperature>	(ComfoAir, comfoairTemps_Chart)	{comfoair="outdoor_incomming_temperatur"}
Number	comfoairIndoorIncomingTemperature	"Supply air temperature [%.1f °C]"		<temperature>	(ComfoAir, comfoairTemps_Chart)	{comfoair="indoor_incomming_temperatur"}
Number	comfoairIndoorOutgoingTemperature	"Return air temperature [%.1f °C]"		<temperature>	(ComfoAir, comfoairTemps_Chart)	{comfoair="indoor_outgoing_temperatur"}
Number	comfoairOutdoorOutgoingTemperature	"Exhaust air temperature [%.1f °C]"		<temperature>	(ComfoAir, comfoairTemps_Chart)	{comfoair="outdoor_outgoing_temperatur"}
Number	comfoairIncomingFan			"Supply capacity [%d %%]"			<fan_in>	(ComfoAir)			{comfoair="incomming_fan"}
Number	comfoairOutgoingFan			"Exhaust capasity [%d %%]"			<fan_out>	(ComfoAir)			{comfoair="outgoing_fan"}
Number	comfoairFanIn0				"Supply capacity - level 0 [%d %%]"		<fan_in>	(ComfoAir)			{comfoair="fan_in_0"}
Number	comfoairFanOut0				"Exhaust capasity - level 0 [%d %%]"		<fan_out>	(ComfoAir)			{comfoair="fan_out_0"}
Number	comfoairEfficiency			"Efficiency [%.1f %%]"				<efficiency>	(ComfoAir)
Number	comfoairBypassMode			"Bypass [MAP(comfoair_bypass.map):%s]"		<climate>	(ComfoAir)			{comfoair="bypass_mode"}
Number	comfoairEWTMode 			"EWT [MAP(comfoair_on-off.map):%s]"		<climate>	(ComfoAir)			{comfoair="ewt_mode"}
Number	comfoairChimneyMode			"Fire programme [MAP(comfoair_on-off.map):%s]"	<climate>	(ComfoAir)			{comfoair="chimney_mode"}
Number	comfoairPreheaterMode			"Preheater [MAP(comfoair_on-off.map):%s]"	<climate>	(ComfoAir)			{comfoair="preheater_mode"}
Number	comfoairCookerHoodMode			"Extractor hood [MAP(comfoair_on-off.map):%s]"	<climate>	(ComfoAir)			{comfoair="cookerhood_mode"}
Number	comfoairEnthalpyMode			"Enthalpy [MAP(comfoair_on-off.map):%s]"	<climate>	(ComfoAir)			{comfoair="enthalpy_mode"}
Number	comfoairFreezeMode			"Freeze [MAP(comfoair_freeze.map):%s]"		<climate>	(ComfoAir)			{comfoair="freeze_mode"}

transform/comfoair_bypass.map:

1=Opened
0=Closed
undefined=unknown
-=unknown

transform/comfoair_on-off.map:

1=On
0=Off
undefined=unknown
-=unknown

transform/comfoair_is-not.map:

1=Install
0=Not install
undefined=unknown
-=unknown

transform/comfoair_freeze.map:

1=Frozen
0=OK
undefined=unknown
-=unknown

transform/comfoair_enthalpy.map:

2=Install without sensor
1=Install with sensor
0=Not install
undefined=unknown
-=unknown

persistence/rrd4j.persist:

Strategies {
	// for rrd charts, we need a cron strategy
	everyMinute : "0 * * * * ?"
}

Items {
	comfoairTemps_Chart : strategy = everyChange, restoreOnStartup
	comfoairEfficiency : strategy = everyMinute, restoreOnStartup
	comfoairFanLevel : strategy = everyMinute, restoreOnStartup
}

sitemaps/comfoair.sitemap:

sitemap comfoair label="ComfoAir" {
	Frame label="Main" {
		Text item=comfoairError_Message labelcolor=[!="OK"="red"] valuecolor=[!="OK"="red"]
		Switch item=comfoairControl mappings=[0="CCEasy", 1="Komputer"]
		Switch item=comfoairErrorReset mappings=[1="Reset"]
		Switch item=comfoairFilterReset mappings=[1="Reset"]
	}
	Frame label="Control" {
		Switch item=comfoairMode mappings=[0="Manual", 1="Auto"]
		Switch item=comfoairFanMode_Message mappings=[0="Sup + Exh", 1="Supply", 2="Exhaust"]
		Switch item=comfoairFanLevel_Message mappings=[2="Level 1", 3="Level 2", 4="Level 3"]
		Setpoint item=comfoairTargetTemperature_Message step=0.5 minValue=15 maxValue=28 valuecolor=["black"]
	}
	Frame label="State" {
		Text item=comfoairOutdoorIncomingTemperature valuecolor=["black"]
		Text item=comfoairOutdoorOutgoingTemperature valuecolor=["black"]
		Text item=comfoairIndoorIncomingTemperature valuecolor=["black"]
		Text item=comfoairIndoorOutgoingTemperature valuecolor=["black"]
	}
	Frame {
		Text item=comfoairIncomingFan valuecolor=["black"]
		Text item=comfoairBypassMode valuecolor=["black"]
		Text item=comfoairOutgoingFan valuecolor=["black"]
		Text item=comfoairEWTMode valuecolor=[0="silver", 1="black"]
		Text item=comfoairEfficiency valuecolor=["black"]
		Text item=comfoairFreezeMode valuecolor=[0="black", 1="red"]
		Text item=comfoairFilterRuntime_Message valuecolor=["black"]
		Text item=comfoairChimneyMode valuecolor=[0="silver", 1="black"]
	}
	Frame label="Results" {
		Text label="Charts" icon="chart" {
			Switch item=comfoairTemps_Chart_Period mappings=[0="Day", 1="Week", 2="Month", 3="Year"]
			Chart item=comfoairTemps_Chart period=D refresh=10000 visibility=[comfoairTemps_Chart_Period==0]
			Chart item=comfoairTemps_Chart period=W refresh=60000 visibility=[comfoairTemps_Chart_Period==1, comfoairTemps_Chart_Period=="Uninitialized"]
			Chart item=comfoairTemps_Chart period=M refresh=60000 visibility=[comfoairTemps_Chart_Period==2]
			Chart item=comfoairTemps_Chart period=Y refresh=600000 visibility=[comfoairTemps_Chart_Period==3]
		}
	}
}

rules/comfoair.rules:

import java.lang.Math
import java.util.Date
import java.util.List
import java.util.ArrayList

// variable for auto_mode state
var Boolean isAutoMode = false

// based capacity for absent level
// absent level is used for supply/exhaust mode
var Number comfoairFanIn0BaseValue = 15
var Number comfoairFanOut0BaseValue = 15
var Number comfoairFanLevelLastValue
var Number comfoairFanIn0LastValue
var Number comfoairFanOut0LastValue


// System start can take some time
rule "delayForSystemStart"
when
	System started
then
	Delayed_Start.postUpdate( OFF )

	createTimer( now.plusSeconds( 120 )) [| Delayed_Start.sendCommand( ON )]
end


rule "setAutoModeForStart"
when
	Item Delayed_Start changed to ON
then
	if( comfoairControl.state == 1 ) {
		comfoairMode.postUpdate( 1 )
		isAutoMode = true
		comfoairFanMode.postUpdate( 0 )
	}
end


rule "setControlToCCEaseWhenSystemClose"
when
	System shuts down
then
	comfoairControl.sendCommand( 0 )
end


rule "messageWhenFrozen"
when
	Item Delayed_Start changed to ON
	or
	Item comfoairControl changed to 1
	or
	Item comfoairIncomingFan changed
	or
	Item comfoairOutgoingFan changed
	or
	Item weatherN_Temperature changed
then
	if( Delayed_Start.state == ON && comfoairControl.state == 1 ) {
		var String msg = ""

		if( comfoairIncomingFan.state instanceof DecimalType && comfoairOutgoingFan.state instanceof DecimalType && weatherN_Temperature.state instanceof DecimalType ) {
			
			if( weatherN_Temperature.state < 0 && ( comfoairIncomingFan.state == 0 || comfoairOutgoingFan.state == 0 ) ) {
				msg = "FROZEN"
			} else msg = "OK"
			
		} else msg = "communication failed"
		
		comfoairFrozenError.postUpdate( msg )
	}
end


rule "messageWhenInletPlugged"
when
	Item Delayed_Start changed to ON
	or
	Item comfoairControl changed to 1
	or
	Item comfoairOutdoorIncomingTemperature changed
	or
	Item weatherN_Temperature changed
	or
	Item comfoairFrozenError changed
then
	if( Delayed_Start.state == ON && comfoairControl.state == 1 ) {
		var String msg = ""

		if( comfoairOutdoorIncomingTemperature.state instanceof DecimalType && weatherN_Temperature.state instanceof DecimalType && comfoairFrozenError.state instanceof StringType ) {
			
			if( weatherN_Temperature.state as DecimalType + 10 < comfoairOutdoorIncomingTemperature.state as DecimalType && comfoairFrozenError.state == "OK" ) {
				msg = "PLUGGED"
			} else msg = "OK"
			
		} else msg = "communication failed"
		
		comfoairInletError.postUpdate( msg )
	}
end


rule "showMessage"
when
	Item Delayed_Start changed to ON
	or
	Item comfoairControl changed to 1
	or
	Item comfoairError changed
	or
	Item comfoairFilterErrorI changed
	or
	Item comfoairFilterErrorE changed
	or
	Item comfoairInletError changed
	or
	Item comfoairFreezeError changed
then
	if( Delayed_Start.state == ON && comfoairControl.state == 1 ) {
		var String msg = "" + callScript( "comfoair_errorMsg" )
		var String msgToSend = "" + callScript( "comfoair_errorMsgToSend" )
		
		comfoairError_Message.postUpdate( msg )
		
		if( comfoairError.state != "Ok" || comfoairFilterErrorI.state == 1 || comfoairFilterErrorE.state == 1 || comfoairInletError.state != "OK" || comfoairFrozenError.state != "OK" ) {
			sendMail( "xyz@gmail.com", "ComfoAir message", msgToSend )
		}
	}
end


rule "showFilterTime"
when
	Item comfoairFilterRuntime changed
	or
	Item comfoairFilterPeriod changed
	or
	Item Delayed_Start changed to ON
	or
	Item comfoairControl changed to 1
then
	if( comfoairFilterRuntime.state instanceof DecimalType && comfoairFilterPeriod.state instanceof DecimalType ) {
		var Number filterPeriodWeeks = comfoairFilterPeriod.state
		var Number filterPeriodHours = filterPeriodWeeks * 7 * 24
		
		if( comfoairFilterRuntime.state instanceof DecimalType ){
			var Number passedHours = comfoairFilterRuntime.state as DecimalType
			var Boolean isTimeExceeded

			if( filterPeriodHours - passedHours < 0) {
				isTimeExceeded = true
			} else isTimeExceeded = false

			var Number passedWeeks = Math::floor( ( passedHours / 168 ).doubleValue )
			var Number passedDays = Math::floor( ( ( passedHours - (passedWeeks * 168 ) ) / 24).doubleValue )
			var Number remainedHours = Math::abs( ( filterPeriodHours - passedHours ).intValue )
			var Number remainedWeeks = Math::floor( ( remainedHours / 168 ).doubleValue )
			var Number remainedDays = Math::floor( ( ( remainedHours - ( remainedWeeks * 168 ) ) / 24).doubleValue )
		
			var String msg = "Passed: "
		
			if( passedWeeks > 0 ) {

				if( passedWeeks == 1 ) msg = msg + "1 week"
				else msg = msg + passedWeeks.intValue + " weeks"
				
				if( passedDays > 0) msg = msg + " "
				else msg = msg + ","
			}
			if( passedDays > 0 ) {
				if( passedDays == 1 ) msg = msg + "1 day,"
				else msg = msg + passedDays.intValue + " days,"
			}
			if( passedWeeks == 0 && passedDays == 0 ) msg = msg + "0 days, "
			
			if( isTimeExceeded ) msg = msg + " Exceeded: "
			else msg = msg + " Remained: "
			
			if( remainedWeeks != 0 ) {

				if( remainedWeeks == 1 ) msg = msg + "1 week"
				else msg = msg + remainedWeeks.intValue + " weeks"

				if( remainedDays > 0 ) msg = msg + " "
			}
			if( remainedDays != 0 ) {
				if( remainedDays == 1 ) msg = msg + "1 day"
				else msg = msg + remainedDays.intValue + " days"
			}
			
			if( remainedWeeks == 0 && remainedDays == 0 ) msg = msg + "0 days"
			
			comfoairFilterRuntime_Message.postUpdate( msg )
			
		} else {
			comfoairFilterRuntime_Message.postUpdate( "communication failed" )
		}
	}
end


rule "errorReset"
when
	Item comfoairReset changed
then
	var String error
	
	if( comfoairControl.state == 1 ) {
		
		if( comfoairReset.state == "0" ) {
			comfoairFilterReset.sendCommand( 0 )
			logInfo( "ComfoAir", "Filter was reset !" )
			
		} else if( comfoairReset.state == "1" ) {
			comfoairErrorReset.sendCommand( 0 )
			logInfo( "ComfoAir", "Error was reset !" )
		}
		
		createTimer(now.plusSeconds( 5 ),  [ |
			error = "" + callScript( "comfoair_errorMsg" )
			comfoairError_Message.postUpdate( error )
		])
	} else {
		if( comfoairReset.state == "0" || comfoairReset.state == "1" ) {
			comfoairError_Message.postUpdate( "PC control is not active" )
			
			createTimer(now.plusSeconds( 10 ),  [ |
				error = "" + callScript( "comfoair_errorMsg" )
				comfoairError_Message.postUpdate( error )
			])
		}
	}
end


rule "calculateEfficiency"
when
	Item Delayed_Start changed to ON
	or
	Item comfoairOutdoorIncomingTemperature changed
	or
	Item comfoairIndoorOutgoingTemperature changed
	or
	Item comfoairIndoorIncomingTemperature changed
	or
	Item comfoairControl changed to 1
then
	var Number efficiency

	if( comfoairOutdoorIncomingTemperature.state instanceof DecimalType && comfoairIndoorOutgoingTemperature.state instanceof DecimalType && comfoairIndoorIncomingTemperature.state instanceof DecimalType && comfoairBypassMode.state == 0 ) {
		var Number tempOutIn = comfoairOutdoorIncomingTemperature.state as DecimalType
		var Number tempInOut = comfoairIndoorOutgoingTemperature.state as DecimalType
		var Number tempInIn = comfoairIndoorIncomingTemperature.state as DecimalType

		if( tempInOut != tempOutIn ) {
			efficiency = ( tempInIn - tempOutIn ) / ( tempInOut - tempOutIn ) * 100
			efficiency = Math::round( efficiency.doubleValue );
		} else efficiency = null
	} else efficiency = null

	comfoairEfficiency.postUpdate( efficiency )
end


rule "changeSupply-Exhaust"
when
	Item comfoairFanMode_Message changed
then
	var Number newFanMode = comfoairFanMode_Message.state as DecimalType
	
	if( comfoairControl.state == 1 ) {

		if( comfoairChimney.state == 0 ) {

			if( comfoairFanMode_Message.state != comfoairFanMode.state ) {
				comfoairFanMode.sendCommand( newFanMode )
			}

		} else if( comfoairFanMode_Message.state != comfoairFanMode.state ) {
			comfoairError_Message.postUpdate( "Fire programme is on" )

			createTimer(now.plusMillis( 200 ),  [ |
				comfoairFanMode_Message.postUpdate( comfoairFanMode.state )
			])
			
			createTimer(now.plusSeconds( 10 ),  [ |
				var String error = "" + callScript( "comfoair_errorMsg" )
				comfoairError_Message.postUpdate( error )
			])
		}
	} else if( comfoairFanMode_Message.state != comfoairFanMode.state ) {
		comfoairError_Message.postUpdate( "PC control is not active" )
		
		createTimer(now.plusMillis( 200 ),  [ |
			comfoairFanMode_Message.postUpdate( comfoairFanMode.state )
		])
		
		createTimer(now.plusSeconds( 10 ),  [ |
			var String error = "" + callScript( "comfoair_errorMsg" )
			comfoairError_Message.postUpdate( error )
		])
	}
end


rule "changeSupply-ExhaustSwitch"
when 
	Item Delayed_Start changed to ON
	or
	Item comfoairFanMode changed
then
	if( comfoairFanMode.state instanceof DecimalType ) {
		comfoairFanMode_Message.postUpdate( comfoairFanMode.state )
	}
end


rule "changeSupply-ExhaustMode"
when
	Item comfoairFanMode changed
then
	if( comfoairControl.state instanceof Number && comfoairChimney.state instanceof Number ) {

		if( comfoairFanMode.state instanceof Number ) {

			if( comfoairFanLevel.state > 1 ) {
				comfoairFanLevelLastValue = comfoairFanLevel.state

				Thread::sleep( 100 )
				comfoairFanIn0LastValue = comfoairIncomingFan.state
				comfoairFanOut0LastValue = comfoairOutgoingFan.state
			}

			// Supply + Exhaust
			if( comfoairFanMode.state == 0 ) {

				if( comfoairIncomingFan.state == 0 || comfoairOutgoingFan.state == 0 ) {
					comfoairFanIn0.sendCommand( comfoairFanIn0BaseValue )

					createTimer(now.plusSeconds( 1 ),  [ |
						comfoairFanOut0.sendCommand( comfoairFanOut0BaseValue )
					])

					if( comfoairFanLevel.state < 2 ) {
						comfoairFanLevel.sendCommand( comfoairFanLevelLastValue.toString )
					}
				}
			} else {
				comfoairFanLevel.sendCommand( "1" )

				// Supply
				if( comfoairFanMode.state == 1 ) {

					if( comfoairIncomingFan.state == 0 ) {
						comfoairFanIn0.sendCommand( comfoairFanIn0LastValue )
					} else {
						comfoairFanIn0.sendCommand( comfoairIncomingFan.state )
					}

					createTimer( now.plusSeconds( 1 ),  [ | comfoairFanOut0.sendCommand( 0 ) ])

					comfoairMode.postUpdate( 0 )
					isAutoMode = false
				}

				// Exhaust
				if( comfoairFanMode.state == 2 ) {

					comfoairFanIn0.sendCommand( 0 )

					createTimer(now.plusSeconds( 1 ),  [ |
						if( comfoairOutgoingFan.state == 0 ) {
							comfoairFanOut0.sendCommand( comfoairFanOut0LastValue )
						} else {
							comfoairFanOut0.sendCommand( comfoairOutgoingFan.state )
						}
					])

					comfoairMode.postUpdate( 0 )
					isAutoMode = false
				}
			}
		}
	}
end


rule "changeAuto-Manual"
when
	Item comfoairMode changed
then
	if( comfoairControl.state == 0 ) {
		comfoairError_Message.postUpdate( "PC control is not active" )
		
		createTimer(now.plusSeconds( 10 ),  [ |
			var String error = "" + callScript( "comfoair_errorMsg" )
			comfoairError_Message.postUpdate( error )
		])
	}
end


rule "changeVentilationLevel"
when
	Item comfoairFanLevel_Message changed
then
	var Number newLevel = comfoairFanLevel_Message.state as DecimalType
	
	if( comfoairControl.state == 1 && comfoairFanLevel_Message.state != comfoairFanLevel.state ) {
		comfoairFanLevel.sendCommand( newLevel )
		
		comfoairMode.postUpdate( 0 )
		isAutoMode = false

		if( newLevel > 1 ) {
			comfoairFanMode.postUpdate( 0 )
		}
	} else {

		if( comfoairFanLevel_Message.state != comfoairFanLevel.state ) {
			comfoairError_Message.postUpdate( "PC control is not active" )
			
			createTimer(now.plusMillis( 200 ),  [ |
				comfoairFanLevel_Message.postUpdate( comfoairFanLevel.state )
			])
			
			createTimer(now.plusSeconds( 10 ),  [ |
				var String error = "" + callScript( "comfoair_errorMsg" )
				comfoairError_Message.postUpdate( error )
			])
		}
	}
end


rule "changeVentilationLevelSwitch"
when 
	Item Delayed_Start changed to ON
	or
	Item comfoairFanLevel changed
then
	if( comfoairFanLevel.state instanceof DecimalType ) {
		comfoairFanLevel_Message.postUpdate( comfoairFanLevel.state )
	}
end


rule "changeComfortTemperature"
when
	Item comfoairTargetTemperature_Message changed
then
	var Number newTemp = comfoairTargetTemperature_Message.state as DecimalType
	
	if( comfoairControl.state == 1 ) {

		if( comfoairTargetTemperature_Message.state != comfoairTargetTemperature.state ) {
			comfoairTargetTemperature.sendCommand( newTemp )
		}
	} else {

		if( comfoairTargetTemperature_Message.state != comfoairTargetTemperature.state ) {
			comfoairError_Message.postUpdate( "PC control is not active" )
			
			createTimer( now.plusMillis( 200 ),  [ |
				comfoairTargetTemperature_Message.postUpdate( comfoairTargetTemperature.state )
			])
			
			createTimer( now.plusSeconds( 10 ),  [ |
				var String error = "" + callScript( "comfoair_errorMsg" )
				comfoairError_Message.postUpdate( error )
			])
	   }
	}
end


rule "changeComfortTemperatureSetpoint"
when 
	Item Delayed_Start changed to ON
	or
	Item comfoairTargetTemperature changed
then
	if( comfoairTargetTemperature.state instanceof DecimalType ) {
		comfoairTargetTemperature_Message.postUpdate( comfoairTargetTemperature.state )
	}
end


rule "AutoProgram"
when
	Item comfoairMode changed
	or
	Time cron "0 0/1 * * * ?"
then
	if( comfoairControl.state instanceof DecimalType && comfoairMode.state instanceof DecimalType && comfoairFanLevel.state instanceof DecimalType ) {
		var Number day    = now.getDayOfWeek
		var Number hour   = now.getHourOfDay
		var Number minute = now.getMinuteOfHour
	
		if( comfoairControl.state == 1 && comfoairMode.state == 1 ) {
			var Number currentLevel = comfoairFanLevel.state as DecimalType
			var Number newLevel
			
			// Summer energy time - from 1.04 to 30.09
			if( EnergySummerTime.state == ON ) {

				// First set level 1 and 2

				// All days a week
				// if you want Monday to Friday remove day==6 and day==7
				if( day == 1 || day == 2 || day == 3 || day == 4 || day == 5 || day == 6 || day == 7 ) {

					// Level 2 : 5:00 - 7:00, 16:00 - 23:00, level 1 : in the other time
					if( ( hour >= 5 && hour < 7 )
						||
						( hour >= 16 && hour < 23 )
					) {
						newLevel = 3
					} else newLevel = 2
				
				// Saterdey and Sunday
				} else if( day == 6 || day == 7 ) {

					if( ( hour >= 12 && hour < 14 )
					) {
						newLevel = 3
					} else newLevel = 2
				}

				// Now set level 3

				// All days a week
				if( day == 1 || day == 2 || day == 3 || day == 4 || day == 5 || day == 6 || day == 7 ) {

					// Level 3 : 13:00 - 13:30
					if( ( hour == 13 && minute < 30 )
					) {
						newLevel = 4
					}
				}
			
			// Winter energy time - from 1.10 to 31.03
			} else {

				// All days a week
				// podwyzszenie 0:00-2:00, 3:00-5:00, 7:00-8:00, 10:00-11:00, 13:00-15:00, 16:30- 18:30, 20:00-21:00, 22:00-23:00
				if( day == 1 || day == 2 || day == 3 || day == 4 || day == 5 || day == 6 || day == 7 ) {

					// Level 2 : 6:00 - 8:00, 16:00 - 21:00, level 1 : in the other time
					if( ( hour >= 6 && hour < 8 )
						||
						( hour >= 16 && hour < 21 )
					) {
						newLevel = 3
					} else newLevel = 2
				
				// Saterdey and Sunday
				} else if( day == 6 || day == 7 ) {
			        
					if( ( hour >= 12 && hour < 14 )
					) {
						newLevel = 3
					} else newLevel = 2
				}

				// Now set level 3

				// All days a week
				if( day == 1 || day == 2 || day == 3 || day == 4 || day == 5 || day == 6 || day == 7 ) {

					// Level 3 : 13:00 - 13:30
					if( ( hour == 13 && minute < 30 )
					) {
						newLevel = 4
					}
				}
			}

			if( newLevel != currentLevel ) {
				comfoairFanLevel.sendCommand( newLevel )
				isAutoMode = true
				comfoairFanMode.postUpdate( 0 )
			}

			logInfo( "comfoair", "ComfoAir - AUTO Mode" )

		} else logInfo( "comfoair", "ComfoAir - MANUAL Mode" )
	}
end