Difference between revisions of "Component: RGB LED LP5030 LP5036 (LEDs)"

From Flowcode Help
Jump to navigationJump to search
 
(15 intermediate revisions by the same user not shown)
Line 14: Line 14:
 
==RGB LED LP5030 LP5036 component==
 
==RGB LED LP5030 LP5036 component==
 
An I2C Based RGB LED driver with 30 or 36 individual constant-current sinks. Used to drive 10 or 12 RGB LEDs with a wide range of applications.
 
An I2C Based RGB LED driver with 30 or 36 individual constant-current sinks. Used to drive 10 or 12 RGB LEDs with a wide range of applications.
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_LP5036_RGB_LED.fcfx FC_Comp_Source_LP5036_RGB_LED.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LP5036_RGB_LED.fcfx FC_Comp_Source_LP5036_RGB_LED.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 22: Line 50:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 27: Line 77:
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
  
−
==Downloadable macro reference==
 
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRGB'''
 
−
|-
 
−
| colspan="2" | Gets the RGB colour of a single LED.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Address
 
−
|-
 
−
| colspan="2" | Range: 0-11&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | RGB
 
−
|-
 
−
| colspan="2" | Byte array containing at least 3 bytes to store Red, Green and Blue&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetBrightness'''
 
−
|-
 
−
| colspan="2" | Allows the brightness of a single LED to be specified as a byte from 0 to 255. Default on reset is 255.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Address
 
−
|-
 
−
| colspan="2" | Range: 0-11&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Brightness
 
−
|-
 
−
| colspan="2" | Brightness value: Range 0-255&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadReg'''
 
−
|-
 
−
| colspan="2" | Reads the data from one or more sequential registers&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Address
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Data
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Count
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
 +
 +
 +
 +
 +
 +
==Macro reference==
 +
 +
===GetBrightness===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteReg'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetBrightness'''
 
|-
 
|-
−
| colspan="2" | Writes data to one or more sequential registers&nbsp;
+
| colspan="2" | Gets the brightness of a single LED.&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 114: Line 103:
 
| width="90%" | Address
 
| width="90%" | Address
 
|-
 
|-
−
| colspan="2" | &nbsp;
+
| colspan="2" | Range: 0-11&nbsp;
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | Data
+
| width="90%" | RGB
 
|-
 
|-
−
| colspan="2" | &nbsp;
+
| colspan="2" | Byte array containing at least 3 bytes to store Red, Green and Blue&nbsp;
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | Count
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===GetDiscreteRGB===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRGB'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDiscreteRGB'''
 
|-
 
|-
−
| colspan="2" | Allows the colour of a single LED to be specified in RGB.&nbsp;
+
| colspan="2" | Gets the RGB format colour of a single LED.&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 145: Line 130:
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | RGB
+
| width="90%" | ColourIndex
 
|-
 
|-
−
| colspan="2" | Byte array containing at least 3 bytes to set Red, Green and Blue&nbsp;
+
| colspan="2" | &nbsp;
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===GetRGB===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetBrightness'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRGB'''
 
|-
 
|-
−
| colspan="2" | Gets the brightness of a single LED.&nbsp;
+
| colspan="2" | Gets the RGB colour of a single LED. Array variables only. For individual variables, use GetDiscreteRGB&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 171: Line 157:
 
|-
 
|-
 
| colspan="2" | Byte array containing at least 3 bytes to store Red, Green and Blue&nbsp;
 
| colspan="2" | Byte array containing at least 3 bytes to store Red, Green and Blue&nbsp;
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
−
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetUnitAddress'''
 
−
|-
 
−
| colspan="2" | Allows the component to taklk to more then one IC or broadcast to all connected ICs.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Address
 
−
|-
 
−
| colspan="2" | Range: 0-3 = Individual / 4 = Broadcast&nbsp;
 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 195: Line 163:
  
  
 +
===Initialise===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 208: Line 177:
  
  
 +
===ReadReg===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Refresh'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadReg'''
 
|-
 
|-
−
| colspan="2" | Clocks out the current colour data to the LEDs from the values stored in RAM&nbsp;
+
| colspan="2" | Reads the data from one or more sequential registers&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
+
| width="90%" | Address
−
|}
 
