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 "drv_digital_out.h"
39#include "drv_digital_in.h"
40
41// -------------------------------------------------------------- PUBLIC MACROS
51#define TOUCHKEY_MAP_MIKROBUS( cfg, mikrobus ) \
52 cfg.b= MIKROBUS( mikrobus, MIKROBUS_AN ); \
53 cfg.a= MIKROBUS( mikrobus, MIKROBUS_RST ); \
54 cfg.c= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
55 cfg.d= MIKROBUS( mikrobus, MIKROBUS_INT )
62#define TOUCHKEY_RETVAL uint8_t
63
64#define TOUCHKEY_OK 0x00
65#define TOUCHKEY_INIT_ERROR 0xFF // End group macro
69// --------------------------------------------------------------- PUBLIC TYPES
78typedef struct
79{
80 // Input pins
81
82 digital_in_t b;
83 digital_in_t a;
84 digital_in_t c;
85 digital_in_t d;
86
88
92typedef struct
93{
94 // Additional gpio pins
95
96 pin_name_t b;
97 pin_name_t a;
98 pin_name_t c;
99 pin_name_t d;
100
102 // End types group
104// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
105
111#ifdef __cplusplus
112extern "C"{
113#endif
114
124
133
144uint8_t touchkey_a ( touchkey_t *ctx );
145
156uint8_t touchkey_b ( touchkey_t *ctx );
157
168uint8_t touchkey_c ( touchkey_t *ctx );
169
180uint8_t touchkey_d ( touchkey_t *ctx );
181
182
183#ifdef __cplusplus
184}
185#endif
186#endif // _TOUCHKEY_H_
187 // End public_function group
190
191// ------------------------------------------------------------------------- END
#define TOUCHKEY_RETVAL
Definition: touchkey.h:62
TOUCHKEY_RETVAL touchkey_init(touchkey_t *ctx, touchkey_cfg_t *cfg)
Initialization function.
uint8_t touchkey_b(touchkey_t *ctx)
Taster B pressed function.
uint8_t touchkey_c(touchkey_t *ctx)
Taster C pressed function.
uint8_t touchkey_d(touchkey_t *ctx)
Taster D pressed function.
void touchkey_cfg_setup(touchkey_cfg_t *cfg)
Config Object Initialization function.
uint8_t touchkey_a(touchkey_t *ctx)
Taster A pressed function.
Click configuration structure definition.
Definition: touchkey.h:93
pin_name_t b
Definition: touchkey.h:96
pin_name_t a
Definition: touchkey.h:97
pin_name_t d
Definition: touchkey.h:99
pin_name_t c
Definition: touchkey.h:98
Click ctx object definition.
Definition: touchkey.h:79
digital_in_t b
Definition: touchkey.h:82
digital_in_t c
Definition: touchkey.h:84
digital_in_t d
Definition: touchkey.h:85
digital_in_t a
Definition: touchkey.h:83