Difference between revisions of "Component: Console User Input (Runtime Tools)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here | + | 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== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 32: | Line 34: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 48: | Line 52: | ||
==Macro reference== | ==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;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:13, 20 January 2023
| Author | Matrix Ltd |
| Version | 1.0 |
| 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.
Component Source Code
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.
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 |
==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 |
