Benutzer-Werkzeuge

Webseiten-Werkzeuge


software:agenten:max

HECoS//Agent MAX


Beschreibung der HXL API zwischen der HECoS//Engine und HECoS//Agent MAX.

Cube

CUBES


Dieses Kommando wird nur vom HCL-Interface verwendet.

Cubes auflisten.

Anfrage:

Attribut Inhalt
cmd CUBES

Antwort:

Attribut Inhalt
rsp CUBES

Beispiele:

<hxl cmd="CUBES" />
<hxl rsp="CUBES">
  <cube id="cube-og" serial="MEQ0376129" rfaddress="11f220" firmware="1.1.3" rooms="8" devices="28" freememoryslots="50" rfdutycycle="1" ip="192.168.0.5" />
  <cube id="cube-ug" serial="MEQ0376128" rfaddress="13d1c5" firmware="1.1.3" rooms="3" devices="10" freememoryslots="50" rfdutycycle="1" ip="192.168.0.6" />
</hxl>

REBOOT


Dieses Kommando wird nur vom HCL-Interface verwendet.

Cube rebooten.

Anfrage:

Attribut Inhalt
cmd REBOOT
p1 Device Id

Antwort:

Attribut Inhalt
rsp OK | NOK

Beispiele:

<hxl cmd="REBOOT" p1="cube-ug" />
<hxl rsp="OK" />

NETONFIG


Dieses Kommando wird nur vom HCL-Interface verwendet.

Netzwerkeinstellungen abfragen oder setzen.

Sind die Parameter p2='SET' und p3='0.0.0.0', werden die Parameter p3, p4, p5 und p6 ignoriert und es wird DHCP auf aktiv gesetzt.

Anfrage:

Attribut Inhalt
cmd NETCONFIG
p1 Device Id
p2 GET/SET
p3 IP-Adresse (nur wenn p2=SET)
p4 Netzmaske (nur wenn p2=SET)
p5 Gateway (nur wenn p2=SET)
p6 DNS1 (nur wenn p2=SET)
p7 DNS2 (nur wenn p2=SET)

Antwort:

Attribut Inhalt
rsp OK | NOK
ip IP-Adresse
netmask Netzmaske
gateway Gateway
dns1 1. DNS
dns2 2. DNS
dhcp DHCP aktiv
encryption Encryption aktiv

Beispiele:

<hxl cmd="NETCONFIG" p1="cube-og" p2="GET" />
<hxl rsp="OK" ip="192.168.0.22" netmask="255.255.255.0" gateway="192.168.0.1" dns1="192.168.0.1" dns2="" encryption="YES" />
<hxl cmd="NETCONFIG" p1="cube-ug" p2="GET" />
<hxl rsp="OK" dhcp="YES" encryption="YES" />
<hxl cmd="NETCONFIG" p1="cube-ug" p2="SET" p3="192.168.0.22" p4="255.255.255.0" p5="192.168.0.1" p6="192.168.0.1" />
<hxl rsp="OK" />
<hxl cmd="NETCONFIG" p1="cube-ug" p2="SET" p3="0.0.0.0" />
<hxl rsp="OK" />

GET


Parameter abfragen.

Anfrage:

Attribut Inhalt
cmd GET
did Device Id
parameter Komma-separierte Liste mit Parameter Namen

Antwort:

Attribut Inhalt
rsp OK | NOK
Parameter name Wert

CUBE: actual-dns-primary actual-dns-secondary actual-gw actual-ip actual-netmask config-dns-primary config-dns-secondary config-gw config-ip config-netmask date dhcp duty-cycle encrypt firmware free-memory-slot http-id ntp-counter ntp-server portal-enabled portal-url rfaddress serial time time-state timezone timezone-dst url

HT: battery boost-duration boost-valve decalcification device-type dst error firmware gateway initialized link mode panel rfaddress room-id serial temperature-actual temperature-comfort temperature-eco temperature-max temperature-min temperature-offset temperature-target temperature-window-open test vacation-until valve valve-max valve-offset weekly-program window-open-duration

WT: battery device-type dst error firmware gateway initialized link mode panel rfaddress room-id serial temperature-actual temperature-comfort temperature-eco temperature-max temperature-min temperature-target test vacation-until weekly-program

SC: battery device-type dst error firmware gateway initialized link panel rfaddress room-id serial test window

SA: battery device-type dst error firmware gateway initialized link panel rfaddress room-id serial state test

Beispiele:

<hxl cmd="GET" did="cube-ug" parameter="serial, rfaddress" />
<hxl rsp="OK" serial="MEQ1234567" rfaddress="0x12abcd" />

SET


Parameter setzen.

Anfrage:

Attribut Inhalt
cmd SET
did Device Id
Parameter Name Wert

Antwort:

Attribut Inhalt
rsp OK | NOK

Beispiele:

<hxl cmd="SET" did="cube-ug" dhcp="YES" />
<hxl rsp="OK" />

ROOMS


Dieses Kommando wird nur vom HCL-Interface verwendet.

Räume abfragen, die in einem Cube konfiguriert sind.

Anfrage:

Attribut Inhalt
cmd ROOMS
did Device Id

Antwort:

Attribut Inhalt
rsp ROOMS

Beispiele:

<hxl cmd="ROOMS" did="cube-ug" />
<hxl rsp="ROOMS" >
  <room name="WOHNZIMMER" number="1" rfaddress="0x123456" />
  <room name="SCHLAFZIMMER" number="2" rfaddress="0x234567" />
  <room name="FLUR" number="3" rfaddress="0x345678" />
</hxl>

DEVICES


Dieses Kommando wird nur vom HCL-Interface verwendet.

Geräte abfragen, die in einem Cube konfiguriert sind.

Anfrage:

Attribut Inhalt
cmd DEVICES
did Device Id

Antwort:

Attribut Inhalt
rsp DEVICES

Beispiele:

<hxl cmd="DEVICES" did="cube-ug" />
<hxl rsp="DEVICES" >
  <device serial="MEQ1234567" name="Heizung" type="HT" room-id="1" room="Küche" rfaddress="0x123456" />
  <device serial="MEQ2345678" name="Tür" type="SC" room-id="2" room="Wohnzimmer" rfaddress="0x234567" />
</hxl>
software/agenten/max.txt · Zuletzt geändert: 2018/09/19 14:37 von Frank Werner