Component: LED Multicolour RGB (5mm, PCB) ()
| Author | Matrix |
| Version | 1.2 |
| Category |
LED Multicolour RGB (5mm, PCB) component
A simulatable RGB LED in a standard 5mm through-hole PCB mount package. Three port pins each output a simple PWM signal - one for each of the primary colours. The colors can then be mixed in any proportions to allow the desired color to be produced.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
|
Enable |
| Enables the RGB LED. This must be done before the LED can be lit or the color changed. | |
 - VOID
|
Return |
|
|
Tick |
| Call this macro at regular intervals to illuminate the LED with the chosen color. Turns each pin on and off to generate a simple PWM signal for each color - when done rapidly, this gives the illusion of the chosen color. | |
| - VOID
|
Return |
|
|
SetColor |
| Set the target color for the LED. Each of the Red, Blue and Green channels can be set to any value from 0 (off) to 255 (full brightness). | |
 - BYTE
|
red |
| Red component of RGB LED local to this macro | |
| - BYTE
|
green |
| Green component of RGB LED local to this macro | |
| - BYTE
|
blue |
| Blue component of RGB LED local to this macro | |
| - VOID
|
Return |
|
|
WriteMicroseconds |
| Sets the PWM output of one of the PCA9685 pins based on the input microseconds, output is not precise | |
| - BYTE
|
Output |
| One of the PWM output pins - Range: 0 to 15 | |
 - UINT
|
Microseconds |
| The number of Microseconds to turn the PWM output ON | |
| - VOID
|
Return |
|
|
SetPWM |
| Sets the PWM output of one of the PCA9685 pins | |
| - BYTE
|
Output |
| One of the PWM output pins - Range: 0 to 15 | |
| - UINT
|
On |
| At what point in the 4096-part cycle to turn the PWM output ON | |
| - UINT
|
Off |
| At what point in the 4096-part cycle to turn the PWM output OFF | |
| - VOID
|
Return |
|
|
Initialise |
| Sets up the I2C ready for communications to begin | |
| - VOID
|
Return |
|
|
WakeUp |
| Wakes the module from Sleep mode | |
| - VOID
|
Return |
|
|
SetPin |
| Sets pin without having to deal with on/off tick placement and properly handles a zero value as completely off and 4095 as completely on. | |
| - BYTE
|
Output |
| One of the PWM output pins - Range: 0 to 15 | |
| - UINT
|
Duty |
| The number of ticks out of 4096 to be active | |
| [[File:]] - | Invert |
| 0=Normal, 1=Inverted | |
| - VOID
|
Return |
|
|
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 |
| - VOID
|
Return |
|
|
ShiftLEDs2D |
| Shifts the contents of the display by the number of vertices specified ***Please Note that Wrap mode is currently unavailable*** | |
| [[File:]] - | X |
| Number of pixels to shift the display -1 to 1 / 0 = No Shift | |
| [[File:]] - | Y |
| Number of pixels to shift the display -1 to 1 / 0 = No Shift | |
| - BYTE
|
DataMode |
| 0=ResetToZero, 1=WrapAroundDisplay, 2=Smear | |
| - VOID
|
Return |
|
|
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 |
|
|
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 | |
| - VOID
|
Return |
|
|
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 |
|
|
ShiftLEDs3D |
| Shifts the contents of the display by the number of vertices specified ***Please Note that Wrap mode is currently unavailable*** | |
| [[File:]] - | X |
| Number of pixels to shift the display -1 to 1 / 0 = No Shift | |
| [[File:]] - | Y |
| Number of pixels to shift the display -1 to 1 / 0 = No Shift | |
| [[File:]] - | Z |
| Number of pixels to shift the display -1 to 1 / 0 = No Shift | |
| - BYTE
|
DataMode |
| 0=ResetToZero, 1=WrapAroundDisplay, 2=Smear | |
| - VOID
|
Return |
|
|
Initialise |
| Sets up the data memory and draws the simulated LED cube on the panel. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Red |
| Pin that the red LED is connected to. | |
|
|
Green |
| Pin that the green LED is connected to. | |
|
|
Blue |
| Pin tha the Blue pin is connected to. | |
|
Polarity |
| Active High: Use for common cathode LEDs - Pin true = LED On. Active Low: Use for common anode LEDs - Pin false = LED On. | |
|
|
Color bit size |
| Color bit depth. Sets the resolution of the virtual PWM signals driving the LEDs. Lower values mean that the 'Tick' macro can be called less often, but reduced the number of colours that can be created. | |
|
Rollover value |
| The number of unique colours each R/G/B channel can output. Range: 0 to (Rollover Value - 1). | |
|
Connections |
|
|
Simulations |