ST / BSP_DISCO_L4R9I

Dependents:   DISCO_L4R9I-LCD-demo

Embed: (wiki syntax)

« Back to documentation index

FT3X67_Exported_Functions

FT3X67_Exported_Functions
[FT3X67]

Functions

void ft3x67_Init (uint16_t DeviceAddr)
 Initialize the ft3x67 communication bus from MCU to FT3X67 : ie I2C channel initialization (if required).
void ft3x67_Reset (uint16_t DeviceAddr)
 Software Reset the ft3x67.
uint16_t ft3x67_ReadID (uint16_t DeviceAddr)
 Read the ft3x67 device ID, pre initialize I2C in case of need to be able to read the FT3X67 device ID, and verify this is a FT3X67.
void ft3x67_TS_Start (uint16_t DeviceAddr)
 Configures the touch Screen IC device to start detecting touches.
uint8_t ft3x67_TS_DetectTouch (uint16_t DeviceAddr)
 Return if there is touches detected or not.
void ft3x67_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 'ft3x67_handle.currActiveTouchIdx'.
void ft3x67_TS_EnableIT (uint16_t DeviceAddr)
 Configure the FT3X67 device to generate IT on given INT pin connected to MCU as EXTI.
void ft3x67_TS_DisableIT (uint16_t DeviceAddr)
 Configure the FT3X67 device to stop generating IT on the given INT pin connected to MCU as EXTI.
uint8_t ft3x67_TS_ITStatus (uint16_t DeviceAddr)
 Get IT status from FT3X67 interrupt status registers Should be called Following an EXTI coming to the MCU to know the detailed reason of the interrupt.
void ft3x67_TS_ClearIT (uint16_t DeviceAddr)
 Clear IT status in FT3X67 interrupt status clear registers Should be called Following an EXTI coming to the MCU.
void ft3x67_TS_GestureConfig (uint16_t DeviceAddr, uint32_t Activation)
 Configure gesture feature (enable/disable).
void ft3x67_TS_GetGestureID (uint16_t DeviceAddr, uint32_t *pGestureId)
 Get the last touch gesture identification (zoom, move up/down...).
void ft3x67_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, ...)


Function Documentation

void ft3x67_Init ( uint16_t  DeviceAddr )

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

Parameters:
DeviceAddr,:Device address on communication Bus (I2C slave address of FT3X67).
Return values:
None

Definition at line 115 of file ft3x67.c.

uint16_t ft3x67_ReadID ( uint16_t  DeviceAddr )

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

Parameters:
DeviceAddr,:I2C FT3X67 Slave address.
Return values:
TheDevice ID (two bytes).

Definition at line 139 of file ft3x67.c.

void ft3x67_Reset ( uint16_t  DeviceAddr )

Software Reset the ft3x67.

Note:
: Not applicable to FT3X67.
Parameters:
DeviceAddr,:Device address on communication Bus (I2C slave address of FT3X67).
Return values:
None

Definition at line 127 of file ft3x67.c.

void ft3x67_TS_ClearIT ( uint16_t  DeviceAddr )

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

Note:
: This feature is not applicable to FT3X67.
Parameters:
DeviceAddr,:Device address on communication Bus (I2C slave address of FT3X67).
Return values:
None

Definition at line 282 of file ft3x67.c.

uint8_t ft3x67_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 170 of file ft3x67.c.

void ft3x67_TS_DisableIT ( uint16_t  DeviceAddr )

Configure the FT3X67 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 FT3X67).
Return values:
None

Definition at line 255 of file ft3x67.c.

void ft3x67_TS_EnableIT ( uint16_t  DeviceAddr )

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

Parameters:
DeviceAddr,:Device address on communication Bus (Slave I2C address of FT3X67).
Return values:
None

Definition at line 243 of file ft3x67.c.

void ft3x67_TS_GestureConfig ( uint16_t  DeviceAddr,
uint32_t  Activation 
)

Configure gesture feature (enable/disable).

Parameters:
DeviceAddr,:Device address on communication Bus (I2C slave address of FT3X67).
Activation: Enable or disable gesture feature. Possible values are FT3X67_GESTURE_DISABLE or FT3X67_GESTURE_ENABLE.
Return values:
None.

Definition at line 294 of file ft3x67.c.

void ft3x67_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 FT3X67).
pGestureId: Pointer to get last touch gesture Identification.
Return values:
None.

Definition at line 316 of file ft3x67.c.

void ft3x67_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 FT3X67).
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'.
Note:
Area and Weight features are not supported by FT3X67. Return always 0 value.
Return values:
None.

Definition at line 340 of file ft3x67.c.

void ft3x67_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 'ft3x67_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 202 of file ft3x67.c.

uint8_t ft3x67_TS_ITStatus ( uint16_t  DeviceAddr )

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

Note:
: This feature is not applicable to FT3X67.
Parameters:
DeviceAddr,:Device address on communication Bus (I2C slave address of FT3X67).
Return values:
TSinterrupts status : always return 0 here

Definition at line 269 of file ft3x67.c.

void ft3x67_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 153 of file ft3x67.c.