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 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define KEYLOCK_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.out1= MIKROBUS( mikrobus, MIKROBUS_AN ); \
53  cfg.out2= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
54  cfg.out3= MIKROBUS( mikrobus, MIKROBUS_INT );
55 
61 #define KEYLOCK_RETVAL uint8_t
62 
63 #define KEYLOCK_OK 0x00
64 #define KEYLOCK_INIT_ERROR 0xFF
65 
71 #define KEYLOCK_KEY_POS_1 1
72 #define KEYLOCK_KEY_POS_2 2
73 #define KEYLOCK_KEY_POS_3 3
74 
80 #define KEYLOCK_ERROR_FLAG 0
81  // End group macro
84 // --------------------------------------------------------------- PUBLIC TYPES
93 typedef struct
94 {
95  // Input pins
96 
97  digital_in_t out1;
98  digital_in_t out2;
99  digital_in_t out3;
100 
101 } keylock_t;
102 
106 typedef struct
107 {
108  // Additional gpio pins
109 
110  pin_name_t out1;
111  pin_name_t out2;
112  pin_name_t out3;
113 
114 } keylock_cfg_t;
115  // End types group
117 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
118 
124 #ifdef __cplusplus
125 extern "C"{
126 #endif
127 
136 void keylock_cfg_setup ( keylock_cfg_t *cfg );
137 
147 
164 uint8_t keylock_check_pin ( keylock_t *ctx, uint8_t pin );
165 
175 uint8_t keylock_get_position ( keylock_t *ctx );
176 
187 uint8_t keylock_check_an_state ( keylock_t *ctx );
188 
199 uint8_t keylock_check_pwm_state ( keylock_t *ctx );
200 
211 uint8_t keylock_check_int_state ( keylock_t *ctx );
212 
213 #ifdef __cplusplus
214 }
215 #endif
216 #endif // _KEYLOCK_H_
217  // End public_function group
220 
221 // ------------------------------------------------------------------------- END
keylock_t
Click ctx object definition.
Definition: keylock.h:93
keylock_t::out2
digital_in_t out2
Definition: keylock.h:98
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:99
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:97
KEYLOCK_RETVAL
#define KEYLOCK_RETVAL
Definition: keylock.h:61
keylock_cfg_t::out3
pin_name_t out3
Definition: keylock.h:112
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:110
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:111
keylock_cfg_t
Click configuration structure definition.
Definition: keylock.h:106