hallcurrent18  2.1.0.0
hallcurrent18.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 HALLCURRENT18_H
29 #define HALLCURRENT18_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_analog_in.h"
48 #include "drv_i2c_master.h"
49 
71 #define HALLCURRENT18_ADC_RESOLUTION 0x0FFFu
72 #define HALLCURRENT18_VREF_3V3 3.3f
73 #define HALLCURRENT18_VREF_5V 5.0f
74 #define HALLCURRENT18_HALF_SCALE_3V3 1.65f
75 
80 #define HALLCURRENT18_SENSITIVITY_MV_A 33.0f
81 #define HALLCURRENT18_CONV_TO_MILI 1000.0f
82 #define HALLCURRENT18_ADC_NUM_OF_MEASURE 500u
83 
89 #define HALLCURRENT18_SET_DEV_ADDR 0x4D
90  // hallcurrent18_set
92 
107 #define HALLCURRENT18_MAP_MIKROBUS( cfg, mikrobus ) \
108  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
109  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
110  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
111  // hallcurrent18_map // hallcurrent18
114 
119 typedef enum
120 {
125 
130 typedef struct
131 {
132  analog_in_t adc;
133  i2c_master_t i2c;
135  uint8_t slave_address;
136  float vref;
137  float zero_vref;
141 
146 typedef struct
147 {
148  pin_name_t an;
149  pin_name_t scl;
150  pin_name_t sda;
152  analog_in_resolution_t resolution;
153  float vref;
154  float zero_vref;
156  uint32_t i2c_speed;
157  uint8_t i2c_address;
162 
167 typedef enum
168 {
171 
173 
190 
206 
221 
235 
247 err_t hallcurrent18_read_raw_adc ( hallcurrent18_t *ctx, uint16_t *raw_adc );
248 
260 err_t hallcurrent18_read_voltage ( hallcurrent18_t *ctx, float *voltage );
261 
273 err_t hallcurrent18_set_vref ( hallcurrent18_t *ctx, float vref );
274 
288 err_t hallcurrent18_read_current ( hallcurrent18_t *ctx, float *current );
289 
303 
304 #ifdef __cplusplus
305 }
306 #endif
307 #endif // HALLCURRENT18_H
308  // hallcurrent18
310 
311 // ------------------------------------------------------------------------ END
hallcurrent18_drv_t
hallcurrent18_drv_t
Hall Current 18 Click driver selector.
Definition: hallcurrent18.h:120
HALLCURRENT18_OK
@ HALLCURRENT18_OK
Definition: hallcurrent18.h:169
hallcurrent18_t::adc
analog_in_t adc
Definition: hallcurrent18.h:132
hallcurrent18_default_cfg
err_t hallcurrent18_default_cfg(hallcurrent18_t *ctx)
Hall Current 18 default configuration function.
HALLCURRENT18_DRV_SEL_ADC
@ HALLCURRENT18_DRV_SEL_ADC
Definition: hallcurrent18.h:121
hallcurrent18_cfg_setup
void hallcurrent18_cfg_setup(hallcurrent18_cfg_t *cfg)
Hall Current 18 configuration object setup function.
HALLCURRENT18_ERROR
@ HALLCURRENT18_ERROR
Definition: hallcurrent18.h:170
HALLCURRENT18_DRV_SEL_I2C
@ HALLCURRENT18_DRV_SEL_I2C
Definition: hallcurrent18.h:122
hallcurrent18_cfg_t::zero_vref
float zero_vref
Definition: hallcurrent18.h:154
hallcurrent18_cfg_t
Hall Current 18 Click configuration object.
Definition: hallcurrent18.h:147
hallcurrent18_t::zero_vref
float zero_vref
Definition: hallcurrent18.h:137
hallcurrent18_cfg_t::vref
float vref
Definition: hallcurrent18.h:153
hallcurrent18_cfg_t::drv_sel
hallcurrent18_drv_t drv_sel
Definition: hallcurrent18.h:159
hallcurrent18_t::slave_address
uint8_t slave_address
Definition: hallcurrent18.h:135
hallcurrent18_drv_interface_selection
void hallcurrent18_drv_interface_selection(hallcurrent18_cfg_t *cfg, hallcurrent18_drv_t drv_sel)
Hall Current 18 driver interface setup function.
hallcurrent18_cfg_t::an
pin_name_t an
Definition: hallcurrent18.h:148
hallcurrent18_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: hallcurrent18.h:156
hallcurrent18_return_value_t
hallcurrent18_return_value_t
Hall Current 18 Click return value data.
Definition: hallcurrent18.h:168
hallcurrent18_cfg_t::sda
pin_name_t sda
Definition: hallcurrent18.h:150
hallcurrent18_set_vref
err_t hallcurrent18_set_vref(hallcurrent18_t *ctx, float vref)
Hall Current 18 set vref function.
hallcurrent18_t::drv_sel
hallcurrent18_drv_t drv_sel
Definition: hallcurrent18.h:138
hallcurrent18_read_raw_adc
err_t hallcurrent18_read_raw_adc(hallcurrent18_t *ctx, uint16_t *raw_adc)
Hall Current 18 read raw ADC value function.
hallcurrent18_read_current
err_t hallcurrent18_read_current(hallcurrent18_t *ctx, float *current)
Hall Current 18 get current function.
hallcurrent18_cfg_t::scl
pin_name_t scl
Definition: hallcurrent18.h:149
hallcurrent18_cfg_t::i2c_address
uint8_t i2c_address
Definition: hallcurrent18.h:157
hallcurrent18_t::i2c
i2c_master_t i2c
Definition: hallcurrent18.h:133
hallcurrent18_set_zero_ref
err_t hallcurrent18_set_zero_ref(hallcurrent18_t *ctx)
Hall Current 18 set zero reference function.
hallcurrent18_cfg_t::resolution
analog_in_resolution_t resolution
Definition: hallcurrent18.h:152
hallcurrent18_t
Hall Current 18 Click context object.
Definition: hallcurrent18.h:131
hallcurrent18_read_voltage
err_t hallcurrent18_read_voltage(hallcurrent18_t *ctx, float *voltage)
Hall Current 18 read voltage level function.
hallcurrent18_t::vref
float vref
Definition: hallcurrent18.h:136
hallcurrent18_init
err_t hallcurrent18_init(hallcurrent18_t *ctx, hallcurrent18_cfg_t *cfg)
Hall Current 18 initialization function.