hallcurrent8120a  2.0.0.0
hallcurrent8120a.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 HALLCURRENT8120A_H
29 #define HALLCURRENT8120A_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 
59 #define HALLCURRENT8120A_MAP_MIKROBUS( cfg, mikrobus ) \
60  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
61  cfg.oc1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
62  cfg.oc2 = MIKROBUS( mikrobus, MIKROBUS_INT )
63  // hallcurrent8120a_map // hallcurrent8120a
66 
71 typedef struct
72 {
73  digital_in_t oc1;
74  digital_in_t oc2;
76  analog_in_t adc;
78  float offset;
81 
86 typedef struct
87 {
88  pin_name_t an;
89  pin_name_t oc1;
90  pin_name_t oc2;
92  analog_in_resolution_t resolution;
93  float vref;
96 
101 typedef enum
102 {
105 
107 
124 
140 
153 err_t hallcurrent8120a_read_pin_value ( hallcurrent8120a_t *ctx, uint16_t *data_out );
154 
169 err_t hallcurrent8120a_read_pin_volt ( hallcurrent8120a_t *ctx, float *data_out );
170 
186 
201 err_t hallcurrent8120a_get_voltage ( hallcurrent8120a_t *ctx, float *avr_voltage );
202 
217 err_t hallcurrent8120a_get_current ( hallcurrent8120a_t *ctx, float *current );
218 
233 
248 
249 #ifdef __cplusplus
250 }
251 #endif
252 #endif // HALLCURRENT8120A_H
253  // hallcurrent8120a
255 
256 // ------------------------------------------------------------------------ END
hallcurrent8120a_t::oc2
digital_in_t oc2
Definition: hallcurrent8120a.h:74
hallcurrent8120a_cfg_t::oc1
pin_name_t oc1
Definition: hallcurrent8120a.h:89
hallcurrent8120a_cfg_t
Hall Current 8 120A Click configuration object.
Definition: hallcurrent8120a.h:87
HALLCURRENT8120A_OK
@ HALLCURRENT8120A_OK
Definition: hallcurrent8120a.h:103
hallcurrent8120a_cfg_t::vref
float vref
Definition: hallcurrent8120a.h:93
hallcurrent8120a_cfg_t::an
pin_name_t an
Definition: hallcurrent8120a.h:88
hallcurrent8120a_calibration
err_t hallcurrent8120a_calibration(hallcurrent8120a_t *ctx)
Hall Current 8 120A calibration function.
hallcurrent8120a_get_odc1
uint8_t hallcurrent8120a_get_odc1(hallcurrent8120a_t *ctx)
Hall Current 8 120A get state of OC1 function.
HALLCURRENT8120A_ERROR
@ HALLCURRENT8120A_ERROR
Definition: hallcurrent8120a.h:104
hallcurrent8120a_cfg_t::oc2
pin_name_t oc2
Definition: hallcurrent8120a.h:90
hallcurrent8120a_read_pin_value
err_t hallcurrent8120a_read_pin_value(hallcurrent8120a_t *ctx, uint16_t *data_out)
Hall Current 8 120A read AN pin value function.
hallcurrent8120a_return_value_t
hallcurrent8120a_return_value_t
Hall Current 8 120A Click return value data.
Definition: hallcurrent8120a.h:102
hallcurrent8120a_get_voltage
err_t hallcurrent8120a_get_voltage(hallcurrent8120a_t *ctx, float *avr_voltage)
Hall Current 8 120A read voltage level function.
hallcurrent8120a_t::oc1
digital_in_t oc1
Definition: hallcurrent8120a.h:73
hallcurrent8120a_t
Hall Current 8 120A Click context object.
Definition: hallcurrent8120a.h:72
hallcurrent8120a_cfg_setup
void hallcurrent8120a_cfg_setup(hallcurrent8120a_cfg_t *cfg)
Hall Current 8 120A configuration object setup function.
hallcurrent8120a_t::offset
float offset
Definition: hallcurrent8120a.h:78
hallcurrent8120a_get_current
err_t hallcurrent8120a_get_current(hallcurrent8120a_t *ctx, float *current)
Hall Current 8 120A get current level function.
hallcurrent8120a_cfg_t::resolution
analog_in_resolution_t resolution
Definition: hallcurrent8120a.h:92
hallcurrent8120a_t::adc
analog_in_t adc
Definition: hallcurrent8120a.h:76
hallcurrent8120a_read_pin_volt
err_t hallcurrent8120a_read_pin_volt(hallcurrent8120a_t *ctx, float *data_out)
Hall Current 8 120A read AN pin voltage level function.
hallcurrent8120a_init
err_t hallcurrent8120a_init(hallcurrent8120a_t *ctx, hallcurrent8120a_cfg_t *cfg)
Hall Current 8 120A initialization function.
hallcurrent8120a_get_odc2
uint8_t hallcurrent8120a_get_odc2(hallcurrent8120a_t *ctx)
Hall Current 8 120A get state of OC2 function.