current4  2.0.0.0
current4.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 CURRENT4_H
29 #define CURRENT4_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 
83 #define CURRENT4_MAP_MIKROBUS( cfg, mikrobus ) \
84  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );
85  // current4_map // current4
88 
93 typedef struct
94 {
95  analog_in_t adc;
96  float ic_vref;
99 } current4_t;
100 
105 typedef struct
106 {
107  pin_name_t an;
109  analog_in_resolution_t resolution;
110  float vref;
113 
118 typedef enum
119 {
121  CURRENT4_ERROR = -1
122 
124 
141 
157 
170 err_t current4_read_an_pin_value ( current4_t *ctx, uint16_t *data_out );
171 
186 err_t current4_read_an_pin_voltage ( current4_t *ctx, float *data_out );
187 
200 err_t current4_read_load_current ( current4_t *ctx, float *load_current );
201 
202 #ifdef __cplusplus
203 }
204 #endif
205 #endif // CURRENT4_H
206  // current4
208 
209 // ------------------------------------------------------------------------ END
CURRENT4_OK
@ CURRENT4_OK
Definition: current4.h:120
current4_return_value_t
current4_return_value_t
Current 4 Click return value data.
Definition: current4.h:119
current4_t::adc
analog_in_t adc
Definition: current4.h:95
current4_cfg_t::an
pin_name_t an
Definition: current4.h:107
current4_cfg_t
Current 4 Click configuration object.
Definition: current4.h:106
current4_init
err_t current4_init(current4_t *ctx, current4_cfg_t *cfg)
Current 4 initialization function.
current4_cfg_t::resolution
analog_in_resolution_t resolution
Definition: current4.h:109
current4_read_an_pin_voltage
err_t current4_read_an_pin_voltage(current4_t *ctx, float *data_out)
Read AN pin voltage level function.
CURRENT4_ERROR
@ CURRENT4_ERROR
Definition: current4.h:121
current4_read_load_current
err_t current4_read_load_current(current4_t *ctx, float *load_current)
Read load current.
current4_cfg_setup
void current4_cfg_setup(current4_cfg_t *cfg)
Current 4 configuration object setup function.
current4_cfg_t::vref
float vref
Definition: current4.h:110
current4_read_an_pin_value
err_t current4_read_an_pin_value(current4_t *ctx, uint16_t *data_out)
Read AN pin value function.
current4_t::ic_vref
float ic_vref
Definition: current4.h:96
current4_t
Current 4 Click context object.
Definition: current4.h:94