search

thannaske / oekofen-json-documentation

The community-driven missing documentation for the JSON interface of Oekofen heating systems
MIT License
20 stars 4 forks source link

Just a few things i found while playing with api might help complete this doc #2

Open hdgdl opened 2 years ago

hdgdl commented 2 years ago

Oekofen JSON Interface V4.00b http://www.oekofen.at

usage: http://touch_ip:JSON_port/password/command

==================================================================================== read multiple values:

http://192.168.1.115:4321/********/all?

Example: http://192.168.1.115:4321/********/hk1?

all[?]     displays values of all available components
           optional parameter [?] adds meta data

error
    read current errors

log[0..3]
    download csv-logging file

system[?]
    system global variables

weather[?]
    current weather data

forecast[?]
    date|temp|cloud|speed|image|code|unit[|sunrise|sunset] code see https://openweathermap.org/weather-conditions

power[?]
    powermeter data

stirling[?]
    stirling data

hk[1..6][?]
    heating circuit data

thirdparty[1..20][?]
    third party sensor

pu[1..3][?]
    accu data

ww[1..3][?]
    domestic hot water data

sk[1..6][?]
    solar circuit data

se[1..3][?]
    solar gain data

circ[1..3][?]
    circulation pump data

pe[1..4][?]
    pellematic data

==================================================================================== read single value (use '.' as delimitor):

http://192.168.1.115:4321/********/id(1..6).variable

Example: http://192.168.1.115:4321/********/hk1.L_roomtemp_act

==================================================================================== set value (use '.' as delimitor):

http://192.168.1.115:4321/********/id(1..6).variable=value

Example: http://192.168.1.115:4321/********/hk1.mode_auto=0

==================================================================================== alternative useage '_' as delimitor:

http://192.168.1.115:4321/********/id(1..6)_variable=value

Example: http://192.168.1.115:4321/********/hk1_mode_auto=0

system
    system global variables

weather
    current weather data

forecast
    date|temp|cloud|speed|image|code|unit[|sunrise|sunset] code see https://openweathermap.org/weather-conditions

power
    powermeter data

stirling
    stirling data

hk(1..6)
    heating circuit data

thirdparty(1..20)
    third party sensor

pu(1..3)
    accu data

ww(1..3)
    domestic hot water data

sk(1..6)
    solar circuit data

se(1..3)
    solar gain data

circ(1..3)
    circulation pump data

pe(1..4)
    pellematic data

only variables without a leading 'L_' can be set.

————————————

only have pellematic and no solar therefor the „all?“ does not include all options

