API - variables

This page serves as a reference manual for all CTS700 QuickApp variables available through the nilan_var() function described on the scene page.

Each variable can be read by calling nilan_var("variable_name"), or by reading the NilanVars["variable_name"] associative array after calling nilan_var() without parameters.

Writable variables can be set by calling nilan_var("variable_name", new_value).

Naming convention

The variable name suffix indicates the access level:

  • _roRead-only. The value can be queried but not changed.
  • _rwRead-write. The value can be queried and changed from a scene.
  • _woWrite-only. An action variable (e.g. reset button) that can only be written.
  • _rw_infRead-write (info). Displayed as a label in the UI, but the underlying register may be writable.

Ventilation

Power & Operating Mode

  • ac_power_rw_inf — Ventilation power, displayed as label (RW)
    • 0 Off, 1 On
  • sys_ac_power_rw — Ventilation power, displayed as switch (RW)
    • 0 Off, 1 On
  • ac_opmode_rw — Operation mode (RW)
    • 0 Auto, 1 Heating, 2 Cooling
  • sys_ac_opmode_rw — Operation mode (Service level) (RW)
    • 0 Auto, 1 Heating, 2 Cooling
  • ac_work_state_ro — Ventilation selected mode (RO)
    • 0 Auto, 1 Cooling, 2 Heating

Alarms

  • ac_alarm_ro — Ventilation active alarm(s) (RO)
    • 0 Active, 1 Not active
  • sys_fire_alarm_ro — Fire alarm (RO)
    • 0 Activated, 1 Not activated
  • sys_fire_alarm_auto_reset_rw — Fire alarm auto reset (RW)
    • 0 Off, 1 On
  • ac_heat_pump_high_pressure_alarm_ro — Heat pump high pressure alarm (RO)
    • 0 Off, 1 On

Temperature Sensors

  • ac_inner_temp_ro — Room temperature (RO) [ºC]
  • ac_target_temp_rw — Room target temperature (RW) [ºC, range: 5–40, step: 0.1]
  • ac_incoming_outer_temp_t1_ro — Incoming outer (fresh air) temperature [T1] (RO) [ºC]
  • ac_incoming_inner_temp_t2_ro — Incoming inner (supply air) temperature [T2] (RO) [ºC]
  • ac_outgoing_inner_temp_t3_ro — Outgoing inner (extract air) temperature [T3] (RO) [ºC]
  • ac_outgoing_outer_temp_t4_ro — Outgoing outer (exhaust air) temperature [T4] (RO) [ºC]
  • ac_condenser_temp_t5_ro — Condenser temperature [T5] (RO) [ºC]
  • ac_evaporator_temp_t6_ro — Evaporator temperature [T6] (RO) [ºC]

Air Quality Sensors

  • ac_inner_humidity_ro — Relative inner humidity (RO) [%]
  • ac_co2_level_ro — CO₂ level (RO) [ppm]

Fan Speed

  • ac_fan_speed_rw — Fan speed (RW)
    • 101 Level 1, 102 Level 2, 103 Level 3, 104 Level 4
  • ac_fan_pause_rw — Fans pausing state (RW)
    • 0 Resume, 1 Pause
  • ac_supply_fan_speed_rw_inf — Supply fan speed (RO) [%]
  • ac_extract_fan_speed_rw_inf — Extract fan speed (RO) [%]

Fan Speed per Level (Service)

  • ac_fan_speed_in_1_rw — Inlet fan speed at level 1 (RW) [%, range: 20–100]
  • ac_fan_speed_out_1_rw — Outlet fan speed at level 1 (RW) [%, range: 20–100]
  • ac_fan_speed_in_2_rw — Inlet fan speed at level 2 (RW) [%, range: 20–100]
  • ac_fan_speed_out_2_rw — Outlet fan speed at level 2 (RW) [%, range: 20–100]
  • ac_fan_speed_in_3_rw — Inlet fan speed at level 3 (RW) [%, range: 20–100]
  • ac_fan_speed_out_3_rw — Outlet fan speed at level 3 (RW) [%, range: 20–100]
  • ac_fan_speed_in_4_rw — Inlet fan speed at level 4 (RW) [%, range: 20–100]
  • ac_fan_speed_out_4_rw — Outlet fan speed at level 4 (RW) [%, range: 20–100]

