Component: RGB LED SK6812 RGBW (LEDs)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix TSL |
| Version | 1.5 |
| Category | LEDs |
Contents
- 1 RGB LED SK6812 RGBW component
- 2 Component Source Code
- 3 Detailed description
- 4 Examples
- 5 Macro reference
- 5.1 Delay_T0H
- 5.2 Delay_T0L
- 5.3 Delay_T1H
- 5.4 Delay_T1L
- 5.5 DrawCuboid3D
- 5.6 DrawLine2D
- 5.7 DrawLine3D
- 5.8 DrawRectangle2D
- 5.9 GetLEDColour
- 5.10 GetLEDIndex2D
- 5.11 GetLEDIndex3D
- 5.12 Initialise
- 5.13 OutputHigh
- 5.14 OutputLow
- 5.15 Refresh
- 5.16 SetAllLEDColour
- 5.17 SetBrightness
- 5.18 SetBrightnessByte
- 5.19 SetLEDColour
- 5.20 ShiftLEDs1D
- 5.21 ShiftLEDs2D
- 5.22 ShiftLEDs3D
- 6 Property reference
RGB LED SK6812 RGBW component
A simple chained RGBW LED controller IC allowing multiple LEDs to be controlled using a serial data stream. Compatible with the SK6812 RGBW Type Controller ICs. Allows RGBW LEDs to be driven with full 24-bit colour depth plus 8-bit white channel. Allows single chains, 2D arrays and 3D cube formations to be simulated. Requires a high speed microcontroller to generate the critical timings to drive the device.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_LED_SK6812RGBW.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_LED_SK6812RGBW.fcfx
Detailed description
No detailed description exists yet for this component
Examples
LEDs can be wired either active high or active low. The LED components should each have a property allowing you to configure which LED type your using.
An active high LED will light when the microcontroller pin is outputting a logic 1 and be off when the microcontroller pin is outputting a logic 0 or in input mode.
An active low LED will light when the microcontroller pin is outputting a logic 0 and be off when the microcontroller pin is outputting a logic 1 or in input mode.
The series resistor can be on either side of the LED and acts to protect the LED from damage due to excess current. The value of resistor used can be changed based on the brightness of the LED and power consumption.
This LED Calculator tool is a good resource for calculating the correct LED series protection resistor.
Macro reference
Delay_T0H
|
Delay_T0H |
 - VOID
|
Return |
Delay_T0L
|
|
Delay_T0L |
| - VOID
|
Return |
Delay_T1H
|
|
Delay_T1H |
| - VOID
|
Return |
Delay_T1L
|
|
Delay_T1L |
| - VOID
|
Return |
DrawCuboid3D
|
|
DrawCuboid3D |
| Draws a basic 3D cuboid onto the LEDs | |
 - BYTE
|
X1 |
| Start X pixel coordinate | |
| - BYTE
|
Y1 |
| Start Y pixel coordinate | |
| - BYTE
|
Z1 |
| Start Z pixel coordinate | |
| - BYTE
|
X2 |
| End X pixel coordinate | |
| - BYTE
|
Y2 |
| End Y pixel coordinate | |
| - BYTE
|
Z2 |
| End Z pixel coordinate | |
| - BYTE
|
DrawStyle |
| Sets the draw style - 0=Soild, 1=Edge, 2=Corners | |
| - BYTE
|
R |
| Red Colour Channel | |
| - BYTE
|
G |
| Green Colour Channel | |
| - BYTE
|
B |
| White Colour Channel | |
| - BYTE
|
W |
| White Colour Channel | |
| - VOID
|
Return |
DrawLine2D
|
|
DrawLine2D |
| Draws a line on a 2D array of LEDs | |
 - UINT
|
X1 |
| Start X Coordinate | |
| - UINT
|
Y1 |
| Start Y Coordinate | |
| - UINT
|
X2 |
| End X Coordinate | |
| - UINT
|
Y2 |
| End Y Coordinate | |
| - BYTE
|
R |
| Red colour channel | |
| - BYTE
|
G |
| Green colour channel | |
| - BYTE
|
B |
| Blue colour channel | |
| - BYTE
|
W |
| White colour channel | |
| - VOID
|
Return |
DrawLine3D
|
|
DrawLine3D |
| Draws a line on a 3D array of LEDs | |
| - UINT
|
X1 |
| Start X Coordinate | |
| - UINT
|
Y1 |
| Start Y Coordinate | |
| - UINT
|
Z1 |
| Start Z Coordinate | |
| - UINT
|
X2 |
| End X Coordinate | |
| - UINT
|
Y2 |
| End Y Coordinate | |
| - UINT
|
Z2 |
| End Z Coordinate | |
| - BYTE
|
R |
| Red Colour Channel | |
| - BYTE
|
G |
| Green Colour Channel | |
| - BYTE
|
B |
| Blue Colour Channel | |
| - BYTE
|
W |
| White Colour Channel | |
| - VOID
|
Return |
DrawRectangle2D
|
|
DrawRectangle2D |
| Draws a basic 2D rectangle onto the LEDs | |
| - BYTE
|
X1 |
| - BYTE
|
Y1 |
| - BYTE
|
X2 |
| - BYTE
|
Y2 |
| - BYTE
|
DrawStyle |
| Sets the draw style - 0=Soild, 1=Edge, 2=Corners | |
| - BYTE
|
R |
| - BYTE
|
G |
| - BYTE
|
B |
| - BYTE
|
W |
| White Colour Channel | |
| - VOID
|
Return |
GetLEDColour
|
|
GetLEDColour |
| Sets the colour of a single LED in RAM as a 1D array. | |
| - UINT
|
LED |
| LED to change the colour / Range: 0 to (LED Count - 1) | |
| - BYTE
|
ColIdx |
| 0 = Red, 1 = Green, 2 = Blue, 3 = White | |
| - BYTE
|
Return |
GetLEDIndex2D
|
|
GetLEDIndex2D |
| Sets the index of a single LED in RAM as a 2D array. | |
| - UINT
|
X |
| LED Column to change the colour / Range: 0 to (LED Column - 1) | |
| - UINT
|
Y |
| LED Row to change the colour / Range: 0 to (LED Row - 1) | |
| - UINT
|
Return |
GetLEDIndex3D
|
|
GetLEDIndex3D |
| Gets the index of a single LED in RAM as a 3D array. | |
| - UINT
|
X |
| LED Column to change the colour / Range: 0 to (LED Column - 1) | |
| - UINT
|
Y |
| LED Row to change the colour / Range: 0 to (LED Row - 1) | |
| - UINT
|
Z |
| LED Layer to change the colour / Range: 0 to (LED Layer - 1) | |
| - UINT
|
Return |
Initialise
|
|
Initialise |
| Inisialises the RGB colour RAM to 0,0,0 = LED Off and clocks out the data to initialise all the LED ICs in the chain. | |
| - VOID
|
Return |
OutputHigh
|
|
OutputHigh |
| - VOID
|
Return |
OutputLow
|
|
OutputLow |
| - VOID
|
Return |
Refresh
|
|
Refresh |
| Clocks out the current colour data to the LEDs from the values stored in RAM | |
| - VOID
|
Return |
SetAllLEDColour
|
|
SetAllLEDColour |
| Sets the colour of all the LEDs in RAM | |
| - BYTE
|
R |
| Red Colour Channel | |
| - BYTE
|
G |
| Green Colour Channel | |
| - BYTE
|
B |
| Blue Colour Channel | |
| - BYTE
|
W |
| White colour channel | |
| - VOID
|
Return |
SetBrightness
|
|
SetBrightness |
| Allows the output colour brightness of the LEDs to be scaled down. For example to save current usage or to reduce brightness in dark environments. | |
 - FLOAT
