linhall2  2.1.0.0
linhall2.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 LINHALL2_H
29 #define LINHALL2_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_analog_in.h"
52 
73 #define LINHALL2_VOLTAGE_AT_0_MT 1.65f
74 #define LINHALL2_SENSITIVITY 0.015f
75 
80 #define LINHALL2_ENABLE_DEVICE 0x01
81 #define LINHALL2_DISABLE_DEVICE 0x00
82  // linhall2_set
84 
99 #define LINHALL2_MAP_MIKROBUS( cfg, mikrobus ) \
100  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
101  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST )
102  // linhall2_map // linhall2
105 
110 typedef struct
111 {
112  digital_out_t en;
114  analog_in_t adc;
116 } linhall2_t;
117 
122 typedef struct
123 {
124  pin_name_t an;
125  pin_name_t en;
127  analog_in_resolution_t resolution;
128  float vref;
131 
136 typedef enum
137 {
139  LINHALL2_ERROR = -1
140 
142 
159 
174 
186 err_t linhall2_read_an_pin_value ( linhall2_t *ctx, uint16_t *data_out );
187 
201 err_t linhall2_read_an_pin_voltage ( linhall2_t *ctx, float *data_out );
202 
213 void linhal2_set_en_pin ( linhall2_t *ctx, uint8_t pin_state );
214 
226 err_t linhal2_get_flux_density ( linhall2_t *ctx, float *data_out );
227 
228 #ifdef __cplusplus
229 }
230 #endif
231 #endif // LINHALL2_H
232  // linhall2
234 
235 // ------------------------------------------------------------------------ END
linhall2_t::en
digital_out_t en
Definition: linhall2.h:112
linhall2_read_an_pin_voltage
err_t linhall2_read_an_pin_voltage(linhall2_t *ctx, float *data_out)
LIN Hall 2 read AN pin voltage level function.
linhal2_get_flux_density
err_t linhal2_get_flux_density(linhall2_t *ctx, float *data_out)
LIN Hall 2 read flux density function.
linhall2_t
LIN Hall 2 Click context object.
Definition: linhall2.h:111
linhall2_return_value_t
linhall2_return_value_t
LIN Hall 2 Click return value data.
Definition: linhall2.h:137
linhall2_cfg_t::resolution
analog_in_resolution_t resolution
Definition: linhall2.h:127
linhall2_cfg_t::an
pin_name_t an
Definition: linhall2.h:124
linhall2_cfg_setup
void linhall2_cfg_setup(linhall2_cfg_t *cfg)
LIN Hall 2 configuration object setup function.
linhall2_cfg_t
LIN Hall 2 Click configuration object.
Definition: linhall2.h:123
linhall2_read_an_pin_value
err_t linhall2_read_an_pin_value(linhall2_t *ctx, uint16_t *data_out)
LIN Hall 2 read AN pin value function.
linhall2_cfg_t::vref
float vref
Definition: linhall2.h:128
linhal2_set_en_pin
void linhal2_set_en_pin(linhall2_t *ctx, uint8_t pin_state)
LIN Hall 2 set EN pin state function.
linhall2_t::adc
analog_in_t adc
Definition: linhall2.h:114
linhall2_init
err_t linhall2_init(linhall2_t *ctx, linhall2_cfg_t *cfg)
LIN Hall 2 initialization function.
LINHALL2_OK
@ LINHALL2_OK
Definition: linhall2.h:138
LINHALL2_ERROR
@ LINHALL2_ERROR
Definition: linhall2.h:139
linhall2_cfg_t::en
pin_name_t en
Definition: linhall2.h:125