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

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

Revision as of 11:50, 3 February 2023

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

InitialiseInjector

Fc9-comp-macro.png InitialiseInjector
Sets up the injector ready to receive commands or send data 
Fc9-string-icon.png - STRING InjectorName
Name of the console that will be created 
Fc9-u8-icon.png - BYTE Return


RxByteCount

Fc9-comp-macro.png RxByteCount
Returns the number of bytes currently sat in the receive buffer. 
Fc9-u16-icon.png - UINT Return


TxByte

Fc9-comp-macro.png TxByte
Puts a byte onto the comms channel. 
Fc9-u8-icon.png - BYTE DataByte
 
Fc9-void-icon.png - VOID Return


RxByte

Fc9-comp-macro.png RxByte
Attempt to receive a byte back from the injector 0 - 255 = Valid data 256 = RX timeout no data available 
Fc9-u16-icon.png - UINT Return


GetConsoleHandle

Fc9-comp-macro.png GetConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc. 
Fc9-h32-icon.png - HANDLE Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-17-icon.png API Slave
SCADA Slave component to use to pipe data to a physical SPI bus 
Fc9-type-16-icon.png Number of Pins
Specifies the number of pins the component can monitor and control. 
Fc9-type-16-icon.png Poll Rate
 
Fc9-conn-icon.png Pin 0
Fc9-type-5-icon.png Simulation I/O Pin
Pin monitored by the simulation 
Fc9-type-21-icon.png SCADA Slave Pin
Pin used by the connected SCADA Slave hardware