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 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define TOUCHKEY_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.b= MIKROBUS( mikrobus, MIKROBUS_AN ); \
63  cfg.a= MIKROBUS( mikrobus, MIKROBUS_RST ); \
64  cfg.c= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
65  cfg.d= MIKROBUS( mikrobus, MIKROBUS_INT )
66 
72 #define TOUCHKEY_RETVAL uint8_t
73 
74 #define TOUCHKEY_OK 0x00
75 #define TOUCHKEY_INIT_ERROR 0xFF
76  // End group macro
79 // --------------------------------------------------------------- PUBLIC TYPES
88 typedef struct
89 {
90  // Input pins
91 
92  digital_in_t b;
93  digital_in_t a;
94  digital_in_t c;
95  digital_in_t d;
96 
97 } touchkey_t;
98 
102 typedef struct
103 {
104  // Additional gpio pins
105 
106  pin_name_t b;
107  pin_name_t a;
108  pin_name_t c;
109  pin_name_t d;
110 
112  // End types group
114 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
115 
121 #ifdef __cplusplus
122 extern "C"{
123 #endif
124 
134 
143 
154 uint8_t touchkey_a ( touchkey_t *ctx );
155 
166 uint8_t touchkey_b ( touchkey_t *ctx );
167 
178 uint8_t touchkey_c ( touchkey_t *ctx );
179 
190 uint8_t touchkey_d ( touchkey_t *ctx );
191 
192 
193 #ifdef __cplusplus
194 }
195 #endif
196 #endif // _TOUCHKEY_H_
197  // End public_function group
200 
201 // ------------------------------------------------------------------------- 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:72
touchkey_t::a
digital_in_t a
Definition: touchkey.h:93
touchkey_t::b
digital_in_t b
Definition: touchkey.h:92
touchkey_t::c
digital_in_t c
Definition: touchkey.h:94
touchkey_cfg_t::b
pin_name_t b
Definition: touchkey.h:106
touchkey_cfg_t
Click configuration structure definition.
Definition: touchkey.h:103
touchkey_d
uint8_t touchkey_d(touchkey_t *ctx)
Taster D pressed function.
touchkey_t::d
digital_in_t d
Definition: touchkey.h:95
touchkey_cfg_t::a
pin_name_t a
Definition: touchkey.h:107
touchkey_cfg_t::c
pin_name_t c
Definition: touchkey.h:108
touchkey_cfg_setup
void touchkey_cfg_setup(touchkey_cfg_t *cfg)
Config Object Initialization function.
touchkey_t
Click ctx object definition.
Definition: touchkey.h:89
touchkey_cfg_t::d
pin_name_t d
Definition: touchkey.h:109
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.