analogkey.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * Permission is hereby granted, free of charge, to any person 
 * obtaining a copy of this software and associated documentation 
 * files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, 
 * publish, distribute, sublicense, and/or sell copies of the Software, 
 * and to permit persons to whom the Software is furnished to do so, 
 * subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be 
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE 
 * OR OTHER DEALINGS IN THE SOFTWARE. 
 */
 
#ifndef ANALOGKEY_H
#define ANALOGKEY_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
 
#define ANALOGKEY_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.an_pin  = MIKROBUS( mikrobus, MIKROBUS_AN )
 // End group macro
// --------------------------------------------------------------- PUBLIC TYPES
typedef enum
{
    ANALOGKEY_TOUCH_KEY_NONE,
    ANALOGKEY_TOUCH_KEY_1,
    ANALOGKEY_TOUCH_KEY_2,
    ANALOGKEY_TOUCH_KEY_3,
    ANALOGKEY_TOUCH_KEY_4,
    ANALOGKEY_TOUCH_KEY_5,
    ANALOGKEY_TOUCH_KEY_6
 
} analogkey_key_id_t;
 
typedef struct
{
    analog_in_t  adc;   
    float        vref;  
    float        vdiv;  
} analogkey_t;
 
typedef struct
{
    // Communication gpio pins
 
    pin_name_t  an_pin;                     
    // Static variable
 
    analog_in_resolution_t  resolution;     
    float  vref;                            
    float  vsel;                            
} analogkey_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void analogkey_cfg_setup ( analogkey_cfg_t *cfg );
 
err_t analogkey_init ( analogkey_t *ctx, analogkey_cfg_t *cfg );
 
uint16_t analogkey_generic_read ( analogkey_t *ctx );
 
float analogkey_read_voltage ( analogkey_t *ctx );
 
analogkey_key_id_t analogkey_get_key ( analogkey_t* ctx, float an_value );
 
#ifdef __cplusplus
}
#endif
#endif  // ANALOGKEY_H
 
 // End public_function group
 
// ------------------------------------------------------------------------ END