Temperature Regulation

  • ac_after_heater_min_temp_rw — Minimum supply air temperature (RW) [ºC, range: 5–30]
  • ac_after_heater_max_temp_rw — Maximum supply air temperature (RW) [ºC, range: 5–30]
  • ac_intemp_min_summer_rw — Minimum inlet temperature in summer (RW) [ºC, range: 5–15]
  • ac_intemp_min_winter_rw — Minimum inlet temperature in winter (RW) [ºC, range: 5–15]
  • ac_temp_regulation_deadband_rw — Temperature regulation deadband (RW) [ºC, range: 0–10]
  • ac_temp_regulation_deadband_external_rw — Regulation deadband for external room heating (RW) [ºC, range: 0–10]
  • sys_sumwin_target_rw — Summer/Winter season changeover target temperature (RW) [ºC, range: 5–30]
  • sys_sumwin_offset_rw — Summer/Winter season changeover offset (RW) [ºC, range: 0–10]

Humidity Regulation

  • ac_low_humidity_limit_rw — Low humidity limit (RW) [%, range: 15–45]
  • ac_low_humidity_fan_speed_rw — Fan speed for low humidity (RW)
    • 101 Level 1, 102 Level 2, 103 Level 3
  • ac_high_humidity_fan_speed_rw — Fan speed for high humidity (RW)
    • 102 Level 2, 103 Level 3, 104 Level 4
  • ac_high_humidity_timeout_rw — Timeout for high humidity (RW) [min, range: 0–180]

Active Cooling

  • ac_active_cooling_on_rw — Active cooling enabled (RW)
    • 0 Off, 1 On
  • ac_active_cooling_fan_on_rw — Active cooling fan enabled (RW)
    • 0 Off, 1 On
  • ac_active_cooling_fan_speed_rw — Active cooling fan speed (RW)
    • 103 Level 3, 104 Level 4
  • ac_active_cooling_min_temp_rw — Minimum cooling supply temperature (RW) [ºC, range: 5–30]
  • ac_free_energy_night_cooling_rw_inf — Free energy night cooling (RO)
    • 0 No, 1 Yes

Low Outdoor Temperature

  • ac_lowtemp_on_rw — Low fan speed at low outdoor temperature (RW)
    • 0 Off, 1 On
  • ac_lowtemp_fan_speed_rw — Fan speed at low outdoor temperature (RW)
    • 101 Level 1, 102 Level 2
  • ac_lowtemp_limit_rw — Activate when outdoor temperature drops below (RW) [ºC, range: -20–10]

Filters

  • ac_inlet_filter_left_ro — Inlet filter replacement in (RO) [days]
  • ac_outlet_filter_left_ro — Outlet filter replacement in (RO) [days]
  • ac_inlet_filter_reset_wo — Reset inlet filter replace period (WO)
  • ac_outlet_filter_reset_wo — Reset outlet filter replace period (WO)
  • ac_inlet_filter_days_rw — Inlet filter change period (RW) [days, range: 30–180]
  • ac_outlet_filter_days_rw — Outlet filter change period (RW) [days, range: 30–180]

User Programs

  • ac_user_prog1_ro — User program 1 (RO)
    • 0 Off, 1 On
  • ac_user_prog2_ro — User program 2 (RO)
    • 0 Off, 1 On

