tp.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
 
#ifndef _TP_H_
#define _TP_H_
 
#include <stdint.h>
#include <stddef.h>
 
#define TP_N_TOUCHES_MAX  5
 
typedef enum
{
    TP_OK,                  
    TP_ERR_INIT_DRV,        
    TP_ERR_UNSUPPORTED_PIN, 
    TP_ERR_SIZE,            
    TP_ERR_PRESS_COORD,     
    TP_ERR_N_TOUCHES,       
    TP_ERR_N_DATA           
} tp_err_t;
 
typedef enum
{
    TP_EVENT_PRESS_DOWN,    
    TP_EVENT_PRESS_UP,      
    TP_EVENT_PRESS_MOVE,    
    TP_EVENT_PRESS_NOT_DET, 
    TP_EVENT_PRESS_DET,     
    TP_EVENT_GEST_NONE,     
    TP_EVENT_GEST_LEFT,     
    TP_EVENT_GEST_RIGHT,    
    TP_EVENT_GEST_UP,       
    TP_EVENT_GEST_DOWN,     
    TP_EVENT_GEST_ZOOM_IN,  
    TP_EVENT_GEST_ZOOM_OUT  
} tp_event_t;
 
typedef enum
{
    TP_TOUCH_ID_0,  
    TP_TOUCH_ID_1,  
    TP_TOUCH_ID_2,  
    TP_TOUCH_ID_3,  
    TP_TOUCH_ID_4,  
    TP_TOUCH_ID_5   
} tp_touch_id_t;
 
typedef enum
{
    TP_ROTATE_0,    
    TP_ROTATE_90,   
    TP_ROTATE_180,  
    TP_ROTATE_270   
} tp_rotate_t;
 
typedef uint16_t tp_coord_t;
 
typedef struct
{
    tp_coord_t     coord_x; 
    tp_coord_t     coord_y; 
    tp_event_t     event;   
    tp_touch_id_t  id;      
} tp_touch_coord_t;
 
typedef struct
{
    tp_touch_coord_t  point[ TP_N_TOUCHES_MAX ];    
    uint8_t           n_touches;                    
} tp_touch_item_t;
 
typedef tp_event_t ( * tp_press_det_t )( void * );
 
typedef void ( * tp_press_coord_t )( void *, tp_touch_item_t * );
 
typedef void ( * tp_gesture_t )( void *, tp_event_t * );
 
typedef tp_err_t ( * tp_process_t )( void * );
 
typedef void ( * tp_press_callback_t )( tp_event_t, tp_coord_t, tp_coord_t,
                                        tp_touch_id_t );
 
typedef void ( * tp_gesture_callback_t )( tp_event_t );
 
typedef struct
{
    tp_press_det_t    tp_press_detect_f;        
    tp_press_coord_t  tp_press_coordinates_f;   
    tp_gesture_t      tp_gesture_f;             
    tp_process_t      tp_process_f;             
} tp_drv_t;
 
typedef struct
{
    uint16_t     width;         
    uint16_t     height;        
    tp_rotate_t  start_pos;     
} tp_cfg_t;
 
typedef struct
{
    // Touch panel interface.
 
    tp_drv_t *       tp_drv;                    
    void *           tp_drv_ctx;                
    tp_press_callback_t   press_callback_f;     
    tp_gesture_callback_t gesture_callback_f;   
    // Touch panel size and orientation.
 
    uint16_t         width;                     
    uint16_t         height;                    
    uint16_t         coord_x_max;               
    uint16_t         coord_y_max;               
    tp_rotate_t      start_pos;                 
    uint8_t          curr_pos;                  
    tp_rotate_t      rotate;                    
    // Touch panel current and previous data.
 
    tp_touch_item_t  touch;                     
    tp_event_t       gesture;                   
    tp_touch_item_t  touch_prev;                
    tp_event_t       gesture_prev;              
    tp_touch_item_t  touch_prev_mirr;           
    uint8_t          release;                   
} tp_t;
 
#ifdef __cplusplus
extern "C"{
#endif
 
void
tp_cfg_setup( tp_cfg_t * cfg );
 
tp_err_t
tp_init( tp_t * ctx, tp_cfg_t * cfg, tp_drv_t * drv, void * drv_ctx );
 
void
tp_press_callback_setup( tp_t * ctx, tp_press_callback_t cb );
 
void
tp_gesture_callback_setup( tp_t * ctx, tp_gesture_callback_t cb );
 
void
tp_rotate( tp_t * ctx, tp_rotate_t rotate );
 
tp_rotate_t
tp_get_orientation( tp_t * ctx );
 
void
tp_get_size( tp_t * ctx, uint16_t * width, uint16_t * height );
 
tp_event_t
tp_press_detect( tp_t * ctx );
 
tp_err_t
tp_press_coordinates( tp_t * ctx, tp_touch_item_t * touch_item );
 
void
tp_gesture( tp_t * ctx, tp_event_t * event );
 
tp_err_t
tp_process( tp_t * ctx );
 
#ifdef __cplusplus
}
#endif
#endif // _TP_H_
 
 // tpgroup
 // apigroup
 
// ------------------------------------------------------------------------ END