touchkey  2.0.0.0
touchkey.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 TOUCHKEY_H
36 #define TOUCHKEY_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 TOUCHKEY_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.b= MIKROBUS( mikrobus, MIKROBUS_AN ); \
67  cfg.a= MIKROBUS( mikrobus, MIKROBUS_RST ); \
68  cfg.c= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
69  cfg.d= MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define TOUCHKEY_RETVAL uint8_t
77 
78 #define TOUCHKEY_OK 0x00
79 #define TOUCHKEY_INIT_ERROR 0xFF
80  // End group macro
83 // --------------------------------------------------------------- PUBLIC TYPES
92 typedef struct
93 {
94  // Input pins
95 
96  digital_in_t b;
97  digital_in_t a;
98  digital_in_t c;
99  digital_in_t d;
100 
101 } touchkey_t;
102 
106 typedef struct
107 {
108  // Additional gpio pins
109 
110  pin_name_t b;
111  pin_name_t a;
112  pin_name_t c;
113  pin_name_t d;
114 
116  // End types group
118 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
119 
125 #ifdef __cplusplus
126 extern "C"{
127 #endif
128 
138 
147 
158 uint8_t touchkey_a ( touchkey_t *ctx );
159 
170 uint8_t touchkey_b ( touchkey_t *ctx );
171 
182 uint8_t touchkey_c ( touchkey_t *ctx );
183 
194 uint8_t touchkey_d ( touchkey_t *ctx );
195 
196 
197 #ifdef __cplusplus
198 }
199 #endif
200 #endif // _TOUCHKEY_H_
201  // End public_function group
204 
205 // ------------------------------------------------------------------------- END
touchkey_c
uint8_t touchkey_c(touchkey_t *ctx)
Taster C pressed function.
touchkey_b
uint8_t touchkey_b(touchkey_t *ctx)
Taster B pressed function.
TOUCHKEY_RETVAL
#define TOUCHKEY_RETVAL
Definition: touchkey.h:76
touchkey_t::a
digital_in_t a
Definition: touchkey.h:97
touchkey_t::b
digital_in_t b
Definition: touchkey.h:96
touchkey_t::c
digital_in_t c
Definition: touchkey.h:98
touchkey_cfg_t::b
pin_name_t b
Definition: touchkey.h:110
touchkey_cfg_t
Click configuration structure definition.
Definition: touchkey.h:107
touchkey_d
uint8_t touchkey_d(touchkey_t *ctx)
Taster D pressed function.
touchkey_t::d
digital_in_t d
Definition: touchkey.h:99
touchkey_cfg_t::a
pin_name_t a
Definition: touchkey.h:111
touchkey_cfg_t::c
pin_name_t c
Definition: touchkey.h:112
touchkey_cfg_setup
void touchkey_cfg_setup(touchkey_cfg_t *cfg)
Config Object Initialization function.
touchkey_t
Click ctx object definition.
Definition: touchkey.h:93
touchkey_cfg_t::d
pin_name_t d
Definition: touchkey.h:113
touchkey_init
TOUCHKEY_RETVAL touchkey_init(touchkey_t *ctx, touchkey_cfg_t *cfg)
Initialization function.
touchkey_a
uint8_t touchkey_a(touchkey_t *ctx)
Taster A pressed function.