tilt2
2.0.0.0
clicks
tilt2
lib
include
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
38
#include "drv_digital_out.h"
39
#include "drv_digital_in.h"
40
41
// -------------------------------------------------------------- PUBLIC MACROS
51
#define TILT2_MAP_MIKROBUS( cfg, mikrobus ) \
52
cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
53
59
#define TILT2_RETVAL uint8_t
60
61
#define TILT2_OK 0x00
62
#define TILT2_INIT_ERROR 0xFF
63
69
#define TILT2_TILT_DETECTION 0x01
70
#define TILT2_TILT_NO_DETECTION 0x00
71
// End group macro
74
// --------------------------------------------------------------- PUBLIC TYPES
83
typedef
struct
84
{
85
// Input pins
86
87
digital_in_t
int_pin
;
88
89
}
tilt2_t
;
90
94
typedef
struct
95
{
96
// Additional gpio pins
97
98
pin_name_t
int_pin
;
99
100
}
tilt2_cfg_t
;
101
// End types group
103
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
104
110
#ifdef __cplusplus
111
extern
"C"
{
112
#endif
113
122
void
tilt2_cfg_setup
(
tilt2_cfg_t
*cfg );
123
131
TILT2_RETVAL
tilt2_init
(
tilt2_t
*ctx,
tilt2_cfg_t
*cfg );
132
140
uint8_t
tilt2_tilt_detection
(
tilt2_t
*ctx );
141
142
#ifdef __cplusplus
143
}
144
#endif
145
#endif // _TILT2_H_
146
// End public_function group
149
150
// ------------------------------------------------------------------------- END
tilt2_t
Click ctx object definition.
Definition:
tilt2.h:83
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:98
tilt2_t::int_pin
digital_in_t int_pin
Definition:
tilt2.h:87
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:94
TILT2_RETVAL
#define TILT2_RETVAL
Definition:
tilt2.h:59
Generated by
1.8.16