mic  2.0.0.0
mic.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 
35 #ifndef MIC_H
36 #define MIC_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_analog_in.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
43 
53 #define MIC_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.an_pin = MIKROBUS( mikrobus, MIKROBUS_AN )
55 
61 #define MIC_RETVAL uint8_t
62 
63 #define MIC_OK 0x00
64 #define MIC_INIT_ERROR 0xFF
65  // End group macro
68 // --------------------------------------------------------------- PUBLIC TYPES
77 typedef uint16_t mic_data_t;
78 
82 typedef struct
83 {
84  // Modules
85 
86  analog_in_t adc;
87 
88 } mic_t;
89 
93 typedef struct
94 {
95  // Communication gpio pins
96 
97  pin_name_t an_pin;
98 
99  // static variable
100 
101  analog_in_resolution_t resolution; // Resolution
102  float vref; // VRef
103 
104 } mic_cfg_t;
105  // End types group
107 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
108 
114 #ifdef __cplusplus
115 extern "C"{
116 #endif
117 
126 void mic_cfg_setup ( mic_cfg_t *cfg );
127 
137 
145 void mic_default_cfg ( mic_t *ctx );
146 
156 
157 
158 #ifdef __cplusplus
159 }
160 #endif
161 #endif // _MIC_H_
162  // End public_function group
165 
166 // ------------------------------------------------------------------------ END
mic_cfg_t::vref
float vref
Definition: mic.h:102
mic_cfg_setup
void mic_cfg_setup(mic_cfg_t *cfg)
Config Object Initialization function.
mic_cfg_t::an_pin
pin_name_t an_pin
Definition: mic.h:97
mic_generic_read
mic_data_t mic_generic_read(mic_t *ctx)
Generic read function.
mic_cfg_t::resolution
analog_in_resolution_t resolution
Definition: mic.h:101
mic_t
Click ctx object definition.
Definition: mic.h:83
mic_cfg_t
Click configuration structure definition.
Definition: mic.h:94
mic_init
MIC_RETVAL mic_init(mic_t *ctx, mic_cfg_t *cfg)
Initialization function.
MIC_RETVAL
#define MIC_RETVAL
Definition: mic.h:61
mic_default_cfg
void mic_default_cfg(mic_t *ctx)
Click Default Configuration function.
mic_data_t
uint16_t mic_data_t
Analog data type.
Definition: mic.h:77
mic_t::adc
analog_in_t adc
Definition: mic.h:86