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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.4 (Release)
+
| 1.4
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Indicators
 
| Indicators
 
|}
 
|}
  
 +
 +
==Simulation LED Template component==
 +
Base for creating simulation 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 intensity of the on color.
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_LED_Sim_Base.fcfx FC_Comp_Source_LED_Sim_Base.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LED_Sim_Base.fcfx FC_Comp_Source_LED_Sim_Base.fcfx]
 +
 +
==Detailed description==
  
  
−
==[[File:Component Icon 1bdd06a6_fc18_4990_917d_004c430f855e.png|Image]] Simulation LED Template component==
 
−
Base for creating simulation 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 intensity of the on color.
 
  
−
This component can be used as a base to create ''child'' components
 
  
−
The following components all inherit the traits of Simulation LED Template:
 
  
−
{| class="wikitable" width="50%"
 
−
|+|-
 
−
|[[File:Component Icon caf757fd_8813_421e_bf75_1a365b20dbc5.png|Image]] Simulation LED (SMD)
 
−
|A simple LED suitable for simulation that does not require a pin connection
 
−
|-
 
−
|[[File:Component Icon 3442e7cf_5482_48ce_886f_f151c73b27ef.png|Image]] Simulation LED (LES, Panel)
 
−
|Panel lamp for a LES bulb.
 
−
Colour can be changed in component properties.
 
−
|-
 
−
|[[File:Component Icon 83bd894c_8f2c_4370_95c3_cae107ccc64d.png|Image]] Simulation LED (3mm, PCB)
 
−
|An industry standard 3mm diameter LED.
 
−
Any color may be chosen, and the leads trimmed to length.
 
−
|-
 
−
|[[File:Component Icon ca4f7f42_4697_4d24_95b8_9cc3a9ebdd83.png|Image]] Simulation LED (5mm, PCB)
 
−
|An industry standard 5mm diameter LED.
 
−
Any color may be chosen, and the leads trimmed to length.
 
−
|}
 
  
−
==Examples==
 
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>TurnOn</tt></u></span>===
 
−
Turn the LED off.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
 +
''No detailed description exists yet for this component''
  
−
===<span style="font-weight: normal;"><u><tt>TurnOff</tt></u></span>===
+
==Examples==
−
Turn the LED on.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
 
  
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Target Object</u></span>
 
  
−
This property is of type ''Panel object'' and can be referenced with the variable name ''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.
 
  
−
<span style="font-weight: normal;"><u>Label</u></span>
+
''<span style="color:red;">No additional examples</span>''
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''component_label1::show_label''.
 
  
−
Decide what label to show...
 
  
−
None - no labels are displayed
 
  
−
Name - shows the component's name
 
  
−
Property - shows a property value of the component (a field for the property name will appear below)
 
  
−
<span style="font-weight: normal;"><u>On Color</u></span>
 
  
−
This property is of type ''Color picker'' and can be referenced with the variable name ''on_color''.
 
  
−
The color of the LED when it is turned on.
 
  
−
<span style="font-weight: normal;"><u>Off Color</u></span>
 
  
−
This property is of type ''Color picker'' and can be referenced with the variable name ''off_color''.
 
  
−
The color of the LED when it is turned off.
+
==Macro reference==
  
−
<span style="font-weight: normal;"><u>Auto Off Color</u></span>
+
===TurnOff===
 +
{| 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.&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 ''True or false'' and can be referenced with the variable name ''auto_off''.
 
  
−
When this is selected, the off color is automatically set to a reduced intensity version of the on color.
+
===TurnOn===
 +
{| 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 off.&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>Startup State</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''StartupState''.
+
==Property reference==
  
−
Default state of the indicator when loading the project or starting the simulation runtime.
+
{| 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;" | 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-16-icon.png]]
 +
| width="90%" | Label
 +
|-
 +
| colspan="2" | Decide what label to show... None - no labels are displayed Name - shows the component's name Property - shows a property value of the component (a field for the property name will appear below)&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 reduced intensity version of the on color.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Startup State
 +
|-
 +
| colspan="2" | Default state of the indicator when loading the project or starting the simulation runtime.&nbsp;
 +
|}

Latest revision as of 13:11, 7 February 2023

Author Matrix Ltd
Version 1.4
Category Indicators


Simulation LED Template component

Base for creating simulation 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 intensity of the on color.

Component Source Code

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

Please click here to view the component source code (Beta): FC_Comp_Source_LED_Sim_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. 
Fc9-void-icon.png - VOID Return


TurnOn

Fc9-comp-macro.png TurnOn
Turn the LED off. 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
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-16-icon.png Label
Decide what label to show... None - no labels are displayed Name - shows the component's name Property - shows a property value of the component (a field for the property name will appear below) 
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 reduced intensity version of the on color. 
Fc9-type-16-icon.png Startup State
Default state of the indicator when loading the project or starting the simulation runtime. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Simulation_LED_Template_(Indicators)&oldid=38165"