tamper2  2.0.0.0
tamper2.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 TAMPER2_H
36 #define TAMPER2_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define TAMPER2_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.ncl= MIKROBUS( mikrobus, MIKROBUS_AN ); \
63  cfg.nop= MIKROBUS( mikrobus, MIKROBUS_INT );
64 
70 #define TAMPER2_RETVAL uint8_t
71 
72 #define TAMPER2_OK 0x00
73 #define TAMPER2_INIT_ERROR 0xFF
74  // End group macro
77 // --------------------------------------------------------------- PUBLIC TYPES
86 typedef struct
87 {
88  // Input pins
89 
90  digital_in_t ncl;
91  digital_in_t nop;
92 
93 } tamper2_t;
94 
98 typedef struct
99 {
100  // Additional gpio pins
101 
102  pin_name_t ncl;
103  pin_name_t nop;
104 
105 } tamper2_cfg_t;
106  // End types group
108 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
109 
115 #ifdef __cplusplus
116 extern "C"{
117 #endif
118 
128 
137 
145 
153 
154 #ifdef __cplusplus
155 }
156 #endif
157 #endif // _TAMPER2_H_
158  // End public_function group
161 
162 // ------------------------------------------------------------------------- END
tamper2_get_on_state
uint8_t tamper2_get_on_state(tamper2_t *ctx)
Switch ON detect.
tamper2_cfg_t::ncl
pin_name_t ncl
Definition: tamper2.h:102
tamper2_t::nop
digital_in_t nop
Definition: tamper2.h:91
tamper2_t
Click ctx object definition.
Definition: tamper2.h:87
tamper2_cfg_t::nop
pin_name_t nop
Definition: tamper2.h:103
tamper2_get_off_state
uint8_t tamper2_get_off_state(tamper2_t *ctx)
Switch OFF detect.
tamper2_t::ncl
digital_in_t ncl
Definition: tamper2.h:90
TAMPER2_RETVAL
#define TAMPER2_RETVAL
Definition: tamper2.h:70
tamper2_init
TAMPER2_RETVAL tamper2_init(tamper2_t *ctx, tamper2_cfg_t *cfg)
Initialization function.
tamper2_cfg_setup
void tamper2_cfg_setup(tamper2_cfg_t *cfg)
Config Object Initialization function.
tamper2_cfg_t
Click configuration structure definition.
Definition: tamper2.h:99