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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_analog_in.h"
38 #include "drv_i2c_master.h"
39 
60 #define HALLCURRENT14_SENSITIVITY_V_TO_A 0.08
61 #define HALLCURRENT14_ZERO_CURRENT_OFFSET 0.5
62 #define HALLCURRENT14_NUM_CONVERSIONS 1000
63 
68 #define HALLCURRENT14_ADC_RESOLUTION 0x0FFF
69 #define HALLCURRENT14_VREF_5V 5.0
70 
76 #define HALLCURRENT14_SET_DEV_ADDR 0x4D
77  // hallcurrent14_set
79 
94 #define HALLCURRENT14_MAP_MIKROBUS( cfg, mikrobus ) \
95  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
96  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
97  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
98  // hallcurrent14_map // hallcurrent14
101 
106 typedef enum
107 {
112 
117 typedef struct
118 {
119  analog_in_t adc;
120  i2c_master_t i2c;
122  uint8_t slave_address;
123  pin_name_t chip_select;
124  float vref;
128 
133 typedef struct
134 {
135  pin_name_t an;
136  pin_name_t scl;
137  pin_name_t sda;
139  analog_in_resolution_t resolution;
140  float vref;
142  uint32_t i2c_speed;
143  uint8_t i2c_address;
148 
153 typedef enum
154 {
157 
159 
176 
192 
207 
219 err_t hallcurrent14_read_raw_adc ( hallcurrent14_t *ctx, uint16_t *raw_adc );
220 
232 err_t hallcurrent14_read_voltage ( hallcurrent14_t *ctx, float *voltage );
233 
245 err_t hallcurrent14_set_vref ( hallcurrent14_t *ctx, float vref );
246 
260 err_t hallcurrent14_read_current ( hallcurrent14_t *ctx, float *current );
261 
262 #ifdef __cplusplus
263 }
264 #endif
265 #endif // HALLCURRENT14_H
266  // hallcurrent14
268 
269 // ------------------------------------------------------------------------ END
hallcurrent14_t
Hall Current 14 Click context object.
Definition: hallcurrent14.h:118
hallcurrent14_t::chip_select
pin_name_t chip_select
Definition: hallcurrent14.h:123
hallcurrent14_return_value_t
hallcurrent14_return_value_t
Hall Current 14 Click return value data.
Definition: hallcurrent14.h:154
hallcurrent14_t::vref
float vref
Definition: hallcurrent14.h:124
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:134
hallcurrent14_t::drv_sel
hallcurrent14_drv_t drv_sel
Definition: hallcurrent14.h:125
HALLCURRENT14_DRV_SEL_ADC
@ HALLCURRENT14_DRV_SEL_ADC
Definition: hallcurrent14.h:108
hallcurrent14_t::i2c
i2c_master_t i2c
Definition: hallcurrent14.h:120
HALLCURRENT14_DRV_SEL_I2C
@ HALLCURRENT14_DRV_SEL_I2C
Definition: hallcurrent14.h:109
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:137
hallcurrent14_cfg_t::vref
float vref
Definition: hallcurrent14.h:140
HALLCURRENT14_ERROR
@ HALLCURRENT14_ERROR
Definition: hallcurrent14.h:156
hallcurrent14_cfg_t::an
pin_name_t an
Definition: hallcurrent14.h:135
hallcurrent14_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: hallcurrent14.h:142
hallcurrent14_t::adc
analog_in_t adc
Definition: hallcurrent14.h:119
hallcurrent14_drv_t
hallcurrent14_drv_t
Hall Current 14 Click driver selector.
Definition: hallcurrent14.h:107
hallcurrent14_cfg_t::scl
pin_name_t scl
Definition: hallcurrent14.h:136
hallcurrent14_cfg_t::i2c_address
uint8_t i2c_address
Definition: hallcurrent14.h:143
HALLCURRENT14_OK
@ HALLCURRENT14_OK
Definition: hallcurrent14.h:155
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:139
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:122
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:145