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 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
70 #define HALLCURRENT9_SET_DEV_ADDR 0x4D
71  // hallcurrent9_set
73 
88 #define HALLCURRENT9_MAP_MIKROBUS( cfg, mikrobus ) \
89  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
90  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
91  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN )
92  // hallcurrent9_map // hallcurrent9
95 
100 typedef struct
101 {
102  // Input pins
103 
104  digital_in_t an;
106  // Modules
107 
108  i2c_master_t i2c;
110  // I2C slave address
111 
112  uint8_t slave_address;
115 
120 typedef struct
121 {
122  pin_name_t scl;
123  pin_name_t sda;
125  pin_name_t an;
127  uint32_t i2c_speed;
128  uint8_t i2c_address;
131 
136 typedef struct
137 {
138  uint16_t zero_adc_val;
139 
141 
146 typedef enum
147 {
149  HALLCURRENT9_ERROR = -1
150 
152 
171 
189 
205 err_t hallcurrent9_read_adc ( hallcurrent9_t *ctx, uint16_t *read_adc );
206 
222 
238 
239 #ifdef __cplusplus
240 }
241 #endif
242 #endif // HALLCURRENT9_H
243  // hallcurrent9
245 
246 // ------------------------------------------------------------------------ END
hallcurrent9_t::an
digital_in_t an
Definition: hallcurrent9.h:104
hallcurrent9_cfg_t::i2c_address
uint8_t i2c_address
Definition: hallcurrent9.h:128
hallcurrent9_t
Hall Current 9 Click context object.
Definition: hallcurrent9.h:101
hallcurrent9_t::slave_address
uint8_t slave_address
Definition: hallcurrent9.h:112
hallcurrent9_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: hallcurrent9.h:127
HALLCURRENT9_ERROR
@ HALLCURRENT9_ERROR
Definition: hallcurrent9.h:149
hallcurrent9_cfg_t::sda
pin_name_t sda
Definition: hallcurrent9.h:123
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:147
hallcurrent9_cfg_t::scl
pin_name_t scl
Definition: hallcurrent9.h:122
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:125
hallcurrent9_calibration_data_t::zero_adc_val
uint16_t zero_adc_val
Definition: hallcurrent9.h:138
HALLCURRENT9_OK
@ HALLCURRENT9_OK
Definition: hallcurrent9.h:148
hallcurrent9_cfg_t
Hall Current 9 Click configuration object.
Definition: hallcurrent9.h:121
hallcurrent9_t::i2c
i2c_master_t i2c
Definition: hallcurrent9.h:108
hallcurrent9_calibration_data_t
Hall Current 9 Click calibration object.
Definition: hallcurrent9.h:137
hallcurrent9_get_current
float hallcurrent9_get_current(hallcurrent9_t *ctx, hallcurrent9_calibration_data_t *adc_val)
Hall Current 9 get current function.