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

Revision as of 11:48, 3 February 2023

Author	Matrix TSL
Version	2.0
Category	API Slave Devices

API I2C Dummy component

API I2C Dummy

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

I2CInitialise

	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

	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

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

I2CStart

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

I2CReceive

	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

	I2CStop
Put the I2C Module into Stop mode
- BYTE	Channel

- VOID	Return

I2CTransSend

	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

	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

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

- BOOL	Return

Initialise

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

Property reference

	Properties

@@ Line 81: / Line 81: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 87: / Line 89: @@
 ==Macro reference==
+===I2CInitialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 110: / Line 113: @@
+===I2CTransReceive===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 138: / Line 142: @@
+===I2CRestart===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 156: / Line 161: @@
+===I2CStart===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 174: / Line 180: @@
+===I2CReceive===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 197: / Line 204: @@
+===I2CStop===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 215: / Line 223: @@
+===I2CTransSend===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 243: / Line 252: @@
+===I2CTransInit===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 271: / Line 281: @@
+===I2CSend===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 294: / Line 305: @@
+===Initialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-