Difference between revisions of "Component: Injector (Loopback) ()"
From Flowcode Help
Jump to navigationJump to search| Line 77: | Line 77: | ||
''<span style="color:red;">No additional examples</span>''  | ''<span style="color:red;">No additional examples</span>''  | ||
| + | |||
| + | |||
| Line 83: | Line 85: | ||
==Macro reference==  | ==Macro reference==  | ||
| + | ===InitialiseInjector===  | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"  | {| class="wikitable" style="width:60%; background-color:#FFFFFF;"  | ||
|-  | |-  | ||
| Line 101: | Line 104: | ||
| + | ===RxByteCount===  | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"  | {| class="wikitable" style="width:60%; background-color:#FFFFFF;"  | ||
|-  | |-  | ||
| Line 114: | Line 118: | ||
| + | ===TxByte===  | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"  | {| class="wikitable" style="width:60%; background-color:#FFFFFF;"  | ||
|-  | |-  | ||
| Line 132: | Line 137: | ||
| + | ===RxByte===  | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"  | {| class="wikitable" style="width:60%; background-color:#FFFFFF;"  | ||
|-  | |-  | ||
| Line 145: | Line 151: | ||
| + | ===GetConsoleHandle===  | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"  | {| class="wikitable" style="width:60%; background-color:#FFFFFF;"  | ||
|-  | |-  | ||
Revision as of 11:50, 3 February 2023
| Author | Matrix Ltd | 
| Version | 1.1 | 
| Category | 
Contents
Injector (Loopback) component
Comms data injector to replicate a basic loopback setup. The component will return any outgoing data back to the receiver.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_InjectorLoopback.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_InjectorLoopback.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
InitialiseInjector
| InitialiseInjector | |
| Sets up the injector ready to receive commands or send data | |
| InjectorName | |
| Name of the console that will be created | |
| Return | |
RxByteCount
| RxByteCount | |
| Returns the number of bytes currently sat in the receive buffer. | |
| Return | |
TxByte
| TxByte | |
| Puts a byte onto the comms channel. | |
| DataByte | |
| Return | |
RxByte
| RxByte | |
| Attempt to receive a byte back from the injector 0 - 255 = Valid data 256 = RX timeout no data available | |
| Return | |
GetConsoleHandle
| GetConsoleHandle | |
| Gets the handle to the console allowing data displaying on the panel etc. | |
| Return | |
Property reference
| Properties | |
| Loopback Injector Settings | |
| Circular Buffer Size | |
| Amount of room in the circular buffers before running out of memory. e.g. max command that can be recorded. | |