−
 
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ShiftLEDs1D'''
 
−
|-
 
−
| colspan="2" | Shifts the LED colours in 1D and wraps &nbsp;
 
 
|-
 
|-
 +
| colspan="2" | &nbsp;
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | Direction
+
| width="90%" | Data
 
|-
 
|-
−
| colspan="2" | 0 = Forwards, 1 = Backwards&nbsp;
+
| colspan="2" | &nbsp;
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | DataMode
+
| width="90%" | Count
 
|-
 
|-
−
| colspan="2" | 0=ResetToZero, 1=WrapAroundDisplay, 2=Smear&nbsp;
+
| colspan="2" | &nbsp;
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 244: Line 206:
  
  
 +
===SetBrightness===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DrawLine3D'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetBrightness'''
 
|-
 
|-
−
| colspan="2" | Draws a line on a 3D array of LEDs&nbsp;
+
| colspan="2" | Allows the brightness of a single LED to be specified as a byte from 0 to 255. Default on reset is 255.&nbsp;
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | X1
 
−
|-
 
−
| colspan="2" | Start X Coordinate&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Y1
 
−
|-
 
−
| colspan="2" | Start Y Coordinate&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Z1
 
−
|-
 
−
| colspan="2" | Start Z Coordinate&nbsp;
 
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | X2
 
−
|-
 
−
| colspan="2" | End X Coordinate&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Y2
 
−
|-
 
−
| colspan="2" | End Y Coordinate&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Z2
 
−
|-
 
−
| colspan="2" | End Z Coordinate&nbsp;
 
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | R
+
| width="90%" | Address
 
|-
 
|-
−
| colspan="2" | Red Colour Channel&nbsp;
+
| colspan="2" | Range: 0-11&nbsp;
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | G
+
| width="90%" | Brightness
−
|-
 
−
| colspan="2" | Green Colour Channel&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | B
 
−
|-
 
−
| colspan="2" | Blue Colour Channel&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Delay_T1H'''
 
−
|-
 
−
| colspan="2" | &nbsp;
 
 
|-
 
|-
 +
| colspan="2" | Brightness value: Range 0-255&nbsp;
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 315: Line 230:
  
  
 +
===SetDiscreteRGB===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLEDIndex2D'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDiscreteRGB'''
−
|-
 
−
| colspan="2" | Sets the index of a single LED in RAM as a 2D array.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | X
 
−
|-
 
−
| colspan="2" | LED Column to change the colour / Range: 0 to (LED Column - 1)&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Y
 
−
|-
 
−
| colspan="2" | LED Row to change the colour / Range: 0 to (LED Row - 1)&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DrawRectangle2D'''
 
 
|-
 
|-
−
| colspan="2" | Draws a basic 2D rectangle onto the LEDs&nbsp;
+
| colspan="2" | Allows the colour of a single LED to be specified in RGB format&nbsp;
 
|-
 
|-
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | X1
+
| width="90%" | Address
 
|-
 
|-
−
| colspan="2" | &nbsp;
+
| colspan="2" | Range: 0-11&nbsp;
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Y1
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | X2
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Y2
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | DrawStyle
 
−
|-
 
−
| colspan="2" | Sets the draw style - 0=Soild, 1=Edge, 2=Corners&nbsp;
 
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | R
+
| width="90%" | Red
 
|-
 
|-
 
| colspan="2" | &nbsp;
 
| colspan="2" | &nbsp;
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | G
+
| width="90%" | Green
 
|-
 
|-
 
| colspan="2" | &nbsp;
 
| colspan="2" | &nbsp;
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | B
+
| width="90%" | Blue
 
|-
 
|-
 
| colspan="2" | &nbsp;
 
| colspan="2" | &nbsp;
Line 391: Line 264:
  
  
 +
===SetRGB===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ShiftLEDs2D'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRGB'''
 
|-
 
|-
−
| colspan="2" | Shifts the contents of the display by the number of vertices specified ***Please Note that Wrap mode is currently unavailable***&nbsp;
+
| colspan="2" | Allows the colour of a single LED to be specified in RGB. Array variables only. For individual variables and literal values, use SetDiscreteRGB&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | X
+
| width="90%" | Address
 
|-
 
|-
−
| colspan="2" | Number of pixels to shift the display -1 to 1 / 0 = No Shift&nbsp;
+
| colspan="2" | Range: 0-11&nbsp;
−
|-
 
−
| width="10%" align="center" | [[File:]] -  
 
−
| width="90%" | Y
 
−
|-
 
−
| colspan="2" | Number of pixels to shift the display -1 to 1 / 0 = No Shift&nbsp;
 
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | DataMode
+
| width="90%" | RGB
 
|-
 
