captouch6  2.1.0.0
captouch6.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef CAPTOUCH6_H
29 #define CAPTOUCH6_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 
58 #define CAPTOUCH6_MAP_MIKROBUS( cfg, mikrobus ) \
59  cfg.tout = MIKROBUS( mikrobus, MIKROBUS_AN ); \
60  cfg.pout = MIKROBUS( mikrobus, MIKROBUS_PWM );
61  // captouch6_map // captouch6
64 
69 typedef struct
70 {
71  digital_in_t tout;
72  digital_in_t pout;
74 } captouch6_t;
75 
80 typedef struct
81 {
82  pin_name_t tout;
83  pin_name_t pout;
86 
91 typedef enum
92 {
94  CAPTOUCH6_ERROR = -1
95 
97 
114 
129 
140 
151 
152 #ifdef __cplusplus
153 }
154 #endif
155 #endif // CAPTOUCH6_H
156  // captouch6
158 
159 // ------------------------------------------------------------------------ END
captouch6_cfg_setup
void captouch6_cfg_setup(captouch6_cfg_t *cfg)
Cap Touch 6 configuration object setup function.
CAPTOUCH6_OK
@ CAPTOUCH6_OK
Definition: captouch6.h:93
captouch6_cfg_t::tout
pin_name_t tout
Definition: captouch6.h:82
CAPTOUCH6_ERROR
@ CAPTOUCH6_ERROR
Definition: captouch6.h:94
captouch6_cfg_t::pout
pin_name_t pout
Definition: captouch6.h:83
captouch6_return_value_t
captouch6_return_value_t
Cap Touch 6 Click return value data.
Definition: captouch6.h:92
captouch6_t::tout
digital_in_t tout
Definition: captouch6.h:71
captouch6_t
Cap Touch 6 Click context object.
Definition: captouch6.h:70
captouch6_t::pout
digital_in_t pout
Definition: captouch6.h:72
captouch6_init
err_t captouch6_init(captouch6_t *ctx, captouch6_cfg_t *cfg)
Cap Touch 6 initialization function.
captouch6_cfg_t
Cap Touch 6 Click configuration object.
Definition: captouch6.h:81
captouch6_get_pout_pin
uint8_t captouch6_get_pout_pin(captouch6_t *ctx)
Cap Touch 6 get pout pin function.
captouch6_get_tout_pin
uint8_t captouch6_get_tout_pin(captouch6_t *ctx)
Cap Touch 6 get tout pin function.