tilt4  2.1.0.0
tilt4.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 TILT4_H
29 #define TILT4_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 
67 #define TILT4_PIN_STATE_HIGH 0x01
68 #define TILT4_PIN_STATE_LOW 0x00
69 
74 #define TILT4_SWITCH_OFF 0x00
75 #define TILT4_SWITCH_ON 0x01
76  // tilt4_set
78 
93 #define TILT4_MAP_MIKROBUS( cfg, mikrobus ) \
94  cfg.led = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
95  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
96  // tilt4_map // tilt4
99 
104 typedef struct
105 {
106  digital_out_t led;
108  digital_in_t int_pin;
110 } tilt4_t;
111 
116 typedef struct
117 {
118  pin_name_t led;
119  pin_name_t int_pin;
121 } tilt4_cfg_t;
122 
127 typedef enum
128 {
129  TILT4_OK = 0,
130  TILT4_ERROR = -1
131 
133 
150 
164 err_t tilt4_init ( tilt4_t *ctx, tilt4_cfg_t *cfg );
165 
176 uint8_t tilt4_read_int_state ( tilt4_t *ctx );
177 
188 void tilt4_set_led_state ( tilt4_t *ctx, uint8_t pin_state );
189 
190 #ifdef __cplusplus
191 }
192 #endif
193 #endif // TILT4_H
194  // tilt4
196 
197 // ------------------------------------------------------------------------ END
tilt4_cfg_t::led
pin_name_t led
Definition: tilt4.h:118
tilt4_return_value_t
tilt4_return_value_t
Tilt 4 Click return value data.
Definition: tilt4.h:128
tilt4_t
Tilt 4 Click context object.
Definition: tilt4.h:105
tilt4_read_int_state
uint8_t tilt4_read_int_state(tilt4_t *ctx)
Tilt 4 Interrupt pin reading function.
TILT4_ERROR
@ TILT4_ERROR
Definition: tilt4.h:130
tilt4_cfg_t::int_pin
pin_name_t int_pin
Definition: tilt4.h:119
tilt4_t::int_pin
digital_in_t int_pin
Definition: tilt4.h:108
tilt4_init
err_t tilt4_init(tilt4_t *ctx, tilt4_cfg_t *cfg)
Tilt 4 initialization function.
tilt4_set_led_state
void tilt4_set_led_state(tilt4_t *ctx, uint8_t pin_state)
Tilt 4 LED pin setting function.
tilt4_cfg_t
Tilt 4 Click configuration object.
Definition: tilt4.h:117
TILT4_OK
@ TILT4_OK
Definition: tilt4.h:129
tilt4_t::led
digital_out_t led
Definition: tilt4.h:106
tilt4_cfg_setup
void tilt4_cfg_setup(tilt4_cfg_t *cfg)
Tilt 4 configuration object setup function.