This is an attempt to publicy document the fields and features of the Ökofen JSON API as it lacks documentation from the vendorside. Please feel free to file pull requests in case you have any additions or corrections. Most of the field descriptions are the result of trial and error.
After enabling the JSON API you need to configure the port and password within the heater's settings menu. Afterwards the JSON API should be exposed and reachable. You are able to access all metrics by hitting the all endpoint of the API.
http://{$ip}:{$port}/{$password}/all
| Abbreviation | Meaning |
|---|---|
| hk{$n} | Heating circuit #{$n} |
| pu{$n} | Buffer tank #{$n} |
| ww{$n} | Hot-water circuit #{$n} |
| sk{$n} | Solar thermal collector circuit #{$n} |
| pe{$n} | Pellematic heater #{$n} |
| se{$n} | Solar gain data #{$n} |
| circ{$n} | Hot-water circulation pump #{$n} |
The name of the fields are described with the dot-notation syntax. For the field json_data['system']['L_ambient'] the field name in this documentation would be system.L_ambient.
| Unit | Factor | Type | Range |
|---|---|---|---|
| °C | 0.1 | int | -32768 to 32767 |
Description
Temperature that was reported by the ambient temperature sensor. You'll need to multiply the value by the given factor to get the actual temperature in degree celsius als floating point value.
| Unit | Factor | Type | Range |
|---|---|---|---|
| None | 1 | int | -32768 to 32767 |
Description (Help Wanted)
Unclear if it's an error counter that is equal to the amount of errors that were detected or if the integer value that is reported by the API represents a specific error code or bitflag.
| Unit | Factor | Type | Range |
|---|---|---|---|
| None | None | bool | 0 or 1 |
Description (Unsure)
Whether an USB-stick is connected to the Pellematic heater or not.
| Unit | Factor | Type | Range |
|---|---|---|---|
| °C | 0.1 | int | -32768 to 32767 |
Description
Current temperature that was reported by the online weather service (see weather.L_source for information about the configured weather provider).
| Unit | Factor | Type | Range |
|---|---|---|---|
| % | 1 | int | -32768 to 32767 |
Description
How cloudy it currently should be according to the configured online weather service (see weather.L_source for information about the configured weather provider).
| Unit | Factor | Type | Range |
|---|---|---|---|
| °C | 0.1 | int | -32768 to 32767 |
Description
The current air temperature that was reported from a sensor that is installed inside a room that is heated by the used heating circuit. This value is zero (0) if there is no sensor installed for the given heating circuit.
| Unit | Factor | Type | Range |
|---|---|---|---|
| °C | 0.1 | int | -32768 to 32767 |
Description
The target air temperature that is set by the user for the selected heating circuit. This value can be ignored if there is no sensor installed for the given heating circuit.
| Unit | Factor | Type | Range |
|---|---|---|---|
| °C | 0.1 | int | -32768 to 32767 |
Description
The current flow temperature ("Vorlauftemperatur") of the heating system for the selected heating circuit.
| Unit | Factor | Type | Range |
|---|---|---|---|
| °C | 0.1 | int | -32768 to 32767 |
Description
The target flow temperature ("Vorlauftemperatur") of the heating system for the selected heating circuit.
| Unit | Factor | Type | Range |
|---|---|---|---|
| K | 0.1 | int | -32768 to 32767 |
Description Influences the target room temperature. Basis is the datapoint temp_heat. This datapoint sets the wanted target to +X or -Y relative to the basis of temp_heat. For example, temp_heat is set to 22 degree and remote_override is set to +2 the real target for the heating system is 24 degree.
| Unit | Factor | Type | Range |
|---|---|---|---|
| number | 1 | int | 0 to 3 |
Description The current mode of the heating circuit. 0: Off, 1: Auto, 2: Heating, 3: Setback
| Unit | Factor | Type | Range |
|---|---|---|---|
| number | 1 | int | 0 to 1 |
Description Defines the current active time program. Value 0 means "time program 1" and value 1 means "time program 2".
| Unit | Factor | Type | Range |
|---|---|---|---|
| °C | 0.1 | int | -32768 to 32767 |
Description The current setback ("Absenktemperatur") temperature. Relevant if either the time program defines that current the setback time is active or if the circuit is set to mode 3.
| Unit | Factor | Type | Range |
|---|---|---|---|
| °C | 0.1 | int | -32768 to 32767 |
Description The target temperature for the LED room thermostate. This temperature is the target if the remote is set to "middle" position. Relevant for the data point remote_override
| Unit | Factor | Type | Range |
|---|---|---|---|
| °C | 0.1 | int | -32768 to 32767 |
Description The target temperature while the heating system is in vacation mode. The vacation mode is set for a period of time on the touch (remote) control panel or through the app.
| Unit | Factor | Type | Range |
|---|---|---|---|
| °C | 0.1 | int | -32768 to 32767 |
Description The target temperature of the hot water boiler.
| Unit | Factor | Type | Range |
|---|---|---|---|
| num | 1 | int | 0 or 1 |
Description Indicates if the pump for the water heater is currently running or not. 0 means off, 1 means on.
| Unit | Factor | Type | Range |
|---|---|---|---|
| number | 1 | int | 0 to 1 |
Description Defines the current active time program. Value 0 means "time program 1" and value 1 means "time program 2".
| Unit | Factor | Type | Range |
|---|---|---|---|
| num | 1 | int | 0 or 1 |
Description If the time program normally would not allow the system to heat the water boiler, this value overrides the behaviour and allows the water to be heated once. This mode is set back after the hot water boiler reaching the target temperature.