Status & Monitoring

  • ac_heating_allowed_ro — Heating allowed (RO)
    • 0 No, 1 Yes
  • ac_cooling_allowed_ro — Cooling allowed (RO)
    • 0 No, 1 Yes
  • ac_bypass_damper_open_ro — Bypass damper state (RO)
    • 0 Closed, 1 Open
  • ac_after_heater_rw_inf — After heating element (RO) [%]
  • ac_compressor_state_rw_inf — Compressor state (RO)
    • 0 Off, 100 On
  • ac_defrost_heat_exchanger_ro — Defrost heat exchanger (RO)
    • 0 Off, 100 On
  • ac_defrost_heat_pump_rw_inf — Defrost heat pump (RO)
    • 0 Off, 100 On
  • ac_supplement_heater_on_ro — Supplement heater (RO)
    • 0 Off, 1 On

CO₂ Control

  • ac_co2_fan2_ro — Activate fan speed 2 at CO₂ level (RO) [ppm]
  • ac_co2_fan3_ro — Activate fan speed 3 at CO₂ level (RO) [ppm]
  • ac_co2_fan4_ro — Activate fan speed 4 at CO₂ level (RO) [ppm]

Frost Protection & De-icing (Service)

  • ac_after_heater_element_type_rw_inf — After heating element type (RW)
    • 0 None, 1 Water, 2 Electrical
  • ac_frost_protection_ro — Frost protection type (RO)
    • 0 None, 1 External/Polar, 2 EHD, 3 BAH
  • ac_frost_protection_temp_t8_rw_inf — T8 temperature sensor (RW)
    • 0 Off, 1 On
  • ac_frost_protection_start_below_rw_inf — Frost protection starts below (RW) [ºC]
  • ac_preheater_setpoint_rw_inf — Setpoint for pre-heater [T4] (RW) [ºC]
  • ac_ehd_offset_rw_inf — EHD offset (RW) [ºC]
  • ac_ehd_hold_time_rw_inf — EHD hold time (RW) [min]
  • ac_ehd_stabilisation_rw_inf — EHD stabilisation (RW) [min]
  • ac_bah_below_rw_inf — BAH below temperature (RW) [ºC]
  • ac_bah_above_rw_inf — BAH above temperature (RW) [ºC]
  • ac_bah_deadband_rw_inf — BAH regulation deadband (RW) [ºC]
  • ac_deicing_outdoor_temp_rw_inf — Outdoor temperature for de-icing (RW) [ºC]
  • ac_deicing_max_time_rw_inf — Maximum time de-icing (RW) [min]
  • ac_deicing_min_gap_rw_inf — Minimum time between de-icings (RW) [min]
  • ac_deicing_infan_speed_rw_inf — Supply fan speed during de-icing (RW)
    • 0 Normal, 1 Extract
  • ac_deicing_outfan_speed_ro — Extract fan speed during de-icing (RO)
  • ac_deicing_hp_evaporator_defrost_rw_inf — Evaporator defrost [T6] (RW)
    • 0 Off, 1 On
  • ac_deicing_hp_max_time_rw_inf — Maximum HP de-icing time (RW) [min]
  • ac_deicing_hp_min_gap_rw_inf — Minimum time between HP de-icings (RW) [min]
  • ac_deicing_hp_start_rw_inf — Start de-icing temperature (RW) [ºC]
  • ac_deicing_hp_stop_rw_inf — Stop de-icing temperature (RW) [ºC]

Compressor Settings (Service)

  • ac_comp_time_between_start_rw_inf — Minimum time between start-ups (RW)
  • ac_comp_time_between_start_stop_rw_inf — Time between stop and start-up (RW) [min]

Device Data & Status (Service)

  • ac_heating_or_cooling_blocked_ro — Heating or cooling blocked (RO)
  • ac_bah_brine_pressostat_ro — BAH brine pressostat (RO)
  • ac_sys_heat_valve_ro — Heat valve (RO)
  • ac_hot_water_valve_rw — Hot water valve (RO)
    • 0 Heating, 1 Hot water production
  • ac_fourway_valve_ro — Four-way valve (RO)
    • 0 Open, 1 Closed
  • hw_warm_water_anode_2_ro — Warm water anode status (RO)

Other Service Settings

  • sys_user_func2_on_rw_inf — User Function 2 (RO)
    • 0 Off, 1 On
  • sys_lock_user_settings_rw — Lock user settings (RW)
    • 0 Off, 1 On

