Difference between revisions of "Component: LED Matrix (Serial) (LEDs)"

From Flowcode Help
Jump to navigationJump to search
Line 16: Line 16:
  
 
==Component Source Code==
 
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_LED_Matrix.fcfx FC_Comp_Source_LED_Matrix.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LED_Matrix.fcfx FC_Comp_Source_LED_Matrix.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LED_Matrix.fcfx FC_Comp_Source_LED_Matrix.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 28: Line 32:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 36: Line 42:
  
 
==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;" | '''StrobeHigh'''
 +
|-
 +
| colspan="2" | Sets the strobe pin high. Strobing controls the LED brightness and does not apply to simulation. 
 +
|-
 +
|-
 +
| 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;" | '''StrobeLow'''
 +
|-
 +
| colspan="2" | Sets the strobe pin low. Strobing controls the LED brightness and does not apply to simulation. 
 +
|-
 +
|-
 +
| 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;" | '''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" 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;" | '''WriteColumn'''
 +
|-
 +
| colspan="2" | Allows a single column of data to be inserted, Acts to shift the rest of the columns across by one. 
 +
|-
 +
|-
 +
| 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-u8-icon.png]] - BYTE
 +
| 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%" | LED Type
 +
|-
 +
| colspan="2" | Active high outputs a logic 1 to set the LED and logic 0 to clear the LED. Active low outputs a logic 0 to set the LED and logic 1 to clear the LED 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Row Count
 +
|-
 +
| colspan="2" | Number of LED rows 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Column Count
 +
|-
 +
| colspan="2" | Number of LED columns 
 +
|-
 +
| 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" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Flip Display
 +
|-
 +
| colspan="2" | Allows the column and text data sent to the display to be flipped 
 +
|-
 +
| 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-5-icon.png]]
 +
| width="90%" | Data In
 +
|-
 +
| colspan="2" | Data In pin which is used to pass the input LED value 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Data Out
 +
|-
 +
| colspan="2" | Data Out Pin - Optional and used to collect the data as it leaves the last buffer 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Clock
 +
|-
 +
| colspan="2" | Clock pin used to clock the external buffer IC's 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Strobe
 +
|-
 +
| colspan="2" | Strobe pin used to control the master display state, strobed at high speed using PWM to set the brightness.  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Reset
 +
|-
 +
| colspan="2" | Reset pin used to clear all of the states in the external buffer IC's 
 +
|-
 +
| 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-15-icon.png]]
 +
| width="90%" | Row Spacing
 +
|-
 +
| colspan="2" | Simulation row spacing 
 +
|-
 +
| 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%" | 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  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Redraw LEDs
 +
|-
 +
| colspan="2" | Simulated LED redraw option, display will not be updated until the redraw is set to Yes. Automatically revers back to No after the refresh has been performed. 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:23, 20 January 2023

Author Matrix Ltd
Version 1.1
Category LEDs


LED Matrix (Serial) component

LED Matrix component designed to work using a single data and clock pin. Each LED on the display can be controlled in a chain by setting the data appropriatley and then generating the appropriate amount of clock pulses.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

Fc9-comp-macro.png StrobeHigh
Sets the strobe pin high. Strobing controls the LED brightness and does not apply to simulation. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png StrobeLow
Sets the strobe pin low. Strobing controls the LED brightness and does not apply to simulation. 
Fc9-void-icon.png - VOID Return


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-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 WriteColumn
Allows a single column of data to be inserted, Acts to shift the rest of the columns across by one. 
Fc9-u8-icon.png - BYTE Data
Data to display on the column of LEDs 
Fc9-u8-icon.png - BYTE Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png LED Type
Active high outputs a logic 1 to set the LED and logic 0 to clear the LED. Active low outputs a logic 0 to set the LED and logic 1 to clear the LED 
Fc9-type-14-icon.png Row Count
Number of LED rows 
Fc9-type-14-icon.png Column Count
Number of LED columns 
Fc9-type-14-icon.png LED Count
Total number of LEDs in the component 
Fc9-type-7-icon.png Flip Display
Allows the column and text data sent to the display to be flipped 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png Data In
Data In pin which is used to pass the input LED value 
Fc9-type-5-icon.png Data Out
Data Out Pin - Optional and used to collect the data as it leaves the last buffer 
Fc9-type-5-icon.png Clock
Clock pin used to clock the external buffer IC's 
Fc9-type-5-icon.png Strobe
Strobe pin used to control the master display state, strobed at high speed using PWM to set the brightness.  
Fc9-type-5-icon.png Reset
Reset pin used to clear all of the states in the external buffer IC's 
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-15-icon.png Row Spacing
Simulation row spacing 
Fc9-type-15-icon.png Column Spacing
Simulation column spacing 
Fc9-type-15-icon.png Width
Simulation LED width 
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  
Fc9-type-7-icon.png Redraw LEDs
Simulated LED redraw option, display will not be updated until the redraw is set to Yes. Automatically revers back to No after the refresh has been performed. 

