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 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_analog_in.h"
48 
69 #define LINHALL2_VOLTAGE_AT_0_MT 1.65f
70 #define LINHALL2_SENSITIVITY 0.015f
71 
76 #define LINHALL2_ENABLE_DEVICE 0x01
77 #define LINHALL2_DISABLE_DEVICE 0x00
78  // linhall2_set
80 
95 #define LINHALL2_MAP_MIKROBUS( cfg, mikrobus ) \
96  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
97  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST )
98  // linhall2_map // linhall2
101 
106 typedef struct
107 {
108  digital_out_t en;
110  analog_in_t adc;
112 } linhall2_t;
113 
118 typedef struct
119 {
120  pin_name_t an;
121  pin_name_t en;
123  analog_in_resolution_t resolution;
124  float vref;
127 
132 typedef enum
133 {
135  LINHALL2_ERROR = -1
136 
138 
155 
170 
182 err_t linhall2_read_an_pin_value ( linhall2_t *ctx, uint16_t *data_out );
183 
197 err_t linhall2_read_an_pin_voltage ( linhall2_t *ctx, float *data_out );
198 
209 void linhal2_set_en_pin ( linhall2_t *ctx, uint8_t pin_state );
210 
222 err_t linhal2_get_flux_density ( linhall2_t *ctx, float *data_out );
223 
224 #ifdef __cplusplus
225 }
226 #endif
227 #endif // LINHALL2_H
228  // linhall2
230 
231 // ------------------------------------------------------------------------ END
linhall2_t::en
digital_out_t en
Definition: linhall2.h:108
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:107
linhall2_return_value_t
linhall2_return_value_t
LIN Hall 2 Click return value data.
Definition: linhall2.h:133
linhall2_cfg_t::resolution
analog_in_resolution_t resolution
Definition: linhall2.h:123
linhall2_cfg_t::an
pin_name_t an
Definition: linhall2.h:120
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:119
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:124
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:110
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:134
LINHALL2_ERROR
@ LINHALL2_ERROR
Definition: linhall2.h:135
linhall2_cfg_t::en
pin_name_t en
Definition: linhall2.h:121