### Manage WLED Presets via HTTP GET

Source: https://kno.wled.ge/interfaces/http-api

This example shows how to save, apply, and cycle through WLED presets. 'PS' saves the current configuration to a preset, 'PL' applies a preset, and 'P1'/'P2' define the range for preset cycling. 'TT' sets the transition time.

```http
GET /win&PS=5 HTTP/1.1
Host: [ipaddress]
```

```http
GET /win&PL=5 HTTP/1.1
Host: [ipaddress]
```

```http
GET /win&P1=1&P2=10&TT=1000 HTTP/1.1
Host: [ipaddress]
```

--------------------------------

### Apply WLED Macro via HTTP GET

Source: https://kno.wled.ge/interfaces/http-api

This example demonstrates how to apply a macro to the WLED device. The 'M' parameter accepts a macro number from 1 to 16. Note that this parameter is deprecated but included for compatibility with older automations.

```http
GET /win&M=3 HTTP/1.1
Host: [ipaddress]
```

--------------------------------

### Toggle WLED Light with CURL Example

Source: https://kno.wled.ge/interfaces/json-api

A CURL command example demonstrating how to toggle the WLED light on or off and retrieve the updated state using a POST request to `/json/state`. This example is applicable for WLED versions 0.13 and later.

```bash
curl -X POST "http://[WLED-IP]/json/state" -d '{"on":"t","v":true}' -H "Content-Type: application/json"
```

--------------------------------

### WLED Macro Examples (HTTP API)

Source: https://kno.wled.ge/features/macros

Examples of WLED macros using HTTP API calls. Macros can be chained and control various aspects of LED behavior such as brightness, color, and effects. The 'win&' prefix is optional.

```http
A=255
R=255&G=160&B=0
T=2
FX=~
```

--------------------------------

### Set WLED Effect and Brightness via HTTP GET

Source: https://kno.wled.ge/interfaces/http-api

This example shows how to simultaneously set the brightness and LED effect of WLED lights. It uses the 'A' parameter for brightness and 'FX' for the effect index. This combined control is useful for dynamic lighting scenes.

```http
GET /win&A=128&FX=0 HTTP/1.1
Host: led.local
```

--------------------------------

### Install WLED Dependencies

Source: https://kno.wled.ge/advanced/compiling-wled

Installs all necessary project dependencies for WLED using npm. This command should be executed after cloning the repository and navigating into the WLED directory. Requires Node.js 20 or higher.

```bash
npm install
```

--------------------------------

### Flash WLED Binary to ESP8266 using esptool.py

Source: https://kno.wled.ge/basics/install-binary

This command flashes the WLED binary to an ESP8266 microcontroller. Ensure esptool.py is installed and the correct binary file is downloaded. Only one ESP device should be connected to avoid accidental overwrites.

```bash
esptool.py write_flash 0x0 ./WLED_XXX.bin

```

--------------------------------

### Example Sensor Object Structure (JSON)

Source: https://kno.wled.ge/interfaces/json-api

This example demonstrates the structure of a single sensor object within the 'info.sensor' array. It shows a temperature sensor with its type, name, and current value.

```json
{
  "type": "T",
  "n": "Outside",
  "val": 12
}
```

--------------------------------

### Control WLED Brightness via HTTP GET

Source: https://kno.wled.ge/interfaces/http-api

This example demonstrates how to set the master brightness of WLED lights using an HTTP GET request. The brightness can be set to a value between 0 and 255. This functionality is available since version 0.2.

```http
GET /win&A=255 HTTP/1.1
Host: [ipaddress]
```

--------------------------------

### Backing up ESP32-C3 Firmware with esptool.py

Source: https://kno.wled.ge/basics/compatible-controllers

This command illustrates how to create a backup of the existing firmware on an ESP32-C3 controller using `esptool.py`. This is a critical step before attempting to flash new firmware, especially on devices with potential encryption. The output file will contain the entire flash content.

```bash
esptool.py read_flash 0 0x400000 sp530e-encrypted.bin
```

--------------------------------

### WLED Basic Status Request

Source: https://kno.wled.ge/interfaces/http-api