==Macro reference==

Fc9-comp-macro.png StrobeHigh
Sets the strobe pin high. Strobing controls the LED brightness and does not apply to simulation. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png StrobeLow
Sets the strobe pin low. Strobing controls the LED brightness and does not apply to simulation. 
Fc9-void-icon.png - VOID Return


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-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 WriteColumn
Allows a single column of data to be inserted, Acts to shift the rest of the columns across by one. 
Fc9-u8-icon.png - BYTE Data
Data to display on the column of LEDs 
Fc9-u8-icon.png - BYTE Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png LED Type
Active high outputs a logic 1 to set the LED and logic 0 to clear the LED. Active low outputs a logic 0 to set the LED and logic 1 to clear the LED 
Fc9-type-14-icon.png Row Count
Number of LED rows 
Fc9-type-14-icon.png Column Count
Number of LED columns 
Fc9-type-14-icon.png LED Count
Total number of LEDs in the component 
Fc9-type-7-icon.png Flip Display
Allows the column and text data sent to the display to be flipped 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png Data In
Data In pin which is used to pass the input LED value 
Fc9-type-5-icon.png Data Out
Data Out Pin - Optional and used to collect the data as it leaves the last buffer 
Fc9-type-5-icon.png Clock
Clock pin used to clock the external buffer IC's 
Fc9-type-5-icon.png Strobe
Strobe pin used to control the master display state, strobed at high speed using PWM to set the brightness.  
Fc9-type-5-icon.png Reset
Reset pin used to clear all of the states in the external buffer IC's 
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-15-icon.png Row Spacing
Simulation row spacing 
Fc9-type-15-icon.png Column Spacing
Simulation column spacing 
Fc9-type-15-icon.png Width
Simulation LED width 
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  
Fc9-type-7-icon.png Redraw LEDs
Simulated LED redraw option, display will not be updated until the redraw is set to Yes. Automatically revers back to No after the refresh has been performed. 

==Macro reference==

Fc9-comp-macro.png StrobeHigh
Sets the strobe pin high. Strobing controls the LED brightness and does not apply to simulation. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png StrobeLow
Sets the strobe pin low. Strobing controls the LED brightness and does not apply to simulation. 
Fc9-void-icon.png - VOID Return


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-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 WriteColumn
Allows a single column of data to be inserted, Acts to shift the rest of the columns across by one. 
Fc9-u8-icon.png - BYTE Data
Data to display on the column of LEDs 
Fc9-u8-icon.png - BYTE Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png LED Type
Active high outputs a logic 1 to set the LED and logic 0 to clear the LED. Active low outputs a logic 0 to set the LED and logic 1 to clear the LED 
Fc9-type-14-icon.png Row Count
Number of LED rows 
Fc9-type-14-icon.png Column Count
Number of LED columns 
Fc9-type-14-icon.png LED Count
Total number of LEDs in the component 
Fc9-type-7-icon.png Flip Display
Allows the column and text data sent to the display to be flipped 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png Data In
Data In pin which is used to pass the input LED value 
Fc9-type-5-icon.png Data Out
Data Out Pin - Optional and used to collect the data as it leaves the last buffer 
Fc9-type-5-icon.png Clock
Clock pin used to clock the external buffer IC's 
Fc9-type-5-icon.png Strobe
Strobe pin used to control the master display state, strobed at high speed using PWM to set the brightness.  
Fc9-type-5-icon.png Reset
Reset pin used to clear all of the states in the external buffer IC's 
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-15-icon.png Row Spacing
Simulation row spacing 
Fc9-type-15-icon.png Column Spacing
Simulation column spacing 
Fc9-type-15-icon.png Width
Simulation LED width 
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  
Fc9-type-7-icon.png Redraw LEDs
Simulated LED redraw option, display will not be updated until the redraw is set to Yes. Automatically revers back to No after the refresh has been performed. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_LED_Matrix_(Serial)_(LEDs)&oldid=33478"