Difference between revisions of "Component: Data Transfer (API I2C) ()"
From Flowcode Help
Jump to navigationJump to search| Line 15: | Line 15: | ||
Comms data injector to allow a I2C bus 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 I2C bus. | Comms data injector to allow a I2C bus 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 I2C bus. | ||
| − | ==Component | + | ==Component Source Code== |
| − | + | Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_InjectorSCADAI2C.fcfx FC_Comp_Source_InjectorSCADAI2C.fcfx] | |
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 34: | Line 36: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 145: | Line 149: | ||
|- | |- | ||
| colspan="2" | SCADA Slave component to use to pipe data to a physical SPI bus | | colspan="2" | SCADA Slave component to use to pipe data to a physical SPI bus | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
Revision as of 17:47, 9 November 2022
| Author | Matrix Ltd |
| Version | 1.2 |
| Category |
Contents
Data Transfer (API I2C) component
Comms data injector to allow a I2C bus 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 I2C bus.
Component Source Code
Please click here for the component source code: FC_Comp_Source_InjectorSCADAI2C.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, 3=LastRx | |
| - VOID
|
Return |
Property reference
|
Properties |
|
SCADA Slave |
| SCADA Slave component to use to pipe data to a physical SPI bus | |
