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 |
|---|---|---|---|
| N/A | N/A | int | 0 to 3 |
Description The heating mode of the heating system, 0 is disabled, 1 is auto, 2 is comfort, 3 is reduced