CAPT_Trackpad

This file contains higher-level sensor processing APIs for trackpad sensor. More...

Enumerations
enum	eTapStates { eBackGround, eTap, eSlide, eWaitForRelease }
	enumeration eTapStates More...
enum	eGestures {   eGestureWakeOnProximity, eGestureReserved1, eGestureSingleTap = 2, eGestureDoubleTap,   eGestureReserved4, eGestureReserved5, eGestureTapAndHold, eGestureReserved7,   eGestureSwipeLeft, eGestureSwipeRight, eGestureSwipeUp, eGestureSwipeDown,   eNoGesture = 0xFF }
	enumeration eGestures More...

Functions
uint16_t	CAPT_getTrackpad_X (tSensor *pSensor)
uint16_t	CAPT_getTrackpad_RawX (tSensor *pSensor)
uint16_t	CAPT_getTrackpad_Y (tSensor *pSensor)
uint16_t	CAPT_getTrackpad_RawY (tSensor *pSensor)
void	CAPT_getTrackpad_XY (tSensor *pSensor, uint16_t *pX, uint16_t *pY)
void	CAPT_getTrackpad_RawXY (tSensor *pSensor, uint16_t *pX, uint16_t *pY)
uint8_t	CAPT_getTrackpad_Gesture (tSensor *pSensor)
void	CAPT_processTrackPadSensor (tSensor *)
void	CAPT_processTrackPadGesture (tSensor *pTrackpad)
	Process the track/gesture pad gestures. More...
bool	CAPT_writeTrackPadData (uint8_t ui8SensorID)
	Send trackpad position and gesture. More...

Detailed Description

This file contains higher-level sensor processing APIs for trackpad sensor.

Version

VERSION Released on RELEASE_DATE

Enumeration Type Documentation

eTapStates

enum eTapStates

enumeration eTapStates

Enumeration for each of the processing state-machine states

Enumerator
eBackGround
eTap
eSlide
eWaitForRelease

eGestures

enum eGestures

enumeration eGestures

Enumeration for each of the supported Gestures

Enumerator
eGestureWakeOnProximity
eGestureReserved1
eGestureSingleTap
eGestureDoubleTap
eGestureReserved4
eGestureReserved5
eGestureTapAndHold
eGestureReserved7
eGestureSwipeLeft
eGestureSwipeRight
eGestureSwipeUp
eGestureSwipeDown
eNoGesture

Function Documentation

CAPT_getTrackpad_X()

uint16_t CAPT_getTrackpad_X

(

tSensor *

pSensor

)

Get Trackpad X position

Parameters

pSensor

is a pointer to the TrackPad Sensor to process

Returns

filtered X position

CAPT_getTrackpad_RawX()

uint16_t CAPT_getTrackpad_RawX

(

tSensor *

pSensor

)

Get Trackpad Raw X position

Parameters

pSensor

is a pointer to the TrackPad Sensor to process

Returns

non-filtered X position

CAPT_getTrackpad_Y()

uint16_t CAPT_getTrackpad_Y

(

tSensor *

pSensor

)

Get Trackpad Y position

Parameters

pSensor

is a pointer to the TrackPad Sensor to process

Returns

filtered Y position

CAPT_getTrackpad_RawY()

uint16_t CAPT_getTrackpad_RawY

(

tSensor *

pSensor

)

Get Trackpad Raw Y position

Parameters

pSensor

is a pointer to the TrackPad Sensor to process

Returns

non-filtered Y position

CAPT_getTrackpad_XY()

void CAPT_getTrackpad_XY	(	tSensor *	pSensor,
		uint16_t *	pX,
		uint16_t *	pY
	)

Get Trackpad X and Y position

Parameters

pSensor	is a pointer to the TrackPad Sensor to process
pX	is a pointer to the filtered X position
pY	is a pointer to the filtered Y position

Returns

void

CAPT_getTrackpad_RawXY()

void CAPT_getTrackpad_RawXY	(	tSensor *	pSensor,
		uint16_t *	pX,
		uint16_t *	pY
	)

Get Trackpad Raw X and Y position

Parameters

pSensor	is a pointer to the TrackPad Sensor to process
pX	is a pointer to the non-filtered X position
pY	is a pointer to the non-filtered Y position

Returns

void

CAPT_getTrackpad_Gesture()

uint8_t CAPT_getTrackpad_Gesture

(

tSensor *

pSensor

)

Get Trackpad Gesture

Parameters

pSensor

is a pointer to the TrackPad Sensor to process

Returns

gesture

CAPT_processTrackPadSensor()

void CAPT_processTrackPadSensor

(

tSensor *

)

Perform Trackpad processing

Does all TrackPad related processing: Position, Track, Filter User can override with custom processing. Refer to touch:CAPT_registerTrackPadSensorProcessing() in touch.c

Parameters

pSensor

is a pointer to the TrackPad Sensor to process

Returns

None.

Referenced by CAPT_initUI().

CAPT_processTrackPadGesture()

void CAPT_processTrackPadGesture

(

tSensor *

pTrackpad

)

Process the track/gesture pad gestures.

This function applies gesture algorithms to the results of trackpad processing. User can override with custom gesture processing. Refer to touch:CAPT_registerTrackPadGestureProcessing() in touch.c

Parameters

pSensor

is a pointer to the sensor to query

Returns

None

Referenced by CAPT_initUI().

CAPT_writeTrackPadData()

bool CAPT_writeTrackPadData

(

uint8_t

ui8SensorID

)

Send trackpad position and gesture.

This function sends trackpad position and gesture data using trackpad protocol to the GUI.

Parameters

None	- Trackpad sensor ID is determined during Trackpad Interface Initialization

Returns

None

Referenced by CAPT_updateUI().