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 
35 #include "drv_i2c_master.h"
36 #include "drv_analog_in.h"
37 
58 #define CURRENT7_NUM_CONVERSIONS 100
59 #define CURRENT7_SENSITIVITY_V_TO_A 0.8f
60 
65 #define CURRENT7_ADC_RESOLUTION 0x0FFF
66 #define CURRENT7_VREF_3V3 3.3
67 #define CURRENT7_VREF_5V 5.0
68 
74 #define CURRENT7_SET_DEV_ADDR 0x4D
75  // current7_set
77 
92 #define CURRENT7_MAP_MIKROBUS( cfg, mikrobus ) \
93  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
94  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
95  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
96  // current7_map // current7
99 
104 typedef enum
105 {
110 
115 typedef struct current7_s
116 {
117  analog_in_t adc;
118  i2c_master_t i2c;
120  uint8_t slave_address;
121  float vref;
125 
130 typedef struct
131 {
132  pin_name_t an;
133  pin_name_t scl;
134  pin_name_t sda;
136  analog_in_resolution_t resolution;
137  float vref;
139  uint32_t i2c_speed;
140  uint8_t i2c_address;
145 
150 typedef enum
151 {
153  CURRENT7_ERROR = -1
154 
156 
173 
189 
204 
216 err_t current7_read_raw_adc ( current7_t *ctx, uint16_t *raw_adc );
217 
229 err_t current7_read_voltage ( current7_t *ctx, float *voltage );
230 
242 err_t current7_set_vref ( current7_t *ctx, float vref );
243 
256 err_t current7_get_current ( current7_t *ctx, float *current );
257 
258 #ifdef __cplusplus
259 }
260 #endif
261 #endif // CURRENT7_H
262  // current7
264 
265 // ------------------------------------------------------------------------ END
current7_cfg_t::an
pin_name_t an
Definition: current7.h:132
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:116
current7_s::slave_address
uint8_t slave_address
Definition: current7.h:120
CURRENT7_DRV_SEL_I2C
@ CURRENT7_DRV_SEL_I2C
Definition: current7.h:107
current7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: current7.h:139
current7_s::adc
analog_in_t adc
Definition: current7.h:117
current7_s::drv_sel
current7_drv_t drv_sel
Definition: current7.h:122
current7_cfg_t
Current 7 Click configuration object.
Definition: current7.h:131
current7_cfg_t::i2c_address
uint8_t i2c_address
Definition: current7.h:140
current7_cfg_t::sda
pin_name_t sda
Definition: current7.h:134
current7_cfg_t::vref
float vref
Definition: current7.h:137
current7_return_value_t
current7_return_value_t
Current 7 Click return value data.
Definition: current7.h:151
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:142
current7_cfg_setup
void current7_cfg_setup(current7_cfg_t *cfg)
Current 7 configuration object setup function.
CURRENT7_OK
@ CURRENT7_OK
Definition: current7.h:152
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:106
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:136
CURRENT7_ERROR
@ CURRENT7_ERROR
Definition: current7.h:153
current7_t
struct current7_s current7_t
Current 7 Click context object.
current7_cfg_t::scl
pin_name_t scl
Definition: current7.h:133
current7_drv_t
current7_drv_t
Current 7 Click driver selector.
Definition: current7.h:105
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:118
current7_s::vref
float vref
Definition: current7.h:121