capwheel2 2.0.0.0
capwheel2.h
Go to the documentation of this file.
1/*
2 * MikroSDK - MikroE Software Development Kit
3 * Copyright© 2020 MikroElektronika d.o.o.
4 *
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation
7 * files (the "Software"), to deal in the Software without restriction,
8 * including without limitation the rights to use, copy, modify, merge,
9 * publish, distribute, sublicense, and/or sell copies of the Software,
10 * and to permit persons to whom the Software is furnished to do so,
11 * subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22 * OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
33// ----------------------------------------------------------------------------
34
35#ifndef CAPWHEEL2_H
36#define CAPWHEEL2_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_i2c_master.h"
41
42
43// -------------------------------------------------------------- PUBLIC MACROS
53#define CAPWHEEL2_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56 cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
63#define CAPWHEEL2_RETVAL uint8_t
64
65#define CAPWHEEL2_OK 0x00
66#define CAPWHEEL2_INIT_ERROR 0xFF
73#define CAPWHEEL2_DEVICE_ADDRESS 0x44
80#define CAPWHEEL2_DEVICE_INFO 0x00
81#define CAPWHEEL2_SYS_FLAGS 0x01
82#define CAPWHEEL2_COORDINATES 0x02
83#define CAPWHEEL2_TOUCH_BYTES 0x03
84#define CAPWHEEL2_COUNTS 0x04
85#define CAPWHEEL2_LTA 0x05
86#define CAPWHEEL2_DELTAS 0x06
87#define CAPWHEEL2_MULTIPLIERS 0x07
88#define CAPWHEEL2_COMPENSATION 0x08
89#define CAPWHEEL2_PROX_SETTINGS 0x09
90#define CAPWHEEL2_THRESHOLDS 0x0A
91#define CAPWHEEL2_TIMINGS_AND_TARGETS 0x0B
92#define CAPWHEEL2_GESTURE_TIMERS 0x0C
93#define CAPWHEEL2_ACTIVE_CHANNELS 0x0D
100#define CAPWHEEL2_TAP_MASK 0x20
101#define CAPWHEEL2_TOUCH_MASK 0x02
102#define CAPWHEEL2_PROX_MASK 0x01 // End group macro
106// --------------------------------------------------------------- PUBLIC TYPES
115typedef struct
116{
117 // Input pins
118
119 digital_in_t rdy;
120
121 // Modules
122
123 i2c_master_t i2c;
124
125 // ctx variable
126
128
130
134typedef struct
135{
136 // Communication gpio pins
137
138 pin_name_t scl;
139 pin_name_t sda;
140
141 // Additional gpio pins
142
143 pin_name_t rdy;
144
145 // static variable
146
147 uint32_t i2c_speed;
148 uint8_t i2c_address;
149
151 // End types group
153// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
154
160#ifdef __cplusplus
161extern "C"{
162#endif
163
173
182
192
203void capwheel2_i2c_write_no_wait ( capwheel2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
204
216void capwheel2_i2c_read_no_wait ( capwheel2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
217
227
237
250uint8_t capwheel2_i2c_read_wait ( capwheel2_t *ctx, uint8_t register_address, uint8_t * read_buffer, uint8_t n_bytes );
251
264uint8_t capwheel2_i2c_write_wait ( capwheel2_t *ctx, uint8_t register_address, uint8_t * register_values, uint8_t n_bytes );
265
266
267#ifdef __cplusplus
268}
269#endif
270#endif // _CAPWHEEL2_H_
271 // End public_function group
274
275// ------------------------------------------------------------------------- END
#define CAPWHEEL2_RETVAL
Definition: capwheel2.h:63
uint8_t capwheel2_default_cfg(capwheel2_t *ctx)
Click Default Configuration function.
void capwheel2_cfg_setup(capwheel2_cfg_t *cfg)
Config Object Initialization function.
uint8_t capwheel2_i2c_read_wait(capwheel2_t *ctx, uint8_t register_address, uint8_t *read_buffer, uint8_t n_bytes)
Read wait function.
CAPWHEEL2_RETVAL capwheel2_init(capwheel2_t *ctx, capwheel2_cfg_t *cfg)
Initialization function.
void capwheel2_i2c_write_no_wait(capwheel2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Write function.
uint8_t capwheel2_i2c_write_wait(capwheel2_t *ctx, uint8_t register_address, uint8_t *register_values, uint8_t n_bytes)
Write wait function.
uint8_t capwheel2_int_get(capwheel2_t *ctx)
Getingg state of INT pin.
void capwheel2_i2c_read_no_wait(capwheel2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Read function.
uint8_t capwheel2_wait_for_rdy(capwheel2_t *ctx)
Waiting for RDY (INT) pin.
Click configuration structure definition.
Definition: capwheel2.h:135
uint32_t i2c_speed
Definition: capwheel2.h:147
pin_name_t scl
Definition: capwheel2.h:138
pin_name_t rdy
Definition: capwheel2.h:143
pin_name_t sda
Definition: capwheel2.h:139
uint8_t i2c_address
Definition: capwheel2.h:148
Click ctx object definition.
Definition: capwheel2.h:116
i2c_master_t i2c
Definition: capwheel2.h:123
uint8_t slave_address
Definition: capwheel2.h:127
digital_in_t rdy
Definition: capwheel2.h:119