|-
−
| colspan="2" | 0=ResetToZero, 1=WrapAroundDisplay, 2=Smear&nbsp;
+
| colspan="2" | Byte array containing at least 3 bytes to set Red, Green and Blue&nbsp;
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 419: Line 288:
  
  
 +
===SetUnitAddress===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLEDIndex3D'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetUnitAddress'''
 
|-
 
|-
−
| colspan="2" | Gets the index of a single LED in RAM as a 3D array.&nbsp;
+
| colspan="2" | Allows the component to taklk to more then one IC or broadcast to all connected ICs.&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | X
+
| width="90%" | Address
 
|-
 
|-
−
| colspan="2" | LED Column to change the colour / Range: 0 to (LED Column - 1)&nbsp;
+
| colspan="2" | Range: 0-3 = Individual / 4 = Broadcast&nbsp;
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
−
| width="90%" | Y
 
−
|-
 
−
| colspan="2" | LED Row to change the colour / Range: 0 to (LED Row - 1)&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Z
 
−
|-
 
−
| colspan="2" | LED Layer to change the colour / Range: 0 to (LED Layer - 1)&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===WriteReg===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DrawCuboid3D'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteReg'''
 
|-
 
|-
−
| colspan="2" | Draws a basic 3D cuboid onto the LEDs&nbsp;
+
| colspan="2" | Writes data to one or more sequential registers&nbsp;
 
|-
 
|-
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | X1
+
| width="90%" | Address
 
|-
 
|-
−
| colspan="2" | Start X pixel coordinate&nbsp;
+
| colspan="2" | &nbsp;
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | Y1
+
| width="90%" | Data
 
|-
 
|-
−
| colspan="2" | Start Y pixel coordinate&nbsp;
+
| colspan="2" | &nbsp;
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | Z1
+
| width="90%" | Count
−
|-
 
−
| colspan="2" | Start Z pixel coordinate&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | X2
 
−
|-
 
−
| colspan="2" | End X pixel coordinate&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Y2
 
−
|-
 
−
| colspan="2" | End Y pixel coordinate&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Z2
 
−
|-
 
−
| colspan="2" | End Z pixel coordinate&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | DrawStyle
 
−
|-
 
−
| colspan="2" | Sets the draw style - 0=Soild, 1=Edge, 2=Corners&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | R
 
−
|-
 
−
| colspan="2" | Red Colour Channel&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | G
 
−
|-
 
−
| colspan="2" | Green Colour Channel&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | B
 
−
|-
 
−
| colspan="2" | White Colour Channel&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 
−
|-
 
−
| colspan="2" | 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.&nbsp;
 
 
|-
 
|-
 +
