ambient7  2.0.0.0
ambient7.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 AMBIENT7_H
29 #define AMBIENT7_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 
73 #define AMBIENT7_MAP_MIKROBUS( cfg, mikrobus ) \
74  cfg.an_pin = MIKROBUS( mikrobus, MIKROBUS_AN );
75  // ambient7_map // ambient7
78 
83 typedef struct
84 {
85  analog_in_t adc;
87 } ambient7_t;
88 
93 typedef struct
94 {
95  pin_name_t an_pin;
97  analog_in_resolution_t resolution;
98  float vref;
101 
106 typedef enum
107 {
109  AMBIENT7_ERROR = -1
110 
112 
129 
144 
156 err_t ambient7_read_an_pin_value ( ambient7_t *ctx, uint16_t *data_out );
157 
171 err_t ambient7_read_an_pin_voltage ( ambient7_t *ctx, float *data_out );
172 
173 #ifdef __cplusplus
174 }
175 #endif
176 #endif // AMBIENT7_H
177  // ambient7
179 
180 // ------------------------------------------------------------------------ END
ambient7_cfg_t::an_pin
pin_name_t an_pin
Definition: ambient7.h:95
ambient7_cfg_t::resolution
analog_in_resolution_t resolution
Definition: ambient7.h:97
ambient7_cfg_t
Ambient 7 Click configuration object.
Definition: ambient7.h:94
ambient7_return_value_t
ambient7_return_value_t
Ambient 7 Click return value data.
Definition: ambient7.h:107
ambient7_cfg_setup
void ambient7_cfg_setup(ambient7_cfg_t *cfg)
Ambient 7 configuration object setup function.
AMBIENT7_OK
@ AMBIENT7_OK
Definition: ambient7.h:108
ambient7_t::adc
analog_in_t adc
Definition: ambient7.h:85
ambient7_cfg_t::vref
float vref
Definition: ambient7.h:98
ambient7_init
err_t ambient7_init(ambient7_t *ctx, ambient7_cfg_t *cfg)
Ambient 7 initialization function.
ambient7_t
Ambient 7 Click context object.
Definition: ambient7.h:84
ambient7_read_an_pin_value
err_t ambient7_read_an_pin_value(ambient7_t *ctx, uint16_t *data_out)
Ambient 7 read AN pin value function.
AMBIENT7_ERROR
@ AMBIENT7_ERROR
Definition: ambient7.h:109
ambient7_read_an_pin_voltage
err_t ambient7_read_an_pin_voltage(ambient7_t *ctx, float *data_out)
Ambient 7 read AN pin voltage level function.