This example shows a basic HTTP GET request to the WLED API to retrieve the current status and values of the lights. The response is typically in XML format.

```http
GET /win HTTP/1.1
Host: [ipaddress]
```

--------------------------------

### Flash ESP32 Bootloader and WLED Binary using esptool.py

Source: https://kno.wled.ge/basics/install-binary

This process involves two steps for ESP32 devices. First, flash the version 4 bootloader, which only needs to be done once. Second, flash the actual firmware binary with a different offset. Ensure the boot button is held if prompted during connection.

```bash
esptool.py write_flash 0x0 ./esp32_bootloader_v4.bin

```

```bash
esptool.py write_flash 0x10000 ./WLED_XXX.bin 

```

--------------------------------

### Control WLED Loxone RGB Values via HTTP GET

Source: https://kno.wled.ge/interfaces/http-api

This example shows how to set the primary and secondary colors using Loxone-compatible RGB values. The 'LX' and 'LY' parameters accept a BBBGGGRRR format where each color component is 0-100%.

```http
GET /win&LX=100070030 HTTP/1.1
Host: [ipaddress]
```

```http
GET /win&LY=030070100 HTTP/1.1
Host: [ipaddress]
```

--------------------------------

### Control WLED Effect Speed and Intensity via HTTP GET

Source: https://kno.wled.ge/interfaces/http-api

This example demonstrates adjusting the speed and intensity of the selected LED effect. The 'SX' parameter controls the effect speed (0-255), and 'IX' controls the effect intensity (0-255).

```http
GET /win&SX=100&IX=50 HTTP/1.1
Host: [ipaddress]
```

--------------------------------

### Apply FastLED Palette via HTTP GET

Source: https://kno.wled.ge/interfaces/http-api

This example shows how to apply a specific FastLED color palette to the WLED effect. The 'FP' parameter accepts values from 0 to 46, corresponding to different palettes. Available since version 0.8.0.

```http
GET /win&FP=20 HTTP/1.1
Host: [ipaddress]
```

--------------------------------

### Control WLED Primary Color via HTTP GET

Source: https://kno.wled.ge/interfaces/http-api

This example demonstrates controlling the primary Red, Green, and Blue (RGB) values of the WLED lights. Each color channel can be set independently from 0 to 255. This allows for precise color customization.

```http
GET /win&R=255&G=0&B=0 HTTP/1.1
Host: [ipaddress]
```

--------------------------------

### WLED Preset Chaining Macro

Source: https://kno.wled.ge/features/macros

An example of a macro that steps through multiple presets. This allows a single button press to cycle through a defined sequence of preset configurations.

```http
P1=1&P2=3&PL=~
```

--------------------------------

### Randomize and Swap WLED Colors via HTTP GET

Source: https://kno.wled.ge/interfaces/http-api

This example shows how to set primary/secondary colors to random hues using the 'SR' parameter (0 or 1) or swap them using the 'SC' parameter. These commands are useful for dynamic and unpredictable color sequences.

```http
GET /win&SR=1 HTTP/1.1
Host: [ipaddress]
```

```http
GET /win&SC HTTP/1.1
Host: [ipaddress]
```

--------------------------------

### General and Experimental Settings API

Source: https://kno.wled.ge/interfaces/http-api

Configure general device settings and access experimental features.

