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 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_analog_in.h"
38 
69 #define CURRENT4_MAP_MIKROBUS( cfg, mikrobus ) \
70  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );
71  // current4_map // current4
74 
79 typedef struct
80 {
81  analog_in_t adc;
82  float ic_vref;
85 } current4_t;
86 
91 typedef struct
92 {
93  pin_name_t an;
95  analog_in_resolution_t resolution;
96  float vref;
99 
104 typedef enum
105 {
107  CURRENT4_ERROR = -1
108 
110 
126 void current4_cfg_setup ( current4_cfg_t *cfg );
127 
142 err_t current4_init ( current4_t *ctx, current4_cfg_t *cfg );
143 
156 err_t current4_read_an_pin_value ( current4_t *ctx, uint16_t *data_out );
157 
172 err_t current4_read_an_pin_voltage ( current4_t *ctx, float *data_out );
173 
186 err_t current4_read_load_current ( current4_t *ctx, float *load_current );
187 
188 #ifdef __cplusplus
189 }
190 #endif
191 #endif // CURRENT4_H
192  // current4
194 
195 // ------------------------------------------------------------------------ END
CURRENT4_OK
Definition: current4.h:105
current4_return_value_t
current4_return_value_t
Current 4 Click return value data.
Definition: current4.h:103
current4_cfg_t
Current 4 Click configuration object.
Definition: current4.h:90
current4_init
err_t current4_init(current4_t *ctx, current4_cfg_t *cfg)
Current 4 initialization function.
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
Definition: current4.h:106
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_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
Current 4 Click context object.
Definition: current4.h:78