boost11  2.1.0.0
boost11.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 BOOST11_H
29 #define BOOST11_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_analog_in.h"
48 
79 #define BOOST11_MAP_MIKROBUS( cfg, mikrobus ) \
80  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
81  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST )
82  // boost11_map // boost11
85 
90 typedef struct
91 {
92  digital_out_t en;
94  analog_in_t adc;
96  float vref;
98 } boost11_t;
99 
104 typedef struct
105 {
106  pin_name_t an;
107  pin_name_t en;
109  analog_in_resolution_t resolution;
110  float vref;
112 } boost11_cfg_t;
113 
118 typedef enum
119 {
121  BOOST11_ERROR = -1
122 
124 
141 
155 err_t boost11_init ( boost11_t *ctx, boost11_cfg_t *cfg );
156 
166 
176 
188 err_t boost11_read_an_pin_value ( boost11_t *ctx, uint16_t *data_out );
189 
203 err_t boost11_read_an_pin_voltage ( boost11_t *ctx, float *data_out );
204 
216 err_t boost11_set_vref ( boost11_t *ctx, float vref );
217 
218 #ifdef __cplusplus
219 }
220 #endif
221 #endif // BOOST11_H
222  // boost11
224 
225 // ------------------------------------------------------------------------ END
BOOST11_ERROR
@ BOOST11_ERROR
Definition: boost11.h:121
boost11_read_an_pin_value
err_t boost11_read_an_pin_value(boost11_t *ctx, uint16_t *data_out)
Boost 11 read AN pin value function.
boost11_cfg_t
Boost 11 Click configuration object.
Definition: boost11.h:105
boost11_cfg_t::resolution
analog_in_resolution_t resolution
Definition: boost11.h:109
boost11_cfg_t::an
pin_name_t an
Definition: boost11.h:106
boost11_cfg_setup
void boost11_cfg_setup(boost11_cfg_t *cfg)
Boost 11 configuration object setup function.
boost11_init
err_t boost11_init(boost11_t *ctx, boost11_cfg_t *cfg)
Boost 11 initialization function.
boost11_standby_mode
void boost11_standby_mode(boost11_t *ctx)
Boost 11 disable function.
boost11_return_value_t
boost11_return_value_t
Boost 11 Click return value data.
Definition: boost11.h:119
boost11_t::en
digital_out_t en
Definition: boost11.h:92
BOOST11_OK
@ BOOST11_OK
Definition: boost11.h:120
boost11_t::vref
float vref
Definition: boost11.h:96
boost11_set_vref
err_t boost11_set_vref(boost11_t *ctx, float vref)
Boost 11 set vref function.
boost11_read_an_pin_voltage
err_t boost11_read_an_pin_voltage(boost11_t *ctx, float *data_out)
Boost 11 read AN pin voltage level function.
boost11_t
Boost 11 Click context object.
Definition: boost11.h:91
boost11_cfg_t::en
pin_name_t en
Definition: boost11.h:107
boost11_cfg_t::vref
float vref
Definition: boost11.h:110
boost11_active_mode
void boost11_active_mode(boost11_t *ctx)
Boost 11 enable function.
boost11_t::adc
analog_in_t adc
Definition: boost11.h:94