vibrasense  2.0.0.0
vibrasense.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 VIBRASENSE_H
36 #define VIBRASENSE_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define VIBRASENSE_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
53  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
54 
59 #define VIBRASENSE_RETVAL uint8_t
60 
61 #define VIBRASENSE_OK 0x00
62 #define VIBRASENSE_INIT_ERROR 0xFF
63 
69 #define VIBRASENSE_DISABLE 0
70 #define VIBRASENSE_ENABLE 1
71  // End group macro
74 // --------------------------------------------------------------- PUBLIC TYPES
83 typedef struct
84 {
85  // Output pins
86 
87  digital_out_t en;
88 
89  // Input pins
90 
91  digital_in_t int_pin;
92 
93 } vibrasense_t;
94 
98 typedef struct
99 {
100  // Additional gpio pins
101 
102  pin_name_t en;
103  pin_name_t int_pin;
104 
106  // End types group
108 // ------------------------------------------------------------------ CONSTANTS // End constants group
117 // ------------------------------------------------------------------ VARIABLES // End variable group
125 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
126 
132 #ifdef __cplusplus
133 extern "C"{
134 #endif
135 
136 
146 
155 
166 void vibrasense_set_mode ( vibrasense_t *ctx, uint8_t en_mode );
167 
177 
190 
191 #ifdef __cplusplus
192 }
193 #endif
194 #endif // _VIBRASENSE_H_
195  // End public_function group
198 
199 // ------------------------------------------------------------------------- END
vibrasense_set_mode
void vibrasense_set_mode(vibrasense_t *ctx, uint8_t en_mode)
Set vibra sense mode function.
vibrasense_cfg_setup
void vibrasense_cfg_setup(vibrasense_cfg_t *cfg)
Config Object Initialization function.
vibrasense_cfg_t::int_pin
pin_name_t int_pin
Definition: vibrasense.h:103
VIBRASENSE_RETVAL
#define VIBRASENSE_RETVAL
Definition: vibrasense.h:59
vibrasense_t::int_pin
digital_in_t int_pin
Definition: vibrasense.h:91
vibrasense_reset
void vibrasense_reset(vibrasense_t *ctx)
Reset vibra sense function.
vibrasense_t::en
digital_out_t en
Definition: vibrasense.h:87
vibrasense_cfg_t::en
pin_name_t en
Definition: vibrasense.h:102
vibrasense_t
Click ctx object definition.
Definition: vibrasense.h:84
vibrasense_cfg_t
Click configuration structure definition.
Definition: vibrasense.h:99
vibrasense_init
VIBRASENSE_RETVAL vibrasense_init(vibrasense_t *ctx, vibrasense_cfg_t *cfg)
Initialization function.
vibrasense_check_interrupt
uint8_t vibrasense_check_interrupt(vibrasense_t *ctx)
Check interrupt function.