WLED

https://kno.wled.ge/
Admin
WLED is a fast and feature-rich ESP32/ESP8266 webserver implementation for controlling NeoPixel and...
Tokens:49,602
Snippets:610
Trust Score:7.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### GET /json/cfg

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

Retrieves the device configuration.

```APIDOC
## GET /json/cfg

### Description
Retrieves the device configuration.
```

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

### Install Dependencies

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

Command to install required project dependencies using npm.

```bash
npm install
```

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

### GET /win

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

Controls various LED properties by appending parameters to the base URL.

```APIDOC
## GET /win

### Description
Sets various properties of the lights by appending parameters to the base URL. Returns an XML file with current values.

### Method
GET

### Endpoint
/[ipaddress]/win

### Parameters
#### Query Parameters
- **A** (integer, 0-255) - Optional - Master brightness
- **T** (integer, 0-2) - Optional - Master Off (0), On (1), or Toggle (2)
- **R** (integer, 0-255) - Optional - Primary Red value
- **G** (integer, 0-255) - Optional - Primary Green value
- **B** (integer, 0-255) - Optional - Primary Blue value
- **W** (integer, 0-255) - Optional - Primary White value
- **FX** (integer, 0-101) - Optional - LED Effect Index
- **SX** (integer, 0-255) - Optional - Effect Speed
- **IX** (integer, 0-255) - Optional - Effect Intensity
- **FP** (integer, 0-46) - Optional - FastLED Palette
- **NL** (integer, 0-255) - Optional - Nightlight active and duration in minutes
- **ND** (none) - Optional - Toggles nightlight on using default duration
- **NT** (integer, 0-255) - Optional - Nightlight target brightness
- **NF** (integer, 0-2) - Optional - Fade Nightlight (1 = fade brightness, 2 = fade brightness and color)
```

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

### Sensor Object Example

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

Example of a temperature sensor object within the info.sensor array.

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

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

### Basic Macro API Commands

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

Examples of standard HTTP API calls used to define macro behavior.

```text
A=255
```

```text
R=255&G=160&B=0
```

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

### GET /json

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

Retrieves the full state, device information, available effects, and palettes.

```APIDOC
## GET /json

### Description
Retrieves the complete JSON object containing the current state, device info, effects list, and palettes list.

### Method
GET

### Endpoint
/json

### Response
#### Success Response (200)
- **state** (object) - Current state of the light
- **info** (object) - General device information
- **effects** (array) - List of effect names
- **palettes** (array) - List of palette names
```

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

### GET /version

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

Returns the build version of the module.

```APIDOC
## GET /version

### Description
Returns the build version of the module.

### Method
GET

### Endpoint
/version
```

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

### Monitor Web UI Changes

Source: https://kno.wled.ge/advanced/custom-features

Starts a development process that watches the wled00/data folder for changes and updates header files automatically.

```bash
> npm run dev
```

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

### Configure Custom Usermods

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

Example configuration for adding usermods to a custom environment in platformio_override.ini.

```ini
[env:esp32dev_temperature]
extends = env:esp32dev
custom_usermods =
  audioreactive
  Temperature
```

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

### Registering Custom LED Effects

Source: https://kno.wled.ge/advanced/custom-features

Define a void function for the effect logic and a PROGMEM metadata string, then register them using strip.addEffect within the setup method.

```cpp
void mode_myEffect() {
  // ... set pixel colors using SEGMENT, SEGENV, SEGLEN, SEGCOLOR(n), etc. ...
}
static const char _data_FX_MODE_MY_EFFECT[] PROGMEM = "My Effect@Speed,Intensity;!,!;!;01";

void setup() override {
  strip.addEffect(255, &mode_myEffect, _data_FX_MODE_MY_EFFECT);
  // 255 = "assign next available slot"; use a fixed ID for a permanent effect
  // call addEffect() again for each additional effect
}
```

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

### Define a playlist via JSON API

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

Example structure for a playlist object defining preset sequences, durations, and repeat behavior.

```json
{
  "playlist": {
    "ps": [26, 20, 18, 20],
    "dur": [30, 20, 10, 50],
    "transition": 0,
    "repeat": 10,
    "end": 21
  }
}
```

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

### Build Web UI Files

Source: https://kno.wled.ge/advanced/custom-features

Initializes dependencies and generates the necessary html_*.h files from the data directory.

```bash
> npm install
> npm run build
```

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

### Navigate to WLED Directory

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

Command to enter the WLED project folder.

```bash
cd WLED
```

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

### GET /json/pal

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

Retrieves available palettes.

```APIDOC
## GET /json/pal

### Description
Retrieves available palettes.
```

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

