-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathcy_capsense_gesture_lib.h
377 lines (326 loc) · 18.8 KB
/
cy_capsense_gesture_lib.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
/***************************************************************************//**
* \file cy_capsense_gesture_lib.h
* \version 5.0
*
* \brief
* Provides the gesture interface.
*
********************************************************************************
* \copyright
* Copyright 2018-2024, Cypress Semiconductor Corporation (an Infineon company)
* or an affiliate of Cypress Semiconductor Corporation. All rights reserved.
* You may use this file only in accordance with the license, terms, conditions,
* disclaimers, and limitations in the end user license agreement accompanying
* the software package with which this file was provided.
*******************************************************************************/
#ifndef CY_CAPSENSE_GESTURE_LIB_H
#define CY_CAPSENSE_GESTURE_LIB_H
#include <stdint.h>
#if (defined(CY_IP_MXCSDV2) || defined(CY_IP_M0S8CSDV2) || defined(CY_IP_M0S8MSCV3) || defined(CY_IP_M0S8MSCV3LP))
#if defined(__cplusplus)
extern "C" {
#endif
/******************************************************************************/
/** \addtogroup group_capsense_gesture_structures *//** \{ */
/******************************************************************************/
/** Gesture configuration structure */
typedef struct
{
/* Common parameters */
uint16_t resolutionX; /**< Widget maximum position X-axis */
uint16_t resolutionY; /**< Widget maximum position Y-axis */
/* Enabled gesture */
uint16_t gestureEnableMask; /**< Enabled gesture mask */
/* Timeout */
uint16_t flickTimeoutMax; /**< Flick maximum timeout */
uint16_t edgeTimeoutMax; /**< Edge Swipe maximum timeout */
uint16_t clickTimeoutMax; /**< Click maximum timeout */
uint16_t clickTimeoutMin; /**< Click minimum timeout */
uint16_t secondClickIntervalMax; /**< Second Click maximum interval */
uint16_t secondClickIntervalMin; /**< Second Click minimum interval */
uint16_t longPressTimeoutMin; /**< Long Press minimum timeout */
/* Distance */
uint16_t zoomDistanceMin; /**< Zoom minimum distance */
uint16_t flickDistanceMin; /**< Flick minimum distance */
uint16_t scrollDistanceMin; /**< Scroll minimum distance */
uint16_t rotateDistanceMin; /**< Rotate minimum distance */
uint16_t edgeDistanceMin; /**< Edge Swipe minimum distance */
uint8_t secondClickDistanceMax; /**< Second Click maximum distance */
uint8_t clickDistanceMax; /**< Click maximum distance */
uint8_t longPressDistanceMax; /**< Long Press maximum distance */
/* Debounce */
uint8_t zoomDebounce; /**< Zoom debounce */
uint8_t scrollDebounce; /**< Scroll debounce */
uint8_t rotateDebounce; /**< Rotate debounce */
/* Edge Swipe Specific */
uint8_t edgeAngleMax; /**< Edge Swipe maximum angle */
uint8_t edgeEdgeSize; /**< Edge Swipe border size */
} cy_stc_capsense_gesture_config_t;
/** Gesture position structure */
typedef struct
{
uint16_t x; /**< X axis position */
uint16_t y; /**< Y axis position */
} cy_stc_capsense_gesture_position_t;
/** Gesture One Finger Single Click context structure */
typedef struct
{
uint32_t touchStartTime1; /**< Touchdown time */
cy_stc_capsense_gesture_position_t touchStartPosition1; /**< Touchdown position */
uint8_t state; /**< Gesture state */
} cy_stc_capsense_ofsc_context_t;
/** Gesture One Finger Double Click context structure */
typedef struct
{
uint32_t touchStartTime1; /**< Touchdown time */
cy_stc_capsense_gesture_position_t touchStartPosition1; /**< Touchdown position */
uint8_t state; /**< Gesture state */
} cy_stc_capsense_ofdc_context_t;
/** Gesture One Finger Click and Drag context structure */
typedef struct
{
uint32_t touchStartTime1; /**< Touchdown time */
cy_stc_capsense_gesture_position_t touchStartPosition1; /**< Touchdown position */
uint8_t state; /**< Gesture state */
} cy_stc_capsense_ofcd_context_t;
/** Gesture Two Finger Single Click context structure */
typedef struct
{
uint32_t touchStartTime1; /**< Touchdown time of the first touch */
uint32_t touchStartTime2; /**< Touchdown time of the second touch */
cy_stc_capsense_gesture_position_t touchStartPosition1; /**< Touchdown position of the first touch */
cy_stc_capsense_gesture_position_t touchStartPosition2; /**< Touchdown position of the second touch */
uint8_t state; /**< Gesture state */
} cy_stc_capsense_tfsc_context_t;
/** Gesture One Finger Scroll context structure */
typedef struct
{
cy_stc_capsense_gesture_position_t touchStartPosition1; /**< Touchdown position */
uint8_t state; /**< Gesture state */
uint8_t debounce; /**< Gesture debounce counter */
uint8_t direction; /**< Last reported direction */
} cy_stc_capsense_ofsl_context_t;
/** Gesture Two Finger Scroll context structure */
typedef struct
{
cy_stc_capsense_gesture_position_t touchStartPosition1; /**< Touchdown position of the first touch */
cy_stc_capsense_gesture_position_t touchStartPosition2; /**< Touchdown position of the second touch */
uint8_t state; /**< Gesture state */
uint8_t debounce; /**< Gesture debounce counter */
uint8_t direction; /**< Last reported direction */
} cy_stc_capsense_tfsl_context_t;
/** Gesture One Finger Flick context structure */
typedef struct
{
uint32_t touchStartTime1; /**< Touchdown time */
cy_stc_capsense_gesture_position_t touchStartPosition1; /**< Touchdown position */
uint8_t state; /**< Gesture state */
} cy_stc_capsense_offl_context_t;
/** Gesture One Finger Edge Swipe context structure */
typedef struct
{
uint32_t touchStartTime1; /**< Touchdown time */
cy_stc_capsense_gesture_position_t touchStartPosition1; /**< Touchdown position */
uint8_t state; /**< Gesture state */
uint8_t edge; /**< Detected edge */
} cy_stc_capsense_ofes_context_t;
/** Gesture Two Finger Zoom context structure */
typedef struct
{
cy_stc_capsense_gesture_position_t touchStartPosition1; /**< Touchdown position of the first touch */
cy_stc_capsense_gesture_position_t touchStartPosition2; /**< Touchdown position of the second touch */
uint16_t distanceX; /**< History of X-axis displacement */
uint16_t distanceY; /**< History of Y-axis displacement */
uint8_t state; /**< Gesture state */
uint8_t debounce; /**< Gesture debounce counter */
} cy_stc_capsense_tfzm_context_t;
/** Gesture One Finger Rotate context structure */
typedef struct
{
cy_stc_capsense_gesture_position_t touchStartPosition1; /**< Touchdown position */
uint8_t state; /**< Gesture state */
uint8_t history; /**< History of detected movements */
uint8_t debounce; /**< Gesture debounce counter */
} cy_stc_capsense_ofrt_context_t;
/** Gesture One Finger Long Press context structure */
typedef struct
{
uint32_t touchStartTime1; /**< Touchdown time */
cy_stc_capsense_gesture_position_t touchStartPosition1; /**< Touchdown position */
uint8_t state; /**< Gesture state */
} cy_stc_capsense_oflp_context_t;
/** Gesture global context structure */
typedef struct
{
cy_stc_capsense_gesture_position_t position1; /**< Current position of the first touch */
cy_stc_capsense_gesture_position_t positionLast1; /**< Previous position of the first touch */
cy_stc_capsense_gesture_position_t position2; /**< Current position of the second touch */
cy_stc_capsense_gesture_position_t positionLast2; /**< Previous position of the second touch */
uint32_t timestamp; /**< Current timestamp */
uint16_t detected; /**< Detected gesture mask */
uint16_t direction; /**< Mask of direction of detected gesture */
cy_stc_capsense_ofrt_context_t ofrtContext; /**< One-finger rotate gesture context */
cy_stc_capsense_ofsl_context_t ofslContext; /**< One-finger scroll gesture context */
cy_stc_capsense_tfzm_context_t tfzmContext; /**< Two-finger zoom gesture context */
cy_stc_capsense_tfsc_context_t tfscContext; /**< Two-finger single click gesture context */
cy_stc_capsense_ofes_context_t ofesContext; /**< One-finger edge swipe gesture context */
cy_stc_capsense_offl_context_t offlContext; /**< One-finger flick gesture context */
cy_stc_capsense_ofsc_context_t ofscContext; /**< One-finger single click gesture context */
cy_stc_capsense_ofdc_context_t ofdcContext; /**< One-finger double click gesture context */
cy_stc_capsense_ofcd_context_t ofcdContext; /**< One-finger click and drag gesture context */
cy_stc_capsense_tfsl_context_t tfslContext; /**< Two-finger scroll gesture context */
cy_stc_capsense_oflp_context_t oflpContext; /**< One-finger long press gesture context */
uint8_t numPosition; /**< Current number of touches */
uint8_t numPositionLast; /**< Previous number of touches */
} cy_stc_capsense_gesture_context_t;
/** \} */
/*******************************************************************************
* Function Prototypes
*******************************************************************************/
/******************************************************************************/
/** \cond SECTION_CAPSENSE_INTERNAL */
/** \addtogroup group_capsense_internal *//** \{ */
/******************************************************************************/
/*******************************************************************************
* Function Name: Cy_CapSense_Gesture_ResetState
****************************************************************************//**
*
* Initializes internal variables and states.
*
* \param context
* The pointer to the gesture context structure
* \ref cy_stc_capsense_gesture_context_t.
*
*******************************************************************************/
void Cy_CapSense_Gesture_ResetState(
cy_stc_capsense_gesture_context_t * context);
/*******************************************************************************
* Function Name: Cy_CapSense_Gesture_Decode
****************************************************************************//**
*
* Decodes all enabled gestures. This function is called each scanning cycle.
*
* \param timestamp
* Current timestamp.
*
* \param touchNumber
* The number of touches. Also this parameter defines the size of position array.
*
* \param position
* The pointer to the array of positions \ref cy_stc_capsense_gesture_position_t.
*
* \param config
* The pointer to the gesture configuration structure
* \ref cy_stc_capsense_gesture_config_t.
*
* \param context
* The pointer to the gesture context structure
* \ref cy_stc_capsense_gesture_context_t.
*
*******************************************************************************/
void Cy_CapSense_Gesture_Decode(
uint32_t timestamp,
uint32_t touchNumber,
const cy_stc_capsense_gesture_position_t * position,
const cy_stc_capsense_gesture_config_t * config,
cy_stc_capsense_gesture_context_t * context);
/** \} \endcond */
/*******************************************************************************
* Macros
*******************************************************************************/
/******************************************************************************/
/** \addtogroup group_capsense_macros_gesture *//** \{ */
/******************************************************************************/
/* Enable and Detection */
/** No gesture detected */
#define CY_CAPSENSE_GESTURE_NO_GESTURE (0x00u)
/** All gestures enable / detection mask */
#define CY_CAPSENSE_GESTURE_ALL_GESTURES_MASK (0x07FFu)
/** Gesture enable filtering mask */
#define CY_CAPSENSE_GESTURE_FILTERING_MASK (0x8000u)
/** Detection mask of Touchdown */
#define CY_CAPSENSE_GESTURE_TOUCHDOWN_MASK (0x2000u)
/** Detection mask of Lift Off */
#define CY_CAPSENSE_GESTURE_LIFTOFF_MASK (0x4000u)
/** Enable / detection mask of one-finger single click gesture */
#define CY_CAPSENSE_GESTURE_ONE_FNGR_SINGLE_CLICK_MASK (0x0001u)
/** Enable / detection mask of one-finger double click gesture */
#define CY_CAPSENSE_GESTURE_ONE_FNGR_DOUBLE_CLICK_MASK (0x0002u)
/** Enable / detection mask of one-finger click and drag gesture */
#define CY_CAPSENSE_GESTURE_ONE_FNGR_CLICK_DRAG_MASK (0x0004u)
/** Enable / detection mask of two-finger single click gesture */
#define CY_CAPSENSE_GESTURE_TWO_FNGR_SINGLE_CLICK_MASK (0x0008u)
/** Enable / detection mask of one-finger scroll gesture */
#define CY_CAPSENSE_GESTURE_ONE_FNGR_SCROLL_MASK (0x0010u)
/** Enable / detection mask of two-finger scroll gesture */
#define CY_CAPSENSE_GESTURE_TWO_FNGR_SCROLL_MASK (0x0020u)
/** Enable / detection mask of one-finger edge swipe gesture */
#define CY_CAPSENSE_GESTURE_ONE_FNGR_EDGE_SWIPE_MASK (0x0040u)
/** Enable / detection mask of one-finger flick gesture */
#define CY_CAPSENSE_GESTURE_ONE_FNGR_FLICK_MASK (0x0080u)
/** Enable / detection mask of one-finger rotate gesture */
#define CY_CAPSENSE_GESTURE_ONE_FNGR_ROTATE_MASK (0x0100u)
/** Enable / detection mask of two-finger zoom gesture */
#define CY_CAPSENSE_GESTURE_TWO_FNGR_ZOOM_MASK (0x0200u)
/** Enable / detection mask of one-finger long press gesture */
#define CY_CAPSENSE_GESTURE_ONE_FNGR_LONG_PRESS_MASK (0x0400u)
/* Direction Offsets */
/** Offset of direction of one-finger scroll gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_OFFSET_ONE_SCROLL (0x00u)
/** Offset of direction of two-finger scroll gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_OFFSET_TWO_SCROLL (0x02u)
/** Offset of direction of one-finger edge swipe gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_OFFSET_ONE_EDGE (0x04u)
/** Offset of direction of one-finger rotate gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_OFFSET_ONE_ROTATE (0x06u)
/** Offset of direction of two-finger zoom gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_OFFSET_TWO_ZOOM (0x07u)
/** Offset of direction of one-finger flick gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_OFFSET_ONE_FLICK (0x08u)
/* Direction Masks */
/** Mask of direction of one-finger scroll gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_MASK_ONE_SCROLL (0x0003u)
/** Mask of direction of two-finger scroll gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_MASK_TWO_SCROLL (0x000Cu)
/** Mask of direction of one-finger edge swipe gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_MASK_ONE_EDGE (0x0030u)
/** Mask of direction of one-finger rotate gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_MASK_ONE_ROTATE (0x0040u)
/** Mask of direction of two-finger zoom gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_MASK_TWO_ZOOM (0x0080u)
/** Mask of direction of one-finger flick gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_MASK_ONE_FLICK (0x0700u)
/** An extra direction offset returned by Cy_CapSense_DecodeWidgetGestures() */
#define CY_CAPSENSE_GESTURE_DIRECTION_OFFSET (16u)
/* Direction */
/** CLOCKWISE direction of Rotate gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_CW (0x00u)
/** COUNTER CLOCKWISE direction of Rotate gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_CCW (0x01u)
/** ZOOM-IN direction of Zoom gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_IN (0x00u)
/** ZOOM-OUT direction of Zoom gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_OUT (0x01u)
/** UP direction of Scroll, Flick and Edge Swipe gestures */
#define CY_CAPSENSE_GESTURE_DIRECTION_UP (0x00u)
/** DOWN direction of Scroll, Flick and Edge Swipe gestures */
#define CY_CAPSENSE_GESTURE_DIRECTION_DOWN (0x01u)
/** RIGHT direction of Scroll, Flick and Edge Swipe gestures */
#define CY_CAPSENSE_GESTURE_DIRECTION_RIGHT (0x02u)
/** LEFT direction of Scroll, Flick and Edge Swipe gestures */
#define CY_CAPSENSE_GESTURE_DIRECTION_LEFT (0x03u)
/** UP-RIGHT direction of Flick gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_UP_RIGHT (0x04u)
/** DOWN-LEFT direction of Flick gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_DOWN_LEFT (0x05u)
/** DOWN-RIGHT direction of Flick gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_DOWN_RIGHT (0x06u)
/** UP-LEFT direction of Flick gesture */
#define CY_CAPSENSE_GESTURE_DIRECTION_UP_LEFT (0x07u)
/** \} */
#if defined(__cplusplus)
}
#endif
#endif /* (defined(CY_IP_MXCSDV2) || defined(CY_IP_M0S8CSDV2) || defined(CY_IP_M0S8MSCV3) || defined(CY_IP_M0S8MSCV3LP)) */
#endif /* CY_CAPSENSE_GESTURE_LIB_H */
/* [] END OF FILE */