Skip to content

LEDPixelsJSONConfig

Rob Dobson edited this page Mar 5, 2026 · 4 revisions

LEDPixels JSON Configuration

{
    "strips": [
        LEDStripConfig#1,
        LEDStripConfig#2
    ],
    "segments": [
        LEDSegmentConfig#1,
        LEDSegmentConfig#2
    ],
}

strips

Array of configurations for the individual LED strips:

Setting Description Type Default Example Max
pin The GPIO pin used to send data to the LED strip. integer N/A 18 N/A
num The number of pixels in the LED strip. integer 60 120 1000
colorOrder Color order for the strip hardware. Used to derive bytes-per-pixel. string GRB RGB, GRB, BGR, RGBWW, GRBWW N/A
rmtHz The RMT (Remote Control) resolution in Hz for communication with the LEDs. integer 10000000 12000000 N/A
T0H, T0L, T1H, T1L WS2812 timing parameters in microseconds. T0H = high time for 0 bit, T0L = low time for 0 bit, T1H = high time for 1 bit, T1L = low time for 1 bit. (Legacy names: bit0_0Us, bit0_1Us, bit1_0Us, bit1_1Us also supported) float 0.4, 0.85, 0.8, 0.45 N/A N/A
resetUs The reset time in microseconds between data frames for the LEDs. float 100.0 N/A N/A
msbFirst Whether the most significant bit (MSB) is transmitted first. boolean true N/A N/A
stopAfterTx Whether to stop the RMT peripheral after transmission is complete. boolean false N/A N/A
blockingShow Whether the show function should block until the LED update is complete. boolean false N/A N/A
powerPin The GPIO pin used to control power to the LED strip. integer N/A 5 N/A
pwrOnLvl The level at which the power pin is activated (high or low). integer 1 N/A N/A
offAfterMs The amount of time (in milliseconds) to wait before turning off the power if all pixels are off. integer 0 N/A N/A
bpp Bytes per pixel override. If colorOrder is set, this is ignored with a warning. integer Derived 3, 5 N/A

segments

An array of LED segments to which patterns and other control can be applied:

Setting Description Type Default Example
name The name of the LED segment. string N/A "Segment1"
start The start offset of the segment from the beginning of the LED strip. integer N/A 0
num The number of pixels in the segment. integer N/A 60
pattern The initial pattern to apply to the segment. string N/A "rainbow"
patternMs The duration (in milliseconds) for the initial pattern. integer N/A 1000
brightnessPC The brightness level for the segment, as a percentage. float 100.0 75.0
startupFirstPixel The color of the first pixel on startup, in hexadecimal format. string N/A "FF0000"
colorOrder Optional logical color order for the segment. If the strip colorOrder is set, it is used for on-wire encoding. string "GRB" "GRB"

Notes:

  • colorOrder is a strip-level hardware setting; it determines bytes-per-pixel and on-wire ordering.
  • Segment colorOrder is optional and should be treated as a logical transform only.

Clone this wiki locally