|
Scaler |
| Range: 0.0 to 1.0 Default: 1.0, 0 = Off, 0.5 = Half Brightness, 1.0 = Full Brightness | |
| - VOID
|
Return |
SetBrightnessByte
|
|
SetBrightnessByte |
| Allows the output colour brightness of the LEDs to be scaled down. For example to save current usage or to reduce brightness in dark environments. | |
| - BYTE
|
Scaler |
| Range: 0 to 255 Default: 255, 0 = Off, 128 = Half Brightness, 255 = Full Brightness | |
| - VOID
|
Return |
SetLEDColour
|
|
SetLEDColour |
| Sets the colour of a single LED in RAM as a 1D array. | |
| - UINT
|
LED |
| LED to change the colour / Range: 0 to (LED Count - 1) | |
| - BYTE
|
R |
| Red Colour Channel | |
| - BYTE
|
G |
| Green Colour Channel | |
| - BYTE
|
B |
| Blue Colour Channel | |
| - BYTE
|
W |
| White Colour Channel | |
| - VOID
|
Return |
ShiftLEDs1D
|
|
ShiftLEDs1D |
| Shifts the LED colours in 1D and wraps | |
| - BYTE
|
Direction |
| 0 = Forwards, 1 = Backwards | |
| - BYTE
|
DataMode |
| 0=ResetToZero, 1=WrapAroundDisplay, 2=Smear | |
| - VOID
|
Return |
ShiftLEDs2D
|
|
ShiftLEDs2D |
| Shifts the contents of the display by the number of vertices specified ***Please Note that Wrap mode is currently unavailable*** | |
 - INT
|
X |
| Number of pixels to shift the display -1 to 1 / 0 = No Shift | |
| - INT
|
Y |
| Number of pixels to shift the display -1 to 1 / 0 = No Shift | |
| - BYTE
|
DataMode |
| 0=ResetToZero, 1=WrapAroundDisplay, 2=Smear | |
| - VOID
|
Return |
ShiftLEDs3D
|
|
ShiftLEDs3D |
| Shifts the contents of the display by the number of vertices specified ***Please Note that Wrap mode is currently unavailable*** | |
| - INT
|
X |
| Number of pixels to shift the display -1 to 1 / 0 = No Shift | |
| - INT
|
Y |
| Number of pixels to shift the display -1 to 1 / 0 = No Shift | |
| - INT
|
Z |
| Number of pixels to shift the display -1 to 1 / 0 = No Shift | |
| - BYTE
|
DataMode |
| 0=ResetToZero, 1=WrapAroundDisplay, 2=Smear | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Controller IC |
|
LED Controller |
| Allows the user to select which LED controller IC they are using. The different controller ICs all work the same way but have different timing characteristics. | |
|
|
Data Order |
| Configures the order the colour data is clocked out to the LEDs | |
|
Reset Time (uS) |
| Blanking reset period to reset the LED shift chain and start from the beginning | |
|
|
T0H (uS) |
| Logic 0 high time in microseconds | |
|
|
T0L (uS) |
| Logic 0 low time in microseconds | |
|
|
T1H (uS) |
| Logic 1 high time in microseconds | |
|
|
T1L (uS) |
| Logic 1 low time in microseconds | |
|
|
LED Properties |
|
|
LED Arrangement |
| Controls the arrangement of the LEDs on the panel. 1D - Creates a straight line of LEDs 2D - Creates an X by Y Array of LEDs 3D - Creates an X by Y by Z Array of LEDs | |
|
LED Count |
| Total number of LEDs in the design | |
|
|
Column Spacing |
| X Spacing Between LEDs on the Panel | |
|
|
Connections |
|
Data Pin |
| LED Data Pin - Connected to the Data In pin of the first WS821x IC. | |
