hallcurrent10  2.0.0.0
hallcurrent10.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 HALLCURRENT10_H
29 #define HALLCURRENT10_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 
60 #define HALLCURRENT10_SET_DEV_ADDR 0x4D
61  // hallcurrent10_set
63 
78 #define HALLCURRENT10_MAP_MIKROBUS( cfg, mikrobus ) \
79  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
80  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
81  // hallcurrent10_map // hallcurrent10
84 
89 typedef struct
90 {
91  // Modules
92  i2c_master_t i2c;
94  // I2C slave address
95  uint8_t slave_address;
98 
103 typedef struct
104 {
105  pin_name_t scl;
106  pin_name_t sda;
108  uint32_t i2c_speed;
109  uint8_t i2c_address;
112 
117 typedef enum
118 {
121 
123 
140 
156 
171 
185 err_t hallcurrent10_read_adc ( hallcurrent10_t *ctx, uint16_t *read_adc );
186 
200 err_t hallcurrent10_get_adc_voltage ( hallcurrent10_t *ctx, float *adc_vtg );
201 
215 err_t hallcurrent10_get_current ( hallcurrent10_t *ctx, float *current );
216 
217 #ifdef __cplusplus
218 }
219 #endif
220 #endif // HALLCURRENT10_H
221  // hallcurrent10
223 
224 // ------------------------------------------------------------------------ END
hallcurrent10_get_current
err_t hallcurrent10_get_current(hallcurrent10_t *ctx, float *current)
Hall Current 10 get current function.
hallcurrent10_return_value_t
hallcurrent10_return_value_t
Hall Current 10 Click return value data.
Definition: hallcurrent10.h:118
hallcurrent10_cfg_t::i2c_address
uint8_t i2c_address
Definition: hallcurrent10.h:109
hallcurrent10_read_adc
err_t hallcurrent10_read_adc(hallcurrent10_t *ctx, uint16_t *read_adc)
Hall Current 10 I2C ADC reading function.
hallcurrent10_cfg_setup
void hallcurrent10_cfg_setup(hallcurrent10_cfg_t *cfg)
Hall Current 10 configuration object setup function.
hallcurrent10_get_adc_voltage
err_t hallcurrent10_get_adc_voltage(hallcurrent10_t *ctx, float *adc_vtg)
Hall Current 10 get ADC voltage function.
hallcurrent10_cfg_t
Hall Current 10 Click configuration object.
Definition: hallcurrent10.h:104
hallcurrent10_cfg_t::sda
pin_name_t sda
Definition: hallcurrent10.h:106
hallcurrent10_init
err_t hallcurrent10_init(hallcurrent10_t *ctx, hallcurrent10_cfg_t *cfg)
Hall Current 10 initialization function.
hallcurrent10_t::i2c
i2c_master_t i2c
Definition: hallcurrent10.h:92
hallcurrent10_cfg_t::scl
pin_name_t scl
Definition: hallcurrent10.h:105
hallcurrent10_t
Hall Current 10 Click context object.
Definition: hallcurrent10.h:90
hallcurrent10_t::slave_address
uint8_t slave_address
Definition: hallcurrent10.h:95
hallcurrent10_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: hallcurrent10.h:108
HALLCURRENT10_OK
@ HALLCURRENT10_OK
Definition: hallcurrent10.h:119
HALLCURRENT10_ERROR
@ HALLCURRENT10_ERROR
Definition: hallcurrent10.h:120
hallcurrent10_default_cfg
err_t hallcurrent10_default_cfg(hallcurrent10_t *ctx)
Hall Current 10 default configuration function.