```APIDOC
## General and Experimental Settings API

### Description
Allows modification of general WLED device parameters and experimental features.

### Method
GET (or POST, depending on context, typically used with query parameters)

### Endpoint
`/` (Root of the WLED device, parameters are appended as query strings)

### Parameters
#### Query Parameters
- **&RB** (none) - Reboot WLED device.
- **&ST** (32bit) - Set current UTC time in Unix epoch.
- **&CT** (32bit) - Set UTC time for countdown end.
- **&MD** (integer: 0 or 1) - Set slider mode to RGB/HSB.
- **&AX** (integer: 0-255) - Debug feature, can be configured for general IO.
- **&IN** (none) - Server will not respond to this request (internal).
- **&OL** (integer: 0-255) - Experimental overlays.
- **&L** (integer: 0-255) - Lock pixel.
- **&L2** (integer: 0-255) - Lock pixel range L to L2.
- **&UL** (none) - Unlock instead (used in conjunction with L and L2).
- **&NX** (String: 1-6) - Cronixie clockface.
- **&NM** (integer: 0 or 1) - Cronixie Time or Countdown mode.
- **&NB** (integer: 0 or 1) - Cronixie Backlight.
- **&IT** (none) - Include UI color theme in API response.
- **&RD** (integer: 0 or 1) - Toggle realtime UDP.
- **&LO** (integer: 0-2) - Live data override. 0 is off, 1 is override until live data ends, 2 is override until ESP reboot.
- **&NP** (none) - Advance to the next preset in a playlist.

### Request Example
```
http://<WLED_IP>/?&RB=1
http://<WLED_IP>/?&ST=1678886400
http://<WLED_IP>/?&MD=1
http://<WLED_IP>/?&NP=1
```

### Response
#### Success Response (200 OK)
XML response detailing the current state of the WLED device.

#### Response Example
```xml
<opt><pn>WLED</pn><wv>0.13.0</wv><ol>1</ol><op>1</op><cl>1</cl><dc>1</dc><cs>0</cs><cm>0</cm><ud>1</ud><lo>0</lo><ls>0</ls><lf>0</lf><lu>0</lu><lr>0</lr><li >0</li ><br/><mn>10</mn><mx>255</mx><or>0</or><ir>0</ir><rg>0</rg><zi>0</zi><rl>0</rl><sx>10</sx><ix>100</ix><au>0</au><ae>0</ae><mv>1</mv><ma>0</ma><cc>0</cc><ah>0</ah><aj>0</aj><ai>0</ai><ad>0</ad><am>0</am><an>0</an><ap>0</ap><aq>0</aq><ar>0</ar><as>0</as><at>0</at><au>0</au><av>0</av><aw>0</aw><ax>0</ax><ay>0</ay><az>0</az><ba>0</ba><bb>0</bb><bc>0</bc><bd>0</bd><be>0</be><bf>0</bf><bg>0</bg><bh>0</bh><bi>0</bi><bj>0</bj><bk>0</bk><bl>0</bl><bm>0</bm><bn>0</bn><bo>0</bo><bp>0</bp><bq>0</bq><br/><pr><pa>0</pa><pb>0</pb><pc>0</pc><pd>0</pd><pe>0</pe><pf>0</pf><pg>0</pg><ph>0</ph><pi>0</pi><pj>0</pj><pk>0</pk><pl>0</pl><pm>0</pm><pn>0</pn><po>0</po><pp>0</pp><pq>0</pq><pr>0</pr><ps>0</ps><pt>0</pt><pu>0</pu><pv>0</pv><pw>0</pw><px>0</px><py>0</py><pz>0</pz><qa>0</qa><qb>0</qb><qc>0</qc><qd>0</qd><qe>0</qe><qf>0</qf><qg>0</qg><qh>0</qh><qi>0</qi><qj>0</qj><qk>0</qk><ql>0</ql><qm>0</qm><qn>0</qn><qo>0</qo><qp>0</qp><qq>0</qq><qr>0</qr><qs>0</qs><qt>0</qt><qu>0</qu><qv>0</qv><qw>0</qw><qx>0</qx><qy>0</qy><qz>0</qz><ra>0</ra><rb>0</rb><rc>0</rc><rd>0</rd><re>0</re><rf>0</rf><rg>0</rg><rh>0</rh><ri>0</ri><rj>0</rj><rk>0</rk><rl>0</rl><rm>0</rm><rn>0</rn><ro>0</ro><rp>0</rp><rq>0</rq><rr>0</rr><rs>0</rs><rt>0</rt><ru>0</ru><rv>0</rv><rw>0</rw><rx>0</rx><ry>0</ry><rz>0</rz><sa>0</sa><sb>0</sb><sc>0</sc><sd>0</sd><se>0</se><sf>0</sf><sg>0</sg><sh>0</sh><si>0</si><sj>0</sj><sk>0</sk><sl>0</sl><sm>0</sm><sn>0</sn><so>0</so><sp>0</sp><sq>0</sq><sr>0</sr><ss>0</ss><st>0</st><su>0</su><sv>0</sv><sw>0</sw><sx>0</sx><sy>0</sy><sz>0</sz><ta>0</ta><tb>0</tb><tc>0</tc><td >0</td ><te>0</te><tf>0</tf><tg>0</tg><th >0</th ><ti>0</ti><tj>0</tj><tk>0</tk><tl>0</tl><tm>0</tm><tn>0</tn><to>0</to><tp>0</tp><tq>0</tq><tr >0</tr ><ts>0</ts><tt>0</tt><tu>0</tu><tv>0</tv><tw>0</tw><tx>0</tx><ty>0</ty><tz>0</tz><ua>0</ua><ub>0</ub><uc>0</uc><ud>0</ud><ue>0</ue><uf>0</uf><ug>0</ug><uh>0</uh><ui>0</ui><uj>0</uj><uk>0</uk><ul >0</ul ><um>0</um><un>0</un><uo>0</uo><up>0</up><uq>0</uq><ur>0</ur><us>0</us><ut>0</ut><uu>0</uu><uv>0</uv><uw>0</uw><ux>0</ux><uy>0</uy><uz>0</uz><va>0</va><vb>0</vb><vc>0</vc><vd>0</vd><ve>0</ve><vf>0</vf><vg>0</vg><vh>0</vh><vi>0</vi><vj>0</vj><vk>0</vk><vl>0</vl><vm>0</vm><vn>0</vn><vo>0</vo><vp>0</vp><vq>0</vq><vr>0</vr><vs>0</vs><vt>0</vt><vu>0</vu><vv>0</vv><vw>0</vw><vx>0</vx><vy>0</vy><vz>0</vz><wa>0</wa><wb>0</wb><wc>0</wc><wd>0</wd><we>0</we><wf>0</wf><wg>0</wg><wh>0</wh><wi>0</wi><wj>0</wj><wk>0</wk><wl>0</wl><wm>0</wm><wn>0</wn><wo>0</wo><wp>0</wp><wq>0</wq><wr>0</wr><ws>0</ws><wt>0</wt><wu>0</wu><wv>0</wv><ww>0</ww><wx>0</wx><wy>0</wy><wz>0</wz><xa>0</xa><xb>0</xb><xc>0</xc><xd>0</xd><xe>0</xe><xf>0</xf><xg>0</xg><xh>0</xh><xi>0</xi><xj>0</xj><xk>0</xk><xl>0</xl><xm>0</xm><xn>0</xn><xo>0</xo><xp>0</xp><xq>0</xq><xr>0</xr><xs>0</xs><xt>0</xt><xu>0</xu><xv>0</xv><xw>0</xw><xx>0</xx><xy>0</xy><xz>0</xz><ya>0</ya><yb>0</yb><yc>0</yc><yd>0</yd><ye>0</ye><yf>0</yf><yg>0</yg><yh>0</yh><yi>0</yi><yj>0</yj><yk>0</yk><yl>0</yl><ym>0</ym><yn>0</yn><yo>0</yo><yp>0</yp><yq>0</yq><yr>0</yr><ys>0</ys><yt>0</yt><yu>0</yu><yv>0</yv><yw>0</yw><yx>0</yx><yy>0</yy><yz>0</yz><za>0</za><zb>0</zb><zc>0</zc><zd>0</zd><ze>0</ze><zf>0</zf><zg>0</zg><zh>0</zh><zi>0</zi><zj>0</zj><zk>0</zk><zl>0</zl><zm>0</zm><zn>0</zn><zo>0</zo><zp>0</zp><zq>0</zq><zr>0</zr><zs>0</zs><zt>0</zt><zu>0</zu><zv>0</zv><zw>0</zw><zx>0</zx><zy>0</zy><zz>0</zz></pr><rr>0</rr><ps>0</ps><cy>0</cy><st>0</st><ur>0</ur><ds>WLED</ds><ss>0</ss><ns>1</ns><nr>1</nr><nl>0</nl><nf>0</nf><nd>0</nd><nt>0</nt><fx>1</fx><sx>10</sx><ix>128</ix><fp>0</fp><wv>255</wv><ws>0</ws><ac>255</ac><cl>255,0,0</cl><cs>0,0,0</cs></opt>
```
```

