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 
35 #include "drv_digital_in.h"
36 #include "drv_analog_in.h"
37 
58 #define ALCOHOL_MAP_MIKROBUS( cfg, mikrobus ) \
59  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );
60  // alcohol_map // alcohol
63 
68 typedef struct {
69  analog_in_t adc;
71 } alcohol_t;
72 
77 typedef struct {
78  pin_name_t an;
81  analog_in_resolution_t resolution;
82  float vref;
85 
90 typedef enum {
92  ALCOHOL_ERROR = -1
93 
95 
111 void alcohol_cfg_setup ( alcohol_cfg_t *cfg );
112 
127 err_t alcohol_init ( alcohol_t *ctx, alcohol_cfg_t *cfg );
128 
141 err_t alcohol_read_an_pin_value ( alcohol_t *ctx, uint16_t *data_out );
142 
157 err_t alcohol_read_an_pin_voltage ( alcohol_t *ctx, float *data_out );
158 
159 #ifdef __cplusplus
160 }
161 #endif
162 #endif // ALCOHOL_H
163  // alcohol
165 
166 // ------------------------------------------------------------------------ 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:67
ALCOHOL_OK
Definition: alcohol.h:90
alcohol_cfg_setup
void alcohol_cfg_setup(alcohol_cfg_t *cfg)
Alcohol configuration object setup function.
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_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:89
ALCOHOL_ERROR
Definition: alcohol.h:91
alcohol_cfg_t
Alcohol Click configuration object.
Definition: alcohol.h:76