Askoma

ASKOMA AG | Industriestrasse 1 | CH-4922 Bützberg | Switzerland | Hotline +41 62 958 70 99 | support@askoma.com


ASKOHEAT+ Power to Heat

© 2020 Askoma AG

askoheat

Screw-in heaters and flange heaters for heating industrial ​and heating water with photovoltaic
Einschraubheizkörper und Flanschheizkörper zur Erwärmung von ​Brauch- ​und Heizungswasser mit Photovoltaik ​  


HTTP JSON Interface

Version 1.0 - 16.04.2020

The JSON interface extends the digital interface of AskoHeat+. The registers listed in the Modbus manual are also made accessible via this interface. The setting options are identical, so the description of the Modbus registers applies here.


Die JSON-Schnittstelle erweitert die digitale Schnittstelle von AskoHeat+. Die im Modbus-Handbuch aufgeführten Register werden ebenfalls über diese Schnittstelle zugänglich gemacht. Die Einstellmöglichkeiten sind identisch, daher gilt hier die Beschreibung der Modbus-Register.

HTTP GET

The connection is established via an HTTP request. The IP address is given as the URL of ASKOHEAT+ followed by the sub-pages listed below. The access method is GET. The web server in AskoHeat+ sends the response within one second.

(e.g. 192.168.1.245/getall.json)

Die Verbindung wird über eine HTTP-Anfrage hergestellt. Die IP-Adresse wird als URL von ASKOHEAT+ angegeben, gefolgt von den unten aufgeführten Unterseiten. Die Zugriffsmethode ist GET. Der Webserver in AskoHeat+ sendet die Antwort innerhalb einer Sekunde.

Command Description
/STATUS.JSON shows a list of current values and system states (update is done manually via the reload function of the browser)
/FULLSTATUS.JSON also shows settings
/GETALL.JSON gets all accessable modbus registeres of ASKOHEAT+
/GETCMD.JSON gets the command block of modbus registers
/GETCOMMAND.JSON same as /GETCMD.JSON
/GETEMA.JSON gets the energymanager values block of modbus registers
/GETENERGYMANAGER.JSON same as /GETEMA.JSON
/GETPAR.JSON gets the parameter block of modbus registers
/GETPARAMETER.JSON same as /GETPAR.JSON
/GETCON.JSON gets the configuration block of modbus registers
/GETCONFIGURATION.JSON same as /GETCON.JSON
/GETVAL.JSON gets the values block of modbus registers
/GETVALUES.JSON same as /GETVAL.JSON
/GETEXT.JSON gets the extended values block of modbus registers
/GETEXTENDED.JSON same as /GETEXT.JSON
/GETINT.JSON gets the internal values block of modbus registers
/GETINTERNAL.JSON same as /GETINT.JSON

HTTP PUT or PATCH

As content type “application/json” must be specified. The data is transferred in the request body to the ASKOHEAT+, where it is processed line by line and the permitted settings are applied. The corresponding data block is transferred as response.

The meaning of the individual registers is defined in the Modbus description and applies here in the same way.

The usage under Python for example is explained in a separate document.


Als Content Typ muss “application/json” angegeben werden. Die Daten werden im Request Body an den ASKOHEAT+ übergeben, dort zeilenweise abgearbeitet und die erlaubten Einstellungen übernommen. Als Antwort wird der entsprechende Datenblock übertragen.

Die Bedeutung der einzelnen Register ist in der Modbus-Beschreibung definiert und gilt hier gleichermaßen.

Die Nutzung beispielsweise unter Python ist in einem separatem Dokument exemplarisch erklärt.