### GET /json/fxdata

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

Retrieves effect data.

```APIDOC
## GET /json/fxdata

### Description
Retrieves effect data.
```

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

### Implement persistent configuration methods

Source: https://kno.wled.ge/advanced/custom-features

Uses addToConfig and readFromConfig to serialize and deserialize settings to cfg.json.

```cpp
void addToConfig(JsonObject& root) override {
  JsonObject top = root.createNestedObject(FPSTR(_name));
  top["myValue"] = myValue;
}

bool readFromConfig(JsonObject& root) override {
  JsonObject top = root[FPSTR(_name)];
  bool ok = !top.isNull();
  ok &= getJsonValue(top["myValue"], myValue, 42 /*default*/);
  return ok;  // return false to have WLED write defaults to disk
}
```

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

### GET /json/eff

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

Retrieves available effects.

```APIDOC
## GET /json/eff

### Description
Retrieves available effects.
```

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

### POST /json/state (Playlist Configuration)

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

Configures and triggers a playlist of presets.

```APIDOC
## POST /json/state

### Description
Applies a sequence of presets as a playlist.

### Request Body
- **playlist** (object) - Required - Playlist configuration
  - **ps** (array) - Required - Array of preset ID integers.
  - **dur** (array) - Optional - Duration for each preset in tenths of seconds.
  - **transition** (array) - Optional - Transition time for each preset in tenths of seconds.
  - **repeat** (integer) - Optional - Number of cycles to repeat.
  - **end** (integer) - Optional - Preset ID to apply after completion.

### Request Example
{
  "playlist": {
    "ps": [26, 20, 18, 20],
    "dur": [30, 20, 10, 50],
    "transition": 0,
    "repeat": 10,
    "end": 21
  }
}
```

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

### Build Web UI files

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

Command to build the Web UI components required for the WLED project.

```bash
npm run build
```

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

### GET /json/si

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

Retrieves sensor information.

```APIDOC
## GET /json/si

### Description
Retrieves sensor information.
```

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

### GET /json/net

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

Retrieves network configuration and status.

```APIDOC
## GET /json/net

### Description
Retrieves network configuration and status.
```

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

### GET /json/palx

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

Retrieves extended palette information.

```APIDOC
## GET /json/palx

### Description
Retrieves extended palette information.
```

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

### Flash ESP32 with esptool

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

Commands for flashing the bootloader and firmware to an ESP32 device.

```bash
esptool.py write-flash 0x0 ./esp32_bootloader_v4.bin
```

```bash
esptool.py write-flash 0x10000 ./WLED_XXX.bin 
```

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

### GET /json/nodes

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

Retrieves information about nodes in the network.

```APIDOC
## GET /json/nodes

### Description
Retrieves information about nodes in the network.
```

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

### Configure library.json for PlatformIO

Source: https://kno.wled.ge/advanced/custom-features

Defines the module metadata and build settings. The libArchive setting must be false to ensure proper registration.

```json
{
  "name": "my-wled-usermod",
  "build": { "libArchive": false },
  "dependencies": {
    "paulstoffregen/OneWire": "~2.3.8"
  }
}
```

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

### GET /json/info

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

Retrieve JSON information about the module.

```APIDOC
## GET /json/info

### Description
Retrieve JSON information about the module.

### Method
GET

### Endpoint
/json/info
```

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

### GET /json/state

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

Retrieve the JSON state object.

```APIDOC
## GET /json/state

### Description
Retrieve the JSON state object.

### Method
GET

### Endpoint
/json/state
```

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

### Define Access Point Settings in C++

Source: https://kno.wled.ge/advanced/custom-ap

Use preprocessor directives in a header file to configure access point credentials.

```cpp
#define WLED_AP_SSID_UNIQUE
#define WLED_AP_SSID "MyWLED"
#define WLED_AP_PASS "MyWLEDPass"
```

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

### GET /json/state

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

Retrieves the current state of the WLED device.

```APIDOC
## GET /json/state

### Description
Retrieves the current state of the WLED device.
```

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

### WLED Builds Section Header

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

Reference header found in platformio.ini.

```ini
 #--------------------
 # WLED BUILDS
 #--------------------
```

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

### GET /uptime

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

Returns the current runtime of the module in milliseconds.

```APIDOC
## GET /uptime

### Description
Returns the current runtime of the module in milliseconds.

### Method
GET

### Endpoint
/uptime
```

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

### GET /json

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

Access the JSON API for the module server.

```APIDOC
## GET /json

### Description
Access the JSON API for the module server.

### Method
GET

### Endpoint
/json
```
Tokens:
Raw