| colspan="2" | &nbsp;
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ShiftLEDs3D'''
 
−
|-
 
−
| colspan="2" | Shifts the contents of the display by the number of vertices specified ***Please Note that Wrap mode is currently unavailable***&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | X
 
−
|-
 
−
| colspan="2" | Number of pixels to shift the display -1 to 1 / 0 = No Shift&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | Y
 
−
|-
 
−
| colspan="2" | Number of pixels to shift the display -1 to 1 / 0 = No Shift&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | Z
 
−
|-
 
−
| colspan="2" | Number of pixels to shift the display -1 to 1 / 0 = No Shift&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | DataMode
 
−
|-
 
−
| colspan="2" | 0=ResetToZero, 1=WrapAroundDisplay, 2=Smear&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
−
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 
−
|-
 
−
| colspan="2" | Sets up the data memory and draws the simulated LED cube on the panel.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
−
 
  
  
Line 577: Line 342:
 
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
 +
|-
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Driver
 
|-
 
|-
 
|-
 
|-
Line 589: Line 358:
 
| colspan="2" | &nbsp;
 
| colspan="2" | &nbsp;
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
| width="90%" | Scope Traces
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
−
|-
 
−
| colspan="2" | Selects if the component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Console Data
 
−
|-
 
−
| colspan="2" | Selects if the console data is automatically generated or not&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | API
 
−
|-
 
−
| colspan="2" | Specifies the API component on the panel to interact with to provide comms simulation.&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
 
 
|-
 
|-
 
|-
 
|-
Line 648: Line 402:
 
| colspan="2" | On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not  a 10ms delay between an I2C stop event and the next I2C start event.  Most modern microcontrollers will not have a problem so this property can be disabled to speed up the  I2C communications. &nbsp;
 
| colspan="2" | On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not  a 10ms delay between an I2C stop event and the next I2C start event.  Most modern microcontrollers will not have a problem so this property can be disabled to speed up the  I2C communications. &nbsp;
 
|-
 
|-
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 
|-
 
|-
 
|-
 
|-

Latest revision as of 10:26, 20 October 2023

Author Matrix TSL
Version 1.0
Category LEDs


RGB LED LP5030 LP5036 component

An I2C Based RGB LED driver with 30 or 36 individual constant-current sinks. Used to drive 10 or 12 RGB LEDs with a wide range of applications.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_LP5036_RGB_LED.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_LP5036_RGB_LED.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

GetBrightness

Fc9-comp-macro.png GetBrightness
Gets the brightness of a single LED. 
Fc9-u8-icon.png - BYTE Address
Range: 0-11 
Fc9-u8-icon.png - BYTE RGB
Byte array containing at least 3 bytes to store Red, Green and Blue 
Fc9-u8-icon.png - BYTE Return


GetDiscreteRGB

Fc9-comp-macro.png GetDiscreteRGB
Gets the RGB format colour of a single LED. 
Fc9-u8-icon.png - BYTE Address
Range: 0-11 
Fc9-u8-icon.png - BYTE ColourIndex
 
Fc9-u8-icon.png - BYTE Return


GetRGB

Fc9-comp-macro.png GetRGB
Gets the RGB colour of a single LED. Array variables only. For individual variables, use GetDiscreteRGB 
Fc9-u8-icon.png - BYTE Address
Range: 0-11 
Fc9-u8-icon.png - BYTE RGB
Byte array containing at least 3 bytes to store Red, Green and Blue 
Fc9-void-icon.png - VOID Return


Initialise

Fc9-comp-macro.png Initialise
Starts up the I2C comms ready for communicating with the LP503x module. Must be called before any of the other component macros are called. 
Fc9-void-icon.png - VOID Return


ReadReg

Fc9-comp-macro.png ReadReg
Reads the data from one or more sequential registers 
Fc9-u8-icon.png - BYTE Address
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-u8-icon.png - BYTE Count
 
Fc9-void-icon.png - VOID Return


SetBrightness

Fc9-comp-macro.png SetBrightness
Allows the brightness of a single LED to be specified as a byte from 0 to 255. Default on reset is 255. 
Fc9-u8-icon.png - BYTE Address
Range: 0-11 
Fc9-u8-icon.png - BYTE Brightness
Brightness value: Range 0-255 
Fc9-void-icon.png - VOID Return


SetDiscreteRGB

Fc9-comp-macro.png SetDiscreteRGB
Allows the colour of a single LED to be specified in RGB format 
Fc9-u8-icon.png - BYTE Address
Range: 0-11 
Fc9-u8-icon.png - BYTE Red
 
Fc9-u8-icon.png - BYTE Green
 
Fc9-u8-icon.png - BYTE Blue
 
Fc9-void-icon.png - VOID Return


SetRGB

Fc9-comp-macro.png SetRGB
Allows the colour of a single LED to be specified in RGB. Array variables only. For individual variables and literal values, use SetDiscreteRGB 
Fc9-u8-icon.png - BYTE Address
Range: 0-11 
Fc9-u8-icon.png - BYTE RGB
Byte array containing at least 3 bytes to set Red, Green and Blue 
Fc9-void-icon.png - VOID Return


SetUnitAddress

Fc9-comp-macro.png SetUnitAddress
Allows the component to taklk to more then one IC or broadcast to all connected ICs. 
Fc9-u8-icon.png - BYTE Address
Range: 0-3 = Individual / 4 = Broadcast 
Fc9-void-icon.png - VOID Return


WriteReg

Fc9-comp-macro.png WriteReg
Writes data to one or more sequential registers 
Fc9-u8-icon.png - BYTE Address
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-u8-icon.png - BYTE Count
 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Driver
Fc9-type-16-icon.png Driver IC
 
Fc9-type-16-icon.png Address Pins
 
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Channel
Channel selection 
Fc9-type-16-icon.png Baud Select
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
Baud rate to be used 
Fc9-type-5-icon.png SDA
Pin used for SDA (data signal) 
Fc9-type-16-icon.png SDA Remap Pin
 
Fc9-type-5-icon.png SCL
Pin used for SCL (clock signal) 
Fc9-type-16-icon.png SCL Remap Pin
 
Fc9-type-7-icon.png Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.  
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png Simulate Comms
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_RGB_LED_LP5030_LP5036_(LEDs)&oldid=39624"