captouch4  2.1.0.0
Data Structures | Macros | Enumerations | Functions
captouch4.h File Reference

This file contains API for Cap Touch 4 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  captouch4_t
 Cap Touch 4 Click context object. More...
 
struct  captouch4_cfg_t
 Cap Touch 4 Click configuration object. More...
 

Macros

#define CAPTOUCH4_REG_PRODUCT_NUM   0x00
 Cap Touch 4 register list. More...
 
#define CAPTOUCH4_REG_VERSION_NUM   0x01
 
#define CAPTOUCH4_REG_SYSFLAGS0   0x10
 
#define CAPTOUCH4_REG_MOVEMENT_VALUE   0x41
 
#define CAPTOUCH4_REG_CS_H   0x42
 
#define CAPTOUCH4_REG_CS_L   0x43
 
#define CAPTOUCH4_REG_LTA_H   0x83
 
#define CAPTOUCH4_REG_LTA_L   0x84
 
#define CAPTOUCH4_REG_TOUCH_THRESHOLD_H   0x90
 
#define CAPTOUCH4_REG_TOUCH_THRESHOLD_L   0x91
 
#define CAPTOUCH4_REG_MULTIPLIERS   0xC4
 
#define CAPTOUCH4_REG_COMPENSATION   0xC5
 
#define CAPTOUCH4_REG_PROX_SETTINGS0   0xC6
 
#define CAPTOUCH4_REG_PROX_SETTINGS1   0xC7
 
#define CAPTOUCH4_REG_PROX_SETTINGS2   0xC8
 
#define CAPTOUCH4_REG_ATI_TARGET   0xC9
 
#define CAPTOUCH4_REG_LP_PERIOD   0xCA
 
#define CAPTOUCH4_REG_PROX_THRESHOLD   0xCB
 
#define CAPTOUCH4_REG_TOUCH_THRESHOLD   0xCC
 
#define CAPTOUCH4_REG_MOVEMENT_THRESHOLD   0xCD
 
#define CAPTOUCH4_REG_AUTO_RESEED_LIMIT   0xCE
 
#define CAPTOUCH4_REG_TEST_MODE   0x0F
 
#define CAPTOUCH4_REG_OTP_BANK_0   0x10
 
#define CAPTOUCH4_REG_OTP_BANK_1   0x11
 
#define CAPTOUCH4_REG_OTP_BANK_2   0x12
 
#define CAPTOUCH4_REG_OTP_BANK_3   0x13
 
#define CAPTOUCH4_REG_OTP_BANK_4   0x14
 
#define CAPTOUCH4_TEST_MODE_OK   0xA5
 Cap Touch 4 OTP test mode setting. More...
 
#define CAPTOUCH4_OTP_BANK_2_OUT_I2C_NO_WKP   0x05
 
#define CAPTOUCH4_SYSFLAGS0_MOVEMENT   0x80
 Cap Touch 4 SYSFLAGS0 register setting. More...
 
#define CAPTOUCH4_SYSFLAGS0_MOVEMENT_LATCH   0x40
 
#define CAPTOUCH4_SYSFLAGS0_PROX   0x20
 
#define CAPTOUCH4_SYSFLAGS0_TOUCH   0x10
 
#define CAPTOUCH4_SYSFLAGS0_SHOW_RESET   0x08
 
#define CAPTOUCH4_SYSFLAGS0_ATI_BUSY   0x04
 
#define CAPTOUCH4_SYSFLAGS0_FILTER_HALT   0x02
 
#define CAPTOUCH4_SYSFLAGS0_LP_ACTIVE   0x01
 
#define CAPTOUCH4_SYSFLAGS0_CLEAR   0x01
 
#define CAPTOUCH4_PRODUCT_NUMBER   0x3D
 Cap Touch 4 device ID setting. More...
 
#define CAPTOUCH4_VERSION_NUMBER   0x02
 
#define CAPTOUCH4_I2C_TIMEOUT   100000ul
 Cap Touch 4 I2C timeout setting. More...
 
#define CAPTOUCH4_DEVICE_ADDRESS   0x47
 Cap Touch 4 device address setting. More...
 
#define CAPTOUCH4_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  captouch4_return_value_t { CAPTOUCH4_OK = 0, CAPTOUCH4_ERROR = -1 }
 Cap Touch 4 Click return value data. More...
 

Functions

void captouch4_cfg_setup (captouch4_cfg_t *cfg)
 Cap Touch 4 configuration object setup function. More...
 
err_t captouch4_init (captouch4_t *ctx, captouch4_cfg_t *cfg)
 Cap Touch 4 initialization function. More...
 
err_t captouch4_default_cfg (captouch4_t *ctx)
 Cap Touch 4 default configuration function. More...
 
err_t captouch4_write_reg (captouch4_t *ctx, uint8_t reg, uint8_t data_in)
 Cap Touch 4 write reg function. More...
 
err_t captouch4_read_reg (captouch4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 Cap Touch 4 read reg function. More...
 
err_t captouch4_check_communication (captouch4_t *ctx)
 Cap Touch 4 check communication function. More...
 
void captouch4_enable_device (captouch4_t *ctx)
 Cap Touch 4 enable device function. More...
 
void captouch4_disable_device (captouch4_t *ctx)
 Cap Touch 4 disable device function. More...
 
err_t captouch4_read_system_flags (captouch4_t *ctx, uint8_t *sysflags)
 Cap Touch 4 read system flags function. More...
 
err_t captouch4_read_movement (captouch4_t *ctx, uint8_t *movement)
 Cap Touch 4 read movement function. More...
 
err_t captouch4_read_cap_counts (captouch4_t *ctx, uint16_t *cap_counts)
 Cap Touch 4 read cap counts function. More...
 
err_t captouch4_read_lta (captouch4_t *ctx, uint16_t *lta)
 Cap Touch 4 read lta function. More...
 

Detailed Description

This file contains API for Cap Touch 4 Click Driver.

Enumeration Type Documentation

◆ captouch4_return_value_t

Cap Touch 4 Click return value data.

Predefined enum values for driver return values.

Enumerator
CAPTOUCH4_OK 
CAPTOUCH4_ERROR