Heat Pump System (HPS)

Power & Operating Mode

  • hps_power_rw — HPS power (RW)
    • 0 Off, 1 On
  • hps_opmode_rw — Selected mode (RW)
    • 0 Auto, 1 Cooling, 2 Heating

Alarms

  • hps_active_alarms_ro — Currently active alarm (RO)
    • 0 None, 1 One or more
  • hps_reset_alarms_wo — Reset all alarms (WO)

Temperature Sensors

  • hps_ground_return_temp_t13_ro — Ground return temperature [T13] (RO) [ºC]
  • hps_ground_forward_temp_t14_ro — Ground forward temperature [T14] (RO) [ºC]
  • hps_before_condeser_temp_t16_ro — Before condenser temperature [T15] (RO) [ºC]
  • hps_after_condenser_temp_t17_ro — After condenser temperature [T17] (RO) [ºC]
  • hps_temp_t18_ro — GEO: central heat supply / AIR: buffer tank (RO) [ºC]

Status & Monitoring

  • hps_heating_demand_ro — Heating demand (RO)
    • 0 None, 1 Yes
  • hps_cooling_demand_ro — Cooling demand (RO)
    • 0 None, 1 Yes
  • hps_compressor_capacity_ro — Compressor capacity (RO) [%]
  • hps_sonda_pump_capacity_ro — Sonda circulation pump capacity (RO)
  • hps_secondary_pump_capacity_rw_inf — Central heat circulation pump capacity (RO) [%]
  • hps_cooling_pressure_ro — Cooling pressure (RO) [bar]
  • hps_high_pressure_ro — High pressure status (RO)
    • 0 Failure, 1 Ok
  • hps_low_pressure_ro — Low pressure status (RO)
    • 0 Failure, 1 Ok
  • hps_brine_pressure_ro — Sonda pressure (RO) [bar]
  • hps_flow_ro — Flow sensor (AIR) (RO)
    • 0 None, 1 Ok

Heating Settings

  • hps_heating_pause_rw — Heating pause (RW)
    • 0 Off, 1 On
  • hps_heating_pause_days_rw — Pause heating for (RW) [days, range: 1–180]
  • hps_forward_target_temp_rw — Forward target temperature (RW) [ºC, range: 5–50]
  • hps_temp_regulation_deadband_rw — Temperature regulation deadband (RW) [ºC, range: 0–5]
  • hps_max_supply_temp_rw — Maximum supply temperature (RW) [ºC, range: 20–55]

Cooling Settings

  • hps_both_heating_cooling_rw — Cooling and heating at the same time (RW)
    • 0 Off, 1 On
  • hps_passive_cooling_rw — Passive cooling (RW)
    • 0 Off, 1 On
  • hps_cooling_target_temp_rw — Cooling target temperature (RW) [ºC, range: 5–25]

Buffer Tank (Service)

  • hps_es_heating_rw — Electrical supplement heating (RW)
    • 0 Off, 1 On
  • hps_es_heating_delay_rw — Electrical supplement heater delay (RW) [min, range: 0–60]
  • hps_buffer_min_temp_rw — Minimum buffer temperature (RW) [ºC, range: 10–50]
  • hps_buffer_max_temp_rw — Maximum buffer temperature (RW) [ºC, range: 20–50]

Domestic Hot Water (DHW)

3-Way Valve

  • dhw_3way_mode_rw_inf — 3-way valve mode (RO)
    • 0 Heating, 1 Hot water production

Temperature Sensors

  • dhw_tank_top_temp_t11_ro — Tank top temperature [T11] (RO) [ºC]
  • dhw_tank_bottom_temp_t12_ro — Tank bottom temperature [T12] (RO) [ºC]

