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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_analog_in.h"
38
53#define METHANE_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );
55
56 // methane_map // methane
59
64typedef struct
65{
66 analog_in_t adc;
68} methane_t;
69
74typedef struct
75{
76 pin_name_t an;
78 analog_in_resolution_t resolution;
79 float vref;
82
87typedef enum
88{
90 METHANE_ERROR = -1
91
93
110
126
139err_t methane_read_an_pin_value ( methane_t *ctx, uint16_t *data_out );
140
155err_t methane_read_an_pin_voltage ( methane_t *ctx, float *data_out );
156
157#ifdef __cplusplus
158}
159#endif
160#endif // METHANE_H
161 // methane
163
164// ------------------------------------------------------------------------ END
err_t methane_read_an_pin_voltage(methane_t *ctx, float *data_out)
Methane read AN pin voltage level function.
err_t methane_init(methane_t *ctx, methane_cfg_t *cfg)
Methane initialization function.
void methane_cfg_setup(methane_cfg_t *cfg)
Methane configuration object setup function.
err_t methane_read_an_pin_value(methane_t *ctx, uint16_t *data_out)
Methane read AN pin value function.
methane_return_value_t
Methane Click return value data.
Definition: methane.h:88
@ METHANE_ERROR
Definition: methane.h:90
@ METHANE_OK
Definition: methane.h:89
Methane Click configuration object.
Definition: methane.h:75
analog_in_resolution_t resolution
Definition: methane.h:78
float vref
Definition: methane.h:79
pin_name_t an
Definition: methane.h:76
Methane Click context object.
Definition: methane.h:65
analog_in_t adc
Definition: methane.h:66