tp_mikroe.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_MIKROE_H_
#define _TP_MIKROE_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "drv_analog_in.h"
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "tp.h"
#include "gl.h"
#include "board.h"
 
#define VREF_VALUE 3.3f
 
#ifndef TP_MIKROE_CALIBRATION_XMIN
#define TP_MIKROE_CALIBRATION_XMIN 0
#endif
#ifndef TP_MIKROE_CALIBRATION_XMAX
#define TP_MIKROE_CALIBRATION_XMAX 0
#endif
 
#ifndef TP_MIKROE_CALIBRATION_YMIN
#define TP_MIKROE_CALIBRATION_YMIN 0
#endif
#ifndef TP_MIKROE_CALIBRATION_YMAX
#define TP_MIKROE_CALIBRATION_YMAX 0
#endif
 
#ifndef TP_MIKROE_PRESSURE_THRESHOLD_LOWER
#define TP_MIKROE_PRESSURE_THRESHOLD_LOWER 0
#endif
#ifndef TP_MIKROE_PRESSURE_THRESHOLD_UPPER
#define TP_MIKROE_PRESSURE_THRESHOLD_UPPER 0
#endif
 
#define TP_MIKROE_MAP_PINS( tp_mikroe_cfg ) \
    tp_mikroe_cfg.left = TP_MIKROE_XL;\
    tp_mikroe_cfg.right = TP_MIKROE_XR;\
    tp_mikroe_cfg.up = TP_MIKROE_YU;\
    tp_mikroe_cfg.down = TP_MIKROE_YD;
 
typedef struct {
    uint16_t min_x;
    uint16_t max_x;
    uint16_t min_y;
    uint16_t max_y;
} tp_mikroe_calibration_data_t;
 
typedef struct {
    uint16_t tp_mikroe_pressure_threshold_lower; 
    uint16_t tp_mikroe_pressure_threshold_upper; 
} tp_mikroe_pressure_threshold_t;
 
typedef struct {
    pin_name_t left;  
    pin_name_t right; 
    pin_name_t up;    
    pin_name_t down;  
    analog_in_config_t analog_in_cfg_read_x; 
    analog_in_config_t analog_in_cfg_read_y; 
    tp_mikroe_pressure_threshold_t pressure_threshold_level;
 
    uint16_t width;  
    uint16_t height; 
} tp_mikroe_cfg_t;
 
#define TP_MIKROE_ADC_CONFIG( cfg ) \
    cfg->analog_in_cfg_read_x.resolution = ANALOG_IN_RESOLUTION_CMAKE; \
    cfg->analog_in_cfg_read_y.resolution = ANALOG_IN_RESOLUTION_CMAKE; \
    cfg->analog_in_cfg_read_x.input_pin = TP_READ_X_CMAKE; \
    cfg->analog_in_cfg_read_y.input_pin = TP_READ_Y_CMAKE; \
    cfg->analog_in_cfg_read_x.vref_input = ANALOG_IN_VREF_CMAKE; \
    cfg->analog_in_cfg_read_y.vref_input = ANALOG_IN_VREF_CMAKE; \
    cfg->analog_in_cfg_read_x.vref_value = VREF_VALUE; \
    cfg->analog_in_cfg_read_y.vref_value = VREF_VALUE;
 
typedef struct {
    pin_name_t left;  
    pin_name_t right; 
    pin_name_t up;    
    pin_name_t down;  
    analog_in_t analog_in_x; 
    analog_in_t analog_in_y; 
    tp_event_t press_det;   
    tp_touch_coord_t touch; 
    tp_event_t gesture;     
    tp_rotate_t rotate;     
    bool pen_down; 
    tp_mikroe_pressure_threshold_t pressure_threshold_level;
 
    tp_mikroe_calibration_data_t calibration_data;
 
    uint16_t width;  
    uint16_t height; 
} tp_mikroe_t;
 
#define SET_PEN() \
    gl_set_pen( GL_WHITE, 4 );
 
#define DRAW_ARROW_TOP_LEFT() \
    gl_clear( GL_BLACK ); \
    gl_draw_line( 0, 0, 10, 0 ); \
    gl_draw_line( 0, 0, 0, 10 ); \
    gl_draw_line( 0, 0, 15, 15 );
 
#define DRAW_ARROW_TOP_RIGHT() \
    gl_clear( GL_BLACK ); \
    gl_draw_line( 320, 0, 320, 10 ); \
    gl_draw_line( 320, 0, 310, 0 ); \
    gl_draw_line( 320, 0, 305, 15 );
 
#define DRAW_ARROW_BOTTOM_LEFT() \
    gl_clear( GL_BLACK ); \
    gl_draw_line( 0, 240, 0, 230 ); \
    gl_draw_line( 0, 240, 10, 240 ); \
    gl_draw_line( 0, 240, 15, 225 );
 
#define DRAW_ARROW_BOTTOM_RIGHT() \
    gl_clear( GL_BLACK ); \
    gl_draw_line( 320, 240, 320, 230 ); \
    gl_draw_line( 320, 240, 310, 240 ); \
    gl_draw_line( 320, 240, 305, 225 );
 
tp_err_t tp_mikroe_process( tp_mikroe_t *ctx );
 
void tp_mikroe_gesture ( tp_mikroe_t *ctx, tp_event_t *event );
 
tp_event_t tp_mikroe_press_detect ( tp_mikroe_t *ctx );
 
void tp_mikroe_press_coordinates ( tp_mikroe_t *ctx, tp_touch_coord_t *touch_item );
 
void tp_mikroe_calibrate( tp_t *tp_instance );
 
void tp_mikroe_get_calibration_data ( tp_mikroe_t *ctx, tp_mikroe_calibration_data_t *cdata );
 
void tp_mikroe_set_calibration_data ( tp_mikroe_t *ctx, const tp_mikroe_calibration_data_t *cdata );
 
void tp_mikroe_set_pressure_threshold_level ( tp_mikroe_cfg_t *cfg, tp_mikroe_pressure_threshold_t pressure );
 
bool tp_mikroe_check_pressure ( tp_mikroe_t *ctx, uint16_t *x_pos, uint16_t *y_pos );
 
void tp_mikroe_set_threshold ( tp_mikroe_t *ctx, uint16_t threshold_upper, uint16_t threshold_lower );
 
void tp_mikroe_update_ctx_coords( tp_mikroe_t *ctx, uint16_t x_pos, uint16_t y_pos );
 
void tp_mikroe_calibrate_point ( tp_mikroe_t *ctx, bool calibration_points_uninitialized );
 
char tp_mikroe_pressure_level_detect ( tp_mikroe_t *ctx );
 
void tp_mikroe_cfg_setup( tp_mikroe_cfg_t *cfg );
 
tp_err_t tp_mikroe_init_tp( tp_mikroe_t *ctx, tp_mikroe_cfg_t *cfg , tp_drv_t *drv );
 
void tp_mikroe_default_cfg_adc( tp_mikroe_t *ctx );
 
 // tp_mikroe
 // mwgroup
 
#ifdef __cplusplus
}
#endif
 
#endif // _TP_MIKROE_H_
 
// ------------------------------------------------------------------------ END