analogkey  2.0.0.0
analogkey.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 
35 #ifndef ANALOGKEY_H
36 #define ANALOGKEY_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_analog_in.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
43 
53 #define ANALOGKEY_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.an_pin = MIKROBUS( mikrobus, MIKROBUS_AN )
55  // End group macro
58 // --------------------------------------------------------------- PUBLIC TYPES
67 typedef enum
68 {
76 
78 
82 typedef struct
83 {
84  analog_in_t adc;
85  float vref;
86  float vdiv;
88 } analogkey_t;
89 
93 typedef struct
94 {
95  // Communication gpio pins
96 
97  pin_name_t an_pin;
99  // Static variable
100 
101  analog_in_resolution_t resolution;
102  float vref;
103  float vsel;
106  // End types group
108 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
114 #ifdef __cplusplus
115 extern "C"{
116 #endif
117 
127 
136 err_t analogkey_init ( analogkey_t *ctx, analogkey_cfg_t *cfg );
137 
146 uint16_t analogkey_generic_read ( analogkey_t *ctx );
147 
156 float analogkey_read_voltage ( analogkey_t *ctx );
157 
167 analogkey_key_id_t analogkey_get_key ( analogkey_t* ctx, float an_value );
168 
169 #ifdef __cplusplus
170 }
171 #endif
172 #endif // ANALOGKEY_H
173  // End public_function group
176 
177 // ------------------------------------------------------------------------ END
ANALOGKEY_TOUCH_KEY_3
Definition: analogkey.h:72
analogkey_t
Click ctx object definition.
Definition: analogkey.h:82
ANALOGKEY_TOUCH_KEY_4
Definition: analogkey.h:73
analogkey_read_voltage
float analogkey_read_voltage(analogkey_t *ctx)
Generic read function.
analogkey_key_id_t
analogkey_key_id_t
Click touch key definition.
Definition: analogkey.h:67
ANALOGKEY_TOUCH_KEY_1
Definition: analogkey.h:70
ANALOGKEY_TOUCH_KEY_6
Definition: analogkey.h:75
analogkey_t::adc
analog_in_t adc
Definition: analogkey.h:84
analogkey_cfg_t::an_pin
pin_name_t an_pin
Definition: analogkey.h:97
ANALOGKEY_TOUCH_KEY_NONE
Definition: analogkey.h:69
ANALOGKEY_TOUCH_KEY_2
Definition: analogkey.h:71
ANALOGKEY_TOUCH_KEY_5
Definition: analogkey.h:74
analogkey_cfg_t::vref
float vref
Definition: analogkey.h:102
analogkey_cfg_setup
void analogkey_cfg_setup(analogkey_cfg_t *cfg)
Config Object Initialization function.
analogkey_cfg_t::vsel
float vsel
Definition: analogkey.h:103
analogkey_init
err_t analogkey_init(analogkey_t *ctx, analogkey_cfg_t *cfg)
Initialization function.
analogkey_get_key
analogkey_key_id_t analogkey_get_key(analogkey_t *ctx, float an_value)
Detects which button is pressed.
analogkey_cfg_t::resolution
analog_in_resolution_t resolution
Definition: analogkey.h:101
analogkey_generic_read
uint16_t analogkey_generic_read(analogkey_t *ctx)
Generic read function.
analogkey_cfg_t
Click configuration structure definition.
Definition: analogkey.h:93
analogkey_t::vref
float vref
Definition: analogkey.h:85
analogkey_t::vdiv
float vdiv
Definition: analogkey.h:86