tamper  2.0.0.0
tamper.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 TAMPER_H
36 #define TAMPER_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define TAMPER_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
53 
59 #define TAMPER_RETVAL uint8_t
60 
61 #define TAMPER_OK 0x00
62 #define TAMPER_INIT_ERROR 0xFF
63  // End group macro
66 // --------------------------------------------------------------- PUBLIC TYPES
75 typedef struct
76 {
77  // Input pins
78 
79  digital_in_t int_pin;
80 
81 } tamper_t;
82 
86 typedef struct
87 {
88  // Additional gpio pins
89 
90  pin_name_t int_pin;
91 
92 } tamper_cfg_t;
93  // End types group
95 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
96 
102 #ifdef __cplusplus
103 extern "C"{
104 #endif
105 
114 void tamper_cfg_setup ( tamper_cfg_t *cfg );
115 
124 
138 uint8_t tamper_state ( tamper_t *ctx );
139 
140 #ifdef __cplusplus
141 }
142 #endif
143 #endif // _TAMPER_H_
144  // End public_function group
147 
148 // ------------------------------------------------------------------------- END
tamper_cfg_t::int_pin
pin_name_t int_pin
Definition: tamper.h:90
tamper_cfg_setup
void tamper_cfg_setup(tamper_cfg_t *cfg)
Config Object Initialization function.
tamper_t::int_pin
digital_in_t int_pin
Definition: tamper.h:79
TAMPER_RETVAL
#define TAMPER_RETVAL
Definition: tamper.h:59
tamper_cfg_t
Click configuration structure definition.
Definition: tamper.h:86
tamper_t
Click ctx object definition.
Definition: tamper.h:75
tamper_init
TAMPER_RETVAL tamper_init(tamper_t *ctx, tamper_cfg_t *cfg)
Initialization function.
tamper_state
uint8_t tamper_state(tamper_t *ctx)
Switch state detection function.