--------------------------------

### Control WLED Nightlight via HTTP GET

Source: https://kno.wled.ge/interfaces/http-api

This example demonstrates how to control the WLED nightlight feature. The 'NL' parameter sets the duration in minutes, 'ND' toggles it on with a default duration, 'NT' sets the target brightness, and 'NF' controls fading behavior.

```http
GET /win&NL=30&NT=100 HTTP/1.1
Host: [ipaddress]
```

--------------------------------

### General and Experimental WLED API Settings

Source: https://kno.wled.ge/interfaces/http-api

This section details general and experimental parameters for the WLED API. It includes rebooting, setting time, slider modes, debug features, internal server commands, experimental overlays, locking pixels, unlocking pixels, Cronixie clockface settings, backlight control, UI theme inclusion, real-time UDP toggle, live data override, and advancing to the next preset.

```URL Parameters
&RB
&ST=32bit
&CT=32bit
&MD=0 or 1
&AX=0 to 255
&IN
&OL=0 to 255
&L=0 to 255
&L2=0 to 255
&UL
&NX=String 1..6
&NM=0 or 1
&NB=0 or 1
&IT
&RD=0 or 1
&LO=0-2
&NP
```

--------------------------------

### WLED HTTP API - Loxone Commands

Source: https://kno.wled.ge/interfaces/http-api