Production

  • dhw_target_temp_rw — DHW target temperature (RW) [ºC, range: 10–60]
  • dhw_production_for_rw — Hot water for (RW)
    • 0 None, 1 SHW, 2 DHW
  • dhw_pause_rw — DHW production pause (RW)
    • 0 Resume, 1 Pause
  • dhw_pause_duration_rw — DHW production pause duration (RW) [days, range: 1–180]
  • dhw_cool_priority_rw — Cooling priority over hot water (RW)
    • 0 Off, 1 On

Status

  • dhw_anode_ro — Anode status (RO)
    • 1 Ok, 3 Failure
  • dhw_compressor_level_rw_inf — Compressor capacity (RW) [%]
  • hw_hotwater_source_rw_inf — Hot water source (RO)
    • 0 Heating, 1 Hot water production

Electrical Supplement Heater

  • dhw_es_heater_on_rw — Electrical supplement heater state (RW)
    • 0 Off, 1 On
  • dhw_es_heater_below_temp_rw — Activate electrical supplement heater below (RW) [ºC, range: 30–65]

Protection

  • dhw_tank_frost_protection_rw — Frost protection of HW tank (RW)
    • 0 Off, 1 On
  • dhw_scalding_protection_rw — Scalding protection temperature (RW) [ºC, range: 40–80]

Anti-Legionella

  • dhw_al_on_ro — Anti-legionella status (RO)
    • 0 Off, 1 On
  • dhw_al_day_rw — Schedule in each month for the day (RW) [range: 1–28]
  • dhw_al_time_rw — Schedule for hour (RW) [o’clock, range: 0–23]
  • dhw_al_man_on_rw — Start anti-legionella manually (RW)
    • 0 Off, 1 On
  • dhw_al_auto_rw — Anti-legionella schedule (RW)
    • 0 Off, 1 Weekly, 2 Monthly

Other

  • ac_bypass_damper_offset_temp_rw — Bypass damper offset (RW) [ºC, range: 0–10]

Solar Hot Water (SHW)

  • shw_temp_t21_ro — SHW top temperature [T21] (RO) [ºC]
  • shw_temp_t22_ro — SHW bottom temperature [T22] (RO) [ºC]
  • shw_anode_ro — SHW anode status (RO)
    • 1 Ok, 3 Failure

Smart Grid

  • sys_smart_grid_on_rw — Smart grid state (RW)
    • 0 Off, 1 On
  • sys_smart_grid_es_heater_rw — Smart grid hot water (RW)
    • 0 Off, 1 On
  • sys_smart_grid_raise_hw_temp_rw — Raise hot water temperature (RW) [ºC, range: 0–10]
  • sys_lowprice_es_heater_rw — Smart grid central heating (RW)
    • 0 Off, 1 On
  • sys_lowprice_raise_ch_temp_rw — Raise central heating temperature (at low prices) (RW) [ºC, range: 0–10]
  • sys_overcapacity_raise_ch_temp_rw — Raise central heating temperature (overcapacity) (RW) [ºC, range: 0–10]

Outdoor Weather Compensation (OWC)

  • ac_owc_mode_rw_inf — OWC mode for ventilation (RW)
    • 0 Setpoint, 1 Curve
  • sys_ac_owc_mode_rw — OWC mode for ventilation (Service level) (RW)
    • 0 Setpoint, 1 Curve
  • owc_temp_m20_rw_inf — Supply temp at -20 ºC outdoor temp (RW) [ºC]
  • owc_temp_m10_rw_inf — Supply temp at -10 ºC outdoor temp (RW) [ºC]
  • owc_temp_0_rw_inf — Supply temp at 0 ºC outdoor temp (RW) [ºC]
  • owc_temp_10_rw_inf — Supply temp at 10 ºC outdoor temp (RW) [ºC]
  • owc_temp_20_rw_inf — Supply temp at 20 ºC outdoor temp (RW) [ºC]
  • owc_curve_offset_rw_inf — Curve offset (RW) [ºC]

Language

  • sys_language_rw_inf — HMI language (RW)
    • 0 EN, 32 DA, 33 DE, 44 FI, 47 FR, 72 IT, 117 NO, 128 PL