lv_hal_indev.h

Go to the documentation of this file.

 
#ifndef LV_HAL_INDEV_H
#define LV_HAL_INDEV_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../lv_conf_internal.h"
 
#include <stdbool.h>
#include <stdint.h>
#include "../misc/lv_area.h"
#include "../misc/lv_timer.h"
 
/*********************
 *      DEFINES
 *********************/
 
/*Drag threshold in pixels*/
#define LV_INDEV_DEF_SCROLL_LIMIT         10
 
/*Drag throw slow-down in [%]. Greater value -> faster slow-down*/
#define LV_INDEV_DEF_SCROLL_THROW         10
 
/*Long press time in milliseconds.
 *Time to send `LV_EVENT_LONG_PRESSSED`)*/
#define LV_INDEV_DEF_LONG_PRESS_TIME      400
 
/*Repeated trigger period in long press [ms]
 *Time between `LV_EVENT_LONG_PRESSED_REPEAT*/
#define LV_INDEV_DEF_LONG_PRESS_REP_TIME  100
 
 
/*Gesture threshold in pixels*/
#define LV_INDEV_DEF_GESTURE_LIMIT        50
 
/*Gesture min velocity at release before swipe (pixels)*/
#define LV_INDEV_DEF_GESTURE_MIN_VELOCITY 3
 
 
/**********************
 *      TYPEDEFS
 **********************/
 
struct _lv_obj_t;
struct _lv_disp_t;
struct _lv_group_t;
struct _lv_indev_t;
struct _lv_indev_drv_t;
 
typedef enum {
    LV_INDEV_TYPE_NONE,    
    LV_INDEV_TYPE_POINTER, 
    LV_INDEV_TYPE_KEYPAD,  
    LV_INDEV_TYPE_BUTTON,  
    LV_INDEV_TYPE_ENCODER, 
} lv_indev_type_t;
 
typedef enum {
    LV_INDEV_STATE_RELEASED = 0,
    LV_INDEV_STATE_PRESSED
} lv_indev_state_t;
 
typedef struct {
    lv_point_t point; 
    uint32_t key;     
    uint32_t btn_id;  
    int16_t enc_diff; 
    lv_indev_state_t state; 
    bool continue_reading;  
} lv_indev_data_t;
 
typedef struct _lv_indev_drv_t {
 
    lv_indev_type_t type;
 
    void (*read_cb)(struct _lv_indev_drv_t * indev_drv, lv_indev_data_t * data);
 
    void (*feedback_cb)(struct _lv_indev_drv_t *, uint8_t);
 
#if LV_USE_USER_DATA
    void * user_data;
#endif
 
    struct _lv_disp_t * disp;
 
    lv_timer_t * read_timer;
 
    uint8_t scroll_limit;
 
    uint8_t scroll_throw;
 
    uint8_t gesture_min_velocity;
 
    uint8_t gesture_limit;
 
    uint16_t long_press_time;
 
    uint16_t long_press_repeat_time;
} lv_indev_drv_t;
 
typedef struct _lv_indev_proc_t {
    lv_indev_state_t state; 
    /*Flags*/
    uint8_t long_pr_sent : 1;
    uint8_t reset_query : 1;
    uint8_t disabled : 1;
    uint8_t wait_until_release : 1;
 
    union {
        struct {
            /*Pointer and button data*/
            lv_point_t act_point; 
            lv_point_t indev_point;
            lv_point_t last_point; 
            lv_point_t last_raw_point; 
            lv_point_t vect; 
            lv_point_t scroll_sum; /*Count the dragged pixels to check LV_INDEV_DEF_SCROLL_LIMIT*/
            lv_point_t scroll_throw_vect;
            lv_point_t scroll_throw_vect_ori;
            struct _lv_obj_t * act_obj;      /*The object being pressed*/
            struct _lv_obj_t * last_obj;     /*The last object which was pressed*/
            struct _lv_obj_t * scroll_obj;   /*The object being scrolled*/
            struct _lv_obj_t * last_pressed; /*The lastly pressed object*/
            lv_area_t scroll_area;
 
            lv_point_t gesture_sum; /*Count the gesture pixels to check LV_INDEV_DEF_GESTURE_LIMIT*/
            /*Flags*/
            lv_dir_t scroll_dir : 4;
            lv_dir_t gesture_dir : 4;
            uint8_t gesture_sent : 1;
        } pointer;
        struct {
            /*Keypad data*/
            lv_indev_state_t last_state;
            uint32_t last_key;
        } keypad;
    } types;
 
    uint32_t pr_timestamp;         
    uint32_t longpr_rep_timestamp; 
} _lv_indev_proc_t;
 
typedef struct _lv_indev_t {
    struct _lv_indev_drv_t * driver;
    _lv_indev_proc_t proc;
    struct _lv_obj_t * cursor;     
    struct _lv_group_t * group;    
    const lv_point_t * btn_points; 
} lv_indev_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
void lv_indev_drv_init(struct _lv_indev_drv_t * driver);
 
lv_indev_t * lv_indev_drv_register(struct _lv_indev_drv_t * driver);
 
void lv_indev_drv_update(lv_indev_t * indev, struct _lv_indev_drv_t * new_drv);
 
void lv_indev_delete(lv_indev_t * indev);
 
lv_indev_t * lv_indev_get_next(lv_indev_t * indev);
 
void _lv_indev_read(lv_indev_t * indev, lv_indev_data_t * data);
 
/**********************
 *      MACROS
 **********************/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif