Component: Data Transfer (API UART) ()

From Flowcode Help
Revision as of 13:11, 7 February 2023 by Wiki bot (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search
Author Matrix Ltd
Version 1.2
Category


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

ChangeState

Fc9-comp-macro.png ChangeState
Sets the state of the bus. SPI - Controls the chip select pin I2C - Controls the start/restart/stop status 
Fc9-u8-icon.png - BYTE State
SPI: 0=CSLow, 1=CSHigh I2C: 0=Stop, 1=Start, 2=Restart 
Fc9-void-icon.png - VOID 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


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


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


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


Property reference

Fc9-prop-icon.png Properties
Fc9-type-17-icon.png SCADA Slave
SCADA Slave component to use to pipe data to a physical SPI bus 
Fc9-type-16-icon.png BAUD Rate
Sets the data bit rate of the Serial UART. See the SCADA Slave UART Baud macro for valid values, 
Fc9-type-7-icon.png RS485 Direction Control
Allows an I/O pin to be automatically assigned when transmitting and receiving. 
Fc9-conn-icon.png RS485 Properties
Fc9-type-21-icon.png RS485 Pin Number
Digital I/O pin number to use for the RS485 data direction pin 
Fc9-type-16-icon.png TX Pin State
Decides the state of the RS485 data direction pin when transmitting data. 
Fc9-type-16-icon.png RX Pin State
Decides the state of the RS485 data direction pin when receiving data.