Skip to content

LED Strip configuration

Charlie Powell edited this page Jan 14, 2021 · 6 revisions

Final step of the setup guide! Almost there. All that's left is for you to check these settings are right, and you'll be on your way!

Here's what to expect out of the LED settings page, which can be accessed via the button 'LED Strip Configuration' in the plugin settings panel.

Config img

The key ones to change, are (1) Strip type, (2) Number of LEDs, (3) LED brightness. See more below.

Options Explained

Strip Type

Pick the type that matches your LED strip. If you get the wrong colour output, try one of the other orders of RGB (eg. GBR or GRB).

Please note that the names below may not necessarily match the type you were sold. The main difference is the order of the colours, so don't worry if you select what you think is 'the wrong type' - if it works, it works!

  • WS2812
  • WS2811 GRB
  • WS2811 RGB
  • WS2811 RBG
  • WS2811 GBR
  • WS2811 BGR
  • WS2811 BRG
  • SK6812
  • SK6812 W
  • SK6812 RGBW
  • SK6812 RBGW
  • SK6812 GRBW
  • SK6812 GBRW
  • SK6812 BRGW
  • SK6812 BGRW

Max Brightness

Sets the maximum brightness the LEDs will hit. Most effects use this, with (currently) the only exception being Pulse, which fades in and out.

Number of LEDs

How many LEDs have you got?

GPIO Pin

  1. Technically possible to use other pins, but as OctoPrint should not be run as root you should keep it at 10.

Frequency

800000 hz (800 khz) - Only included for backwards compatibility with old strips which used 400 khz, not usually changed.

DMA Channel

Internal SPI channel of the Raspberry Pi. Do not change unless you know what you are doing. Other channels can cause filesystem corruption and other issues, 10 is safe. I will not be held responsible if something goes wrong changing this!

Invert pin output

Invert the signal from the Raspberry Pi. Useful if your setup uses a level shifter that inverts the signal, so it can be inverted again to make it the right way around in the end.

PWM Channel

(To be removed in a future version) Internal PWM Channel. Irrelevant to the plugin since it uses SPI in most cases. Will still be available via config.yaml manual editing.

Heads up! This documentation has migrated to Gitbook! Find it here: https://cp2004.gitbook.io/ws281x-led-status/

Clone this wiki locally