capslider2  2.0.0.0
capslider2.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 CAPSLIDER2_H
36 #define CAPSLIDER2_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 CAPSLIDER2_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
69  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
70  cfg. clr = MIKROBUS( mikrobus, MIKROBUS_RST ); \
71  cfg. rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
72 
78 #define CAPSLIDER2_RETVAL uint8_t
79 
80 #define CAPSLIDER2_OK 0x00
81 #define CAPSLIDER2_INIT_ERROR 0xFF
82 
88 #define CAPSLDR2_DEVICE_ADDR 0x64
89 
95 #define CAPSLDR2_DEVICE_INFO_REG 0x00
96 #define CAPSLDR2_SYSTEM_FLAGS_REG 0x01
97 #define CAPSLDR2_WHEEL_COORDNT_REG 0x02
98 #define CAPSLDR2_TOUCH_BYTES_REG 0x03
99 #define CAPSLDR2_COUNTS_REG 0x04
100 #define CAPSLDR2_LTA_REG 0x05
101 #define CAPSLDR2_MULTIPLIERS_REG 0x06
102 #define CAPSLDR2_COMPENS_REG 0x07
103 #define CAPSLDR2_PROXSETT_REG 0x08
104 #define CAPSLDR2_THRESH_REG 0x09
105 #define CAPSLDR2_TIMINGS_REG 0x0A
106 #define CAPSLDR2_TARGETS_REG 0x0B
107 #define CAPSLDR2_PWM_DUTY_REG 0x0C
108 #define CAPSLDR2_PWM_LIM_REG 0x0D
109 #define CAPSLDR2_ACTIVE_CHANN_REG 0x0E
110 #define CAPSLDR2_BUZZER_REG 0x0F
111 
117 #define CAPSLDR2_DEV_INFO_NBYTES 2
118 #define CAPSLDR2_SYST_FLAGS_NBYTES 1
119 #define CAPSLDR2_WHEEL_NBYTES 4
120 #define CAPSLDR2_TOUCH_NBYTES 2
121 #define CAPSLDR2_COUNTS_NBYTES 18
122 #define CAPSLDR2_LTA_NBYTES 18
123 #define CAPSLDR2_MULTIPL_NBYTES 10
124 #define CAPSLDR2_COMPENS_NBYTES 10
125 #define CAPSLDR2_PROXSETT_NBYTES 6
126 #define CAPSLDR2_THRESH_NBYTES 10
127 #define CAPSLDR2_TIMINGS_NBYTES 13
128 #define CAPSLDR2_TARGETS_NBYTES 10
129 #define CAPSLDR2_PWM_DUTY_NBYTES 8
130 #define CAPSLDR2_PWM_LIM_NBYTES 2
131 #define CAPSLDR2_ACT_CHANN_NBYTES 2
132 #define CAPSLDR2_BUZZER_NBYTES 1
133 
139 #define CAPSLDR2_BUZZER_EN 0x80
140 #define CAPSLDR2_BUZZER_DC_HIGH 0x04
141 #define CAPSLDR2_BUZZER_DC_LOW 0x00
142 #define CAPSLDR2_BUZZER_PERM_EN 0x02
143 #define CAPSLDR2_BUZZER_BURST_EN 0x01
144 
150 #define CAPSLDR2_CH0_PROX_EN 0x001
151 #define CAPSLDR2_CH1_EN 0x002
152 #define CAPSLDR2_CH2_EN 0x004
153 #define CAPSLDR2_CH3_EN 0x008
154 #define CAPSLDR2_CH4_EN 0x010
155 #define CAPSLDR2_CH5_EN 0x020
156 #define CAPSLDR2_CH6_EN 0x040
157 #define CAPSLDR2_CH7_EN 0x080
158 #define CAPSLDR2_CH8_EN 0x100
159 #define CAPSLDR2_CH9_EN 0x200
160 
166 #define CAPSLDR2_PWM_OFF 0x00
167 #define CAPSLDR2_PWM_CONST 0x20
168 #define CAPSLDR2_PWM_DECR_0_PERCENTS 0x80
169 #define CAPSLDR2_PWM_DECR_LIM 0xA0
170 #define CAPSLDR2_PWM_INCR_100_PERCENTS 0xC0
171 #define CAPSLDR2_PWM_INCR_LIM 0xE0
172 #define CAPSLDR2_PWM_DUTY_0_PERCENTS 0x00
173 #define CAPSLDR2_PWM_DUTY_25_PERCENTS 0x10
174 #define CAPSLDR2_PWM_DUTY_50_PERCENTS 0x18
175 #define CAPSLDR2_PWM_DUTY_75_PERCENTS 0x1C
176 #define CAPSLDR2_PWM_DUTY_100_PERCENTS 0x1F
177 
183 #define CAPSLDR2_DATA_READY 0
184 #define CAPSLDR2_DATA_NOT_READY 1
185 #define CAPSLDR2_INVALID_ADDR 0xFF
186 #define CAPSLDR2_INVALID_NBYTES 0xFE
187 #define CAPSLDR2_INVALID_CHANNEL 0xFD
188 #define CAPSLDR2_OK 0x00
189 
195 #define CAPSLDR2_LED_INTENSITY 0
196 #define CAPSLDR2_LED_NUMBER 1
197  // End group macro
202 // --------------------------------------------------------------- PUBLIC TYPES
211 typedef struct
212 {
213  // Output pins
214 
215  digital_out_t clr;
216 
217  // Input pins
218 
219  digital_in_t rdy;
220 
221  // Modules
222 
223  i2c_master_t i2c;
224 
225  // ctx variable
226 
227  uint8_t slave_address;
228 
229 } capslider2_t;
230 
234 typedef struct
235 {
236  // Communication gpio pins
237 
238  pin_name_t scl;
239  pin_name_t sda;
240 
241  // Additional gpio pins
242 
243  pin_name_t clr;
244  pin_name_t rdy;
245 
246  // static variable
247 
248  uint32_t i2c_speed;
249  uint8_t i2c_address;
250 
252  // End types group
254 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
255 
261 #ifdef __cplusplus
262 extern "C"{
263 #endif
264 
274 
283 
294 void capslider2_generic_write ( capslider2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
295 
307 void capslider2_generic_read ( capslider2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
308 
309 
322 uint8_t capsldr2_write_reg ( capslider2_t *ctx, uint8_t register_address, uint8_t *data_in, uint8_t n_bytes );
323 
336 uint8_t capsldr2_read_reg ( capslider2_t *ctx, uint8_t register_address, uint8_t *data_out, uint8_t n_bytes );
337 
348 
362 uint8_t capsldr2_enable_chann ( capslider2_t *ctx, uint16_t sel_chann );
363 
373 void capsldr2_get_data( capslider2_t *ctx, uint16_t *wheel_data1, uint16_t *wheel_data2 );
374 
387 void capsldr2_set_output ( capslider2_t *ctx, uint8_t input_data, uint8_t output_mode );
388 
398 void capsldr2_set_threshold ( capslider2_t *ctx, uint8_t thresh_value );
399 
408 
417 
418 #ifdef __cplusplus
419 }
420 #endif
421 #endif // _CAPSLIDER2_H_
422  // End public_function group
425 
426 // ------------------------------------------------------------------------- END
capslider2_generic_write
void capslider2_generic_write(capslider2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
capsldr2_write_reg
uint8_t capsldr2_write_reg(capslider2_t *ctx, uint8_t register_address, uint8_t *data_in, uint8_t n_bytes)
Generic Write function.
capslider2_cfg_t::clr
pin_name_t clr
Definition: capslider2.h:243
capsldr2_read_reg
uint8_t capsldr2_read_reg(capslider2_t *ctx, uint8_t register_address, uint8_t *data_out, uint8_t n_bytes)
Generic Read function.
capslider2_t::clr
digital_out_t clr
Definition: capslider2.h:215
capslider2_cfg_setup
void capslider2_cfg_setup(capslider2_cfg_t *cfg)
Config Object Initialization function.
capslider2_generic_read
void capslider2_generic_read(capslider2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
capslider2_t
Click ctx object definition.
Definition: capslider2.h:212
capsldr2_enable_chann
uint8_t capsldr2_enable_chann(capslider2_t *ctx, uint16_t sel_chann)
Channel Enable function.
capslider2_cfg_t
Click configuration structure definition.
Definition: capslider2.h:235
capslider2_cfg_t::scl
pin_name_t scl
Definition: capslider2.h:238
capslider2_cfg_t::i2c_address
uint8_t i2c_address
Definition: capslider2.h:249
capsldr2_reset
void capsldr2_reset(capslider2_t *ctx)
Reset function.
capslider2_t::i2c
i2c_master_t i2c
Definition: capslider2.h:223
capsldr2_set_output
void capsldr2_set_output(capslider2_t *ctx, uint8_t input_data, uint8_t output_mode)
Output Set function.
capslider2_cfg_t::sda
pin_name_t sda
Definition: capslider2.h:239
capsldr2_config
void capsldr2_config(capslider2_t *ctx)
Config function.
capslider2_init
CAPSLIDER2_RETVAL capslider2_init(capslider2_t *ctx, capslider2_cfg_t *cfg)
Initialization function.
capslider2_t::rdy
digital_in_t rdy
Definition: capslider2.h:219
capslider2_t::slave_address
uint8_t slave_address
Definition: capslider2.h:227
capsldr2_get_data
void capsldr2_get_data(capslider2_t *ctx, uint16_t *wheel_data1, uint16_t *wheel_data2)
Data Get function.
capsldr2_check_data_ready
uint8_t capsldr2_check_data_ready(capslider2_t *ctx)
Data Ready Check function.
capslider2_cfg_t::rdy
pin_name_t rdy
Definition: capslider2.h:244
capslider2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: capslider2.h:248
capsldr2_set_threshold
void capsldr2_set_threshold(capslider2_t *ctx, uint8_t thresh_value)
Threshold Set function.
CAPSLIDER2_RETVAL
#define CAPSLIDER2_RETVAL
Definition: capslider2.h:78