current11  2.1.0.0
current11.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 CURRENT11_H
29 #define CURRENT11_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 #include "drv_i2c_master.h"
53 
74 #define CURRENT11_SENSITIVITY_V_G 0.006f
75 #define CURRENT11_COUPLING_FACTOR_G_A 4.66f
76 #define CURRENT11_NUM_CONVERSIONS 200
77 #define CURRENT11_SENSOR_OUT_DIVIDER_2 2.0f
78 #define CURRENT11_SENSOR_VREF 2.5f
79 
84 #define CURRENT11_ADC_RESOLUTION 0x0FFF
85 #define CURRENT11_VREF_3V3 3.3f
86 #define CURRENT11_VREF_5V 5.0f
87 
93 #define CURRENT11_SET_DEV_ADDR 0x4D
94  // current11_set
96 
111 #define CURRENT11_MAP_MIKROBUS( cfg, mikrobus ) \
112  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
113  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
114  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
115  // current11_map // current11
118 
123 typedef enum
124 {
129 
134 typedef struct
135 {
136  analog_in_t adc;
137  i2c_master_t i2c;
139  uint8_t slave_address;
140  float vref;
145 } current11_t;
146 
151 typedef struct
152 {
153  pin_name_t an;
154  pin_name_t scl;
155  pin_name_t sda;
157  analog_in_resolution_t resolution;
158  float vref;
160  uint32_t i2c_speed;
161  uint8_t i2c_address;
166 
171 typedef enum
172 {
174  CURRENT11_ERROR = -1
175 
177 
194 
210 
225 
237 err_t current11_read_raw_adc ( current11_t *ctx, uint16_t *raw_adc );
238 
250 err_t current11_read_voltage ( current11_t *ctx, float *voltage );
251 
263 err_t current11_set_vref ( current11_t *ctx, float vref );
264 
276 
291 err_t current11_read_current ( current11_t *ctx, float *current );
292 
293 #ifdef __cplusplus
294 }
295 #endif
296 #endif // CURRENT11_H
297  // current11
299 
300 // ------------------------------------------------------------------------ END
current11_calibrate_offset
err_t current11_calibrate_offset(current11_t *ctx)
Current 11 calibrate offset function.
current11_cfg_t::an
pin_name_t an
Definition: current11.h:153
current11_read_raw_adc
err_t current11_read_raw_adc(current11_t *ctx, uint16_t *raw_adc)
Current 11 read raw ADC value function.
current11_read_current
err_t current11_read_current(current11_t *ctx, float *current)
Current 11 read current function.
current11_t::zero_curr_offset
float zero_curr_offset
Definition: current11.h:143
CURRENT11_OK
@ CURRENT11_OK
Definition: current11.h:173
current11_t::slave_address
uint8_t slave_address
Definition: current11.h:139
current11_cfg_t
Current 11 Click configuration object.
Definition: current11.h:152
CURRENT11_ERROR
@ CURRENT11_ERROR
Definition: current11.h:174
current11_cfg_t::vref
float vref
Definition: current11.h:158
current11_drv_interface_sel
void current11_drv_interface_sel(current11_cfg_t *cfg, current11_drv_t drv_sel)
Current 11 driver interface setup function.
current11_cfg_t::scl
pin_name_t scl
Definition: current11.h:154
CURRENT11_DRV_SEL_ADC
@ CURRENT11_DRV_SEL_ADC
Definition: current11.h:125
current11_read_voltage
err_t current11_read_voltage(current11_t *ctx, float *voltage)
Current 11 read voltage level function.
current11_cfg_t::drv_sel
current11_drv_t drv_sel
Definition: current11.h:163
current11_cfg_setup
void current11_cfg_setup(current11_cfg_t *cfg)
Current 11 configuration object setup function.
current11_t::drv_sel
current11_drv_t drv_sel
Definition: current11.h:141
current11_cfg_t::sda
pin_name_t sda
Definition: current11.h:155
current11_return_value_t
current11_return_value_t
Current 11 Click return value data.
Definition: current11.h:172
current11_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: current11.h:160
current11_cfg_t::i2c_address
uint8_t i2c_address
Definition: current11.h:161
current11_t::vref
float vref
Definition: current11.h:140
current11_init
err_t current11_init(current11_t *ctx, current11_cfg_t *cfg)
Current 11 initialization function.
current11_t::adc
analog_in_t adc
Definition: current11.h:136
current11_t
Current 11 Click context object.
Definition: current11.h:135
current11_t::i2c
i2c_master_t i2c
Definition: current11.h:137
current11_cfg_t::resolution
analog_in_resolution_t resolution
Definition: current11.h:157
current11_drv_t
current11_drv_t
Current 11 Click driver selector.
Definition: current11.h:124
CURRENT11_DRV_SEL_I2C
@ CURRENT11_DRV_SEL_I2C
Definition: current11.h:126
current11_set_vref
err_t current11_set_vref(current11_t *ctx, float vref)
Current 11 set vref function.