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 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_analog_in.h"
38 
59 #define AMBIENT7_MAP_MIKROBUS( cfg, mikrobus ) \
60  cfg.an_pin = MIKROBUS( mikrobus, MIKROBUS_AN );
61  // ambient7_map // ambient7
64 
69 typedef struct
70 {
71  analog_in_t adc;
73 } ambient7_t;
74 
79 typedef struct
80 {
81  pin_name_t an_pin;
83  analog_in_resolution_t resolution;
84  float vref;
87 
92 typedef enum
93 {
95  AMBIENT7_ERROR = -1
96 
98 
115 
130 
142 err_t ambient7_read_an_pin_value ( ambient7_t *ctx, uint16_t *data_out );
143 
157 err_t ambient7_read_an_pin_voltage ( ambient7_t *ctx, float *data_out );
158 
159 #ifdef __cplusplus
160 }
161 #endif
162 #endif // AMBIENT7_H
163  // ambient7
165 
166 // ------------------------------------------------------------------------ END
ambient7_cfg_t::an_pin
pin_name_t an_pin
Definition: ambient7.h:81
ambient7_cfg_t::resolution
analog_in_resolution_t resolution
Definition: ambient7.h:83
ambient7_cfg_t
Ambient 7 Click configuration object.
Definition: ambient7.h:80
ambient7_return_value_t
ambient7_return_value_t
Ambient 7 Click return value data.
Definition: ambient7.h:93
ambient7_cfg_setup
void ambient7_cfg_setup(ambient7_cfg_t *cfg)
Ambient 7 configuration object setup function.
AMBIENT7_OK
@ AMBIENT7_OK
Definition: ambient7.h:94
ambient7_t::adc
analog_in_t adc
Definition: ambient7.h:71
ambient7_cfg_t::vref
float vref
Definition: ambient7.h:84
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:70
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:95
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.