hallcurrent14  2.0.0.0
hallcurrent14.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 HALLCURRENT14_H
29 #define HALLCURRENT14_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 
70 #define HALLCURRENT14_SENSITIVITY_V_TO_A 0.08
71 #define HALLCURRENT14_ZERO_CURRENT_OFFSET 0.5
72 #define HALLCURRENT14_NUM_CONVERSIONS 1000
73 
78 #define HALLCURRENT14_ADC_RESOLUTION 0x0FFF
79 #define HALLCURRENT14_VREF_5V 5.0
80 
86 #define HALLCURRENT14_SET_DEV_ADDR 0x4D
87  // hallcurrent14_set
89 
104 #define HALLCURRENT14_MAP_MIKROBUS( cfg, mikrobus ) \
105  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
106  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
107  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
108  // hallcurrent14_map // hallcurrent14
111 
116 typedef enum
117 {
122 
127 typedef struct
128 {
129  analog_in_t adc;
130  i2c_master_t i2c;
132  uint8_t slave_address;
133  pin_name_t chip_select;
134  float vref;
138 
143 typedef struct
144 {
145  pin_name_t an;
146  pin_name_t scl;
147  pin_name_t sda;
149  analog_in_resolution_t resolution;
150  float vref;
152  uint32_t i2c_speed;
153  uint8_t i2c_address;
158 
163 typedef enum
164 {
167 
169 
186 
202 
217 
229 err_t hallcurrent14_read_raw_adc ( hallcurrent14_t *ctx, uint16_t *raw_adc );
230 
242 err_t hallcurrent14_read_voltage ( hallcurrent14_t *ctx, float *voltage );
243 
255 err_t hallcurrent14_set_vref ( hallcurrent14_t *ctx, float vref );
256 
270 err_t hallcurrent14_read_current ( hallcurrent14_t *ctx, float *current );
271 
272 #ifdef __cplusplus
273 }
274 #endif
275 #endif // HALLCURRENT14_H
276  // hallcurrent14
278 
279 // ------------------------------------------------------------------------ END
hallcurrent14_t
Hall Current 14 Click context object.
Definition: hallcurrent14.h:128
hallcurrent14_t::chip_select
pin_name_t chip_select
Definition: hallcurrent14.h:133
hallcurrent14_return_value_t
hallcurrent14_return_value_t
Hall Current 14 Click return value data.
Definition: hallcurrent14.h:164
hallcurrent14_t::vref
float vref
Definition: hallcurrent14.h:134
hallcurrent14_init
err_t hallcurrent14_init(hallcurrent14_t *ctx, hallcurrent14_cfg_t *cfg)
Hall Current 14 initialization function.
hallcurrent14_read_raw_adc
err_t hallcurrent14_read_raw_adc(hallcurrent14_t *ctx, uint16_t *raw_adc)
Hall Current 14 read raw ADC value function.
hallcurrent14_cfg_t
Hall Current 14 Click configuration object.
Definition: hallcurrent14.h:144
hallcurrent14_t::drv_sel
hallcurrent14_drv_t drv_sel
Definition: hallcurrent14.h:135
HALLCURRENT14_DRV_SEL_ADC
@ HALLCURRENT14_DRV_SEL_ADC
Definition: hallcurrent14.h:118
hallcurrent14_t::i2c
i2c_master_t i2c
Definition: hallcurrent14.h:130
HALLCURRENT14_DRV_SEL_I2C
@ HALLCURRENT14_DRV_SEL_I2C
Definition: hallcurrent14.h:119
hallcurrent14_cfg_setup
void hallcurrent14_cfg_setup(hallcurrent14_cfg_t *cfg)
Hall Current 14 configuration object setup function.
hallcurrent14_cfg_t::sda
pin_name_t sda
Definition: hallcurrent14.h:147
hallcurrent14_cfg_t::vref
float vref
Definition: hallcurrent14.h:150
HALLCURRENT14_ERROR
@ HALLCURRENT14_ERROR
Definition: hallcurrent14.h:166
hallcurrent14_cfg_t::an
pin_name_t an
Definition: hallcurrent14.h:145
hallcurrent14_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: hallcurrent14.h:152
hallcurrent14_t::adc
analog_in_t adc
Definition: hallcurrent14.h:129
hallcurrent14_drv_t
hallcurrent14_drv_t
Hall Current 14 Click driver selector.
Definition: hallcurrent14.h:117
hallcurrent14_cfg_t::scl
pin_name_t scl
Definition: hallcurrent14.h:146
hallcurrent14_cfg_t::i2c_address
uint8_t i2c_address
Definition: hallcurrent14.h:153
HALLCURRENT14_OK
@ HALLCURRENT14_OK
Definition: hallcurrent14.h:165
hallcurrent14_read_voltage
err_t hallcurrent14_read_voltage(hallcurrent14_t *ctx, float *voltage)
Hall Current 14 read voltage level function.
hallcurrent14_cfg_t::resolution
analog_in_resolution_t resolution
Definition: hallcurrent14.h:149
hallcurrent14_read_current
err_t hallcurrent14_read_current(hallcurrent14_t *ctx, float *current)
Hall Current 14 read current function.
hallcurrent14_set_vref
err_t hallcurrent14_set_vref(hallcurrent14_t *ctx, float vref)
Hall Current 14 set vref function.
hallcurrent14_t::slave_address
uint8_t slave_address
Definition: hallcurrent14.h:132
hallcurrent14_drv_interface_selection
void hallcurrent14_drv_interface_selection(hallcurrent14_cfg_t *cfg, hallcurrent14_drv_t drv_sel)
Hall Current 14 driver interface setup function.
hallcurrent14_cfg_t::drv_sel
hallcurrent14_drv_t drv_sel
Definition: hallcurrent14.h:155