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 
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 TAMPER2_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.ncl= MIKROBUS( mikrobus, MIKROBUS_AN ); \
67  cfg.nop= MIKROBUS( mikrobus, MIKROBUS_INT );
68 
74 #define TAMPER2_RETVAL uint8_t
75 
76 #define TAMPER2_OK 0x00
77 #define TAMPER2_INIT_ERROR 0xFF
78  // End group macro
81 // --------------------------------------------------------------- PUBLIC TYPES
90 typedef struct
91 {
92  // Input pins
93 
94  digital_in_t ncl;
95  digital_in_t nop;
96 
97 } tamper2_t;
98 
102 typedef struct
103 {
104  // Additional gpio pins
105 
106  pin_name_t ncl;
107  pin_name_t nop;
108 
109 } tamper2_cfg_t;
110  // End types group
112 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
113 
119 #ifdef __cplusplus
120 extern "C"{
121 #endif
122 
132 
141 
149 
157 
158 #ifdef __cplusplus
159 }
160 #endif
161 #endif // _TAMPER2_H_
162  // End public_function group
165 
166 // ------------------------------------------------------------------------- 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:106
tamper2_t::nop
digital_in_t nop
Definition: tamper2.h:95
tamper2_t
Click ctx object definition.
Definition: tamper2.h:91
tamper2_cfg_t::nop
pin_name_t nop
Definition: tamper2.h:107
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:94
TAMPER2_RETVAL
#define TAMPER2_RETVAL
Definition: tamper2.h:74
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:103