Jump to content

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

From Flowcode Help
No edit summary
No edit summary
Line 20: Line 20:


==Detailed description==
==Detailed description==




Line 38: Line 40:


==Examples==
==Examples==




Line 57: Line 61:




==Downloadable macro reference==
==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 14:11, 20 January 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 for the component source code: FC_Comp_Source_InjectorSCADAAnalogInput.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


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