Difference between revisions of "Component: Console User Input (Runtime Tools)"

From Flowcode Help
Jump to navigationJump to search
 
(15 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 Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| 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
 
| Runtime Tools
 
| Runtime Tools
 
|}
 
|}
 +
 +
 +
==Console User Input component==
 +
Allows data to be input via a console tab in raw ASCII form or as numeric byte data 0-255.
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ConsoleRead.fcfx FC_Comp_Source_ConsoleRead.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ConsoleRead.fcfx FC_Comp_Source_ConsoleRead.fcfx]
 +
 +
==Detailed description==
 +
  
  
  
−
==[[File:Component Icon 3bf29e52_ebb4_4528_8d19_b2860c8ab80c.png|Image]] Console User Input component==
+
 
−
Allows data to be input via a console tab in raw ASCII form or as numeric byte data 0-255.
+
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
''No detailed description exists yet for this component''
  
 
==Examples==
 
==Examples==
  
−
A simple example showing how to pull user inputted data from the console tab and passing it to a COM port component byte by byte.
 
  
−
[fcfile:ConsoleDemo.fcfx]
 
  
−
==Downloadable macro reference==
 
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>DataAvailable</tt></u></span>===
 
−
Checks to see if there is any user data entered into the console tab.
 
  
−
Returns 1 if data is available.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
 
  
  
−
===<span style="font-weight: normal;"><u><tt>GetByte</tt></u></span>===
 
−
Attempt to collect a byte from the console
 
  
−
0 - 255 = Valid data
 
  
−
256 = No data available
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|UINT]]
+
A simple example showing how to pull user inputted data from the console tab and passing it to a COM port component byte by byte.
 +
 
 +
{{Fcfile|ConsoleDemo.fcfx|Console Demo}}
 +
 
  
  
  
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Data Mode</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DataMode''.
 
  
−
Sets the console data to interperete the data as ASCII or as Numbers 0-255
 
  
−
<span style="font-weight: normal;"><u>New line encoding</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''NewLineEnc''.
 
  
−
''<span style="color:red;">No additional information</span>''
 
  
 +
==Macro reference==
  
 +
===DataAvailable===
 +
{| 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;" | '''DataAvailable'''
 +
|-
 +
| colspan="2" | Checks to see if there is any user data entered into the console tab. Returns 1 if data is available.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
===GetByte===
 +
{| 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;" | '''GetByte'''
 +
|-
 +
| colspan="2" | Attempt to collect a byte from the console 0 - 255 = Valid data 256 = No data available&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
<span style="font-weight: normal;"><u>Console Tab Name</u></span>
 
  
−
This property is of type ''Line of text'' and can be referenced with the variable name ''label''.
+
==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" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Data Mode
 +
|-
 +
| colspan="2" | Sets the console data to interperete the data as ASCII or as Numbers 0-255&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | New line encoding
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Console Tab Name
 +
|-
 +
| colspan="2" | &nbsp;
 +
|}

Latest revision as of 13:09, 7 February 2023

Author Matrix Ltd
Version 1.0
Category Runtime Tools


Console User Input component

Allows data to be input via a console tab in raw ASCII form or as numeric byte data 0-255.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

A simple example showing how to pull user inputted data from the console tab and passing it to a COM port component byte by byte.

FC6 Icon.png Console Demo






Macro reference

DataAvailable

Fc9-comp-macro.png DataAvailable
Checks to see if there is any user data entered into the console tab. Returns 1 if data is available. 
Fc9-bool-icon.png - BOOL Return


GetByte

Fc9-comp-macro.png GetByte
Attempt to collect a byte from the console 0 - 255 = Valid data 256 = No data available 
Fc9-u16-icon.png - UINT Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Data Mode
Sets the console data to interperete the data as ASCII or as Numbers 0-255 
Fc9-type-16-icon.png New line encoding
 
Fc9-type-10-icon.png Console Tab Name
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Console_User_Input_(Runtime_Tools)&oldid=37847"