Difference between revisions of "Component: Data Transfer (API SPI) ()"
From Flowcode Help
Jump to navigationJump to search| Line 14: | Line 14: | ||
==Data Transfer (API SPI) component== | ==Data Transfer (API SPI) component== | ||
Comms data injector to allow a SPI 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 SPI bus. | Comms data injector to allow a SPI 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 SPI bus. | ||
| + | |||
| + | ==Component Pack== | ||
| + | |||
| + | FREE | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 28: | Line 34: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
Revision as of 16:20, 7 January 2022
| Author | Matrix Ltd |
| Version | 1.2 |
| Category |
Contents
Data Transfer (API SPI) component
Comms data injector to allow a SPI 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 SPI bus.
Component Pack
FREE
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 | |
|
CS Pin Number |
| Digital I/O pin number to use for the CS pin | |
|
|
SPI Prescaler |
| Sets the prescaler rate of the SPI bus. See the SCADA Slave SPIPrescaler macro for valid values, | |
|
Connections |
|
|
Simulations |
