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

Revision as of 13:06, 7 January 2022

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 Pack

FREE

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

Downloadable macro reference

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

	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

	Connections
	Simulations

@@ Line 1: / Line 1: @@
+{| style="width:50%"
-{| width="50%"
 |-
-| width="20%" style="color: gray;" | Author
+| width="20%" style="color:gray;" | Author
 | 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
 |}
+==Console User Input component==
-==[[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.
-==Examples==
+==Component Pack==
-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.
+FREE
-{{Fcfile|ConsoleDemo.fcfx|Console Demo}}
+==Detailed description==
-==Downloadable macro reference==
+''No detailed description exists yet for this component''
-''This component does not contain any downloadable macros''
+==Examples==
-==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.
+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.
-'''Parameters'''
+{{Fcfile|ConsoleDemo.fcfx|Console Demo}}
-:''This macro has no parameters''
+==Downloadable 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.&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''
+|}
-'''Return value'''
-:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-===<span style="font-weight: normal;"><u><tt>GetByte</tt></u></span>===
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByte'''
-Attempt to collect a byte from the console
+|-
+| colspan="2" | Attempt to collect a byte from the console 0 - 255 = Valid data 256 = No data available&nbsp;
-- 255 = Valid data
+|-
+|-
-= 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''
-'''Parameters'''
+|}
-:''This macro has no parameters''
-'''Return value'''
-:[[Variable Types|UINT]]
@@ Line 65: / Line 62: @@
 ==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''.
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
-Sets the console data to interperete the data as ASCII or as Numbers 0-255
+| 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>New line encoding</u></span>
+|-
+|-
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''NewLineEnc''.
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Data Mode
-''<span style="color:red;">No additional information</span>''
+|-
+| 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]]
-<span style="font-weight: normal;"><u>Console Tab Name</u></span>
+| width="90%" | New line encoding
+|-
-This property is of type ''Line of text'' and can be referenced with the variable name ''label''.
+| colspan="2" | &nbsp;
+|-
-''<span style="color:red;">No additional information</span>''
+| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
+| width="90%" | Console Tab Name
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
+|-
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
+|-
+|}

Wiki bot (talk | contribs)