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 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define CAPTOUCH_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.mod = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
53  cfg.out = MIKROBUS( mikrobus, MIKROBUS_INT );
54 
60 #define CAPTOUCH_RETVAL uint8_t
61 
62 #define CAPTOUCH_OK 0x00
63 #define CAPTOUCH_INIT_ERROR 0xFF
64 
70 #define CAPTOUCH_FAST_MODE 1
71 #define CAPTOUCH_LOW_POWER_MODE 0
72  // End group macro
75 // --------------------------------------------------------------- PUBLIC TYPES
84 typedef struct
85 {
86  // Output pins
87 
88  digital_out_t mod;
89 
90  // Input pins
91 
92  digital_in_t out;
93 
94 } captouch_t;
95 
99 typedef struct
100 {
101  // Additional gpio pins
102 
103  pin_name_t mod;
104  pin_name_t out;
105 
107  // End types group
109 
110 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
111 
117 #ifdef __cplusplus
118 extern "C"{
119 #endif
120 
129 void captouch_cfg_setup ( captouch_cfg_t *cfg );
130 
139 
147 void captouch_default_cfg ( captouch_t *ctx );
148 
155 void captouch_set_mode( captouch_t *ctx, uint8_t mode );
156 
163 uint8_t captouch_get_touch( captouch_t *ctx );
164 
165 
166 #ifdef __cplusplus
167 }
168 #endif
169 #endif // _CAPTOUCH_H_
170  // End public_function group
173 
174 // ------------------------------------------------------------------------- END
#define CAPTOUCH_RETVAL
Definition: captouch.h:60
void captouch_set_mode(captouch_t *ctx, uint8_t mode)
Select mode.
Click configuration structure definition.
Definition: captouch.h:99
void captouch_cfg_setup(captouch_cfg_t *cfg)
Config Object Initialization function.
pin_name_t out
Definition: captouch.h:104
pin_name_t mod
Definition: captouch.h:103
digital_in_t out
Definition: captouch.h:92
void captouch_default_cfg(captouch_t *ctx)
Click Default Configuration function.
Click ctx object definition.
Definition: captouch.h:84
CAPTOUCH_RETVAL captouch_init(captouch_t *ctx, captouch_cfg_t *cfg)
Initialization function.
uint8_t captouch_get_touch(captouch_t *ctx)
Get touch state.
digital_out_t mod
Definition: captouch.h:88