Difference between revisions of "Component: LED (BL0167) (E-blocks 2)"

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.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| E-blocks 2
 
| E-blocks 2
 
|}
 
|}
  
  
 +
==LED component==
 +
LED component to drive the E-blocks 2 BL0167 LED board. Provides eight individually addressable LEDs.
  
−
==[[File:Component Icon 103aab27_2ea3_483c_9710_fc3c495288a7.png|Image]] LED (BL0167) component==
+
==Component Source Code==
−
LED component to drive the E-blocks 2 BL0167 LED board.
 
−
Provides eight individually addressable LEDs.
 
  
−
==Examples==
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBlocks2_LED_BL0167.fcfx FC_Comp_Source_EBlocks2_LED_BL0167.fcfx]
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBlocks2_LED_BL0167.fcfx FC_Comp_Source_EBlocks2_LED_BL0167.fcfx]
  
−
==Downloadable macro reference==
+
==Detailed description==
  
−
===<span style="font-weight: normal;"><u><tt>BarGraph</tt></u></span>===
 
−
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. Range 0-8
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>LEDOn</tt></u></span>===
 
−
Turns on the selected LED leaving the other LEDs as was.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Index''
 
−
::LED to switch on. Range: 0-7
 
  
 +
''No detailed description exists yet for this component''
  
−
'''Return value'''
+
==Examples==
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>AllOn</tt></u></span>===
 
−
Switches On All LEDs.
 
  
−
'''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>===
 
−
Turns off the selected LED leaving the other LEDs as was.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Index''
+
''<span style="color:red;">No additional examples</span>''
−
::LED to switch off. Range: 0-7
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>PointGraph</tt></u></span>===
 
−
Turns on the Indexed LED and turns all others off.
 
  
−
Does nothing if the index is out of range.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Index''
 
−
::The LED to light. Range: 0-7
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
 +
==Macro reference==
  
−
===<span style="font-weight: normal;"><u><tt>WriteValue</tt></u></span>===
+
===AllOff===
−
Write a number which is presented on the LEDs in binary.
+
{| 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" | Switches Off All LEDs.&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''
 +
|}
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Value''
+
===AllOn===
−
::Value to write to the LEDs. Range: 0-255
+
{| 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" | Switches On All LEDs.&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''
 +
|}
  
  
−
'''Return value'''
+
===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. Range 0-8&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 call does not return a value''
 
  
 +
===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" | Turns off the selected LED leaving the other LEDs as was.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | LED to switch off. Range: 0-7&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><tt>AllOff</tt></u></span>===
 
−
Switches Off All LEDs.
 
  
−
'''Parameters'''
+
===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" | Turns on the selected LED leaving the other LEDs as was.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | LED to switch on. Range: 0-7&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 macro has no parameters''
 
  
 +
===PointGraph===
 +
{| 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 light. Range: 0-7&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''
 +
|}
  
−
'''Return value'''
 
−
 
−
:''This call does not return a value''
 
  
−
 
+
===WriteValue===
−
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
==Simulation macro reference==
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
''This component does not contain any simulation macros''
+
| 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" | Value to write to the LEDs. Range: 0-255&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==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Output Mode</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''OutputMode''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
 
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Port</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Output Mode
−
This property is of type ''Digital port byte'' and can be referenced with the variable name ''Port''.
+
|-
−
 
+
| colspan="2" | &nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
 +
| width="10%" align="center" | [[File:Fc9-type-19-icon.png]]
 +
| width="90%" | Port
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Colour
 +
|-
 +
| colspan="2" | &nbsp;
 +
|}

Latest revision as of 13:10, 7 February 2023

Author Matrix TSL
Version 1.0
Category E-blocks 2


LED component

LED component to drive the E-blocks 2 BL0167 LED board. Provides eight individually addressable LEDs.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

AllOff

Fc9-comp-macro.png AllOff
Switches Off All LEDs. 
Fc9-void-icon.png - VOID Return


AllOn

Fc9-comp-macro.png AllOn
Switches On All LEDs. 
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. Range 0-8 
Fc9-void-icon.png - VOID Return


LEDOff

Fc9-comp-macro.png LEDOff
Turns off the selected LED leaving the other LEDs as was. 
Fc9-u8-icon.png - BYTE Index
LED to switch off. Range: 0-7 
Fc9-void-icon.png - VOID Return


LEDOn

Fc9-comp-macro.png LEDOn
Turns on the selected LED leaving the other LEDs as was. 
Fc9-u8-icon.png - BYTE Index
LED to switch on. Range: 0-7 
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 light. Range: 0-7 
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
Value to write to the LEDs. Range: 0-255 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Output Mode
 
Fc9-type-19-icon.png Port
 
Fc9-type-16-icon.png Colour
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_LED_(BL0167)_(E-blocks_2)&oldid=37955"