keylock  2.0.0.0
keylock.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 KEYLOCK_H
36 #define KEYLOCK_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define KEYLOCK_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.out1= MIKROBUS( mikrobus, MIKROBUS_AN ); \
67  cfg.out2= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
68  cfg.out3= MIKROBUS( mikrobus, MIKROBUS_INT );
69 
75 #define KEYLOCK_RETVAL uint8_t
76 
77 #define KEYLOCK_OK 0x00
78 #define KEYLOCK_INIT_ERROR 0xFF
79 
85 #define KEYLOCK_KEY_POS_1 1
86 #define KEYLOCK_KEY_POS_2 2
87 #define KEYLOCK_KEY_POS_3 3
88 
94 #define KEYLOCK_ERROR_FLAG 0
95  // End group macro
98 // --------------------------------------------------------------- PUBLIC TYPES
107 typedef struct
108 {
109  // Input pins
110 
111  digital_in_t out1;
112  digital_in_t out2;
113  digital_in_t out3;
114 
115 } keylock_t;
116 
120 typedef struct
121 {
122  // Additional gpio pins
123 
124  pin_name_t out1;
125  pin_name_t out2;
126  pin_name_t out3;
127 
128 } keylock_cfg_t;
129  // End types group
131 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
132 
138 #ifdef __cplusplus
139 extern "C"{
140 #endif
141 
151 
161 
178 uint8_t keylock_check_pin ( keylock_t *ctx, uint8_t pin );
179 
190 
202 
214 
226 
227 #ifdef __cplusplus
228 }
229 #endif
230 #endif // _KEYLOCK_H_
231  // End public_function group
234 
235 // ------------------------------------------------------------------------- END
keylock_t
Click ctx object definition.
Definition: keylock.h:108
keylock_t::out2
digital_in_t out2
Definition: keylock.h:112
keylock_check_int_state
uint8_t keylock_check_int_state(keylock_t *ctx)
Checks INT pin state.
keylock_check_pwm_state
uint8_t keylock_check_pwm_state(keylock_t *ctx)
Checks PWM pin state.
keylock_check_pin
uint8_t keylock_check_pin(keylock_t *ctx, uint8_t pin)
Checks pin state.
keylock_t::out3
digital_in_t out3
Definition: keylock.h:113
keylock_cfg_setup
void keylock_cfg_setup(keylock_cfg_t *cfg)
Config Object Initialization function.
keylock_t::out1
digital_in_t out1
Definition: keylock.h:111
KEYLOCK_RETVAL
#define KEYLOCK_RETVAL
Definition: keylock.h:75
keylock_cfg_t::out3
pin_name_t out3
Definition: keylock.h:126
keylock_init
KEYLOCK_RETVAL keylock_init(keylock_t *ctx, keylock_cfg_t *cfg)
Initialization function.
keylock_cfg_t::out1
pin_name_t out1
Definition: keylock.h:124
keylock_get_position
uint8_t keylock_get_position(keylock_t *ctx)
Gets key position.
keylock_check_an_state
uint8_t keylock_check_an_state(keylock_t *ctx)
Checks AN pin state.
keylock_cfg_t::out2
pin_name_t out2
Definition: keylock.h:125
keylock_cfg_t
Click configuration structure definition.
Definition: keylock.h:121