Difference between revisions of "Component: Injector (API Analog Input) (Test Injectors)"

Latest revision as of 13:11, 7 February 2023

Author	Matrix Ltd
Version	1.2
Category	Test Injectors

Injector (API Analog Input) component

Data injector to allow a physical analog 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_InjectorSCADAAnalogInput.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_InjectorSCADAAnalogInput.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 ADC Pin
Pin monitored by the simulation
	SCADA Slave ADC Pin
Pin used by the connected SCADA Slave hardware

Difference between revisions of "Component: Injector (API Analog Input) (Test Injectors)"

Latest revision as of 13:11, 7 February 2023

Contents

Injector (API Analog Input) component

Component Source Code

Detailed description

Examples

Macro reference

GetConsoleHandle

InitialiseInjector

RxByte

RxByteCount

TxByte

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 15: / Line 15: @@
 Data injector to allow a physical analog 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 to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_InjectorSCADAAnalogInput.fcfx FC_Comp_Source_InjectorSCADAAnalogInput.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_InjectorSCADAAnalogInput.fcfx FC_Comp_Source_InjectorSCADAAnalogInput.fcfx]
 ==Detailed description==
@@ Line 34: / Line 50: @@
 ==Examples==
@@ Line 49: / Line 79: @@
-==Downloadable macro reference==
+==Macro reference==
+===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''
+|}
+===InitialiseInjector===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 69: / Line 124: @@
+===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;" | '''RxByteCount'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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: @@
+===RxByteCount===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 |}
+===TxByte===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 |}
@@ Line 151: / Line 194: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
-| width="90%" | Simulation ADC 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 ADC Pin
-|-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
-| width="90%" | Simulation ADC Pin
-|-
-| colspan="2" | Pin monitored by the simulation&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | SCADA Slave ADC Pin
-|-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
-| width="90%" | Simulation ADC Pin
-|-
-| colspan="2" | Pin monitored by the simulation&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | SCADA Slave ADC Pin
-|-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
-| width="90%" | Simulation ADC Pin
-|-
-| colspan="2" | Pin monitored by the simulation&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | SCADA Slave ADC Pin
-|-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
-| width="90%" | Simulation ADC Pin
-|-
-| colspan="2" | Pin monitored by the simulation&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | SCADA Slave ADC Pin
-|-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
-| width="90%" | Simulation ADC Pin
-|-
-| colspan="2" | Pin monitored by the simulation&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | SCADA Slave ADC Pin
-|-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
-| width="90%" | Simulation ADC Pin
-|-
-| colspan="2" | Pin monitored by the simulation&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | SCADA Slave ADC Pin
 |-
-| colspan="2" | Pin used by the connected SCADA Slave hardware&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
@@ Line 230: / Line 207: @@
 |-
 | 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'''
-|-
 |}