capsense  2.0.0.0
capsense.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef CAPSENSE_H
36 #define CAPSENSE_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 CAPSENSE_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
57  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
58 
65 #define CAPSENSE_RETVAL uint8_t
66 
67 #define CAPSENSE_OK 0x00
68 #define CAPSENSE_INIT_ERROR 0xFF
69 
75 #define CAPSENSE_COMMAND_REG 0xA0
76 #define CAPSENSE_CS_ENABL0 0x06
77 #define CAPSENSE_CS_ENABL1 0x07
78 #define CAPSENSE_GPIO_ENABLE0 0x08
79 #define CAPSENSE_DM_STRONG0 0x11
80 #define CAPSENSE_CS_SLID_CONFIG 0x75
81 #define CAPSENSE_CS_SLID_MULM 0x77
82 #define CAPSENSE_CS_SLID_MULL 0x78
83 #define CAPSENSE_OUTPUT_PORT0 0x04
84 #define CAPSENSE_CS_READ_RAW 0x87
85 #define CAPSENSE_CS_READ_STATUS0 0x88
86 #define CAPSENSE_CS_READ_STATUS1 0x89
87 #define CAPSENSE_CS_READ_CEN_POSM 0x8A
88 #define CAPSENSE_CS_READ_CEN_POSL 0x8B
89 #define CAPSENSE_CS_READ_CEN_PEAKM 0x8C
90 #define CAPSENSE_CS_READ_CEN_PEAKL 0x8D
91 #define CAPSENSE_DEVICE_ID 0x7A
92 #define CAPSENSE_DEVICE_STATUS 0x7B
93 
99 #define CAPSENSE_I2C_ADDRESS_0 0x00
100 #define CAPSENSE_I2C_ADDRESS_1 0x4B
101  // End group macro
104 // --------------------------------------------------------------- PUBLIC TYPES
113 typedef struct
114 {
115  // Output pins
116 
117  digital_out_t an;
118 
119  // Input pins
120 
121  digital_in_t rst;
122 
123  // Modules
124 
125  i2c_master_t i2c;
126 
127  // ctx variable
128 
129  hal_i2c_address_t slave_address;
130 
131 } capsense_t;
132 
136 typedef struct
137 {
138  // Communication gpio pins
139 
140  pin_name_t scl;
141  pin_name_t sda;
142 
143  // Additional gpio pins
144 
145  pin_name_t an;
146  pin_name_t rst;
147 
148  // static variable
149 
150  hal_i2c_speed_t i2c_speed;
151  hal_i2c_address_t i2c_address;
152 
154  // End types group
156 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
157 
163 #ifdef __cplusplus
164 extern "C"{
165 #endif
166 
175 void capsense_cfg_setup ( capsense_cfg_t *cfg );
176 
185 
208 void capsense_default_cfg ( capsense_t *ctx );
209 
222 void capsense_generic_write ( capsense_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
223 
235 void capsense_generic_read ( capsense_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
236 
246 void capsense_write_data( capsense_t *ctx, uint8_t reg_address, uint8_t write_command );
247 
258 uint8_t capsense_read_data( capsense_t *ctx, uint8_t reg_address );
259 
270 uint16_t capsense_read_data_bytes( capsense_t *ctx, uint8_t reg_address );
271 
281 uint16_t capsense_get_slider_lvl( capsense_t *ctx );
282 
283 
284 #ifdef __cplusplus
285 }
286 #endif
287 #endif // _CAPSENSE_H_
288  // End public_function group
291 
292 // ------------------------------------------------------------------------- END
capsense_t::slave_address
hal_i2c_address_t slave_address
Definition: capsense.h:129
capsense_init
CAPSENSE_RETVAL capsense_init(capsense_t *ctx, capsense_cfg_t *cfg)
Initialization function.
capsense_cfg_t
Click configuration structure definition.
Definition: capsense.h:136
capsense_generic_read
void capsense_generic_read(capsense_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
capsense_cfg_t::scl
pin_name_t scl
Definition: capsense.h:140
capsense_write_data
void capsense_write_data(capsense_t *ctx, uint8_t reg_address, uint8_t write_command)
Generic write data function.
capsense_read_data_bytes
uint16_t capsense_read_data_bytes(capsense_t *ctx, uint8_t reg_address)
Read two bytes from register address.
capsense_read_data
uint8_t capsense_read_data(capsense_t *ctx, uint8_t reg_address)
Read one byte from register address.
capsense_default_cfg
void capsense_default_cfg(capsense_t *ctx)
Click Default Configuration function.
capsense_cfg_t::an
pin_name_t an
Definition: capsense.h:145
capsense_generic_write
void capsense_generic_write(capsense_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
capsense_cfg_t::rst
pin_name_t rst
Definition: capsense.h:146
capsense_cfg_t::sda
pin_name_t sda
Definition: capsense.h:141
capsense_t::rst
digital_in_t rst
Definition: capsense.h:121
capsense_cfg_setup
void capsense_cfg_setup(capsense_cfg_t *cfg)
Config Object Initialization function.
capsense_t::i2c
i2c_master_t i2c
Definition: capsense.h:125
capsense_t::an
digital_out_t an
Definition: capsense.h:117
capsense_cfg_t::i2c_speed
hal_i2c_speed_t i2c_speed
Definition: capsense.h:150
capsense_get_slider_lvl
uint16_t capsense_get_slider_lvl(capsense_t *ctx)
Function get slider level.
capsense_cfg_t::i2c_address
hal_i2c_address_t i2c_address
Definition: capsense.h:151
capsense_t
Click ctx object definition.
Definition: capsense.h:113
CAPSENSE_RETVAL
#define CAPSENSE_RETVAL
Definition: capsense.h:65