Ft5336_Exported_Functions

Modules
	Ft5336_Imported_Functions
	Ft5336_Imported_Globals

Functions
void	ft5336_Init (uint16_t DeviceAddr)
	ft5336 Control functions More...
void	ft5336_Reset (uint16_t DeviceAddr)
	Software Reset the ft5336. More...
uint16_t	ft5336_ReadID (uint16_t DeviceAddr)
	Read the ft5336 device ID, pre initialize I2C in case of need to be able to read the FT5336 device ID, and verify this is a FT5336. More...
void	ft5336_TS_Start (uint16_t DeviceAddr)
	Configures the touch Screen IC device to start detecting touches. More...
uint8_t	ft5336_TS_DetectTouch (uint16_t DeviceAddr)
	Return if there is touches detected or not. Try to detect new touches and forget the old ones (reset internal global variables). More...
void	ft5336_TS_GetXY (uint16_t DeviceAddr, uint16_t *X, uint16_t *Y)
	Get the touch screen X and Y positions values Manage multi touch thanks to touch Index global variable 'ft5336_handle.currActiveTouchIdx'. More...
void	ft5336_TS_EnableIT (uint16_t DeviceAddr)
	Configure the FT5336 device to generate IT on given INT pin connected to MCU as EXTI. More...
void	ft5336_TS_DisableIT (uint16_t DeviceAddr)
	Configure the FT5336 device to stop generating IT on the given INT pin connected to MCU as EXTI. More...
uint8_t	ft5336_TS_ITStatus (uint16_t DeviceAddr)
	Get IT status from FT5336 interrupt status registers Should be called Following an EXTI coming to the MCU to know the detailed reason of the interrupt. More...
void	ft5336_TS_ClearIT (uint16_t DeviceAddr)
	Clear IT status in FT5336 interrupt status clear registers Should be called Following an EXTI coming to the MCU. More...
void	ft5336_TS_GetGestureID (uint16_t DeviceAddr, uint32_t *pGestureId)
	Get the last touch gesture identification (zoom, move up/down...). More...
void	ft5336_TS_GetTouchInfo (uint16_t DeviceAddr, uint32_t touchIdx, uint32_t *pWeight, uint32_t *pArea, uint32_t *pEvent)
	Get the touch detailed informations on touch number 'touchIdx' (0..1) This touch detailed information contains : More...

Detailed Description

Function Documentation

void ft5336_Init

(

uint16_t

DeviceAddr

)

ft5336 Control functions

Initialize the ft5336 communication bus from MCU to FT5336 : ie I2C channel initialization (if required).

Parameters

DeviceAddr

Device address on communication Bus (I2C slave address of FT5336).

Return values

None	ft5336 Control functions

Parameters

DeviceAddr

Device address on communication Bus (I2C slave address of FT5336).

Return values

None

Definition at line 147 of file ft5336.c.

uint16_t ft5336_ReadID

(

uint16_t

DeviceAddr

)

Read the ft5336 device ID, pre initialize I2C in case of need to be able to read the FT5336 device ID, and verify this is a FT5336.

Parameters

DeviceAddr

I2C FT5336 Slave address.

Return values

The	Device ID (two bytes).

Definition at line 175 of file ft5336.c.

void ft5336_Reset

(

uint16_t

DeviceAddr

)

Software Reset the ft5336.

Parameters

DeviceAddr

Device address on communication Bus (I2C slave address of FT5336).

Return values

None

Note

: Not applicable to FT5336.

Parameters

DeviceAddr

Device address on communication Bus (I2C slave address of FT5336).

Return values

None

Definition at line 163 of file ft5336.c.

void ft5336_TS_ClearIT

(

uint16_t

DeviceAddr

)

Clear IT status in FT5336 interrupt status clear registers Should be called Following an EXTI coming to the MCU.

Parameters

DeviceAddr

Device address on communication Bus (I2C slave address of FT5336).

