Component: Injector (Loopback) (): Difference between revisions

Latest revision as of 14:36, 13 July 2026

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 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

GetConsoleHandle

	GetConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc.
- HANDLE	Return

InitialiseInjector

	InitialiseInjector
Sets up the injector ready to receive commands or send data
- STRING	InjectorName
Name of the console that will be created
- BYTE	Return

RxByte

	RxByte
Attempt to receive a byte back from the injector 0 - 255 = Valid data 256 = RX timeout no data available
- UINT	Return

RxByteCount

	RxByteCount
Returns the number of bytes currently sat in the receive buffer.
- UINT	Return

TxByte

	TxByte
Puts a byte onto the comms channel.
- BYTE	DataByte

- VOID	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.

@@ Line 15: / Line 15: @@
 Comms data injector to replicate a basic loopback setup.  The component will return any outgoing data back to the receiver.
-==Component Pack==
+==Component Source Code==
-COMMSA
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_InjectorLoopback.fcfx FC_Comp_Source_InjectorLoopback.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_InjectorLoopback.fcfx FC_Comp_Source_InjectorLoopback.fcfx]
 ==Detailed description==
@@ Line 34: / Line 50: @@
 ==Examples==
@@ Line 49: / Line 79: @@
-==Downloadable macro reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+==Macro reference==
+===GetConsoleHandle===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''InitialiseInjector'''
+| width="90%" class="mtx-class-macrohead" | '''GetConsoleHandle'''
+|-
+| colspan="2" | Gets the handle to the console allowing data displaying on the panel etc.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===InitialiseInjector===
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''InitialiseInjector'''
 |-
 | colspan="2" | Sets up the injector ready to receive commands or send data&nbsp;
@@ Line 69: / Line 124: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===RxByte===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxByteCount'''
+| width="90%" class="mtx-class-macrohead" | '''RxByte'''
 |-
-| colspan="2" | Returns the number of bytes currently sat in the receive buffer.&nbsp;
+| colspan="2" | Attempt to receive a byte back from the injector 0 - 255 = Valid data 256 = RX timeout no data available&nbsp;
 |-
 |-
@@ Line 82: / Line 138: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===RxByteCount===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TxByte'''
+| width="90%" class="mtx-class-macrohead" | '''RxByteCount'''
 |-
-| colspan="2" | Puts a byte onto the comms channel.&nbsp;
+| colspan="2" | Returns the number of bytes currently sat in the receive buffer.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | DataByte
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===TxByte===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RxByte'''
+| width="90%" class="mtx-class-macrohead" | '''TxByte'''
 |-
-| colspan="2" | Attempt to receive a byte back from the injector 0 - 255 = Valid data 256 = RX timeout no data available&nbsp;
+| colspan="2" | Puts a byte onto the comms channel.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | DataByte
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| colspan="2" | &nbsp;
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetConsoleHandle'''
 |-
-| colspan="2" | Gets the handle to the console allowing data displaying on the panel etc.&nbsp;
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
+|-
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-propfolder" | Loopback Injector Settings
 |-
 |-
@@ Line 140: / Line 187: @@
 |-
 | colspan="2" | Amount of room in the circular buffers before running out of memory. e.g. max command that can be recorded.&nbsp;
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
-|-
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
-|-
 |}

SteveT (talk | contribs)