hallcurrent9  2.0.0.0
hallcurrent9.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 HALLCURRENT9_H
29 #define HALLCURRENT9_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_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
84 #define HALLCURRENT9_SET_DEV_ADDR 0x4D
85  // hallcurrent9_set
87 
102 #define HALLCURRENT9_MAP_MIKROBUS( cfg, mikrobus ) \
103  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
104  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
105  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
106  // hallcurrent9_map // hallcurrent9
109 
114 typedef struct
115 {
116  // Input pins
117 
118  digital_in_t an;
120  // Modules
121 
122  i2c_master_t i2c;
124  // I2C slave address
125 
126  uint8_t slave_address;
129 
134 typedef struct
135 {
136  pin_name_t scl;
137  pin_name_t sda;
139  pin_name_t an;
141  uint32_t i2c_speed;
142  uint8_t i2c_address;
145 
150 typedef struct
151 {
152  uint16_t zero_adc_val;
153 
155 
160 typedef enum
161 {
163  HALLCURRENT9_ERROR = -1
164 
166 
185 
203 
219 err_t hallcurrent9_read_adc ( hallcurrent9_t *ctx, uint16_t *read_adc );
220 
236 
252 
253 #ifdef __cplusplus
254 }
255 #endif
256 #endif // HALLCURRENT9_H
257  // hallcurrent9
259 
260 // ------------------------------------------------------------------------ END
hallcurrent9_t::an
digital_in_t an
Definition: hallcurrent9.h:118
hallcurrent9_cfg_t::i2c_address
uint8_t i2c_address
Definition: hallcurrent9.h:142
hallcurrent9_t
Hall Current 9 Click context object.
Definition: hallcurrent9.h:115
hallcurrent9_t::slave_address
uint8_t slave_address
Definition: hallcurrent9.h:126
hallcurrent9_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: hallcurrent9.h:141
HALLCURRENT9_ERROR
@ HALLCURRENT9_ERROR
Definition: hallcurrent9.h:163
hallcurrent9_cfg_t::sda
pin_name_t sda
Definition: hallcurrent9.h:137
hallcurrent9_set_calibration
err_t hallcurrent9_set_calibration(hallcurrent9_t *ctx, hallcurrent9_calibration_data_t *adc_val)
Hall Current 9 set calibration function.
hallcurrent9_init
err_t hallcurrent9_init(hallcurrent9_t *ctx, hallcurrent9_cfg_t *cfg)
Hall Current 9 initialization function.
hallcurrent9_return_value_t
hallcurrent9_return_value_t
Hall Current 9 Click return value data.
Definition: hallcurrent9.h:161
hallcurrent9_cfg_t::scl
pin_name_t scl
Definition: hallcurrent9.h:136
hallcurrent9_read_adc
err_t hallcurrent9_read_adc(hallcurrent9_t *ctx, uint16_t *read_adc)
Hall Current 9 I2C ADC reading function.
hallcurrent9_cfg_setup
void hallcurrent9_cfg_setup(hallcurrent9_cfg_t *cfg)
Hall Current 9 configuration object setup function.
hallcurrent9_cfg_t::an
pin_name_t an
Definition: hallcurrent9.h:139
hallcurrent9_calibration_data_t::zero_adc_val
uint16_t zero_adc_val
Definition: hallcurrent9.h:152
HALLCURRENT9_OK
@ HALLCURRENT9_OK
Definition: hallcurrent9.h:162
hallcurrent9_cfg_t
Hall Current 9 Click configuration object.
Definition: hallcurrent9.h:135
hallcurrent9_t::i2c
i2c_master_t i2c
Definition: hallcurrent9.h:122
hallcurrent9_calibration_data_t
Hall Current 9 Click calibration object.
Definition: hallcurrent9.h:151
hallcurrent9_get_current
float hallcurrent9_get_current(hallcurrent9_t *ctx, hallcurrent9_calibration_data_t *adc_val)
Hall Current 9 get current function.