Component: Console User Input (Runtime Tools)

From Flowcode Help
Revision as of 09:55, 27 January 2023 by Wiki bot (talk | contribs)
Jump to navigationJump to search
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

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


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
 

==Macro reference==

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


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
 

==Macro reference==

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


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
 

==Macro reference==

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


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
 

==Macro reference==

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


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