Difference between revisions of "Component: API I2C Dummy (API Slave Devices)"

Revision as of 14:39, 16 January 2023

API I2C Dummy

Please click here for the component source code: FC_Comp_Source_API_I2C_Dummy.fcfx

No detailed description exists yet for this component

No additional examples

	I2CInitialise
Initialsie the I2C module ready for communications
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Baud
0=100KHz, 1=400KHz, 2=1MHz
- VOID	Return

	I2CTransReceive
Receives an I2C Transaction on the selected I2C channel. Returns the number of bytes received.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Data
Data variable to receive into
- UINT	Count
Number of bytes to receive
- UINT	Return

	I2CRestart
Put the I2C Module into Restart mode
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- VOID	Return

	I2CStart
Put the I2C Module into Start mode
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- VOID	Return

	I2CReceive
Receive a byte using the I2C bus
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BOOL	Last
Last byte to receive: Range 0-1
- BYTE	Return

	I2CStop
Put the I2C Module into Stop mode
- BYTE	Channel

- VOID	Return

	I2CTransSend
Sends an I2C Transaction on the selected I2C channel. Returns the number of bytes sent.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Data
Data to send
- UINT	Count
Number of bytes to send out, MS bit 0x8000 signifies no Stop if set
- UINT	Return

	I2CTransInit
Initialises the I2C Transaction mode with the 7-bit device address
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	DeviceAddress
7-bit Device Address
- BYTE	Baud
0=100KHz, 1=400KHz, 2=1MHz
- VOID	Return

	I2CSend
Transmit a byte using the I2C bus
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	DataOut

- BOOL	Return

	Initialise
Initialise the comms to the Arduino board ready for commands to be sent.
- VOID	Return

	Properties

Revision as of 17:44, 9 November 2022 (view source) Wiki bot (talk \| contribs) (Created page with "{\| style="width:50%" \|- \| width="20%" style="color:gray;" \| Author \| Matrix TSL \|- \| width="20%" style="color:gray;" \| Version \| 2.0 \|- \| width="20%" style="color:gray...")		Revision as of 14:39, 16 January 2023 (view source) Wiki bot (talk \| contribs) Newer edit →
Line 20:		Line 20:

	==Detailed description==		==Detailed description==
		+
		+


Line 36:		Line 38:

	==Examples==		==Examples==
		+
		+