Updated HTTP request API (markdown)

master
Aircoookie 2019-02-03 17:58:51 +01:00
rodzic b4c4c3c2a5
commit f7be0f7015
1 zmienionych plików z 5 dodań i 5 usunięć

@ -1,9 +1,9 @@
WLED's HTTP API allows you to set many properties of your lights, even more than the index page UI supports, via a simple GET web request. WLED's HTTP API allows you to set many properties of your lights, even more than the index page UI supports, via a simple GET web request.
The basic URL scheme is: "[ipadress]/win". This will return an XML file with some current values (see bottom of page). The basic URL scheme is: `[ipadress]/win`. This will return an XML file with some current values (see bottom of page).
Parameters can be added to control some of the variables. Parameters can be added to control some of the variables.
- Example (AP): **192.168.4.1/win&A=255** sets the brightness to maximum - Example (AP): `192.168.4.1/win&A=255` sets the brightness to maximum
- Example (mdns): **led.local/win&A=255&FX=0** sets the brightness to maximum and the effect to static - Example (mdns): `led.local/win&A=128&FX=0` sets the brightness to half and the effect to static
In conjunction with a [router port forwarding](https://github.com/Aircoookie/WLED/wiki/Remote-Access-and-IFTTT) this can be used to automate WLED, for example via IFTTT. In conjunction with a [router port forwarding](https://github.com/Aircoookie/WLED/wiki/Remote-Access-and-IFTTT) this can be used to automate WLED, for example via IFTTT.
@ -20,8 +20,9 @@ Parameter | Value Range | Description | Since Version
&G= | 0 to 255 | Primary Green value | 0.2 &G= | 0 to 255 | Primary Green value | 0.2
&B= | 0 to 255 | Primary Blue value | 0.2 &B= | 0 to 255 | Primary Blue value | 0.2
&W= | 0 to 255 | Primary White value | 0.4 &W= | 0 to 255 | Primary White value | 0.4
&FX= | 0 to 73 | LED Effect Index | 0.3 &FX= | 0 to 79 | LED Effect Index | 0.3
&SX= | 0 to 255 | Effect Speed | 0.3 &SX= | 0 to 255 | Effect Speed | 0.3
&IX= | 0 to 255 | Effect Intensity | 0.5.0
&NL= | 0 to 255 | Nightlight active and duration | 0.3 &NL= | 0 to 255 | Nightlight active and duration | 0.3
&ND | none | Toggles nightlight on but uses default duration | 0.6.3 &ND | none | Toggles nightlight on but uses default duration | 0.6.3
&NT= | 0 to 255 | Nightlight target brightness | 0.5.0 &NT= | 0 to 255 | Nightlight target brightness | 0.5.0
@ -45,7 +46,6 @@ Parameter | Value Range | Description | Since Version
&SB | none | Set secondary color to black | 0.4 &SB | none | Set secondary color to black | 0.4
&SP | none | Set secondary color to primary | 0.4 &SP | none | Set secondary color to primary | 0.4
&SC | none | Swap primary and secondary color | 0.4 &SC | none | Swap primary and secondary color | 0.4
&IX= | 0 to 255 | Effect Intensity | 0.5.0
&FP= | 0 to 44 | FastLED Palette | 0.8.0 &FP= | 0 to 44 | FastLED Palette | 0.8.0
## Notifications ## Notifications