alcohol  2.0.0.0
alcohol.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 ALCOHOL_H
29 #define ALCOHOL_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_in.h"
50 #include "drv_analog_in.h"
51 
72 #define ALCOHOL_MAP_MIKROBUS( cfg, mikrobus ) \
73  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );
74  // alcohol_map // alcohol
77 
82 typedef struct {
83  analog_in_t adc;
85 } alcohol_t;
86 
91 typedef struct {
92  pin_name_t an;
95  analog_in_resolution_t resolution;
96  float vref;
99 
104 typedef enum {
106  ALCOHOL_ERROR = -1
107 
109 
126 
141 err_t alcohol_init ( alcohol_t *ctx, alcohol_cfg_t *cfg );
142 
155 err_t alcohol_read_an_pin_value ( alcohol_t *ctx, uint16_t *data_out );
156 
171 err_t alcohol_read_an_pin_voltage ( alcohol_t *ctx, float *data_out );
172 
173 #ifdef __cplusplus
174 }
175 #endif
176 #endif // ALCOHOL_H
177  // alcohol
179 
180 // ------------------------------------------------------------------------ END
alcohol_read_an_pin_voltage
err_t alcohol_read_an_pin_voltage(alcohol_t *ctx, float *data_out)
Alcohol read AN pin voltage level function.
alcohol_t
Alcohol Click context object.
Definition: alcohol.h:82
alcohol_cfg_t::vref
float vref
Definition: alcohol.h:96
ALCOHOL_OK
@ ALCOHOL_OK
Definition: alcohol.h:105
alcohol_cfg_setup
void alcohol_cfg_setup(alcohol_cfg_t *cfg)
Alcohol configuration object setup function.
alcohol_cfg_t::resolution
analog_in_resolution_t resolution
Definition: alcohol.h:95
alcohol_t::adc
analog_in_t adc
Definition: alcohol.h:83
alcohol_read_an_pin_value
err_t alcohol_read_an_pin_value(alcohol_t *ctx, uint16_t *data_out)
Alcohol read AN pin value function.
alcohol_cfg_t::an
pin_name_t an
Definition: alcohol.h:92
alcohol_init
err_t alcohol_init(alcohol_t *ctx, alcohol_cfg_t *cfg)
Alcohol initialization function.
alcohol_return_value_t
alcohol_return_value_t
Alcohol Click return value data.
Definition: alcohol.h:104
ALCOHOL_ERROR
@ ALCOHOL_ERROR
Definition: alcohol.h:106
alcohol_cfg_t
Alcohol Click configuration object.
Definition: alcohol.h:91