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 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define CAPWHEEL2_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
69  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
70  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
71 
77 #define CAPWHEEL2_RETVAL uint8_t
78 
79 #define CAPWHEEL2_OK 0x00
80 #define CAPWHEEL2_INIT_ERROR 0xFF
81 
87 #define CAPWHEEL2_DEVICE_ADDRESS 0x44
88 
94 #define CAPWHEEL2_DEVICE_INFO 0x00
95 #define CAPWHEEL2_SYS_FLAGS 0x01
96 #define CAPWHEEL2_COORDINATES 0x02
97 #define CAPWHEEL2_TOUCH_BYTES 0x03
98 #define CAPWHEEL2_COUNTS 0x04
99 #define CAPWHEEL2_LTA 0x05
100 #define CAPWHEEL2_DELTAS 0x06
101 #define CAPWHEEL2_MULTIPLIERS 0x07
102 #define CAPWHEEL2_COMPENSATION 0x08
103 #define CAPWHEEL2_PROX_SETTINGS 0x09
104 #define CAPWHEEL2_THRESHOLDS 0x0A
105 #define CAPWHEEL2_TIMINGS_AND_TARGETS 0x0B
106 #define CAPWHEEL2_GESTURE_TIMERS 0x0C
107 #define CAPWHEEL2_ACTIVE_CHANNELS 0x0D
108 
114 #define CAPWHEEL2_TAP_MASK 0x20
115 #define CAPWHEEL2_TOUCH_MASK 0x02
116 #define CAPWHEEL2_PROX_MASK 0x01
117  // End group macro
120 // --------------------------------------------------------------- PUBLIC TYPES
129 typedef struct
130 {
131  // Input pins
132 
133  digital_in_t rdy;
134 
135  // Modules
136 
137  i2c_master_t i2c;
138 
139  // ctx variable
140 
141  uint8_t slave_address;
142 
143 } capwheel2_t;
144 
148 typedef struct
149 {
150  // Communication gpio pins
151 
152  pin_name_t scl;
153  pin_name_t sda;
154 
155  // Additional gpio pins
156 
157  pin_name_t rdy;
158 
159  // static variable
160 
161  uint32_t i2c_speed;
162  uint8_t i2c_address;
163 
165  // End types group
167 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
168 
174 #ifdef __cplusplus
175 extern "C"{
176 #endif
177 
187 
196 
206 
217 void capwheel2_i2c_write_no_wait ( capwheel2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
218 
230 void capwheel2_i2c_read_no_wait ( capwheel2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
231 
241 
251 
264 uint8_t capwheel2_i2c_read_wait ( capwheel2_t *ctx, uint8_t register_address, uint8_t * read_buffer, uint8_t n_bytes );
265 
278 uint8_t capwheel2_i2c_write_wait ( capwheel2_t *ctx, uint8_t register_address, uint8_t * register_values, uint8_t n_bytes );
279 
280 
281 #ifdef __cplusplus
282 }
283 #endif
284 #endif // _CAPWHEEL2_H_
285  // End public_function group
288 
289 // ------------------------------------------------------------------------- END
capwheel2_int_get
uint8_t capwheel2_int_get(capwheel2_t *ctx)
Getingg state of INT pin.
capwheel2_init
CAPWHEEL2_RETVAL capwheel2_init(capwheel2_t *ctx, capwheel2_cfg_t *cfg)
Initialization function.
capwheel2_default_cfg
uint8_t capwheel2_default_cfg(capwheel2_t *ctx)
Click Default Configuration function.
capwheel2_cfg_t
Click configuration structure definition.
Definition: capwheel2.h:149
capwheel2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: capwheel2.h:161
capwheel2_i2c_read_no_wait
void capwheel2_i2c_read_no_wait(capwheel2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Read function.
capwheel2_i2c_write_no_wait
void capwheel2_i2c_write_no_wait(capwheel2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Write function.
capwheel2_t
Click ctx object definition.
Definition: capwheel2.h:130
capwheel2_cfg_t::rdy
pin_name_t rdy
Definition: capwheel2.h:157
capwheel2_t::i2c
i2c_master_t i2c
Definition: capwheel2.h:137
capwheel2_wait_for_rdy
uint8_t capwheel2_wait_for_rdy(capwheel2_t *ctx)
Waiting for RDY (INT) pin.
CAPWHEEL2_RETVAL
#define CAPWHEEL2_RETVAL
Definition: capwheel2.h:77
capwheel2_t::slave_address
uint8_t slave_address
Definition: capwheel2.h:141
capwheel2_cfg_t::scl
pin_name_t scl
Definition: capwheel2.h:152
capwheel2_i2c_read_wait
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_cfg_t::i2c_address
uint8_t i2c_address
Definition: capwheel2.h:162
capwheel2_i2c_write_wait
uint8_t capwheel2_i2c_write_wait(capwheel2_t *ctx, uint8_t register_address, uint8_t *register_values, uint8_t n_bytes)
Write wait function.
capwheel2_cfg_t::sda
pin_name_t sda
Definition: capwheel2.h:153
capwheel2_cfg_setup
void capwheel2_cfg_setup(capwheel2_cfg_t *cfg)
Config Object Initialization function.
capwheel2_t::rdy
digital_in_t rdy
Definition: capwheel2.h:133