capwheel 2.0.0.0
capwheel.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 CAPWHEEL_H
36#define CAPWHEEL_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 CAPWHEEL_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56 cfg. clr = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57 cfg. rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
64#define CAPWHEEL_RETVAL uint8_t
65
66#define CAPWHEEL_OK 0x00
67#define CAPWHEEL_INIT_ERROR 0xFF
74#define CAPWHEEL_DEVICE_ADDR 0x64
81#define CAPWHEEL_DEVICE_INFO_REG 0x00
82#define CAPWHEEL_SYSTEM_FLAGS_REG 0x01
83#define CAPWHEEL_WHEEL_COORDNT_REG 0x02
84#define CAPWHEEL_TOUCH_BYTES_REG 0x03
85#define CAPWHEEL_COUNTS_REG 0x04
86#define CAPWHEEL_LTA_REG 0x05
87#define CAPWHEEL_MULTIPLIERS_REG 0x06
88#define CAPWHEEL_COMPENS_REG 0x07
89#define CAPWHEEL_PROXSETT_REG 0x08
90#define CAPWHEEL_THRESH_REG 0x09
91#define CAPWHEEL_TIMINGS_REG 0x0A
92#define CAPWHEEL_TARGETS_REG 0x0B
93#define CAPWHEEL_PWM_DUTY_REG 0x0C
94#define CAPWHEEL_PWM_LIM_REG 0x0D
95#define CAPWHEEL_ACTIVE_CHANN_REG 0x0E
96#define CAPWHEEL_BUZZER_REG 0x0F
103#define CAPWHEEL_DEV_INFO_NBYTES 2
104#define CAPWHEEL_SYST_FLAGS_NBYTES 1
105#define CAPWHEEL_WHEEL_NBYTES 4
106#define CAPWHEEL_TOUCH_NBYTES 2
107#define CAPWHEEL_COUNTS_NBYTES 18
108#define CAPWHEEL_LTA_NBYTES 18
109#define CAPWHEEL_MULTIPL_NBYTES 9
110#define CAPWHEEL_COMPENS_NBYTES 9
111#define CAPWHEEL_PROXSETT_NBYTES 6
112#define CAPWHEEL_THRESH_NBYTES 10
113#define CAPWHEEL_TIMINGS_NBYTES 13
114#define CAPWHEEL_TARGETS_NBYTES 10
115#define CAPWHEEL_PWM_DUTY_NBYTES 8
116#define CAPWHEEL_PWM_LIM_NBYTES 2
117#define CAPWHEEL_ACT_CHANN_NBYTES 2
118#define CAPWHEEL_BUZZER_NBYTES 1
125#define CAPWHEEL_BUZZER_EN 0x80
126#define CAPWHEEL_BUZZER_DC_HIGH 0x04
127#define CAPWHEEL_BUZZER_DC_LOW 0x00
128#define CAPWHEEL_BUZZER_PERM_EN 0x02
129#define CAPWHEEL_BUZZER_BURST_EN 0x01
136#define CAPWHEEL_CH0_PROX_EN 0x001
137#define CAPWHEEL_CH1_EN 0x002
138#define CAPWHEEL_CH2_EN 0x004
139#define CAPWHEEL_CH3_EN 0x008
140#define CAPWHEEL_CH4_EN 0x010
141#define CAPWHEEL_CH5_EN 0x020
142#define CAPWHEEL_CH6_EN 0x040
143#define CAPWHEEL_CH7_EN 0x080
144#define CAPWHEEL_CH8_EN 0x100
145#define CAPWHEEL_CH9_EN 0x200
152#define CAPWHEEL_PWM_OFF 0x00
153#define CAPWHEEL_PWM_CONST 0x20
154#define CAPWHEEL_PWM_DECR_0_PERCENTS 0x80
155#define CAPWHEEL_PWM_DECR_LIM 0xA0
156#define CAPWHEEL_PWM_INCR_100_PERCENTS 0xC0
157#define CAPWHEEL_PWM_INCR_LIM 0xE0
158#define CAPWHEEL_PWM_DUTY_0_PERCENTS 0x00
159#define CAPWHEEL_PWM_DUTY_25_PERCENTS 0x10
160#define CAPWHEEL_PWM_DUTY_50_PERCENTS 0x18
161#define CAPWHEEL_PWM_DUTY_75_PERCENTS 0x1C
162#define CAPWHEEL_PWM_DUTY_100_PERCENTS 0x1F
169#define CAPWHEEL_DATA_READY 0
170#define CAPWHEEL_DATA_NOT_READY 1
171#define CAPWHEEL_ADDR_ERROR 0xFF
172#define CAPWHEEL_NBYTES_ERROR 0xFE
173#define CAPWHEEL_CH_SEL_ERROR 0xFD
174#define CAPWHEEL_OK 0x00
181#define CAPWHEEL_LED_BRIGHTNESS_INTENSITY 0
182#define CAPWHEEL_LED_BRIGHTNESS_NUMBER 1 // End group macro
186// --------------------------------------------------------------- PUBLIC TYPES
195typedef struct
196{
197 // Output pins
198
199 digital_out_t clr;
200
201 // Input pins
202
203 digital_in_t rdy;
204
205 // Modules
206
207 i2c_master_t i2c;
208
209 // ctx variable
210
212
213} capwheel_t;
214
218typedef struct
219{
220 // Communication gpio pins
221
222 pin_name_t scl;
223 pin_name_t sda;
224
225 // Additional gpio pins
226
227 pin_name_t clr;
228 pin_name_t rdy;
229
230 // static variable
231
232 uint32_t i2c_speed;
233 uint8_t i2c_address;
234
236 // End types group
238// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
239
245#ifdef __cplusplus
246extern "C"{
247#endif
248
258
267
276
287void capwheel_generic_write ( capwheel_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
288
300void capwheel_generic_read ( capwheel_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
301
314uint8_t capwheel_write_reg ( capwheel_t *ctx, uint8_t register_address, uint8_t *data_in, uint8_t n_bytes );
315
328uint8_t capwheel_read_reg ( capwheel_t *ctx, uint8_t register_address, uint8_t *data_out, uint8_t n_bytes );
329
340
353uint8_t capwheel_enable_chann ( capwheel_t *ctx, uint16_t sel_chann );
354
363void capwheel_get_data ( capwheel_t *ctx, uint16_t *wheel_data );
364
376void capwheel_set_output( capwheel_t *ctx, uint16_t input_data, uint8_t output_mode );
377
387void capwheel_set_threshold ( capwheel_t *ctx, uint8_t thresh_value );
388
397
398#ifdef __cplusplus
399}
400#endif
401#endif // _CAPWHEEL_H_
402 // End public_function group
405
406// ------------------------------------------------------------------------- END
#define CAPWHEEL_RETVAL
Definition: capwheel.h:64
CAPWHEEL_RETVAL capwheel_init(capwheel_t *ctx, capwheel_cfg_t *cfg)
Initialization function.
void capwheel_generic_read(capwheel_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
void capwheel_default_cfg(capwheel_t *ctx)
Click Default Configuration function.
uint8_t capwheel_read_reg(capwheel_t *ctx, uint8_t register_address, uint8_t *data_out, uint8_t n_bytes)
Generic Read function.
uint8_t capwheel_enable_chann(capwheel_t *ctx, uint16_t sel_chann)
Channel Enable function.
uint8_t capwheel_check_data_ready(capwheel_t *ctx)
Data Ready Check function.
void capwheel_get_data(capwheel_t *ctx, uint16_t *wheel_data)
Data Get function.
void capwheel_reset(capwheel_t *ctx)
Reset function.
void capwheel_set_output(capwheel_t *ctx, uint16_t input_data, uint8_t output_mode)
Output Set function.
void capwheel_cfg_setup(capwheel_cfg_t *cfg)
Config Object Initialization function.
uint8_t capwheel_write_reg(capwheel_t *ctx, uint8_t register_address, uint8_t *data_in, uint8_t n_bytes)
Generic Write function.
void capwheel_generic_write(capwheel_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
void capwheel_set_threshold(capwheel_t *ctx, uint8_t thresh_value)
Threshold Set function.
Click configuration structure definition.
Definition: capwheel.h:219
pin_name_t clr
Definition: capwheel.h:227
uint32_t i2c_speed
Definition: capwheel.h:232
pin_name_t scl
Definition: capwheel.h:222
pin_name_t rdy
Definition: capwheel.h:228
pin_name_t sda
Definition: capwheel.h:223
uint8_t i2c_address
Definition: capwheel.h:233
Click ctx object definition.
Definition: capwheel.h:196
i2c_master_t i2c
Definition: capwheel.h:207
uint8_t slave_address
Definition: capwheel.h:211
digital_out_t clr
Definition: capwheel.h:199
digital_in_t rdy
Definition: capwheel.h:203