Difference between revisions of "Component: LED Matrix Dummy (HT16K33) (Outputs: LEDs)"

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_LED_Matrix_HT16K33_Dummy.fcfx FC_Comp_Source_LED_Matrix_HT16K33_Dummy.fcfx]
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LED_Matrix_HT16K33_Dummy.fcfx FC_Comp_Source_LED_Matrix_HT16K33_Dummy.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 32: Line 34:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 60: Line 64:
  
 
==Macro reference==
 
==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;" | '''DisplayString'''
 +
|-
 +
| colspan="2" | Prints an ASCII string onto the LED Matrix a column at a time. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | Data string to display on the LEDs 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Animation_Delay
 +
|-
 +
| colspan="2" | Delay in milliseconds between writing to the next column 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Leadout
 +
|-
 +
| colspan="2" | Allows the text to scroll completely off the display before returning 0=No, 1=Yes 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Add_Spaces
 +
|-
 +
| colspan="2" | Add spaces between each ASCII character 0=No, 1=Yes 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Orientation
 +
|-
 +
| colspan="2" | 0=Normal, 1=Rotated 90 Degrees 
 +
|-
 +
| 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" | Configures the brightness of the LEDs by varying the On portion of the duty. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Brightness
 +
|-
 +
| colspan="2" | Range: 0-15 - 0 = Min Brightness, 15 = Full Brightness 
 +
|-
 +
| 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;" | '''ShiftColumns'''
 +
|-
 +
| colspan="2" | Shifts the columns one place left or right.  Used for things like displaying scrolling text. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Direction
 +
|-
 +
| colspan="2" | 0 = Shift Left, 1 = Shift Right 
 +
|-
 +
| 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;" | '''ClearLEDs'''
 +
|-
 +
| colspan="2" | Sets all of the LEDs in the matrix to the off state. 
 +
|-
 +
|-
 +
| 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;" | '''WriteLED'''
 +
|-
 +
| colspan="2" | Allows a single LED to be controlled using the basic column / row coordinate system. Each column is comprised of 8 rows. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Column
 +
|-
 +
| colspan="2" | Range: 0-15 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Row
 +
|-
 +
| colspan="2" | Range: 0-7 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | 0 = LED Off, 1 = LED On 
 +
|-
 +
| 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;" | '''WriteLEDXY'''
 +
|-
 +
| colspan="2" | Allows a single LED to be controlled using a more standard X, Y coordinate system. 0,0 refers to the bottom left hand LED. Only works with the fixed display modules, custom module not supported. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | X coordinate. Range: 0-15 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | Y coordinate. Range: 0-15 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | State
 +
|-
 +
| colspan="2" | State 0=Off, 1=On 
 +
|-
 +
| 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;" | '''WriteCommand'''
 +
|-
 +
| colspan="2" | Writes a command. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Command
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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;" | '''WriteColumn'''
 +
|-
 +
| colspan="2" | Allows a single column of 8 LEDs to be controlled in a single action. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Column
 +
|-
 +
| colspan="2" | Range: 0-15 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | Data to display on the column of LEDs 
 +
|-
 +
| 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;" | '''WriteRegister'''
 +
|-
 +
| colspan="2" | Writes a value to a register. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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" | Configures the I2C peripheral and sets up the HT16K33 IC ready to drive the LEDs. 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
 +
 +
==Property reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Display Module
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | LED Count
 +
|-
 +
| colspan="2" | Total number of LEDs in the component 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Slave Address
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Channel selection 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Baud Select
 +
|-
 +
| colspan="2" | Baud rate option selector 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Baud Rate
 +
|-
 +
| colspan="2" | Baud rate to be used 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Stop Delay
 +
|-
 +
| 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.  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | SDA
 +
|-
 +
| colspan="2" | Pin used for SDA (data signal) 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | SCL
 +
|-
 +
| colspan="2" | Pin used for SCL (clock signal) 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colours
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | On Color
 +
|-
 +
| colspan="2" | Simulated colour of the LEDs when switched On 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Off Color
 +
|-
 +
| colspan="2" | Simulated colour of the LEDs when switched Off 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Simulation Type
 +
|-
 +
| colspan="2" | Sets the simulation type. Component GUI allows the object on the panel to reflect what the reakl life LED matrix should do. I2C Injector allows the I2C communications to be simulated via injectors. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | GUI
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Column Spacing
 +
