JSON Feed

The CIC runs a webserver (this page is an output of it!). Next to this index page there is only one URL: /beta/feed/data.json which returns a dynamic JSON with the stats of the CIC, heatpump(s) and cv-ketel. The performance data can be requested from any CiC connected to the same network and can be integrated into a home automation system (eg Home Assistant). Only GET requests are accepted, CIC settings cannot be changed with this URL. The JSON feed is updated every second, requesting more often will not result in faster updates of the data.

Live feed:

Structure

The feed is structured as a JSON object, with the following properties:

• time:
  • ts: The timestamp of the JSON feed in Unix time (milliseconds since 1970-01-01T00:00:00Z).
  • tsHuman: The timestamp of the JSON feed in human-readable format (ISO 8601).
• hp1 / hp2: Information about the heatpump unit.
  • getMainWorkingMode: The current working mode of the heatpump as a numerical value. 0 - standby mode, 2 - Heating mode
  • temperatureOutside: The current ambient temperature outside the heatpump (in degrees Celsius).
  • temperatureWaterIn: The current temperature of the water going into the heatpump (in degrees Celsius).
  • temperatureWaterOut: The current temperature of the water coming out of the heatpump (in degrees Celsius).
  • limitedByCop: A boolean value indicating if the heatpump is limited by the COP based on energy pricing, current ambient temperature and heat pump outlet temperature.
  • power: The thermal power output of the heatpump (in Watts)
  • powerInput: The electrical power consumed by the heatpump (in Watts)
• boiler: Information about the boiler (cv ketel) - all boiler properties are only valid for systems with OpenTherm boiler only, unless specified otherwise.
  • otFbChModeActive: A boolean value indicating if the central heating mode is active.
  • otFbDhwActive: A boolean value indicating if the domestic hot water mode is active.
  • otFbFlameOn: A boolean value indicating if the boiler's flame is on.
  • otFbSupplyInletTemperature: The temperature of the water going into the boiler (in degrees Celsius).
  • otFbSupplyOutletTemperature: The temperature of the water coming out of the boiler (in degrees Celsius).
  • otTbCH: A boolean value representing CiC’s command to switch the boiler to heating mode.
  • oTtbTurnOnOffBoilerOn: A boolean value representing CiC’s command to switch an on-off boiler on.. This property is only valid for systems with on-off boilers.
• flowMeter: Information about the flow meter.
  • waterSupplyTemperature: The current temperature of the water supplied by the boiler (in degrees Celsius).
• thermostat: Information about the thermostat.
  • otFtChEnabled: A boolean value representing command from thermostat to switch on heating.
  • otFtDhwEnabled: A boolean value indicating if the domestic hot water is enabled.
  • otFtCoolingEnabled: A boolean value indicating if the cooling is enabled.
  • otFtControlSetpoint: The current setpoint for water supply temperature from the thermostat (in degrees Celsius).
  • otFtRoomSetpoint: The current setpoint temperature for the room (in degrees Celsius).
  • otFtRoomTemperature: The current temperature of the room (in degrees Celsius).
• qc: Quality control information.
  • supervisoryControlMode: The current supervisory control mode of the heatpump as a numerical value.

    Description	supervisoryControlMode
    Standby	0
    Standby - heating	1
    Heating - heatpump only	2
    Heating - heatpump + boiler	3
    Heating - boiler only	4
    Anti-freeze protection - boiler on	96
    Anti-freeze protection - boiler pre-pump	97
    Anti-freeze protection - water circulation	98
    Fault - circulation pump on	99
    Commissioning modes	>= 100

  • stickyPumpProtectionEnabled: A flag that indicates when the circulating pump is being operated to prevent pump from sticking
  • flowRateFiltered: The current flow rate of the water in the heating circuit (in liters per hour).
  • electricityPriceUsed: Electricity price currently used by the controller (in €/kWh)
  • gasPriceUsed: Gas price currently used by the controller (in €/m3)
• system: Information about the system hosting the heatpump.
  • hostname: The hostname of the system hosting the heatpump.
  • electricityTariffType: Electricity tariff type as a numerical value. 0 - single, 1 - double, 2 - dynamic
  • gasTariffType: Gas tariff type as a numerical value. 0 - single, 2 - dynamic

All-electric (All-E) properties

These properties apply to All-Electric systems.

• hb:
  • showerMinutes: Shower minutes stored in HeatBattery
  • topTemperature: HeatCharger water temperature at the top of the HeatBattery (in degrees Celsius)
  • middleTemperature: HeatCharger water temperature at the middle of the HeatBattery (in degrees Celsius)
  • bottomTemperature: HeatCharger water temperature at the bottom of the HeatBattery (in degrees Celsius)
• hc:
  • chHeatExchangerInletTemperature: HeatCharger water temperature going into the CH heat exchanger, coming in from the ODU (in degrees Celsius)
  • heatingSystemPressure: HeatCharger water pressure in the heating system (in BarA)
  • distributionSystemSupplyTemperature: HeatCharger central heating distribution system supply water temperature
• qcAllE:
  • isAntilegionellaActive: Is anti legionella mode active
  • allESupervisoryControlMode: Supervisory control mode of the all-electric controller.

    Description	allESupervisoryControlMode
    Idle	0
    Pre/post pumping	1
    Charge - normal	2
    Charge - boost	3
    Charge - backup	4
    Charge - normal backup	5
    Charge - CH backup	6
    CH backup	7
    Discharge	8
    Discharge - CH backup	9
    Sticky pump protection	10
    Pre/post pump to charging	11
    Pre/post pump to discharging	12