tilt3 2.0.0.0
tilt3.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2020 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
28#ifndef TILT3_H
29#define TILT3_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37
58#define TILT3_SWITCH_OFF 0
59#define TILT3_SWITCH_ON 1
60
61 // tilt3_set
63
78#define TILT3_MAP_MIKROBUS( cfg, mikrobus ) \
79 cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
80 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
81 // tilt3_map // tilt3
84
89typedef struct
90{
91 digital_out_t en;
92 digital_in_t int_pin;
94} tilt3_t;
95
100typedef struct
101{
102 pin_name_t en;
103 pin_name_t int_pin;
106
111typedef enum
112{
114 TILT3_ERROR = -1
115
117
134
149err_t tilt3_init ( tilt3_t *ctx, tilt3_cfg_t *cfg );
150
160
170
181
182#ifdef __cplusplus
183}
184#endif
185#endif // TILT3_H
186 // tilt3
188
189// ------------------------------------------------------------------------ END
uint8_t tilt3_get_switch_state(tilt3_t *ctx)
Tilt 3 get switch state function.
void tilt3_cfg_setup(tilt3_cfg_t *cfg)
Tilt 3 configuration object setup function.
err_t tilt3_init(tilt3_t *ctx, tilt3_cfg_t *cfg)
Tilt 3 initialization function.
void tilt3_enable_switch(tilt3_t *ctx)
Tilt 3 enable switch function.
void tilt3_disable_switch(tilt3_t *ctx)
Tilt 3 disable switch function.
Tilt 3 Click configuration object.
Definition: tilt3.h:101
pin_name_t en
Definition: tilt3.h:102
pin_name_t int_pin
Definition: tilt3.h:103
Tilt 3 Click context object.
Definition: tilt3.h:90
digital_in_t int_pin
Definition: tilt3.h:92
digital_out_t en
Definition: tilt3.h:91
tilt3_return_value_t
Tilt 3 Click return value data.
Definition: tilt3.h:112
@ TILT3_ERROR
Definition: tilt3.h:114
@ TILT3_OK
Definition: tilt3.h:113