captouch  2.0.0.0
captouch.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 CAPTOUCH_H
36 #define CAPTOUCH_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 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define CAPTOUCH_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.mod = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
67  cfg.out = MIKROBUS( mikrobus, MIKROBUS_INT );
68 
74 #define CAPTOUCH_RETVAL uint8_t
75 
76 #define CAPTOUCH_OK 0x00
77 #define CAPTOUCH_INIT_ERROR 0xFF
78 
84 #define CAPTOUCH_FAST_MODE 1
85 #define CAPTOUCH_LOW_POWER_MODE 0
86  // End group macro
89 // --------------------------------------------------------------- PUBLIC TYPES
98 typedef struct
99 {
100  // Output pins
101 
102  digital_out_t mod;
103 
104  // Input pins
105 
106  digital_in_t out;
107 
108 } captouch_t;
109 
113 typedef struct
114 {
115  // Additional gpio pins
116 
117  pin_name_t mod;
118  pin_name_t out;
119 
121  // End types group
123 
124 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
125 
131 #ifdef __cplusplus
132 extern "C"{
133 #endif
134 
144 
153 
162 
169 void captouch_set_mode( captouch_t *ctx, uint8_t mode );
170 
178 
179 
180 #ifdef __cplusplus
181 }
182 #endif
183 #endif // _CAPTOUCH_H_
184  // End public_function group
187 
188 // ------------------------------------------------------------------------- END
CAPTOUCH_RETVAL
#define CAPTOUCH_RETVAL
Definition: captouch.h:74
captouch_t
Click ctx object definition.
Definition: captouch.h:99
captouch_cfg_t::out
pin_name_t out
Definition: captouch.h:118
captouch_t::out
digital_in_t out
Definition: captouch.h:106
captouch_cfg_t::mod
pin_name_t mod
Definition: captouch.h:117
captouch_cfg_t
Click configuration structure definition.
Definition: captouch.h:114
captouch_default_cfg
void captouch_default_cfg(captouch_t *ctx)
Click Default Configuration function.
captouch_init
CAPTOUCH_RETVAL captouch_init(captouch_t *ctx, captouch_cfg_t *cfg)
Initialization function.
captouch_set_mode
void captouch_set_mode(captouch_t *ctx, uint8_t mode)
Select mode.
captouch_cfg_setup
void captouch_cfg_setup(captouch_cfg_t *cfg)
Config Object Initialization function.
captouch_t::mod
digital_out_t mod
Definition: captouch.h:102
captouch_get_touch
uint8_t captouch_get_touch(captouch_t *ctx)
Get touch state.