Jedes Steuergerät hat einen eigenen API-Typ, der auf der Registerkarte „Details, Aktualisierung und Hilfe“ eingesehen werden kann; so hat beispielsweise der Temperatursensor „tempSensor“ den API-Typ „multiSensor“.
Ausführliche Unterlagen finden Sie unter diesem Link: https://technical.blebox.eu/
switchBox
Für Aktionen vom Typ „URL senden“:
– http://IP/s/(…REQUEST…)
Für Aktionen vom Typ: „Ein anderes Gerät steuern“:
– (…REQUEST…)
wobei (…REQUEST…) die im Folgenden beschriebene Ziffer ist:
- 0 – deaktiviert
- 1 – schaltet ein
- 2 – schaltet den Zustand in den entgegengesetzten um (wenn er eingeschaltet war, wird er ausgeschaltet und umgekehrt)
Fortgeschrittene:
- 1/forTime/(…TIMES…)/ns/0
wobei (…TIMES…) die Zeit in Sekunden angibt, für die die SwitchBox eingeschaltet bleiben soll
Beispiele:
- 1/forTime/5/ns/0 – Das angeschlossene Gerät wird für 5 Sekunden eingeschaltet
SwitchBox mit mehreren Ausgängen
Für Aktionen vom Typ „URL senden“:
– http://IP/s/(…OUTPUT…)/(…REQUEST…)
Für Aktionen vom Typ: „Ein anderes Gerät steuern“:
– (…OUTPUT…)/(…REQUEST…)
wobei (…OUTPUT…) die im Folgenden beschriebene Ziffer ist:
- 0 – erster Ausgang (O1)
- 1 – zweiter Ausgang (O2)
wobei (…REQUEST…) die im Folgenden beschriebene Ziffer ist:
- 0 – deaktiviert
- 1 – schaltet ein
- 2 – schaltet den Zustand in den entgegengesetzten um (wenn er eingeschaltet war, wird er ausgeschaltet und umgekehrt)
Beispiele:
- 0/1 – schaltet den Ausgang O1 ein
- 1/1 – schaltet den Ausgang O2 ein
- 0/2 – kehrt den Zustand des Ausgangs O1 um (wenn der Ausgang eingeschaltet war, wird er ausgeschaltet und umgekehrt)
Fortgeschrittene:
- (…OUTPUT…)/1/forTime/(…TIMES…)/ns/0
wobei (…OUTPUT…) die Ausgangsnummer ist (siehe oben) und (…TIMES…) die Zeit in Sekunden angibt, für die der Ausgang „switchBoxD“ eingeschaltet werden soll.
Beispiele:
- 0/1/forTime/5/ns/0 – schaltet den Ausgang O1 für 5 Sekunden ein
- 1/1/forTime/5/ns/0 – schaltet den Ausgang O2 für 5 Sekunden ein
wLightBoxS und dimmerBox
Für Aktionen vom Typ „URL senden“:
– http://IP/s/(…REQUEST…)
Für Aktionen vom Typ: „Ein anderes Gerät steuern“:
– (…REQUEST…)
wobei (…REQUEST…) der Helligkeitswert im WW-Format ist. Er wird hexadezimal mit zwei Zeichen dargestellt (00–FF, was der dezimalen Darstellung 0–255 entspricht):
- 00 – schaltet aus
- FF – schaltet ein, stellt die Helligkeit auf 100 % ein
Beispiele:
- 00 – ausschalten
- 19 – schaltet das Licht ein und stellt die Helligkeit auf 10 % ein
- 33 – schaltet das Licht ein und stellt die Helligkeit auf 20 % ein
- 4D – schaltet das Gerät ein und stellt die Helligkeit auf 30 % ein
- 66 – schaltet das Gerät ein und stellt die Helligkeit auf 40 % ein
- 7F – schaltet das Licht ein und stellt die Helligkeit auf 50 % ein
- 99 – schaltet das Gerät ein und stellt die Helligkeit auf 60 % ein
- B3 – schaltet das Licht ein und stellt die Helligkeit auf 70 % ein
- CC – schaltet das Gerät ein und stellt die Helligkeit auf 80 % ein
- E6 – schaltet das Gerät ein und stellt die Helligkeit auf 90 % ein
- FF – schaltet das Licht ein und stellt die Helligkeit auf 100 % ein
Erweiterte Funktionen in LightBoxS:
- offon/last —> ändert den Zustand – aus / letzter Zustand (letzte Helligkeit)
- onlast —> aktiviert immer den letzten Zustand
- inc/XX —> erhöht die aktuelle Helligkeit um XX (hex)
- dec/XX —> verringert die aktuelle Helligkeit um XX (hex)
- x/(…EFFECT_ID…) —> aktiviert den Effekt mit der angegebenen ID (0–9)
- x/(…EFFECT_ID…)/forTime/(…TIME_S…) —> aktiviert den angegebenen Effekt für die festgelegte Dauer
- XX/colorFadeMs/(…TIME_MS…) —> aktiviert die angegebene Helligkeit mit der vorgegebenen Aufhellungszeit
- XX/forTime/(…TIME_S…) —> schaltet die jeweilige Helligkeit für die festgelegte Zeit ein
- s/XX/colorFadeMs/(…TIME_MS…)/forTime/(…TIME_S…) —> schaltet die angegebene Helligkeit für die festgelegte Zeit mit der festgelegten Aufhellzeit ein
wobei XX einen Wert zwischen 0 und FF darstellt, (…TIME_S…) die Zeit in Sekunden angibt, (…TIME_MS…) die Aufhellungszeit in Millisekunden angibt und (…EFFECT_ID…) eine Ziffer – die Nummer des Effekts aus der App (0–9) – darstellt.
Erweiterte DimmerBox:
- offon/last —> ändert den Zustand – aus / letzter Zustand (letzte Helligkeit)
- offon/toggle —> ändert den Zustand – aus / ein (max. 100 %)
- offon/XX —> ändert den Zustand – off / XX (Helligkeit in HEX 00–FF)
- onlast —> aktiviert immer den letzten Zustand
- onfull —> schaltet immer auf Maximum (genau wie /s/FF)
- off —> deaktiviert (genau wie /s/00)
- inc/XX —> erhöht die aktuelle Helligkeit um XX (hex)
- dec/XX —> verringert die aktuelle Helligkeit um XX (hex)
wLighBox (5CH) und pixelBox
Aktionen (Befehle) für das Produkt in LightBox und pixelBox:
Für Aktionen vom Typ „URL senden“:
– http://IP/s/(…CHANNELS…)
Für Aktionen vom Typ: „Ein anderes Gerät steuern“:
– (…CHANNELS…)
wobei (…CHANNELS…) für 5 Helligkeitswerte (RR-GG-BB-WW-CW) steht. Diese werden im Hexadezimalformat mit jeweils zwei Zeichen pro Farbe bzw. LED-Streifenkanal gespeichert (00–FF, was der Dezimalschreibweise 0–255 entspricht), und zwar wie folgt:
- RR – d. h. 00–FF (0–255) – Helligkeit der roten Farbe / Kanal 1
- GG – d. h. 00–FF (0–255) – Helligkeit der Farbe Grün / Kanal 2
- BB – d. h. 00–FF (0–255) – Helligkeit der Farbe Blau / Kanal 3
- WW – d. h. 00–FF (0–255) – Helligkeit der Farbe „Warmweiß“ / Kanal 4
- CW – d. h. 00–FF (0–255) – Helligkeit der Farbe „Kaltweiß“ / Kanal 5
Umgerechnete Helligkeitsskala:
- 00 – Helligkeit 0 %
- 19 – Helligkeit 10 %
- 33 – Helligkeit 20 %
- 4D – Helligkeit 30 %
- 66 – Helligkeit 40 %
- 7F – Helligkeit 50 %
- 99 – Helligkeit 60 %
- B3 – Helligkeit 70 %
- CC – Helligkeit 80 %
- E6 – Helligkeit 90 %
- FF – Helligkeit 100 %
Beispiele:
- 0000000000 – schaltet das LED-Band aus / alle Kanäle ausgeschaltet
- FF00000000 – schaltet die Farbe Rot ein / Kanal 1 eingeschaltet, die übrigen ausgeschaltet
- 00FF000000 – schaltet die Farbe Grün ein / Kanal 2 eingeschaltet, die übrigen ausgeschaltet
- 0000FF0000 – aktiviert die Farbe Blau / Kanal 3 aktiviert, die übrigen Kanäle deaktiviert
- 000000FF00 – schaltet die Farbe „Warmweiß“ ein / Kanal 4 eingeschaltet, die übrigen Kanäle ausgeschaltet
- 00000000FF – schaltet die Farbe „Kaltweiß“ ein / Kanal 5 eingeschaltet, die übrigen ausgeschaltet
- FFFFFF0000 – aktiviert die Farbe Weiß (Rot, Grün, Blau)
- FFFF000000 – aktiviert die Farbe Gelb (Rot, Grün)
- FF00FF0000 – aktiviert die Farbe Fuchsia (rot, blau)
- 00FFFF0000 – aktiviert die Farbe Cyan (grün, blau)
- FF7F000000 – aktiviert die Farbe Orange (Rot, 50 % Grün)
Fortgeschrittene:
- offon/last
schaltet die zuletzt eingestellte Farbe/Helligkeit der Kanäle ein oder aus. Mit anderen Worten: Wenn das LED-Band leuchtet, wird es ausgeschaltet; wenn es nicht leuchtet, wird die zuletzt eingestellte Farbe eingeschaltet.
- (…KANÄLE…)/forTime/(…ZEITEN…)
wobei (…CHANNELS…) für die 4 Helligkeitswerte steht (siehe oben) und (…TIMES…) für die Zeit in Sekunden, für die die jeweilige Helligkeit/Farbe aktiviert werden soll.
- x/(…EFFECT_ID…)
wobei (…EFFECT_ID…) eine Ziffer ist – die Nummer des Effekts aus der App (0–9).
Beispiele:
- offon/last – Schaltet die zuletzt eingestellte Farbe bzw. Helligkeit der Kanäle ein oder aus.
- FF00000000/forTime/5 – schaltet die Farbe Rot für 5 Sekunden ein
- x/0 – deaktiviert den Effekt
- x/1 – aktiviert den Effekt mit der Nummer 1
- x/5 – aktiviert den Effekt mit der Nummer 5
shutterBox
Für Aktionen vom Typ „URL senden“:
– http://IP/s/(…REQUEST…)
Für Aktionen vom Typ: „Ein anderes Gerät steuern“:
– (…REQUEST…)
wobei (…REQUEST…) ein Zeichen oder ein Wert ist (im Falle einer am Steuergerät durchgeführten Kalibrierung), der im Folgenden beschrieben wird:
- u – öffnen
- d – schließen
- s – Stopp
- n – nächster Befehl in der Abfolge (nächster Befehl in der Abfolge „Öffnen-Stopp-Schließen-Stopp“)
- f – Lieblingsposition (nur bei kalibriertem Steuergerät)
Beispiele:
- u – führt zum Öffnen
- d – führt zum Schließen
- s – führt zum Anhalten
- n- löst den nächsten Befehl in der Abfolge „Öffnen-Stopp-Schließen-Stopp“ aus
- f – führt dazu, dass das Programm zur Favoritenposition „springt“
Fortgeschrittene:
- p/(…VALUE_PERCENTAGE…)
- t/(…VALUE_PERCENTAGE…)
wobei (…VALUE_PERCENTAGE…) eine Zahl zwischen 0 und 100 ist, die den Schließprozentsatz angibt (nur bei einem kalibrierten Regler).
Beispiele:
- p/0 – bewirkt das Öffnen (entspricht u)
- p/100 – führt zum Schließen (entspricht d)
- p/50 – bewirkt, dass sich das Tor zur Hälfte schließt
- t/0 – bewirkt die minimale Lamellenstellung, abhängig vom Motor
- t/100 – bewirkt die maximale Einstellung der Lamellen je nach Motor
- t/50 – bewirkt die Einstellung der Lamellen je nach Motor
rollerGate
Für Aktionen vom Typ „URL senden“:
– http://IP/s/(…REQUEST…)
Für Aktionen vom Typ: „Ein anderes Gerät steuern“:
– (…REQUEST…)
wobei (…REQUEST…) das unten beschriebene Zeichen ist:
- o – öffnen
- c – schließen
- s – Stopp
- n – nächster Befehl in der Abfolge (nächster Befehl in der Abfolge „Öffnen-Stopp-Schließen-Stopp“)
- w – Übergangs-/Lüftungsstellung (nur bei kalibriertem Regler)
Beispiele:
- o – bewirkt das Öffnen
- c – führt zum Schließen
- s – führt zum Anhalten
- n – löst den nächsten Befehl in der Abfolge „Öffnen-Stopp-Schließen-Stopp“ aus
- w – führt zu einer „Fahrt“ zur Favoritenposition, zu Fußgängerüberwegen oder zum Lüften
Fortgeschrittene:
- p/(…VALUE_PERCENTAGE…)
wobei (…VALUE_PERCENTAGE…) eine Zahl zwischen 0 und 100 ist, die den Prozentsatz des Torverschlusses angibt (nur bei kalibrierter Steuerung).
Beispiele:
- p/0 – bewirkt das Öffnen (gleichbedeutend mit o)
- p/100 – führt zum Schließen (entspricht c)
- p/50 – bewirkt, dass sich das Tor zur Hälfte schließt
gateBox
Für Aktionen vom Typ „URL senden“:
– http://IP/s/(…REQUEST…)
Für Aktionen vom Typ: „Ein anderes Gerät steuern“:
– (…REQUEST…)
wobei (…REQUEST…) das unten beschriebene Zeichen ist:
- p – den ersten Ausgang ansteuern (Impuls am Tastereingang der Torsteuerung)
- s – den zweiten Ausgang ansteuern (Impuls am Tastereingang der Torsteuerung), (fällt bei der doorBox weg)
Beispiele:
- p – bewirkt die Ansteuerung des ersten Ausgangs
- s – bewirkt die Ansteuerung des zweiten Ausgangs (nicht vorhanden bei der doorBox)
saunaBox
Maßnahmen (Anweisungen) für das Produkt „saunaBox“:
Für Aktionen vom Typ „URL senden“:
– http://IP/s/(…REQUEST…)
Für Aktionen vom Typ: „Ein anderes Gerät steuern“:
– (…REQUEST…)
wobei (…REQUEST…) die im Folgenden beschriebene Ziffer ist:
- 0 – Heizung ausschalten
- 1 – Heizung mit der zuletzt eingestellten Temperatur einschalten
Beispiele:
- 0 – schaltet die Heizung aus
- 1 – schaltet die Heizung mit der zuletzt eingestellten Temperatur ein
Fortgeschrittene:
- t/(…TEMPERATURE_X100…)
wobei (…TEMPERATURE_X100…) die mit 100 multiplizierte Temperatur ist, d. h. von -5500 bis 12500 (von -55 bis +125).
Beispiele:
- t/0 – stellt die Temperatur auf 0 Grad ein (schaltet die Sauna weder ein noch aus)
- t/125 – stellt die Temperatur auf 125 Grad ein (schaltet die Sauna nicht ein/aus)
- t/60 – stellt die Temperatur auf 60 Grad ein (schaltet die Sauna nicht ein/aus)
thermoBox
Für Aktionen vom Typ „URL senden“:
– http://IP/s/(…REQUEST…)
Für Aktionen vom Typ: „Ein anderes Gerät steuern“:
– (…REQUEST…)
wobei (…REQUEST…) die im Folgenden beschriebene Ziffer ist:
- 0 – Controller ausschalten
- 1 – Schalten Sie den Regler mit der zuletzt eingestellten Temperatur ein
- 3 – Aktiviere den BOOST-Modus
Beispiele:
- 0 – schaltet die Heizung aus
- 1 – schaltet die Heizung mit der zuletzt eingestellten Temperatur ein
Fortgeschrittene:
- 1/t/(…TEMPERATURE_X100…)
- 0/t/(…TEMPERATURE_X100…)
- t/(…TEMPERATURE_X100…)
- t/inc/(…TEMPERATURE_X100…)
- t/dec/(…TEMPERATURE_X100…)
wobei (…TEMPERATURE_X100…) die mit 100 multiplizierte Temperatur ist, d. h. von -5500 bis 12500 (von -55 bis +125).
Beispiele:
- 1/t/2300 – bewirkt das Einschalten des Reglers und die Einstellung der Temperatur auf 23 Grad
- t/2000 – stellt die Temperatur auf 20 Grad ein (schaltet den Regler nicht ein/aus)
- t/2250 – stellt die Temperatur auf 22,5 Grad ein (schaltet den Regler nicht ein/aus)
- 0/t/2100 – bewirkt das Ausschalten des Reglers und die Einstellung der Temperatur auf 21 (z. B. für die zukünftige Heizperiode)
- t/inc/100 – bewirkt einen Temperaturanstieg um 1 Grad
- t/dec/50 – bewirkt eine Senkung der Temperatur um 0,5 Grad
actionBox
Für Aktionen vom Typ „URL senden“: (Achtung: anders als bei anderen Treibern)
– http://IP/t/(…REQUEST…)
Für Aktionen vom Typ: „Ein anderes Gerät steuern“:
– (…REQUEST…)
wobei (…REQUEST…) für
- <Tastennummer> ist eine Zahl zwischen 0 und 3 (entsprechend der Nummer der actionBox-Taste, die mit 1 bis 4 gekennzeichnet ist)
- <Trigger-Nummer> ist der in der actionBox festgelegte Trigger:
- 1 – kurzer Klick
- 2 – Langdruck
- 3 – abfallende Flanke (z. B. Loslassen einer Taste)
- 4 – ansteigende Flanke (z. B. beim Drücken einer Taste)
- 5 – Schräge (z. B. sowohl Loslassen als auch Drücken)
Beispiele:
- 0/1
- 2/5
multiSensor
Maßnahmen (Anweisungen) für das Produkt „saunaBox“:
Für Aktionen vom Typ „URL senden“:
– http://IP/(…ENDPOINT…)
wobei (…ENDPOINT…) der unten beschriebene Pfad ist:
state– gibt den Grundzustand der Sensoren zurück (id, type, value, state, trend, elapsedTimeS)state/extended– führt zum Auslesen der vollständigen Sensordaten einschließlich ihrer Bezeichnungen und Symbole
Sensortypen (type als Reaktion auf state)
temperature– Temperatur- Weitere Typen, abhängig vom Modell/der Konfiguration der Sonden – siehe
api/probes/state
Felder zur Beschreibung eines einzelnen Sensors
id– Sensornummertype– Sensortypvalue– aktueller Wertstate– Messstatus (Zahlencode)trend– Richtung des Werttrends (Zahlencode)elapsedTimeS– Zeit (s) seit der letzten MessungiconSet(nurstate/extended) – dem Sensor zugewiesenes Symbolname(nur „state/extended“) – Bezeichnung des Sensors