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

From Flowcode Help
Jump to navigationJump to search
 
(5 intermediate revisions by the same user not shown)
Line 37: Line 37:
  
  
−
''No detailed description exists yet for this component''
 
  
−
==Examples==
 
  
  
  
 +
''No detailed description exists yet for this component''
  
 +
==Examples==
  
  
Line 57: Line 57:
  
  
−
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}}
 
  
−
==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;" | '''DataAvailable'''
 
−
|-
 
−
| colspan="2" | Checks to see if there is any user data entered into the console tab. Returns 1 if data is available. 
 
−
|-
 
−
|-
 
−
| 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''
 
−
|}
 
  
  
−
{| 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 
 
−
|-
 
−
|-
 
−
| 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''
 
−
|}
 
  
  
  
 +
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.
  
−
==Property reference==
+
{{Fcfile|ConsoleDemo.fcfx|Console Demo}}
  
−
{| 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 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | New line encoding
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Console Tab Name
 
−
|-
 
−
| colspan="2" |  
 
−
|}==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;" | '''DataAvailable'''
 
−
|-
 
−
| colspan="2" | Checks to see if there is any user data entered into the console tab. Returns 1 if data is available. 
 
−
|-
 
−
|-
 
−
| 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''
 
−
|}
 
  
  
−
{| 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 
 
−
|-
 
−
|-
 
−
| 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''
 
−
|}
 
  
  
  
  
−
==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" | [[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 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | New line encoding
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Console Tab Name
 
−
|-
 
−
| colspan="2" |  
 
−
|}==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;" | '''DataAvailable'''
 
−
|-
 
−
| colspan="2" | Checks to see if there is any user data entered into the console tab. Returns 1 if data is available. 
 
−
|-
 
−
|-
 
−
| 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''
 
−
|}
 
  
 +
==Macro reference==
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
===DataAvailable===
−
|-
 
−
| 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 
 
−
|-
 
−
|-
 
−
| 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''
 
−
|}
 
−
 
 
−
 
 
−
 
 
−
 
 
−
==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" | [[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 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | New line encoding
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
−
| width="90%" | Console Tab Name
 
−
|-
 
−
| colspan="2" |  
 
−
|}==Macro reference==
 
−
 
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 232: Line 95:
  
  
 +
===GetByte===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 243: Line 107:
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
  
  

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"