Difference between revisions of "Component: Data Transfer (API UART) ()"
From Flowcode Help
Jump to navigationJump to search| Line 15: | Line 15: | ||
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. | 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 | + | ==Component Source Code== |
| − | + | Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_InjectorSCADAUART.fcfx FC_Comp_Source_InjectorSCADAUART.fcfx] | |
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 34: | Line 36: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 155: | Line 159: | ||
|- | |- | ||
| colspan="2" | Allows an I/O pin to be automatically assigned when transmitting and receiving. | | colspan="2" | Allows an I/O pin to be automatically assigned when transmitting and receiving. | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | RS485 Properties | ||
| + | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| Line 170: | Line 178: | ||
|- | |- | ||
| colspan="2" | Decides the state of the RS485 data direction pin when receiving data. | | colspan="2" | Decides the state of the RS485 data direction pin when receiving data. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
Revision as of 17:47, 9 November 2022
| 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 for the component source code: FC_Comp_Source_InjectorSCADAUART.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable 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 |
|
|
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 |
|
|
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. | |
