methane  2.0.0.0
methane.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 METHANE_H
29 #define METHANE_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 #include "drv_analog_in.h"
52 
67 #define METHANE_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );
69 
70  // methane_map // methane
73 
78 typedef struct
79 {
80  analog_in_t adc;
82 } methane_t;
83 
88 typedef struct
89 {
90  pin_name_t an;
92  analog_in_resolution_t resolution;
93  float vref;
96 
101 typedef enum
102 {
104  METHANE_ERROR = -1
105 
107 
124 
139 err_t methane_init ( methane_t *ctx, methane_cfg_t *cfg );
140 
153 err_t methane_read_an_pin_value ( methane_t *ctx, uint16_t *data_out );
154 
169 err_t methane_read_an_pin_voltage ( methane_t *ctx, float *data_out );
170 
171 #ifdef __cplusplus
172 }
173 #endif
174 #endif // METHANE_H
175  // methane
177 
178 // ------------------------------------------------------------------------ END
methane_cfg_setup
void methane_cfg_setup(methane_cfg_t *cfg)
Methane configuration object setup function.
methane_read_an_pin_value
err_t methane_read_an_pin_value(methane_t *ctx, uint16_t *data_out)
Methane read AN pin value function.
METHANE_ERROR
@ METHANE_ERROR
Definition: methane.h:104
methane_return_value_t
methane_return_value_t
Methane Click return value data.
Definition: methane.h:102
methane_cfg_t::resolution
analog_in_resolution_t resolution
Definition: methane.h:92
METHANE_OK
@ METHANE_OK
Definition: methane.h:103
methane_t::adc
analog_in_t adc
Definition: methane.h:80
methane_cfg_t::an
pin_name_t an
Definition: methane.h:90
methane_t
Methane Click context object.
Definition: methane.h:79
methane_cfg_t::vref
float vref
Definition: methane.h:93
methane_init
err_t methane_init(methane_t *ctx, methane_cfg_t *cfg)
Methane initialization function.
methane_read_an_pin_voltage
err_t methane_read_an_pin_voltage(methane_t *ctx, float *data_out)
Methane read AN pin voltage level function.
methane_cfg_t
Methane Click configuration object.
Definition: methane.h:89