Difference between revisions of "Component: Injector (Loopback) ()"
From Flowcode Help
Jump to navigationJump to search| Line 20: | Line 20: | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 38: | Line 40: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 57: | Line 61: | ||
| − | == | + | ==Macro reference== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 14:11, 20 January 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 for the component source code: FC_Comp_Source_InjectorLoopback.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
InitialiseInjector |
| Sets up the injector ready to receive commands or send data | |
 - STRING
|
InjectorName |
| Name of the console that will be created | |
 - BYTE
|
Return |
|
|
RxByteCount |
| Returns the number of bytes currently sat in the receive buffer. | |
 - UINT
|
Return |
|
|
TxByte |
| Puts a byte onto the comms channel. | |
| - BYTE
|
DataByte |
 - VOID
|
Return |
|
|
RxByte |
| Attempt to receive a byte back from the injector 0 - 255 = Valid data 256 = RX timeout no data available | |
| - UINT
|
Return |
|
|
GetConsoleHandle |
| Gets the handle to the console allowing data displaying on the panel etc. | |
 - HANDLE
|
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. | |