|-
 +
| colspan="2" | Simulation column spacing 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Width
 +
|-
 +
| colspan="2" | Simulation LED width 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Row Spacing
 +
|-
 +
| colspan="2" | Simulation row spacing 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Height
 +
|-
 +
| colspan="2" | Simulated LED height 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Depth
 +
|-
 +
| colspan="2" | Simulated LED Depth (3D environments only) 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | LED Shape
 +
|-
 +
| colspan="2" | Simulated LED basic shape  
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:15, 20 January 2023

Author Matrix Ltd
Version 1.2
Category Outputs: LEDs


LED Matrix Dummy component

LED Matrix component designed to work using a HT16K33 LED driver IC. Can drive up to 16 x 8 (128) LEDs. Includes support for 8x16 Backpack, 16x8 Featherwing, 8x8 Backpack and Custom.

Component Source Code

Please click here to view the component source code (Beta): FC_Comp_Source_LED_Matrix_HT16K33_Dummy.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.

LED Active.jpg


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.

LED Resistor Calculator Tool

Macro reference

Fc9-comp-macro.png DisplayString
Prints an ASCII string onto the LED Matrix a column at a time. 
Fc9-string-icon.png - STRING Data
Data string to display on the LEDs 
Fc9-u16-icon.png - UINT Animation_Delay
Delay in milliseconds between writing to the next column 
Fc9-u8-icon.png - BYTE Leadout
Allows the text to scroll completely off the display before returning 0=No, 1=Yes 
Fc9-u8-icon.png - BYTE Add_Spaces
Add spaces between each ASCII character 0=No, 1=Yes 
Fc9-u8-icon.png - BYTE Orientation
0=Normal, 1=Rotated 90 Degrees 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetBrightness
Configures the brightness of the LEDs by varying the On portion of the duty. 
Fc9-u8-icon.png - BYTE Brightness
Range: 0-15 - 0 = Min Brightness, 15 = Full Brightness 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ShiftColumns
Shifts the columns one place left or right. Used for things like displaying scrolling text. 
Fc9-u8-icon.png - BYTE Direction
0 = Shift Left, 1 = Shift Right 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ClearLEDs
Sets all of the LEDs in the matrix to the off state. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteLED
Allows a single LED to be controlled using the basic column / row coordinate system. Each column is comprised of 8 rows. 
Fc9-u8-icon.png - BYTE Column
Range: 0-15 
Fc9-u8-icon.png - BYTE Row
Range: 0-7 
Fc9-u8-icon.png - BYTE Data
0 = LED Off, 1 = LED On 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteLEDXY
Allows a single LED to be controlled using a more standard X, Y coordinate system. 0,0 refers to the bottom left hand LED. Only works with the fixed display modules, custom module not supported. 
Fc9-u8-icon.png - BYTE X
X coordinate. Range: 0-15 
Fc9-u8-icon.png - BYTE Y
Y coordinate. Range: 0-15 
Fc9-u8-icon.png - BYTE State
State 0=Off, 1=On 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteCommand
Writes a command. 
Fc9-u8-icon.png - BYTE Command
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteColumn
Allows a single column of 8 LEDs to be controlled in a single action. 
Fc9-u8-icon.png - BYTE Column
Range: 0-15 
Fc9-u8-icon.png - BYTE Data
Data to display on the column of LEDs 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteRegister
Writes a value to a register. 
Fc9-u8-icon.png - BYTE Address
 
Fc9-u8-icon.png - BYTE Value
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Configures the I2C peripheral and sets up the HT16K33 IC ready to drive the LEDs. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Display Module
 
Fc9-type-14-icon.png LED Count
Total number of LEDs in the component 
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Slave Address
 
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-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-type-5-icon.png SDA
Pin used for SDA (data signal) 
Fc9-type-5-icon.png SCL
Pin used for SCL (clock signal) 
Fc9-conn-icon.png Colours
Fc9-type-1-icon.png On Color
Simulated colour of the LEDs when switched On 
Fc9-type-1-icon.png Off Color
Simulated colour of the LEDs when switched Off 
Fc9-conn-icon.png Simulation
Fc9-type-16-icon.png Simulation Type
Sets the simulation type. Component GUI allows the object on the panel to reflect what the reakl life LED matrix should do. I2C Injector allows the I2C communications to be simulated via injectors. 
Fc9-conn-icon.png GUI
Fc9-type-15-icon.png Column Spacing
Simulation column spacing 
Fc9-type-15-icon.png Width
Simulation LED width 
Fc9-type-15-icon.png Row Spacing
Simulation row spacing 
Fc9-type-15-icon.png Height
Simulated LED height 
Fc9-type-15-icon.png Depth
Simulated LED Depth (3D environments only) 
Fc9-type-16-icon.png LED Shape
Simulated LED basic shape  

