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

Revision as of 17:47, 9 November 2022

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 for the component source code: FC_Comp_Source_InjectorSCADADigitalInput.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
	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 15: / Line 15: @@
 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 Pack==
+==Component Source Code==
-FREE
+Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_InjectorSCADADigitalInput.fcfx FC_Comp_Source_InjectorSCADADigitalInput.fcfx]
 ==Detailed description==
@@ Line 34: / Line 36: @@
 ==Examples==
@@ Line 50: / Line 54: @@
 ==Downloadable macro reference==
+{| 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;" | '''InitialiseInjector'''
+|-
+| colspan="2" | Sets up the injector ready to receive commands or send data&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | InjectorName
+|-
+| colspan="2" | Name of the console that will be created&nbsp;
+|-
+| 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''
+|}
+{| 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;" | '''RxByteCount'''
+|-
+| colspan="2" | Returns the number of bytes currently sat in the receive buffer.&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''
+|}
+{| 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;" | '''TxByte'''
+|-
+| colspan="2" | Puts a byte onto the comms channel.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| 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;"
+|-
+| 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''
+|}
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
@@ Line 89: / Line 155: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
-| width="90%" | Simulation I/O Pin
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Pin 0
 |-
-| colspan="2" | Pin monitored by the simulation&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | SCADA Slave Pin
-|-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
@@ Line 108: / Line 168: @@
 |-
 | colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-| width="90%" | Simulation I/O Pin
-|-
-| colspan="2" | Pin monitored by the simulation&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | SCADA Slave Pin
-|-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-| width="90%" | Simulation I/O Pin
-|-
-| colspan="2" | Pin monitored by the simulation&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | SCADA Slave Pin
-|-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-| width="90%" | Simulation I/O Pin
-|-
-| colspan="2" | Pin monitored by the simulation&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | SCADA Slave Pin
-|-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-| width="90%" | Simulation I/O Pin
-|-
-| colspan="2" | Pin monitored by the simulation&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | SCADA Slave Pin
-|-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-| width="90%" | Simulation I/O Pin
-|-
-| colspan="2" | Pin monitored by the simulation&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | SCADA Slave Pin
-|-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
-| width="90%" | Simulation I/O Pin
-|-
-| colspan="2" | Pin monitored by the simulation&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | SCADA Slave Pin
-|-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&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'''
-|-
 |}

Wiki bot (talk | contribs)