Difference between revisions of "Component: LED Template (LED)"

From Flowcode Help
Jump to navigationJump to search
 
(6 intermediate revisions by the same user not shown)
Line 17: Line 17:
 
==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_Base.fcfx FC_Comp_Source_LED_Base.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_LED_Base.fcfx FC_Comp_Source_LED_Base.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LED_Base.fcfx FC_Comp_Source_LED_Base.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LED_Base.fcfx FC_Comp_Source_LED_Base.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
  
  
Line 47: Line 51:
  
  
−
''<span style="color:red;">No additional examples</span>''
 
  
−
==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;" | '''TurnOn'''
 
−
|-
 
−
| colspan="2" | Turn the LED on. Active high - The pin is configured to output high. Active low - The pin is configured to output low.&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;"
+
''<span style="color:red;">No additional examples</span>''
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TurnOff'''
 
−
|-
 
−
| colspan="2" | Turn the LED off. Active high - The pin is configured to output low. Active low - The pin is configured to output high.&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==
 
  
−
{| 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-5-icon.png]]
 
−
| width="90%" | Pin
 
−
|-
 
−
| colspan="2" | Chip pin to connect the LED to.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Polarity
 
−
|-
 
−
| colspan="2" | Active High:  Pin true -> On color,  Pin false -> Off color Active Low:  Pin true -> Off color,  Pin false -> On color&nbsp;
 
−
|-
 
−
| 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-17-icon.png]]
 
−
| width="90%" | Target Object
 
−
|-
 
−
| colspan="2" | Set a target object to be the illuminating part of the LED. To change the colour of multiple objects, group them first, then target the group.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 
−
| width="90%" | On Color
 
−
|-
 
−
| colspan="2" | The color of the LED when it is turned on.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 
−
| width="90%" | Off Color
 
−
|-
 
−
| colspan="2" | The color of the LED when it is turned off.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Auto Off Color
 
−
|-
 
−
| colspan="2" | When this is selected, the off color is automatically set to a darker version of the on color.&nbsp;
 
−
|}==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;" | '''TurnOn'''
 
−
|-
 
−
| colspan="2" | Turn the LED on. Active high - The pin is configured to output high. Active low - The pin is configured to output low.&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;" | '''TurnOff'''
 
−
|-
 
−
| colspan="2" | Turn the LED off. Active high - The pin is configured to output low. Active low - The pin is configured to output high.&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==
 
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
==Macro reference==
−
|-
 
−
| 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-5-icon.png]]
 
−
| width="90%" | Pin
 
−
|-
 
−
| colspan="2" | Chip pin to connect the LED to.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Polarity
 
−
|-
 
−
| colspan="2" | Active High:  Pin true -> On color,  Pin false -> Off color Active Low:  Pin true -> Off color,  Pin false -> On color&nbsp;
 
−
|-
 
−
| 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-17-icon.png]]
 
−
| width="90%" | Target Object
 
−
|-
 
−
| colspan="2" | Set a target object to be the illuminating part of the LED. To change the colour of multiple objects, group them first, then target the group.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 
−
| width="90%" | On Color
 
−
|-
 
−
| colspan="2" | The color of the LED when it is turned on.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 
−
| width="90%" | Off Color
 
−
|-
 
−
| colspan="2" | The color of the LED when it is turned off.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Auto Off Color
 
−
|-
 
−
| colspan="2" | When this is selected, the off color is automatically set to a darker version of the on color.&nbsp;
 
−
|}==Macro reference==
 
  
 +
===TurnOff===
 
{| 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;" | '''TurnOn'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TurnOff'''
 
|-
 
|-
−
| colspan="2" | Turn the LED on. Active high - The pin is configured to output high. Active low - The pin is configured to output low.&nbsp;
+
| colspan="2" | Turn the LED off. Active high - The pin is configured to output low. Active low - The pin is configured to output high.&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 214: Line 85:
  
  
 +
===TurnOn===
 
{| 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;" | '''TurnOff'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TurnOn'''
 
|-
 
|-
−
| colspan="2" | Turn the LED off. Active high - The pin is configured to output low. Active low - The pin is configured to output high.&nbsp;
+
| colspan="2" | Turn the LED on. Active high - The pin is configured to output high. Active low - The pin is configured to output low.&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 225: Line 97:
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
  
  

Latest revision as of 10:26, 20 October 2023

Author Matrix Ltd
Version 1.3
Category LED


LED Template component

Base for creating LEDs and other on/off visual indicators. Choose a 'Target Object' that will change colour when the pin changes; if multiple objects must change color, group them, and target the group. When 'Auto off color" is selected, changing the 'on color' will automatically choose an off color by reducing the on-color intensity.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

TurnOff

Fc9-comp-macro.png TurnOff
Turn the LED off. Active high - The pin is configured to output low. Active low - The pin is configured to output high. 
Fc9-void-icon.png - VOID Return


TurnOn

Fc9-comp-macro.png TurnOn
Turn the LED on. Active high - The pin is configured to output high. Active low - The pin is configured to output low. 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png Pin
Chip pin to connect the LED to. 
Fc9-type-16-icon.png Polarity
Active High: Pin true -> On color, Pin false -> Off color Active Low: Pin true -> Off color, Pin false -> On color 
Fc9-conn-icon.png Simulation
Fc9-type-17-icon.png Target Object
Set a target object to be the illuminating part of the LED. To change the colour of multiple objects, group them first, then target the group. 
Fc9-type-1-icon.png On Color
The color of the LED when it is turned on. 
Fc9-type-1-icon.png Off Color
The color of the LED when it is turned off. 
Fc9-type-7-icon.png Auto Off Color
When this is selected, the off color is automatically set to a darker version of the on color. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_LED_Template_(LED)&oldid=39623"