HTTP Anfrage API - Aircoookie/WLED-wiki-DE GitHub Wiki
Mit der HTTP-API von WLED können Sie über eine einfache GET-Webanforderung viele Eigenschaften Ihrer Lichter festlegen, sogar mehr als die von der Benutzeroberfläche der Indexseite unterstützte.
Unsicher, wie all diese API-Sachen funktionieren? Schauen Sie sich diesen erstaunlichen Leitfaden von tynick an!
Das grundlegende URL-Schema lautet: [ipadress]/win. Dadurch wird eine XML-Datei mit einigen aktuellen Werten zurückgegeben (siehe unten auf der Seite).
Parameter können hinzugefügt werden, um einige der Variablen zu steuern.
- Beispiel (AP):
192.168.4.1/win&A=255setzt die Helligkeit auf Maximum - Beispiel (mdns):
led.local/win&A=128&FX=0setzt die Helligkeit auf die Hälfte und den Effekt auf Solid
In Verbindung mit einer Router-Port-Weiterleitung kann dies zur Automatisierung von WLED verwendet werden, beispielsweise über IFTTT.
Fügen Sie nach der Basis-URL/IP einen oder mehrere der folgenden Parameter hinzu, um die Werte zu ändern: (Wenn der Parameter unbekannt oder der Wert unzulässig ist, passiert nichts)
| Parameter | Wertebereich | Beschreibung | Seit Version |
|---|---|---|---|
| &A= | 0 bis 255 | Master Helligkeit | 0,2 |
| &T= | 0, 1 oder 2 | Master Aus / Ein / Umschalten | 0,3 |
| &R= | 0 bis 255 | Primärer roter Wert | 0,2 |
| &G= | 0 bis 255 | Primärer grüner Wert | 0,2 |
| &B= | 0 bis 255 | Primärer blauer Wert | 0,2 |
| &W= | 0 bis 255 | Primärer Weißwert | 0,4 |
| &FX= | 0 bis 101 | LED-Effektindex | 0,3 |
| &SX= | 0 bis 255 | Effektgeschwindigkeit | 0,3 |
| &IX= | 0 bis 255 | Effektintensität | 0,5,0 |
| &FP= | 0 bis 46 | FastLED-Palette | 0.8.0 |
| &NL= | 0 bis 255 | Nachtlicht aktiv und Dauer | 0,3 |
| &ND | Keine | Schaltet das Nachtlicht ein, verwendet jedoch die Standarddauer | 0.6.3 |
| &NT= | 0 bis 255 | Helligkeit des Nachtlichtziels | 0,5,0 |
| &NF= | 0 bis 2 | Nachtlicht verblassen, 1 = nur Helligkeit verblassen, 2 = Farbe zusätzlich von Primär- zu Sekundärfarbe verblassen |
0,5,0 |
| Parameter | Wertebereich | Beschreibung | Seit Version |
|---|---|---|---|
| &CL= | HEX / DEC | Primärfarbe | 0.8.0 |
| &C2= | HEX / DEC | Sekundärfarbe | 0.8.0 |
| &R2= | 0 bis 255 | Sekundärer roter Wert | 0,4 |
| &G2= | 0 bis 255 | Sekundärer grüner Wert | 0,4 |
| &B2= | 0 bis 255 | Sekundärer blauer Wert | 0,4 |
| &W2= | 0 bis 255 | Sekundärer Weißwert | 0,4 |
| &HU= | 0 bis 65535 | Farbton | 0.5.1 |
| &SA= | 0 bis 255 | Sättigung (nur in Verbindung mit Farbton) | 0.5.1 |
| &H2 | Keine | Farbton + Sättigung setzt die Sekundärfarbe | 0.5.1 |
| &SR= | 0 oder 1 | Stellen Sie die Primär- / Sekundärfarbe auf zufälligen Farbton | ein 0,4 |
| &SC | Keine | Primär- und Sekundärfarbe tauschen 0,4 |
| Parameter | Wertebereich | Beschreibung | Seit Version |
|---|---|---|---|
| &RN= | 0 oder 1 | UDP-Benachrichtigungen erhalten | 0,3 |
| &SN= | 0 oder 1 | UDP-Benachrichtigungen senden | 0,3 |
| &NN | Keine | Keine Benachrichtigung für diese Anfrage 0,3 | |
| &HP= | 0 bis 99 | Stellt die ID des Farbton-Abfragelichts ein (0 ist aus) | 0.5.1 |
| Parameter | Wertebereich | Beschreibung | Seit Version |
|---|---|---|---|
| &PS= | 1 bis 16 | Speichert das aktuelle Setup in der Voreinstellung | 0,4 |
| &PL= | 0 bis 16 | Wendet die gesamte Voreinstellung an 0,4 | |
| &CY= | 0 oder 1 | Preset-Zyklus umschalten | 0.6.3 |
| &PA= | 0 oder 1 | Voreinstellungen wenden Helligkeit an | 0.7.0 |
| &P1= | 1 bis 25 | Erste Zyklusvoreinstellung | 0.6.3 |
| &P2= | 1 bis 25 | Voreinstellung des letzten Zyklus | 0.6.3 |
| &PT= | 50 bis 65000 | Zykluszeit in jeder Voreinstellung (ms) | 0.6.3 |
| &TT= | 0 bis 65000 | Übergangszeit (ms) einstellen | 0.6.3 |
| Parameter | Wertebereich | Beschreibung | Seit Version |
|---|---|---|---|
| &MS = | 0 bis 16 (String 0..64) | API-Makro speichern | 0,5,0 |
| &M = | 0 bis 16 | Makro anwenden | 0,5,0 |
Es wird dringend empfohlen, beim Umgang mit Segmenten die JSON-API zu verwenden.
| Parameter | Value Range | Description | Since Version |
|---|---|---|---|
| &SM= | 0 to 9 | Set the main segment (values are reported to XML) | 0.9.0 |
| &SS= | 0 to 9 | Select segment to apply THIS api call to | 0.9.0 |
| &SV= | 0 or 1 | Set segment selected | 0.9.0 |
| &S= | 0 to ledcount-1 | Set segment start | 0.9.0 |
| &S2= | 0 to ledcount | Set segment stop | 0.9.0 |
| &GP= | 1 to 255 | Set segment grouping | 0.9.1 |
| &SP= | 0 to 255 | Set segment spacing | 0.9.1 |
| Parameter | Wertebereich | Beschreibung | Seit Version |
|---|---|---|---|
| &SM= | 0 bis 9 | Legen Sie das Hauptsegment fest (Werte werden an XML gemeldet) | 0.9.0 |
| &SS= | 0 bis 9 | Wählen Sie ein Segment aus, um DIESEN API-Aufruf auf | anzuwenden 0.9.0 |
| &SV= | 0 oder 1 | Segment ausgewählt auswählen | 0.9.0 |
| &S= | 0 bis ledcount-1 | Segmentstart einstellen | 0.9.0 |
| &S2= | 0 bis ledcount | Segmentstopp einstellen | 0.9.0 |
| &GP= | 1 bis 255 | Segmentgruppierung einstellen | 0.9.1 |
| &SP= | 0 bis 255 | Segmentabstand einstellen | 0.9.1 |
| Parameter | Wertebereich | Beschreibung | Seit Version |
|---|---|---|---|
| &ST= | 32bit | Aktuelle UTC-Zeit in der Unix-Epoche | 0,4 |
| &CT= | 32bit | UTC-Zeit für Countdown-Ende | 0,4 |
| &MD= | 0 oder 1 | Stellen Sie den Schieberegler auf RGB / HSB | 0,3 |
| &AX= | 0 bis 255 | Debug-Funktion, kann für allgemeine E / A | konfiguriert werden 0,3 |
| &IN | Keine | Der Server antwortet nicht auf diese Anfrage (intern) | 0,3 |
| &OL= | 0 bis 255 | Experimentelle Überlagerungen 0,3 | |
| &L= | 0 bis 255 | Pixel sperren | 0,4 |
| &L2= | 0 bis 255 | Pixelbereich L bis L2 | sperren 0,4 |
| &UL | Keine | Entsperren Sie stattdessen (in Verbindung mit L und L2) | 0,4 |
| &NX= | String 1..6 | Cronixie Zifferblatt | 0,4 |
| &NM= | 0 oder 1 | Cronixie Time oder Countdown-Modus | 0,4 |
| &NB= | 0 oder 1 | Cronixie Hintergrundbeleuchtung | 0,4 |
| &IT | Keine | Einbeziehen des UI-Farbthemas in die API-Antwort | 0.8.2 |
| &RD= | 0 oder 1 | Echtzeit-UDP umschalten | 0.8.4 |
| &NP | Keine | Wird mit Voreinstellungen verwendet, um nur im RAM zu speichern und Flash-Verschleiß zu verhindern | 0.10.0 |
Dies ist die XML-Datei, die als Antwort auf jeden API-Aufruf gesendet wird.
| Parameter | Wertebereich | Beschreibung |
|---|---|---|
| <ac> | 0 bis 255 | Master Helligkeit |
| <cl> | 3x 0..255 | Primärfarbe RGB |
| <cs> | 3x 0..255 | Sekundäres RGB |
| <ns> | 0 oder 1 | Benachrichtigung Senden an |
| <nr> | 0 oder 1 | Benachrichtigung Empfangen am |
| <nl> | 0 oder 1 | Nachtlicht aktiv |
| <nf> | 0 oder 2 | Nachtlicht verblassen Typ |
| <nd> | 0 bis 255 | Nachtlichtverzögerung |
| <nt> | 0 bis 255 | Helligkeit des Nachtlichtziels |
| <fx> | 0 bis 73 | Effektindex |
| <sx> | 0 bis 255 | Effektgeschwindigkeit |
| <ix> | 0 bis 255 | Effektintensität |
| <fp> | 0 bis 43 | FastLED-Palette |
| <wv> | -1 bis 255 | Primärer Weißwert |
| <ws> | 0 bis 255 | Sekundärweiß |
| <md> | 0 oder 1 | RGB- oder HSB-UI-Modus |
| <ds> | String 0..32 | Serverbeschreibung |
Mit dem Zeichen ~ können Sie einfach Werte relativ zu ihrem aktuellen Wert festlegen.
Dies wird derzeit für die folgenden Parameter unterstützt:
A, R, G, B, W, R2, G2, B2, W2, FX, SX, IX, FP, PL
Verwenden Sie beispielsweise, PL=~ um zur nächsten Voreinstellung zu gelangen. Wenn Sie nur ~ ohne Zahl verwenden wird der Wert um 1 erhöht, ~- wird er um 1 verringert. Der Wert wird dann umbrochen. Wenn Sie also A=~- verwenden wird A bei 0 auf 255 gesetzt.
Sie können auch angeben, um wie viel der Wert geändert werden soll. Wenn Sie beispielsweise A=~10 verwenden, wird die Helligkeit um 10 erhöht. Wenn Sie eine Zahl hinter ~ verwenden, wird der Wert abgeschnitten (sodass er nicht umbrochen wird, wenn die maximale Helligkeit eingestellt ist, hat A=~10 keinen Effekt)