Jump to content

Component: Data Transfer (API I2C) (): Difference between revisions

From Flowcode Help
No edit summary
No edit summary
Line 16: Line 16:


==Detailed description==
==Detailed description==




Line 24: Line 26:


==Examples==
==Examples==





Revision as of 13:28, 17 November 2021

Author Matrix Ltd
Version 1.2
Category


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.

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. 
[[File:]] - 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 
Connections
Simulations