Difference between revisions of "Component: Injector (Human Interface) (Test Injectors)"

Revision as of 12:01, 3 February 2023

Author	Matrix Ltd
Version	1.0
Category	Test Injectors

Injector (Human Interface) component

Comms data injector to allow typed data values to be inserted into a component. Allows data to be input 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_temp/InjectorHI.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/InjectorHI.fcfx

Detailed description

No detailed description exists yet for this component

Examples

This example receives a character via the RS232 component and outputs it to the LCD, an injector has been added to allow you to type data into the console. Human Interface Injector Example The Console window has tabs for the human interface data injector allowing you to type in data that will be received by the component.

Again the RS232 console tabs reflect the data as it is sent and received.

LCD showing received data.

Macro reference

GetConsoleHandle

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

IOGetInputPin

	IOGetInputPin
Sets the selected digital pin to an input and reads the input state.
- BYTE	Pin
Range: 0-19
- BOOL	Return

IOSetOutputPin

	IOSetOutputPin
Sets the selected digital pin to an output and assigns the output state.
- BYTE	Pin
Range: 0-53
- BOOL	State
Range: 0-1
- VOID	Return

Initialise

	Initialise
Sets up the injector ready to receive commands or send data
- VOID	Return

UARTBaud

	UARTBaud

- BYTE	Channel

- BYTE	Rate

- VOID	Return

UARTCheckRX

	UARTCheckRX

- BYTE	Channel

- BYTE	Return

UARTInitialise

	UARTInitialise

- BYTE	Channel

- VOID	Return

UARTReceive

	UARTReceive

- BYTE	Channel

- BYTE	Return

UARTSend

	UARTSend

- BYTE	Channel

- BYTE	Data

- VOID	Return

Property reference

	Properties
	HI Injector Settings
	Buffer Size
Max number of bytes that can be stored in the components circular buffer
	Data Mode
Sets the console data to interperete the data as ASCII or as Numbers 0-255
	label

	Show Console

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_InjectorHI.fcfx FC_Comp_Source_InjectorHI.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/InjectorHI.fcfx FC_Comp_Source_temp/InjectorHI.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_InjectorHI.fcfx FC_Comp_Source_InjectorHI.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/InjectorHI.fcfx FC_Comp_Source_temp/InjectorHI.fcfx]
 ==Detailed description==
@@ Line 91: / Line 91: @@
 [[File:RS2324.jpg]]
@@ Line 98: / Line 100: @@
 ==Macro reference==
-===UARTBaud===
+===GetConsoleHandle===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTBaud'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetConsoleHandle'''
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Gets the handle to the console allowing data displaying on the panel etc.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
-| width="90%" | Channel
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Rate
-|-
-| 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''
 |}
@@ Line 141: / Line 133: @@
-===UARTCheckRX===
+===IOSetOutputPin===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTCheckRX'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IOSetOutputPin'''
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Sets the selected digital pin to an output and assigns the output state.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
+| width="90%" | Pin
+|-
+| colspan="2" | Range: 0-53&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | State
+|-
+| colspan="2" | Range: 0-1&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''
+|}
+===Initialise===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+|-
+| colspan="2" | Sets up the injector ready to receive commands or send data&nbsp;
 |-
-| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| 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''
 |}
-===UARTInitialise===
+===UARTBaud===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTInitialise'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTBaud'''
 |-
 | colspan="2" | &nbsp;
@@ Line 171: / Line 182: @@
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" | Channel
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Rate
 |-
 | colspan="2" | &nbsp;
@@ Line 179: / Line 195: @@
-===GetConsoleHandle===
+===UARTCheckRX===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetConsoleHandle'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTCheckRX'''
+|-
+| colspan="2" | &nbsp;
+|-
 |-
-| colspan="2" | Gets the handle to the console allowing data displaying on the panel etc.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Channel
 |-
+| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===UARTReceive===
+===UARTInitialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTReceive'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTInitialise'''
 |-
 | colspan="2" | &nbsp;
@@ Line 207: / Line 228: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| 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''
 |}
-===IOSetOutputPin===
+===UARTReceive===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IOSetOutputPin'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTReceive'''
 |-
-| colspan="2" | Sets the selected digital pin to an output and assigns the output state.&nbsp;
+| colspan="2" | &nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Pin
+| width="90%" | Channel
 |-
-| colspan="2" | Range: 0-53&nbsp;
+| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | State
-|-
-| colspan="2" | Range: 0-1&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''
 |}
@@ Line 254: / Line 270: @@
 |-
 | 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''
-|}
-===Initialise===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
-|-
-| colspan="2" | Sets up the injector ready to receive commands or send data&nbsp;
-|-
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID