keylock.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 KEYLOCK_H
#define KEYLOCK_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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define KEYLOCK_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.out1= MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.out2= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.out3= MIKROBUS( mikrobus, MIKROBUS_INT );
#define KEYLOCK_RETVAL            uint8_t
 
#define KEYLOCK_OK                0x00
#define KEYLOCK_INIT_ERROR        0xFF
#define KEYLOCK_KEY_POS_1         1
#define KEYLOCK_KEY_POS_2         2
#define KEYLOCK_KEY_POS_3         3
#define KEYLOCK_ERROR_FLAG        0
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
 
    digital_in_t out1;
    digital_in_t out2;
    digital_in_t out3;
 
} keylock_t;
 
typedef struct
{
    // Additional gpio pins 
 
    pin_name_t out1;
    pin_name_t out2;
    pin_name_t out3;
 
} keylock_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void keylock_cfg_setup ( keylock_cfg_t *cfg );
 
KEYLOCK_RETVAL keylock_init ( keylock_t *ctx, keylock_cfg_t *cfg );
 
uint8_t keylock_check_pin ( keylock_t *ctx, uint8_t pin );
 
uint8_t keylock_get_position ( keylock_t *ctx );
 
uint8_t keylock_check_an_state ( keylock_t *ctx );
 
uint8_t keylock_check_pwm_state ( keylock_t *ctx );
 
uint8_t keylock_check_int_state ( keylock_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _KEYLOCK_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END