current7  2.0.0.0
current7.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 CURRENT7_H
29 #define CURRENT7_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_i2c_master.h"
50 #include "drv_analog_in.h"
51 
72 #define CURRENT7_NUM_CONVERSIONS 100
73 #define CURRENT7_SENSITIVITY_V_TO_A 0.8f
74 
79 #define CURRENT7_ADC_RESOLUTION 0x0FFF
80 #define CURRENT7_VREF_3V3 3.3
81 #define CURRENT7_VREF_5V 5.0
82 
88 #define CURRENT7_SET_DEV_ADDR 0x4D
89  // current7_set
91 
106 #define CURRENT7_MAP_MIKROBUS( cfg, mikrobus ) \
107  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
108  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
109  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
110  // current7_map // current7
113 
118 typedef enum
119 {
124 
129 typedef struct current7_s
130 {
131  analog_in_t adc;
132  i2c_master_t i2c;
134  uint8_t slave_address;
135  float vref;
139 
144 typedef struct
145 {
146  pin_name_t an;
147  pin_name_t scl;
148  pin_name_t sda;
150  analog_in_resolution_t resolution;
151  float vref;
153  uint32_t i2c_speed;
154  uint8_t i2c_address;
159 
164 typedef enum
165 {
167  CURRENT7_ERROR = -1
168 
170 
187 
203 
218 
230 err_t current7_read_raw_adc ( current7_t *ctx, uint16_t *raw_adc );
231 
243 err_t current7_read_voltage ( current7_t *ctx, float *voltage );
244 
256 err_t current7_set_vref ( current7_t *ctx, float vref );
257 
270 err_t current7_get_current ( current7_t *ctx, float *current );
271 
272 #ifdef __cplusplus
273 }
274 #endif
275 #endif // CURRENT7_H
276  // current7
278 
279 // ------------------------------------------------------------------------ END
current7_cfg_t::an
pin_name_t an
Definition: current7.h:146
current7_init
err_t current7_init(current7_t *ctx, current7_cfg_t *cfg)
Current 7 initialization function.
current7_s
Current 7 Click context object.
Definition: current7.h:130
current7_s::slave_address
uint8_t slave_address
Definition: current7.h:134
CURRENT7_DRV_SEL_I2C
@ CURRENT7_DRV_SEL_I2C
Definition: current7.h:121
current7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: current7.h:153
current7_s::adc
analog_in_t adc
Definition: current7.h:131
current7_s::drv_sel
current7_drv_t drv_sel
Definition: current7.h:136
current7_cfg_t
Current 7 Click configuration object.
Definition: current7.h:145
current7_cfg_t::i2c_address
uint8_t i2c_address
Definition: current7.h:154
current7_cfg_t::sda
pin_name_t sda
Definition: current7.h:148
current7_cfg_t::vref
float vref
Definition: current7.h:151
current7_return_value_t
current7_return_value_t
Current 7 Click return value data.
Definition: current7.h:165
current7_set_vref
err_t current7_set_vref(current7_t *ctx, float vref)
Current 7 set vref function.
current7_cfg_t::drv_sel
current7_drv_t drv_sel
Definition: current7.h:156
current7_cfg_setup
void current7_cfg_setup(current7_cfg_t *cfg)
Current 7 configuration object setup function.
CURRENT7_OK
@ CURRENT7_OK
Definition: current7.h:166
current7_drv_interface_selection
void current7_drv_interface_selection(current7_cfg_t *cfg, current7_drv_t drv_sel)
Current 7 driver interface setup function.
CURRENT7_DRV_SEL_ADC
@ CURRENT7_DRV_SEL_ADC
Definition: current7.h:120
current7_read_voltage
err_t current7_read_voltage(current7_t *ctx, float *voltage)
Current 7 read voltage level function.
current7_read_raw_adc
err_t current7_read_raw_adc(current7_t *ctx, uint16_t *raw_adc)
Current 7 read raw ADC value function.
current7_cfg_t::resolution
analog_in_resolution_t resolution
Definition: current7.h:150
CURRENT7_ERROR
@ CURRENT7_ERROR
Definition: current7.h:167
current7_t
struct current7_s current7_t
Current 7 Click context object.
current7_cfg_t::scl
pin_name_t scl
Definition: current7.h:147
current7_drv_t
current7_drv_t
Current 7 Click driver selector.
Definition: current7.h:119
current7_get_current
err_t current7_get_current(current7_t *ctx, float *current)
Current 7 get current function.
current7_s::i2c
i2c_master_t i2c
Definition: current7.h:132
current7_s::vref
float vref
Definition: current7.h:135