==Macro reference==

Fc9-comp-macro.png DisplayString
Prints an ASCII string onto the LED Matrix a column at a time. 
Fc9-string-icon.png - STRING Data
Data string to display on the LEDs 
Fc9-u16-icon.png - UINT Animation_Delay
Delay in milliseconds between writing to the next column 
Fc9-u8-icon.png - BYTE Leadout
Allows the text to scroll completely off the display before returning 0=No, 1=Yes 
Fc9-u8-icon.png - BYTE Add_Spaces
Add spaces between each ASCII character 0=No, 1=Yes 
Fc9-u8-icon.png - BYTE Orientation
0=Normal, 1=Rotated 90 Degrees 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetBrightness
Configures the brightness of the LEDs by varying the On portion of the duty. 
Fc9-u8-icon.png - BYTE Brightness
Range: 0-15 - 0 = Min Brightness, 15 = Full Brightness 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ShiftColumns
Shifts the columns one place left or right. Used for things like displaying scrolling text. 
Fc9-u8-icon.png - BYTE Direction
0 = Shift Left, 1 = Shift Right 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ClearLEDs
Sets all of the LEDs in the matrix to the off state. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteLED
Allows a single LED to be controlled using the basic column / row coordinate system. Each column is comprised of 8 rows. 
Fc9-u8-icon.png - BYTE Column
Range: 0-15 
Fc9-u8-icon.png - BYTE Row
Range: 0-7 
Fc9-u8-icon.png - BYTE Data
0 = LED Off, 1 = LED On 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteLEDXY
Allows a single LED to be controlled using a more standard X, Y coordinate system. 0,0 refers to the bottom left hand LED. Only works with the fixed display modules, custom module not supported. 
Fc9-u8-icon.png - BYTE X
X coordinate. Range: 0-15 
Fc9-u8-icon.png - BYTE Y
Y coordinate. Range: 0-15 
Fc9-u8-icon.png - BYTE State
State 0=Off, 1=On 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteCommand
Writes a command. 
Fc9-u8-icon.png - BYTE Command
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteColumn
Allows a single column of 8 LEDs to be controlled in a single action. 
Fc9-u8-icon.png - BYTE Column
Range: 0-15 
Fc9-u8-icon.png - BYTE Data
Data to display on the column of LEDs 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteRegister
Writes a value to a register. 
Fc9-u8-icon.png - BYTE Address
 
Fc9-u8-icon.png - BYTE Value
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Configures the I2C peripheral and sets up the HT16K33 IC ready to drive the LEDs. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Display Module
 
Fc9-type-14-icon.png LED Count
Total number of LEDs in the component 
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Slave Address
 
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-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-type-5-icon.png SDA
Pin used for SDA (data signal) 
Fc9-type-5-icon.png SCL
Pin used for SCL (clock signal) 
Fc9-conn-icon.png Colours
Fc9-type-1-icon.png On Color
Simulated colour of the LEDs when switched On 
Fc9-type-1-icon.png Off Color
Simulated colour of the LEDs when switched Off 
Fc9-conn-icon.png Simulation
Fc9-type-16-icon.png Simulation Type
Sets the simulation type. Component GUI allows the object on the panel to reflect what the reakl life LED matrix should do. I2C Injector allows the I2C communications to be simulated via injectors. 
Fc9-conn-icon.png GUI
Fc9-type-15-icon.png Column Spacing
Simulation column spacing 
Fc9-type-15-icon.png Width
Simulation LED width 
Fc9-type-15-icon.png Row Spacing
Simulation row spacing 
Fc9-type-15-icon.png Height
Simulated LED height 
Fc9-type-15-icon.png Depth
Simulated LED Depth (3D environments only) 
Fc9-type-16-icon.png LED Shape
Simulated LED basic shape  
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_LED_Matrix_Dummy_(HT16K33)_(Outputs:_LEDs)&oldid=32720"