Component: Data Transfer (API SPI) ()

Author	Matrix Ltd
Version	1.2
Category

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 Source Code

Please click here to download the component source project: FC_Comp_Source_InjectorSCADASPI.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_InjectorSCADASPI.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

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

GetConsoleHandle

	GetConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc.
- HANDLE	Return

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

RxByte

	RxByte
Attempt to receive a byte back from the injector 0 - 255 = Valid data 256 = RX timeout no data available
- UINT	Return

TxByte

	TxByte
Puts a byte onto the comms channel.
- BYTE	DataByte
- 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,