Component: Injector (API Digital Output) (Test Injectors): Difference between revisions
No edit summary |
No edit summary |
||
| Line 16: | Line 16: | ||
==Component Source Code== | ==Component Source Code== | ||
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_InjectorSCADADigitalOutput.fcfx FC_Comp_Source_InjectorSCADADigitalOutput.fcfx] | |||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_InjectorSCADADigitalOutput.fcfx FC_Comp_Source_InjectorSCADADigitalOutput.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_InjectorSCADADigitalOutput.fcfx FC_Comp_Source_InjectorSCADADigitalOutput.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| Line 42: | Line 46: | ||
==Examples== | ==Examples== | ||
| Line 66: | Line 72: | ||
==Macro reference== | ==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 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | |||
| width="90%" | InjectorName | |||
|- | |||
| colspan="2" | Name of the console that will be created | |||
|- | |||
| 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. | |||
|- | |||
|- | |||
| 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. | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | |||
| width="90%" | DataByte | |||
|- | |||
| colspan="2" | | |||
|- | |||
| 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 | |||
|- | |||
|- | |||
| 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;" | '''GetConsoleHandle''' | |||
|- | |||
| colspan="2" | Gets the handle to the console allowing data displaying on the panel etc. | |||
|- | |||
|- | |||
| 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'' | |||
|} | |||
==Property reference== | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |||
|- | |||
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | |||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]] | |||
| width="90%" | API Slave | |||
|- | |||
| colspan="2" | SCADA Slave component to use to pipe data to a physical SPI bus | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |||
| width="90%" | Number of Pins | |||
|- | |||
| colspan="2" | Specifies the number of pins the component can monitor and control. | |||
|- | |||
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Pin 0 | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | |||
| width="90%" | Simulation I/O Pin | |||
|- | |||
| colspan="2" | Pin monitored by the simulation | |||
|- | |||
| 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 | |||
|}==Macro reference== | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:22, 20 January 2023
| Author | Matrix Ltd |
| Version | 1.2 |
| Category | Test Injectors |
Injector (API Digital Output) component
Data injector to allow a physical digital output pin to be attached to a simulated component. The component will forward any output state changes through to a 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_InjectorSCADADigitalOutput.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_InjectorSCADADigitalOutput.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. | |
|
Pin 0 |
|
Simulation I/O Pin |
| Pin monitored by the simulation | |
|
SCADA Slave Pin |
| Pin used by the connected SCADA Slave hardware | |
==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. | |
|
|
Pin 0 |
|
|
Simulation I/O Pin |
| Pin monitored by the simulation | |
|
|
SCADA Slave Pin |
| Pin used by the connected SCADA Slave hardware | |
==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. | |
|
|
Pin 0 |
|
|
Simulation I/O Pin |
| Pin monitored by the simulation | |
|
|
SCADA Slave Pin |
| Pin used by the connected SCADA Slave hardware | |