{
 "system":{
  "system_info":"system global variables",
  "L_ambient":{"val":104, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_errors":{"val":0, "factor":1, "min":-32768, "max":32767}, 
  "L_usb_stick":{"val":0, "format":"0:Aus|1:Ein"}, 
  "L_existing_boiler":{"val":0, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}
 },
 "weather":{
  "weather_info":"current weather data",
  "L_temp":{"val":100, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_clouds":{"val":1, "unit":"%", "factor":1, "min":-32768, "max":32767}, 
  "L_forecast_temp":{"val":150, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_forecast_clouds":{"val":68, "unit":"%", "factor":1, "min":-32768, "max":32767}, 
  "L_forecast_today":{"val":0, "format":"0:Heute|1:Morgen"}, 
  "L_starttime":{"val":900, "factor":1, "min":-32768, "max":32767}, 
  "L_endtime":{"val":1620, "factor":1, "min":-32768, "max":32767}, 
  "L_source":{"val":"http://www.openweathermap.org", "length":20}, 
  "L_location":{"val":"xxx|DE|12345", "length":20}, 
  "cloud_limit":{"val":55, "unit":"%", "factor":1, "min":0, "max":100}, 
  "hysteresys":{"val":-40, "unit":"K", "factor":0.1, "min":-200, "max":0}, 
  "offtemp":{"val":-100, "unit":"°C", "factor":0.1, "min":-300, "max":200}, 
  "lead":{"val":120, "unit":"min", "factor":1, "min":0, "max":600}, 
  "refresh":{"val":0}, 
  "oekomode":{"val":0, "format":"0:Aus|1:Ein"}
 },
 "forecast":{
  "forecast_info":"date|temp|cloud|speed|image|code|unit[|sunrise|sunset] code see https://openweathermap.org/weather-conditions",
  "L_w_0":{"val":"Di, 26 Okt 22:15|10|1|3 km/h|01n|800|C|08:06|18:14", "length":20}, 
  "L_w_1":{"val":"Di, 26 Okt 20:00|11|20|6 km/h|02n|801|C", "length":20}, 
  "L_w_2":{"val":"Di, 26 Okt 23:00|11|47|6 km/h|03n|802|C", "length":20}, 
  "L_w_3":{"val":"Mi, 27 Okt 02:00|10|73|5 km/h|04n|803|C", "length":20}, 
  "L_w_4":{"val":"Mi, 27 Okt 05:00|8|58|5 km/h|04n|803|C", "length":20}, 
  "L_w_5":{"val":"Mi, 27 Okt 08:00|8|57|5 km/h|04n|803|C", "length":20}, 
  "L_w_6":{"val":"Mi, 27 Okt 11:00|12|90|5 km/h|04d|804|C", "length":20}, 
  "L_w_7":{"val":"Mi, 27 Okt 14:00|15|85|7 km/h|04d|804|C", "length":20}, 
  "L_w_8":{"val":"Mi, 27 Okt 17:00|15|51|6 km/h|04d|803|C", "length":20}, 
  "L_w_9":{"val":"Mi, 27 Okt 20:00|11|39|3 km/h|03n|802|C", "length":20}, 
  "L_w_10":{"val":"Mi, 27 Okt 23:00|10|58|3 km/h|04n|803|C", "length":20}, 
  "L_w_11":{"val":"Do, 28 Okt 02:00|9|61|3 km/h|04n|803|C", "length":20}, 
  "L_w_12":{"val":"Do, 28 Okt 05:00|9|18|3 km/h|02n|801|C", "length":20}, 
  "L_w_13":{"val":"Do, 28 Okt 08:00|8|13|4 km/h|02n|801|C", "length":20}, 
  "L_w_14":{"val":"Do, 28 Okt 11:00|11|5|6 km/h|01d|800|C", "length":20}, 
  "L_w_15":{"val":"Do, 28 Okt 14:00|14|3|9 km/h|01d|800|C", "length":20}, 
  "L_w_16":{"val":"Do, 28 Okt 17:00|13|1|8 km/h|01d|800|C", "length":20}, 
  "L_w_17":{"val":"Do, 28 Okt 20:00|10|2|6 km/h|01n|800|C", "length":20}, 
  "L_w_18":{"val":"Do, 28 Okt 23:00|9|23|4 km/h|02n|801|C", "length":20}, 
  "L_w_19":{"val":"Fr, 29 Okt 02:00|9|46|4 km/h|03n|802|C", "length":20}, 
  "L_w_20":{"val":"Fr, 29 Okt 05:00|8|94|6 km/h|04n|804|C", "length":20}, 
  "L_w_21":{"val":"Fr, 29 Okt 08:00|8|93|5 km/h|04n|804|C", "length":20}, 
  "L_w_22":{"val":"Fr, 29 Okt 11:00|11|96|6 km/h|04d|804|C", "length":20}, 
  "L_w_23":{"val":"Fr, 29 Okt 14:00|15|83|8 km/h|04d|803|C", "length":20}, 
  "L_w_24":{"val":"Fr, 29 Okt 17:00|14|100|6 km/h|04d|804|C", "length":20}
 },
 "hk1":{
  "hk_info":"heating circuit data",
  "L_roomtemp_act":{"val":0, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_roomtemp_set":{"val":80, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_flowtemp_act":{"val":424, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_flowtemp_set":{"val":80, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_comfort":{"val":0, "unit":"K", "factor":0.1, "min":-32768, "max":32767}, 
  "L_state":{"val":65552, "factor":1}, 
  "L_statetext":"Absenkbetrieb aktiv|Außentemp über Heizgrenze absenken",
  "L_pump":{"val":0, "format":"0:Aus|1:Ein"}, 
  "remote_override":{"val":0, "unit":"K", "factor":0.1, "min":-32768, "max":32767}, 
  "mode_auto":{"val":1, "format":"0:Aus|1:Auto|2:Heizen|3:Absenken"}, 
  "time_prg":{"val":0, "format":"0:Zeit 1|1:Zeit 2"}, 
  "temp_setback":{"val":180, "unit":"°C", "factor":0.1, "min":100, "max":400}, 
  "temp_heat":{"val":220, "unit":"°C", "factor":0.1, "min":100, "max":400}, 
  "temp_vacation":{"val":150, "unit":"°C", "factor":0.1, "min":100, "max":400}, 
  "name":{"val":"Heizkreis", "length":20}, 
  "oekomode":{"val":0, "format":"0:Aus|1:Komfort|2:Minimum|3:Ökologisch"}, 
  "autocomfort":{"val":-1, "format":"0:Aus|1:Ein|2:Morgens|3:Abends"}, 
  "autocomfort_sunset":{"val":0, "unit":"min", "factor":1, "min":-120, "max":120}, 
  "autocomfort_sunrise":{"val":0, "unit":"min", "factor":1, "min":-120, "max":120}
 },
 "pu1":{
  "pu_info":"accu data",
  "L_tpo_act":{"val":613, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_tpo_set":{"val":80, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_tpm_act":{"val":418, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_tpm_set":{"val":80, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_pump_release":{"val":80, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_pump":{"val":0, "unit":"%", "factor":1, "min":0, "max":100}, 
  "L_state":{"val":512, "factor":1}, 
  "L_statetext":"Anforderung Aus",
  "mintemp_off":{"val":80, "unit":"°C", "factor":0.1, "min":80, "max":900}, 
  "mintemp_on":{"val":80, "unit":"°C", "factor":0.1, "min":80, "max":900}, 
  "ext_mintemp_off":{"val":80, "unit":"°C", "factor":0.1, "min":80, "max":900}, 
  "ext_mintemp_on":{"val":80, "unit":"°C", "factor":0.1, "min":80, "max":900}
 },
 "ww1":{
  "ww_info":"domestic hot water data",
  "L_temp_set":{"val":250, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_ontemp_act":{"val":617, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_offtemp_act":{"val":617, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_pump":{"val":0, "format":"0:Aus|1:Ein"}, 
  "L_state":{"val":8200, "factor":1}, 
  "L_statetext":"Zeit außerhalb Zeitprogramm|Anforderung Aus",
  "time_prg":{"val":0, "format":"0:Zeit 1|1:Zeit 2"}, 
  "sensor_on":{"val":0, "format":"0:WW|1:TPO|2:TPM|3:SpUnten"}, 
  "sensor_off":{"val":0, "format":"0:WW|1:TPO|2:TPM|3:SpUnten"}, 
  "mode_auto":{"val":1, "format":"0:Aus|1:Auto|2:Ein"}, 
  "mode_dhw":{"val":1, "format":"0:Aus|1:Auto|2:Ein"}, 
  "heat_once":{"val":0, "format":"0:Aus|1:Ein"}, 
  "temp_min_set":{"val":300, "unit":"°C", "factor":0.1, "min":80, "max":800}, 
  "temp_max_set":{"val":550, "unit":"°C", "factor":0.1, "min":80, "max":800}, 
  "name":{"val":"", "length":20}, 
  "smartstart":{"val":0, "unit":"min", "factor":1, "min":0, "max":90}, 
  "use_boiler_heat":{"val":0, "format":"0:Aus|1:Ein"}, 
  "oekomode":{"val":0, "format":"0:Aus|1:Komfort|2:Minimum|3:Ökologisch"}
 },
 "circ1":{
  "circ_info":"circulation pump data",
  "L_pummp":{"val":0, "format":"0:Aus|1:Ein"}, 
  "L_ret_temp":{"val":356, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_release_temp":{"val":617, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "time_prg":{"val":0, "format":"0:Zeit 1|1:Zeit 2"}, 
  "mode":{"val":1, "format":"0:Aus|1:Auto"}, 
  "pump_release":{"val":300, "unit":"°C", "factor":0.1, "min":0, "max":900}, 
  "return_set":{"val":450, "unit":"°C", "factor":0.1, "min":0, "max":900}, 
  "name":{"val":"", "length":20}
 },
 "pe1":{
  "pe_info":"pellematic data",
  "L_temp_act":{"val":642, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_temp_set":{"val":80, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_ext_temp":{"val":-32768, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_frt_temp_act":{"val":1093, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_frt_temp_set":{"val":80, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_frt_temp_end":{"val":80, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_br":{"val":0, "format":"0:Aus|1:Ein"}, 
  "L_ak":{"val":0, "format":"0:Aus|1:Ein"}, 
  "L_not":{"val":1, "format":"0:Aus|1:Ein"}, 
  "L_stb":{"val":1, "format":"0:Aus|1:Ein"}, 
  "L_modulation":{"val":0, "unit":"%", "factor":1, "min":-32768, "max":32767}, 
  "L_runtimeburner":{"val":0, "unit":"zs", "factor":0.01}, 
  "L_resttimeburner":{"val":0, "unit":"zs", "factor":0.01}, 
  "L_currentairflow":{"val":0, "unit":"%", "factor":1, "min":-32768, "max":32767}, 
  "L_lowpressure":{"val":620, "unit":"EH", "factor":0.1, "min":-32768, "max":32767}, 
  "L_lowpressure_set":{"val":800, "unit":"EH", "factor":0.1, "min":-32768, "max":32767}, 
  "L_fluegas":{"val":0, "unit":"%", "factor":1, "min":-32768, "max":32767}, 
  "L_uw_speed":{"val":0, "unit":"%", "factor":1, "min":-32768, "max":32767}, 
  "L_state":{"val":99, "format":"0:Dauerlauf|1:Start|2:Zuendung|3:Softstart|4:Leistungsbrand|5:Nachlauf|6:Aus|7:Saugen|8:! Asche !|9:! Pellets !|10:Pell Switch|11:Störung|12:Einmessen|13:1|14:1|15:1|16:1|17:1|18:1|19:1|20:1|21:1|22:1|23:1|24:1|25:1|26:1|27:1|28:1|29:1|30:1|31:1|32:1|33:1|34:1|35:1|36:1|37:1|38:1|39:1|40:1|41:1|42:1|43:1|44:1|45:1|46:1|47:1|48:1|49:1|50:1|51:1|52:1|53:1|54:1|55:1|56:1|57:1|58:1|59:1|60:1|61:1|62:1|63:1|64:1|65:1|66:1|67:1|68:1|69:1|70:1|71:1|72:1|73:1|74:1|75:1|76:1|77:1|78:1|79:1|80:1|81:1|82:1|83:1|84:1|85:1|86:1|87:1|88:1|89:1|90:1|91:1|92:1|93:1|94:1|95:1|96:1|97:Aus|98:Aus|99:Aus|100:Aus|101:Aus"}, 
  "L_statetext":"Aus",
  "L_type":{"val":1, "format":"0:PE|1:PES|2:PEK|3:PESK|4:SMART V1|5:SMART V2|6:CONDENS|7:SMART XS|8:SMART V3|9:COMPACT|10:AIR"}, 
  "L_starts":{"val":220, "factor":1}, 
  "L_runtime":{"val":173, "unit":"h", "factor":1}, 
  "L_avg_runtime":{"val":47, "unit":"min", "factor":1}, 
  "L_uw_release":{"val":613, "unit":"°C", "factor":0.1, "min":-32768, "max":32767}, 
  "L_uw":{"val":0, "unit":"%", "factor":1, "min":-32768, "max":32767}, 
  "L_storage_fill":{"val":3916, "unit":"kg", "factor":1}, 
  "L_storage_min":{"val":400, "unit":"kg", "factor":1, "min":0, "max":4000}, 
  "L_storage_max":{"val":6000, "unit":"kg", "factor":1, "min":150, "max":30000}, 
  "L_storage_popper":{"val":37, "unit":"kg", "factor":1, "min":-32768, "max":32767}, 
  "storage_fill_today":{"val":23, "unit":"kg", "factor":1, "min":-32768, "max":32767}, 
  "storage_fill_yesterday":{"val":23, "unit":"kg", "factor":1, "min":-32768, "max":32767}, 
  "mode":{"val":1, "format":"0:Aus|1:Auto|2:Ein"}
 },
   "error":{
   }
}
ansysic commented 11 months ago

Any idea why all commands I try only get me the "landing" page json? No single command working either.

http://192.168.178.178:4321/Gn7c/all? returns:

Oekofen JSON Interface          http://www.oekofen.at

usage:
http://touch_ip:JSON_port/password/command

====================================================================================
read multiple values:
====================================================================================
http://192.168.178.178:4321/********/all?

Example: http://192.168.178.178:4321/********/hk1?

    all[?]     displays values of all available components
               optional parameter [?] adds meta data

    system[?]
        system global variables
ansysic commented 11 months ago

Wow, found the error. Edge was automatically lowercasing my password. WTF. Works now in curl