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

Latest revision as of 14:22, 13 July 2026

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.

Console Demo

Macro reference

DataAvailable

	DataAvailable
Checks to see if there is any user data entered into the console tab. Returns 1 if data is available.
- BOOL	Return

GetByte

	GetByte
Attempt to collect a byte from the console 0 - 255 = Valid data 256 = No data available
- UINT	Return

Property reference

	Properties
	Data Mode
Sets the console data to interperete the data as ASCII or as Numbers 0-255
	New line encoding

	Console Tab Name

@@ Line 82: / Line 82: @@
 ===DataAvailable===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DataAvailable'''
+| width="90%" class="mtx-class-macrohead" | '''DataAvailable'''
 |-
 | colspan="2" | Checks to see if there is any user data entered into the console tab. Returns 1 if data is available.&nbsp;
@@ Line 96: / Line 96: @@
 ===GetByte===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByte'''
+| width="90%" class="mtx-class-macrohead" | '''GetByte'''
 |-
 | colspan="2" | Attempt to collect a byte from the console 0 - 255 = Valid data 256 = No data available&nbsp;
@@ Line 111: / Line 111: @@
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-

SteveT (talk | contribs)