Skip to content

JSON Interface

Gargano edited this page Jul 24, 2023 · 16 revisions

The key/value pairs are not absolutely necessary, any key/value pairs can be combined in post requests. Except there is a valve number defined, the valve number is absolutely necessary.

Valves

  • Set valves -

    • URL : http://ip/setvalve Request Method: POST

    • Payload : "valve": valvenr,"value": value

    • Example : { "valve": 1, "value": 21 }

  • Set tValue -

    • URL : http://ip/setvalve Request Method: POST

    • Payload : {"valve": valvenr,"ctrlValue": value}

    • Example : { "valve": 1, "ctrlValue": 21.2 }

  • Set tTarget -

    • URL : http://ip/setvalve Request Method: POST

    • Payload : {"valve": valvenr,"ctrlValue": value,"ctrlTarget": value}

    • Example : { "valve": 1, "ctrlTarget": 22 }

    • Example : { "valve": 1, "ctrlValue": 21.2, "ctrlTarget": 22 }

Please note that tTarget and tValue json posts only works if the value and target source is set to json in the valve control section

  • Get valves -
    • URL : http://ip/valves Request Method: GET
    • Response : { "valves": [ { "idx": 1, "name": "Wohn", "state": 1, "pos": 2, "meanCur": 19, "targetPos": 2, "tTarget": 21.0, "tValue": 18.0 } ] }

Valves control config

  • Set valve control config -

    • URL : http://ip/valvesctrlconfig Request Method: POST

    • Payload : { "common": { "heatControl": 1, "parkPosition": "10" }, "valves": [ { "no": 1, "active": 1, "allow": "0", "link": "0", "vSource": "3", "tSource": "1", "xp": "22", "offset": "0", "ti": "38", "ts": "900", "scheme": "0", "ki": "0.01", "startAZ": "5", "endAZ": "100" }, { "no": 2, "active": 0, "allow": "1", "link": "0", "vSource": "3", "tSource": "1", "xp": "22", "offset": "0", "ti": "39", "ts": "11", "scheme": "0", "ki": "0.01", "startAZ": "5", "endAZ": "100" }, { "no": 3, "active": 0, "allow": "1", "link": "0", "vSource": "3", "tSource": "1", "xp": "22", "offset": "0", "ti": "38", "ts": "900", "scheme": "0", "ki": "0.01", "startAZ": "5", "endAZ": "100" } ] }

    Regarding to the size limit you can send max. 3 items in the array per post

  • Example for [manual|heating|cooling|off]

  • Set valve control config of all valves

    • URL : http://ip/valvesctrlconfig Request Method: POST
    • Payload : {"active":0,"allow":1,"tSource":1,"vSource":3,"scheme":0,"startAZ":0,"endAZ":100}

    Please note that here is no array and no valve number defined

Clone this wiki locally