Benutzer-Werkzeuge

Webseiten-Werkzeuge


software:hxl:cmd

Anfragen und Antworten


PING


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

Anfrage:

Attribut Inhalt
cmd PING

Antwort:

Attribut Inhalt
rsp PONG

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:

Attribut Inhalt
cmd LOGIN
type AGENT/ONEWIRE, AGENT/CUL, AGENT/CAN, UI/ANDROID
cid Die Client Id
key Der SHA224-, SHA256-, SHA384- oder SHA512-Hash aus dem zusammengesetzen String des Preshared-Key und dem Attribut challenge aus dem Event CONNECTED, dargestellt in hexadezimaler Schreibweise

Antwort:

Attribut Inhalt
rsp GRANTED oder DENIED

Beispiel: Login.

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

EVENTS


Sender Empfänger
User Interfaces HECoS//Engine

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

Anfrage:

Attribut Inhalt
cmd EVENTS
did Device Id
state ON, OFF

Antwort:

Attribut Inhalt
rsp EVENTS
did Device Id
state ON, OFF

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


Sender Empfänger
User Interfaces HECoS//Engine

Abfragen, welche Etagen es gibt.

Anfrage:

Attribut Inhalt
cmd GETLEVELS

Antwort:

Attribut Inhalt
rsp LEVELS
lid Level Id
description Beschreibung der Etage

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


Sender Empfänger
User Interfaces HECoS//Engine

Abfragen, welche Räume es gibt.

Anfrage:

Attribut Inhalt
cmd GETROOMS

Antwort:

Attribut Inhalt
rsp ROOMS
lid Level Id
rid Room Id
description Beschreibung des Raumes

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


Sender Empfänger
User Interfaces HECoS//Engine

Abfragen, welche Devices es gibt.

Anfrage:

Attribut Inhalt
cmd GETDEVICES
dt Device Type

Antwort:

Attribut Inhalt
rsp DEVICES
dt Device Type
did Device Id
description Beschreibung des Devices
room Raum
weitere Attribute sind devicespezifisch

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:

Attribut Inhalt
cmd GET
did Device Id
weitere Attribute sind devicespezifisch

Antwort:

Attribut Inhalt
rsp GET
did Device Id
weitere Attribute sind devicespezifisch

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:

Attribut Inhalt
cmd SET
did Device Id
weitere Attribute sind devicespezifisch

Antwort:

Attribut Inhalt
rsp SET
did Device Id
weitere Attribute sind devicespezifisch

Beispiele:

<hxl cmd="SET" did="garten-lampe-kugeln" state="ON" />
<hxl rsp="SET" did="garten-lampe-kugeln" state="ON" />
software/hxl/cmd.txt · Zuletzt geändert: 2016/06/28 14:36 von Frank Werner