Difference between revisions of "Component: Data Transfer (API UART) ()"
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: | ||
| + | ===TxByte=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 119: | Line 123: | ||
| + | ===RxByte=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 132: | Line 137: | ||
| + | ===GetConsoleHandle=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 145: | Line 151: | ||
| + | ===ChangeState=== | ||
{| 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 |
Contents
Data Transfer (API UART) component
Comms data injector to allow a Serial UART peripheral to be attached to a comms component. The component will forward any byte transactions through to a SCADA Slave enabled hardware. Enabling the Flowcode simulation runtime to directly drive a physical UART.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_InjectorSCADAUART.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_InjectorSCADAUART.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 |
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 |
ChangeState
|
|
ChangeState |
| Sets the state of the bus. SPI - Controls the chip select pin I2C - Controls the start/restart/stop status | |
| - BYTE
|
State |
| SPI: 0=CSLow, 1=CSHigh I2C: 0=Stop, 1=Start, 2=Restart | |
| - VOID
|
Return |
Property reference
|
Properties |
|
SCADA Slave |
| SCADA Slave component to use to pipe data to a physical SPI bus | |
|
BAUD Rate |
| Sets the data bit rate of the Serial UART. See the SCADA Slave UART Baud macro for valid values, | |
|
RS485 Direction Control |
| Allows an I/O pin to be automatically assigned when transmitting and receiving. | |
|
RS485 Properties |
|
RS485 Pin Number |
| Digital I/O pin number to use for the RS485 data direction pin | |
|
|
TX Pin State |
| Decides the state of the RS485 data direction pin when transmitting data. | |
|
|
RX Pin State |
| Decides the state of the RS485 data direction pin when receiving data. | |
