Component: Injector (API Digital Input) (Test Injectors): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix Ltd
Version	1.2
Category	Test Injectors

Injector (API Digital Input) component

Data injector to allow a physical digital input pin to be attached to a simulated component. The component will poll for any input state changes via SCADA Slave enabled hardware. Enabling the Flowcode simulation runtime to directly interface with a physical I/O pin.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_InjectorSCADADigitalInput.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_InjectorSCADADigitalInput.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
	API Slave
SCADA Slave component to use to pipe data to a physical SPI bus
	Number of Pins
Specifies the number of pins the component can monitor and control.
	Poll Rate

	Pin 0
	Simulation I/O Pin
Pin monitored by the simulation
	SCADA Slave Pin
Pin used by the connected SCADA Slave hardware

@@ Line 77: / Line 77: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 84: / Line 90: @@
 ==Macro reference==
+===GetConsoleHandle===
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| 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="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| 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" | '''InitialiseInjector'''
 |-
 | colspan="2" | Sets up the injector ready to receive commands or send data&nbsp;
@@ Line 100: / Line 120: @@
 |-
 | 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''
+|}
+===RxByte===
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''RxByte'''
+|-
+| colspan="2" | Attempt to receive a byte back from the injector 0 - 255 = Valid data 256 = RX timeout no data available&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
@@ Line 105: / Line 139: @@
 ===RxByteCount===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| 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" | '''RxByteCount'''
 |-
 | colspan="2" | Returns the number of bytes currently sat in the receive buffer.&nbsp;
@@ Line 119: / Line 153: @@
 ===TxByte===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| 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" | '''TxByte'''
 |-
 | colspan="2" | Puts a byte onto the comms channel.&nbsp;
@@ Line 135: / Line 169: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===RxByte===
-{| 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;" | '''RxByte'''
-|-
-| colspan="2" | Attempt to receive a byte back from the injector 0 - 255 = Valid data 256 = RX timeout no data available&nbsp;
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-===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;" | '''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''
-|}
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-
@@ Line 190: / Line 194: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Pin 0
+| width="90%" class="mtx-class-propfolder" | Pin 0
 |-
 |-

SteveT (talk | contribs)