Component: Injector (Loopback) (): Difference between revisions
No edit summary |
No edit summary |
||
| Line 15: | Line 15: | ||
Comms data injector to replicate a basic loopback setup. The component will return any outgoing data back to the receiver. | Comms data injector to replicate a basic loopback setup. The component will return any outgoing data back to the receiver. | ||
==Component | ==Component Source Code== | ||
Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_InjectorLoopback.fcfx FC_Comp_Source_InjectorLoopback.fcfx] | |||
==Detailed description== | ==Detailed description== | ||
| Line 34: | Line 36: | ||
==Examples== | ==Examples== | ||
| Line 134: | Line 138: | ||
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
|- | |||
|- | |||
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Loopback Injector Settings | |||
|- | |- | ||
|- | |- | ||
| Line 140: | Line 148: | ||
|- | |- | ||
| colspan="2" | Amount of room in the circular buffers before running out of memory. e.g. max command that can be recorded. | | colspan="2" | Amount of room in the circular buffers before running out of memory. e.g. max command that can be recorded. | ||
|} | |} | ||
Revision as of 17:47, 9 November 2022
| Author | Matrix Ltd |
| Version | 1.1 |
| Category |
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
Downloadable 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. | |