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

Revision as of 11:50, 3 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

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

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

RxByte

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

GetConsoleHandle

	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 ADC Pin
Pin monitored by the simulation
	SCADA Slave ADC Pin
Pin used by the connected SCADA Slave hardware

@@ Line 77: / Line 77: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 83: / Line 85: @@
 ==Macro reference==
+===InitialiseInjector===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 101: / Line 104: @@
+===RxByteCount===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 114: / Line 118: @@
+===TxByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 132: / Line 137: @@
+===RxByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 145: / Line 151: @@
+===GetConsoleHandle===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-

Wiki bot (talk | contribs)