ft5x06.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021 Inria
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
 
#include "periph/gpio.h"
#include "periph/i2c.h"
 
#include "ft5x06_constants.h"
 
#ifdef MODULE_TOUCH_DEV
#include "touch_dev.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
    uint16_t x;                         
    uint16_t y;                         
} ft5x06_touch_position_t;

typedef enum {
    FT5X06_TOUCH_NO_GESTURE,            
    FT5X06_TOUCH_MOVE_UP,               
    FT5X06_TOUCH_MOVE_LEFT,             
    FT5X06_TOUCH_MOVE_DOWN,             
    FT5X06_TOUCH_MOVE_RIGHT,            
    FT5X06_TOUCH_ZOOM_IN,               
    FT5X06_TOUCH_ZOOM_OUT,              
} ft5x06_touch_gesture_t;

typedef enum {
    FT5X06_TYPE_FT5X06,                 
    FT5X06_TYPE_FT5606,                 
    FT5X06_TYPE_FT5X16,                 
    FT5X06_TYPE_FT6X06,                 
    FT5X06_TYPE_FT6X36,                 
    FT5X06_TYPE_FT5X06I,                
    FT5X06_TYPE_FT5336,                 
    FT5X06_TYPE_FT3316,                 
    FT5X06_TYPE_FT5436I,                
    FT5X06_TYPE_FT5336I,                
    FT5X06_TYPE_FT5X46,                 
} ft5x06_type_t;

typedef enum {
    FT5X06_NO_CONV  = 0x00, 
    FT5X06_MIRROR_X = 0x01, 
    FT5X06_MIRROR_Y = 0x02, 
    FT5X06_SWAP_XY  = 0x04, 
} ft5x06_touch_conv_t;

typedef void (*ft5x06_event_cb_t)(void *arg);

typedef struct {
    i2c_t i2c;                  
    uint8_t addr;               
    gpio_t int_pin;             
    uint16_t xmax;              
    uint16_t ymax;              
    ft5x06_touch_conv_t xyconv; 
    ft5x06_type_t type;         
} ft5x06_params_t;

typedef struct {
#ifdef MODULE_TOUCH_DEV
    touch_dev_t *dev;               
#endif
    const ft5x06_params_t *params;  
} ft5x06_t;

int ft5x06_init(ft5x06_t *dev, const ft5x06_params_t *params,
                ft5x06_event_cb_t cb, void *arg);

int ft5x06_read_touch_positions(const ft5x06_t *dev, ft5x06_touch_position_t *positions, size_t len);

int ft5x06_read_touch_count(const ft5x06_t *dev, uint8_t *count);

int ft5x06_read_touch_gesture(const ft5x06_t *dev, ft5x06_touch_gesture_t *gesture);
 
#ifdef __cplusplus
}
#endif