HECoS//wiki

PING

Um zu überprüfen, ob die Gegenstelle noch verfügbar ist, kann ein PING abgesetzt werden. Die Gegenstelle antwortet mit einem PONG.

Anfrage:

Antwort:

Beispiel:

<hxl cmd="PING" />
<hxl rsp="PONG" />

LOGIN

Für die Authentifizierung und Autorisierung ist die Anfrage LOGIN erforderlich.
Wenn die Anfrage mit einem DENIED beantwortet wird, beendet HECoS//Engine die Verbindung.

Anfrage:

Antwort:

Beispiel: Login.

<hxl cmd="LOGIN" type="AGENT/ONEWIRE" cid="agent-onewire-1" key="599d89037942e68a471c82435b7dfcc1a1df3d2dfbb97f1c1c877ee3f3ce11d6" />
<hxl rsp="GRANTED" />

EVENTS

Device-Events ein- oder ausschalten. Wird das Attribute state weggelassen, wird der aktuelle Status ermittelt.

Anfrage:

Antwort:

Beispiele:

<hxl cmd="EVENTS" did="aussen-ambient" state="ON" />
<hxl rsp="EVENTS" did="aussen-ambient" state="ON" />

<hxl cmd="EVENTS" did="aussen-ambient" />
<hxl rsp="EVENTS" did="aussen-ambient" state="ON" />

<hxl cmd="EVENTS" did="aussen-ambient" state="OFF" />
<hxl rsp="EVENTS" did="aussen-ambient" state="OFF" />

<hxl cmd="EVENTS" did="innen-ambient" />
<hxl rsp="EVENTS" did="innen-ambient" error="unknown device" />

GETLEVELS

Abfragen, welche Etagen es gibt.

Anfrage:

Antwort:

Beispiele:

<hxl cmd="GETLEVELS" />
<hxl rsp="LEVELS" >
  <level lid="GA" description="Aussen" />
  <level lid="UG" description="Untergeschoss" />
  <level lid="EG" description="Erdgeschoss" />
  <level lid="DG" description="Dachgeschoss" />
  <level lid="FW" description="Ferienwohnung" />
</hxl>

GETROOMS

Abfragen, welche Räume es gibt.

Anfrage:

Antwort:

Beispiele:

<hxl cmd="GETROOMS" />
<hxl rsp="ROOMS" >
  <room lid="GA" rid="1" description="Vorgarten" />
  <room lid="DG" rid="1" description="Abstellraum/Serverraum" />
  <room lid="EG" rid="1" description="Flur" />
</hxl>

GETDEVICES

Abfragen, welche Devices es gibt.

Anfrage:

Antwort:

Beispiele:

<hxl cmd="GETDEVICES" />
<hxl rsp="DEVICES" >
  <device dt="ONEWIRE/AMBIENTSENSOR" rid="GA.1" did="aussen-ambient" description="Aussensensor" voc="false" />
  <device dt="ONEWIRE/TEMPERATURESENSOR" rid="DG.1" did="serverraum-temperatur" description="Temperatur im Serverraum" />
  <device dt="FS20/SWITCH" rid="EG.5" did="wohnzimmer-lampe" description="Lampe im Wohnzimmer" />
</hxl>

GET

Wert eines Devices abfragen.

Anfrage:

Antwort:

Beispiele:

<hxl cmd="GET" did="aussen-ambient" sensor="huminity" />
<hxl rsp="GET" did="aussen-ambient" ts="1388996746000" huminity="95.2" />

SET

Wert eines Devices setzen.

Anfrage:

Antwort:

Beispiele:

<hxl cmd="SET" did="garten-lampe-kugeln" state="ON" />
<hxl rsp="SET" did="garten-lampe-kugeln" state="ON" />