Difference between revisions of "Component: LED (EB004) (E-blocks 1)"

From Flowcode Help
Jump to navigationJump to search
(XML import - Pre 8.0 release)
 
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.1 (Release)
+
| 1.1
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| E-blocks 1
 
| E-blocks 1
 
|}
 
|}
  
  
−
 
+
==LED  component==
−
==[[File:Component Icon 82c2f7d0_c6ed_4c6e_8ab8_7958b490dc99.png|Image]] LED  (EB004) component==
 
 
An LED matrix made up of standard PCB mount 5mm LEDs.
 
An LED matrix made up of standard PCB mount 5mm LEDs.
  
−
==Examples==
+
==Component Source Code==
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_LED_Array_EB004.fcfx FC_Comp_Source_LED_Array_EB004.fcfx]
  
−
==Downloadable macro reference==
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LED_Array_EB004.fcfx FC_Comp_Source_LED_Array_EB004.fcfx]
  
−
===<span style="font-weight: normal;"><u><tt>BarGraph</tt></u></span>===
+
==Detailed description==
−
Turns on the first N elements of the array - for generating bar graph metes etc.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Length''
 
−
::How many items to light up.
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>LEDOn</tt></u></span>===
 
−
Turn on the selected LED.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Index''
 
−
::Index of the LED to turn on.
 
  
  
−
'''Return value'''
+
''No detailed description exists yet for this component''
  
−
:''This call does not return a value''
+
==Examples==
  
  
−
===<span style="font-weight: normal;"><u><tt>AllOn</tt></u></span>===
 
−
Turns on all elements
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>LEDOff</tt></u></span>===
 
−
Turn off the selected led.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Index''
 
−
::Index of the LED to turn on.
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
 +
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.
  
−
===<span style="font-weight: normal;"><u><tt>PointGraph</tt></u></span>===
+
[[File:LED_Active.jpg]]
−
Turns on the Indexed LED and turns all others off.
 
  
−
Does nothing if the index is out of range.
 
  
−
'''Parameters'''
+
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.
  
−
:[[Variable Types|BYTE]] ''Index''
 
−
::The LED to show.
 
  
 +
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.
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
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.
  
  
−
===<span style="font-weight: normal;"><u><tt>WriteValue</tt></u></span>===
+
This LED Calculator tool is a good resource for calculating the correct LED series protection resistor.
−
Write a number which is presented on the LEDs in binary.
 
  
−
'''Parameters'''
+
[https://www.digikey.co.uk/en/resources/conversion-calculators/conversion-calculator-led-series-resistor  LED Resistor Calculator Tool]
  
−
:[[Variable Types|BYTE]] ''Value''
 
−
::Provide a value to be written to the LEDs in binary
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>AllOff</tt></u></span>===
 
−
Turns off all elements
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
==Macro reference==
  
 +
===AllOff===
 +
{| 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;" | '''AllOff'''
 +
|-
 +
| colspan="2" | Turns off all elements&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''
 +
|}
 +
 +
 +
===AllOn===
 +
{| 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;" | '''AllOn'''
 +
|-
 +
| colspan="2" | Turns on all elements&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''
 +
|}
  
  
−
==Simulation macro reference==
+
===BarGraph===
 +
{| 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;" | '''BarGraph'''
 +
|-
 +
| colspan="2" | Turns on the first N elements of the array - for generating bar graph metes etc.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Length
 +
|-
 +
| colspan="2" | How many items to light up.&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''
 +
|}
 +
 
 +
 
 +
===LEDOff===
 +
{| 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;" | '''LEDOff'''
 +
|-
 +
| colspan="2" | Turn off the selected led.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | Index of the LED to turn on.&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''
 +
|}
 +
 
  
−
''This component does not contain any simulation macros''
+
===LEDOn===
 +
{| 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;" | '''LEDOn'''
 +
|-
 +
| colspan="2" | Turn on the selected LED.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | Index of the LED to turn on.&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''
 +
|}
  
  
−
==Property reference==
+
===PointGraph===
−
<span style="font-weight: normal;"><u>Output Mode</u></span>
+
{| 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;" | '''PointGraph'''
 +
|-
 +
| colspan="2" | Turns on the Indexed LED and turns all others off. Does nothing if the index is out of range.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | The LED to show.&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''
 +
|}
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''port''.
 
  
−
Choose a single port for all LEDs, or to allocate them to arbitrary pins.
+
===WriteValue===
 +
{| 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;" | '''WriteValue'''
 +
|-
 +
| colspan="2" | Write a number which is presented on the LEDs in binary.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | Provide a value to be written to the LEDs in binary&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''
 +
|}
  
−
<span style="font-weight: normal;"><u>Port</u></span>
 
  
−
This property is of type ''Digital port byte'' and can be referenced with the variable name ''PortByte''.
+
==Property reference==
  
−
''<span style="color:red;">No additional information</span>''
+
{| 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" 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%" | Output Mode
 +
|-
 +
| colspan="2" | Choose a single port for all LEDs, or to allocate them to arbitrary pins.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-19-icon.png]]
 +
| width="90%" | Port
 +
|-
 +
| colspan="2" | &nbsp;
 +
|}

Latest revision as of 13:11, 7 February 2023

Author Matrix TSL
Version 1.1
Category E-blocks 1


LED component

An LED matrix made up of standard PCB mount 5mm LEDs.

Component Source Code

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

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

AllOff

Fc9-comp-macro.png AllOff
Turns off all elements 
Fc9-void-icon.png - VOID Return


AllOn

Fc9-comp-macro.png AllOn
Turns on all elements 
Fc9-void-icon.png - VOID Return


BarGraph

Fc9-comp-macro.png BarGraph
Turns on the first N elements of the array - for generating bar graph metes etc. 
Fc9-u8-icon.png - BYTE Length
How many items to light up. 
Fc9-void-icon.png - VOID Return


LEDOff

Fc9-comp-macro.png LEDOff
Turn off the selected led. 
Fc9-u8-icon.png - BYTE Index
Index of the LED to turn on. 
Fc9-void-icon.png - VOID Return


LEDOn

Fc9-comp-macro.png LEDOn
Turn on the selected LED. 
Fc9-u8-icon.png - BYTE Index
Index of the LED to turn on. 
Fc9-void-icon.png - VOID Return


PointGraph

Fc9-comp-macro.png PointGraph
Turns on the Indexed LED and turns all others off. Does nothing if the index is out of range. 
Fc9-u8-icon.png - BYTE Index
The LED to show. 
Fc9-void-icon.png - VOID Return


WriteValue

Fc9-comp-macro.png WriteValue
Write a number which is presented on the LEDs in binary. 
Fc9-u8-icon.png - BYTE Value
Provide a value to be written to the LEDs in binary 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Output Mode
Choose a single port for all LEDs, or to allocate them to arbitrary pins. 
Fc9-type-19-icon.png Port
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_LED_(EB004)_(E-blocks_1)&oldid=38146"