Difference between revisions of "Component: Console User Input (Runtime Tools)"
(XML import) |
|||
| Line 19: | Line 19: | ||
==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== | ==Downloadable macro reference== | ||
Revision as of 13:04, 7 January 2022
| Author | Matrix Ltd |
| Version | 1.0 (Release) |
| Category | Runtime Tools |
Contents
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
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
DataAvailable
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
- BOOL : Returns true if the operation is a success, else false
GetByte
Attempt to collect a byte from the console
0 - 255 = Valid data
256 = No data available
Parameters
- This macro has no parameters
Return value
Property reference
Data Mode
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
New line encoding
This property is of type Fixed list of ints and can be referenced with the variable name NewLineEnc.
No additional information
Console Tab Name
This property is of type Line of text and can be referenced with the variable name label.
No additional information
