tilt2  2.0.0.0
tilt2.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 TILT2_H
36 #define TILT2_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 TILT2_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
67 
73 #define TILT2_RETVAL uint8_t
74 
75 #define TILT2_OK 0x00
76 #define TILT2_INIT_ERROR 0xFF
77 
83 #define TILT2_TILT_DETECTION 0x01
84 #define TILT2_TILT_NO_DETECTION 0x00
85  // End group macro
88 // --------------------------------------------------------------- PUBLIC TYPES
97 typedef struct
98 {
99  // Input pins
100 
101  digital_in_t int_pin;
102 
103 } tilt2_t;
104 
108 typedef struct
109 {
110  // Additional gpio pins
111 
112  pin_name_t int_pin;
113 
114 } tilt2_cfg_t;
115  // End types group
117 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
118 
124 #ifdef __cplusplus
125 extern "C"{
126 #endif
127 
137 
146 
154 uint8_t tilt2_tilt_detection ( tilt2_t *ctx );
155 
156 #ifdef __cplusplus
157 }
158 #endif
159 #endif // _TILT2_H_
160  // End public_function group
163 
164 // ------------------------------------------------------------------------- END
tilt2_t
Click ctx object definition.
Definition: tilt2.h:98
tilt2_cfg_setup
void tilt2_cfg_setup(tilt2_cfg_t *cfg)
Config Object Initialization function.
tilt2_tilt_detection
uint8_t tilt2_tilt_detection(tilt2_t *ctx)
Tilt detection function.
tilt2_cfg_t::int_pin
pin_name_t int_pin
Definition: tilt2.h:112
tilt2_t::int_pin
digital_in_t int_pin
Definition: tilt2.h:101
tilt2_init
TILT2_RETVAL tilt2_init(tilt2_t *ctx, tilt2_cfg_t *cfg)
Initialization function.
tilt2_cfg_t
Click configuration structure definition.
Definition: tilt2.h:109
TILT2_RETVAL
#define TILT2_RETVAL
Definition: tilt2.h:73