Return values

TS	interrupts status

Note

: This feature is not applicable to FT5336.

Parameters

DeviceAddr

Device address on communication Bus (I2C slave address of FT5336).

Return values

None

Definition at line 422 of file ft5336.c.

uint8_t ft5336_TS_DetectTouch

(

uint16_t

DeviceAddr

)

Return if there is touches detected or not. Try to detect new touches and forget the old ones (reset internal global variables).

Parameters

DeviceAddr

Device address on communication Bus.

Return values

Number of active touches detected (can be 0, 1 or 2).

Definition at line 224 of file ft5336.c.

void ft5336_TS_DisableIT

(

uint16_t

DeviceAddr

)

Configure the FT5336 device to stop generating IT on the given INT pin connected to MCU as EXTI.

Parameters

DeviceAddr

Device address on communication Bus (Slave I2C address of FT5336).

Return values

None

Definition at line 392 of file ft5336.c.

void ft5336_TS_EnableIT

(

uint16_t

DeviceAddr

)

Configure the FT5336 device to generate IT on given INT pin connected to MCU as EXTI.

Parameters

DeviceAddr

Device address on communication Bus (Slave I2C address of FT5336).

Return values

None

Definition at line 377 of file ft5336.c.

void ft5336_TS_GetGestureID	(	uint16_t	DeviceAddr,
		uint32_t *	pGestureId
	)

Get the last touch gesture identification (zoom, move up/down...).

Parameters

DeviceAddr	Device address on communication Bus (I2C slave address of FT5336).
pGestureId	: Pointer to get last touch gesture Identification.

Return values

None.

Definition at line 437 of file ft5336.c.

void ft5336_TS_GetTouchInfo	(	uint16_t	DeviceAddr,
		uint32_t	touchIdx,
		uint32_t *	pWeight,
		uint32_t *	pArea,
		uint32_t *	pEvent
	)

Get the touch detailed informations on touch number 'touchIdx' (0..1) This touch detailed information contains :

• weight that was applied to this touch
• sub-area of the touch in the touch panel
• event of linked to the touch (press down, lift up, ...)

  Parameters

  DeviceAddr	Device address on communication Bus (I2C slave address of FT5336).
  touchIdx	: Passed index of the touch (0..1) on which we want to get the detailed information.
  pWeight	: Pointer to to get the weight information of 'touchIdx'.
  pArea	: Pointer to to get the sub-area information of 'touchIdx'.
  pEvent	: Pointer to to get the event information of 'touchIdx'.

  Return values

  None.

Definition at line 461 of file ft5336.c.

void ft5336_TS_GetXY	(	uint16_t	DeviceAddr,
		uint16_t *	X,
		uint16_t *	Y
	)

Get the touch screen X and Y positions values Manage multi touch thanks to touch Index global variable 'ft5336_handle.currActiveTouchIdx'.

Parameters

DeviceAddr	Device address on communication Bus.
X	Pointer to X position value
Y	Pointer to Y position value

Return values

None.

Definition at line 256 of file ft5336.c.

uint8_t ft5336_TS_ITStatus

(

uint16_t

DeviceAddr

)

Get IT status from FT5336 interrupt status registers Should be called Following an EXTI coming to the MCU to know the detailed reason of the interrupt.

Parameters

DeviceAddr

Device address on communication Bus (I2C slave address of FT5336).

Return values

TS	interrupts status

Note

: This feature is not applicable to FT5336.

Parameters

DeviceAddr

Device address on communication Bus (I2C slave address of FT5336).

Return values

TS	interrupts status : always return 0 here

Definition at line 409 of file ft5336.c.

void ft5336_TS_Start

(

uint16_t

DeviceAddr

)

Configures the touch Screen IC device to start detecting touches.

Parameters

DeviceAddr

Device address on communication Bus (I2C slave address).

Return values

None.

Definition at line 207 of file ft5336.c.