Documentation for Loxone-specific commands used to control RGB values, brightness, and color temperature.

```APIDOC
## GET /win (Loxone Commands)

### Description
Control WLED devices using Loxone-specific commands for RGB values, brightness, and color temperature.

### Method
GET

### Endpoint
`[ipaddress]/win`

### Parameters
#### Query Parameters
- **LX** (BBBGGGRRR or 20bbbtttt) - Required - Loxone command for primary color.
  - RGB: `BBBGGGRRR` (0-100% for each color component).
  - Brightness & Color Temp: `20bbbtttt` (brightness 0-100%, temp 2700-6500K).
- **LY** (BBBGGGRRR or 20bbbtttt) - Required - Loxone command for secondary color.
  - RGB: `BBBGGGRRR` (0-100% for each color component).
  - Brightness & Color Temp: `20bbbtttt` (brightness 0-100%, temp 2700-6500K).

### Request Example
`GET /win?LX=100100100` (Loxone command for full red)
`GET /win?LX=201005000` (Loxone command for 100% brightness, 5000K temp)

### Response
#### Success Response (200)
An XML response confirming the Loxone command execution.

#### Response Example
```xml
<data>
  <loxone_command_status>success</loxone_command_status>
  ...
</data>
```
```

--------------------------------

### Configure WLED Notifications via HTTP GET

Source: https://kno.wled.ge/interfaces/http-api

This example demonstrates how to manage UDP notifications for WLED. 'RN' enables receiving notifications, 'SN' enables sending them, and 'NN' disables notifications for the current request. 'HP' sets the Hue polling light ID.

```http
GET /win&RN=1&SN=1 HTTP/1.1
Host: [ipaddress]
```

--------------------------------

### WLED API Commands for Presets

Source: https://kno.wled.ge/features/presets

Examples of HTTP and JSON API commands that can be embedded within WLED presets to control various aspects of the lighting. These commands enable functionality like toggling power, setting brightness, changing colors, applying effects, and iterating through other presets.

```http
T=2
```

```json
{"on":"t"}
```

```http
T=1
```

```json
{"on":true}
```

```http
T=0
```

```json
{"on":false}
```

```json
{"on":true, "tt":0}
```

```http
A=128
```

```json
{"bri": 128}
```

```http
A=~10
```

```json
{"bri":"~10"}
```

```http
A=~-20
```

```json
{"bri":"~-10"}
```

```http
R=255&G=0&B=0
```

```json
{"seg":[{"col":[[255,0,0]]}]}
```

```http
R=0&G=255&B=0&A=128&FX=0
```

```json
{"seg":[{"fx":0, "col":[[0,255,0]]}], "bri":128}
```

```http
P1=1&P2=3&PL=~
```

```json
{"ps":"1~ 3~"}
```