Thing Kommandos

19min
System
Über diese Kommandos wird die grundlegende Verwaltung der angelernten Geräte durchgeführt.
RefreshSupportedThingsDTO
Aktualisiert die Informationen über die unterstützten Geräte. Es wird ein SupportedThingInfoDTO﻿ für jedes unterstütze Gerät zurückgeliefert.
Codebeispiele
RefreshSupportedThingsDTO
{
  "commandId" : "OwnCommandId"
}
{
  "commandId" : "OwnCommandId"
}
﻿
CreateThingDTO
Erzeugt ein neues Gerät basierend auf der Referenz-ID.
Feld
Datentyp
Beschreibung
referenceId
String
Eindeutige ID des Kommandos, diese wird selbst vergeben.
name
String
Der für das neue Gerät zu verwendente Name.
Codebeispiele
CreateThingDTO
{
  "commandId" : "OwnCommandId",
  "referenceId" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "name" : "Dimmer bathroom"
}
{
  "commandId" : "OwnCommandId",
  "referenceId" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "name" : "Dimmer bathroom"
}
﻿
SetAutoPairingEnabledDTO
Das automatische Anlernen kann über dieses Kommando aktiviert / deaktiviert werden. Optional lässt sich einstellen das dieses nach einer vorgegebenen Zeit automatisch wieder deaktiviert wird.
Feld
Datentyp
Beschreibung
enabled
Boolean
Flag ob das automatische Anlernen aktiviert oder deaktiviert werden soll.
enabledForSec
Number
Angabe wie viele Sekunden das automatische Anlernen aktiv sein soll. Bei einem Wert von 0 bleibt das automatische Anlernen so lange aktiv bis es wieder deaktiviert wird.
Codebeispiele
SetAutoPairingEnabledDTO
{
  "commandId" : "OwnCommandId",
  "enabled" : true,
  "enabledForSec" : 120
}
{
  "commandId" : "OwnCommandId",
  "enabled" : true,
  "enabledForSec" : 120
}
﻿
RefreshThingsDTO
Aktualisierung von einem oder mehreren Geräten anfordern.
Feld
Datentyp
Beschreibung
thingIds
Array
Eine Auflistung von Geräte IDs. Ist das Feld nicht vorhanden oder leer, werden alle Geräte aktualisiert.
Codebeispiele
RefreshThingsDTO 1
RefreshThingsDTO 2
{
  "commandId" : "OwnCommandId",
  "thingIds" : [ "dd340905-2c7a-4d57-a702-d3758902d03b", "8d638845-6270-476f-9878-860dc7ae0bde" ]
}
{
  "commandId" : "OwnCommandId",
  "thingIds" : [ "dd340905-2c7a-4d57-a702-d3758902d03b", "8d638845-6270-476f-9878-860dc7ae0bde" ]
}
﻿
RefreshDescriptionsDTO
Aktualisierung aller Wertbeschreibungen.
Feld
Datentyp
Beschreibung
descriptionIds
Array
Eine Auflistung von Wertbeschreibungs-IDs. Ist das Feld nicht vorhanden oder leer, werden alle Wertbeschreibungsen aktualisiert.
Codebeispiele
RefreshDescriptionsDTO 1
RefreshDescriptionsDTO 2
{
  "commandId" : "OwnCommandId",
  "descriptionIds" : [ "C59CC0096A458B4038E20E7ADDC70A0D", "E21D6D20C03D05AA9E368DD9F79BEC5A" ]
}
{
  "commandId" : "OwnCommandId",
  "descriptionIds" : [ "C59CC0096A458B4038E20E7ADDC70A0D", "E21D6D20C03D05AA9E368DD9F79BEC5A" ]
}
﻿
Gerätespezifisch
Kommandos die sich direkt auf ein existierendes Gerät beziehen, benötigen immer die ID des Gerätes. Daher ist das Feld "id" in jedem Geräte-Kommando-Objekt vorhanden.
Feld
Datentyp
Beschreibung
id
String
Eindeutige ID eines Gerätes.
DeleteThingDTO
Zum Löschen eines Gerätes wird nur die Geräte-ID benötigt, daher gibt es keine weiteren Felder.
Codebeispiele
DeleteThingDTO
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b"
}
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b"
}
﻿
RenameThingDTO
Umbenennen eines Gerätes.
Feld
Datentyp
Beschreibung
newName
String
Der neue Name für das Gerät.
Codebeispiele
RenameThingDTO
{
  "commandId" : "OwnCommandId",
  "id" : "da592b04-af82-4d88-a8b2-446d4f21fb80",
  "newName" : "Renamed Device"
}
{
  "commandId" : "OwnCommandId",
  "id" : "da592b04-af82-4d88-a8b2-446d4f21fb80",
  "newName" : "Renamed Device"
}
﻿
SetThingChannelValueDTO
Stellt den Kanalwert eines Geräts auf den eingestellten Wert ein.
Feld
Datentyp
Beschreibung
channelId
String
Eindeutige ID eines Gerätekanals.
newValue
String
Der neue zu setzende Wert. Dieser wird immer als String übertragen. Auch bei Zahlenwerten!
Bei erfolgreicher Änderung wird das zugehörige Geräteobjekt aktualisiert.
Codebeispiele
SetThingChannelValueDTO 1
SetThingChannelValueDTO 2
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "channelId" : "Dimmer",
  "newValue" : "80"
}
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "channelId" : "Dimmer",
  "newValue" : "80"
}
﻿
SetThingParameterDTO
Ändern von Geräteparametern.
Feld
Datentyp
Beschreibung
parameterId
String
Eindeutige Parameter ID bezogen auf ein Gerät.
newValue
String
Der neue zu setzende Wert. Dieser wird immer als String übertragen. Auch bei Zahlenwerten!
Codebeispiele
SetThingParameterDTO 1
SetThingParameterDTO 2
{
  "commandId" : "OwnCommandId",
  "id" : "295d0951-ff6b-4cf4-9b86-add3f7d2808f",
  "parameterId" : "ShutdownTime",
  "newValue" : "60"
}
{
  "commandId" : "OwnCommandId",
  "id" : "295d0951-ff6b-4cf4-9b86-add3f7d2808f",
  "parameterId" : "ShutdownTime",
  "newValue" : "60"
}
﻿
EnOcean
Hierbei handelt es sich um Kommandos welche nur mit EnOcean Geräten funktionieren.
AssignAcknowledgeIdDTO
Zuweisung einer EnOcean-ID zu einem Empfangskanal.
Feld
Datentyp
Beschreibung
eurid
String
Die EURID des EnOcean Gerätes. 
acknowledgeChannelName
String
Einer der für das Gerät möglichen Empfangskanalnamen.
Codebeispiele
AssignAcknowledgeIdDTO
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "eurid" : "0x03245245",
  "acknowledgeChannelName" : "default"
}
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "eurid" : "0x03245245",
  "acknowledgeChannelName" : "default"
}
﻿
SendPairingSignalDTO
Senden eines Lernsignals für Aktoren. Das Gateway für das Senden des Signals muss angegeben werden, damit die korrekte Sende-ID bestimmt werden kann.
Feld
Datentyp
Beschreibung
gatewayId
String
Eindeutige ID eines EnOcean Gateways zur Bestimmung der Sende-ID.
transmissionChannelName
String
Einer der für das Gerät möglichen Sendekanalnamen.
secure
Boolean
Angabe ob ein Lernsignal mit Verschlüsselung gesendet wird.
Codebeispiele
SendPairingSignalDTO
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "gatewayId" : "12342648",
  "transmissionChannelName" : "default",
  "secure" : false
}
{
  "commandId" : "OwnCommandId",
  "id" : "dd340905-2c7a-4d57-a702-d3758902d03b",
  "gatewayId" : "12342648",
  "transmissionChannelName" : "default",
  "secure" : false
}
﻿
﻿
Aktualisiert 25 Mar 2024
Hat Ihnen diese Seite geholfen?
System Kommandos
ALS NÄCHSTES
Logik Kommandos
Docs powered by Archbee
INHALT
System
RefreshSupportedThingsDTO
CreateThingDTO
SetAutoPairingEnabledDTO
RefreshThingsDTO
RefreshDescriptionsDTO
Gerätespezifisch
DeleteThingDTO
RenameThingDTO
SetThingChannelValueDTO
SetThingParameterDTO
EnOcean
AssignAcknowledgeIdDTO
SendPairingSignalDTO
Feld	Datentyp	Beschreibung
referenceId	String	Eindeutige ID des Kommandos, diese wird selbst vergeben.
name	String	Der für das neue Gerät zu verwendente Name.