lpg  2.0.0.0
lpg.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 LPG_H
29 #define LPG_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_analog_in.h"
50 
66 #define LPG_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
68 
69  // lpg_map // lpg
71 
76 typedef struct {
77 
78  // Modules
79 
80  analog_in_t adc;
82 } lpg_t;
83 
88 typedef struct {
89 
90  // Communication gpio pins
91 
92  pin_name_t an;
94  // static variable
95 
96  analog_in_resolution_t resolution;
97  float vref;
99 } lpg_cfg_t;
100 
105 typedef enum
106 {
107  LPG_OK = 0,
108  LPG_ERROR = -1
109 
111 
127 void lpg_cfg_setup ( lpg_cfg_t *cfg );
128 
143 err_t lpg_init ( lpg_t *ctx, lpg_cfg_t *cfg );
144 
157 err_t lpg_read_an_pin_value ( lpg_t *ctx, uint16_t *data_out );
158 
173 err_t lpg_read_an_pin_voltage ( lpg_t *ctx, float *data_out );
174 
175 #ifdef __cplusplus
176 }
177 #endif
178 #endif // LPG_H
179  // lpg
181 
182 // ------------------------------------------------------------------------ END
lpg_read_an_pin_voltage
err_t lpg_read_an_pin_voltage(lpg_t *ctx, float *data_out)
LPG read AN pin voltage level function.
lpg_cfg_t::an
pin_name_t an
Definition: lpg.h:92
lpg_cfg_setup
void lpg_cfg_setup(lpg_cfg_t *cfg)
LPG configuration object setup function.
LPG_ERROR
@ LPG_ERROR
Definition: lpg.h:108
lpg_cfg_t::vref
float vref
Definition: lpg.h:97
lpg_cfg_t
LPG Click configuration object.
Definition: lpg.h:88
lpg_cfg_t::resolution
analog_in_resolution_t resolution
Definition: lpg.h:96
LPG_OK
@ LPG_OK
Definition: lpg.h:107
lpg_t::adc
analog_in_t adc
Definition: lpg.h:80
lpg_return_value_t
lpg_return_value_t
LPG Click return value data.
Definition: lpg.h:106
lpg_read_an_pin_value
err_t lpg_read_an_pin_value(lpg_t *ctx, uint16_t *data_out)
LPG read AN pin value function.
lpg_init
err_t lpg_init(lpg_t *ctx, lpg_cfg_t *cfg)
LPG initialization function.
lpg_t
LPG Click context object.
Definition: lpg.h:76