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
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 
68 #define TILT3_SWITCH_OFF 0
69 #define TILT3_SWITCH_ON 1
70 
71  // tilt3_set
73 
88 #define TILT3_MAP_MIKROBUS( cfg, mikrobus ) \
89  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
90  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
91  // tilt3_map // tilt3
94 
99 typedef struct
100 {
101  digital_out_t en;
102  digital_in_t int_pin;
104 } tilt3_t;
105 
110 typedef struct
111 {
112  pin_name_t en;
113  pin_name_t int_pin;
115 } tilt3_cfg_t;
116 
121 typedef enum
122 {
123  TILT3_OK = 0,
124  TILT3_ERROR = -1
125 
127 
144 
159 err_t tilt3_init ( tilt3_t *ctx, tilt3_cfg_t *cfg );
160 
170 
180 
191 
192 #ifdef __cplusplus
193 }
194 #endif
195 #endif // TILT3_H
196  // tilt3
198 
199 // ------------------------------------------------------------------------ END
tilt3_cfg_t::en
pin_name_t en
Definition: tilt3.h:112
tilt3_init
err_t tilt3_init(tilt3_t *ctx, tilt3_cfg_t *cfg)
Tilt 3 initialization function.
tilt3_enable_switch
void tilt3_enable_switch(tilt3_t *ctx)
Tilt 3 enable switch function.
tilt3_t
Tilt 3 Click context object.
Definition: tilt3.h:100
tilt3_get_switch_state
uint8_t tilt3_get_switch_state(tilt3_t *ctx)
Tilt 3 get switch state function.
tilt3_cfg_t::int_pin
pin_name_t int_pin
Definition: tilt3.h:113
TILT3_ERROR
@ TILT3_ERROR
Definition: tilt3.h:124
tilt3_t::int_pin
digital_in_t int_pin
Definition: tilt3.h:102
TILT3_OK
@ TILT3_OK
Definition: tilt3.h:123
tilt3_return_value_t
tilt3_return_value_t
Tilt 3 Click return value data.
Definition: tilt3.h:122
tilt3_cfg_t
Tilt 3 Click configuration object.
Definition: tilt3.h:111
tilt3_t::en
digital_out_t en
Definition: tilt3.h:101
tilt3_disable_switch
void tilt3_disable_switch(tilt3_t *ctx)
Tilt 3 disable switch function.
tilt3_cfg_setup
void tilt3_cfg_setup(tilt3_cfg_t *cfg)
Tilt 3 configuration object setup function.