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
32extern "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 LINHALL2_VOLTAGE_AT_0_MT 1.65f
60#define LINHALL2_SENSITIVITY 0.015f
61
66#define LINHALL2_ENABLE_DEVICE 0x01
67#define LINHALL2_DISABLE_DEVICE 0x00
68 // linhall2_set
70
85#define LINHALL2_MAP_MIKROBUS( cfg, mikrobus ) \
86 cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
87 cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST )
88 // linhall2_map // linhall2
91
96typedef struct
97{
98 digital_out_t en;
100 analog_in_t adc;
102} linhall2_t;
103
108typedef struct
109{
110 pin_name_t an;
111 pin_name_t en;
113 analog_in_resolution_t resolution;
114 float vref;
117
122typedef enum
123{
125 LINHALL2_ERROR = -1
126
128
145
160
172
184err_t linhall2_read_an_pin_value ( linhall2_t *ctx, uint16_t *data_out );
185
199err_t linhall2_read_an_pin_voltage ( linhall2_t *ctx, float *data_out );
200
211void linhal2_set_en_pin ( linhall2_t *ctx, uint8_t pin_state );
212
224err_t linhal2_get_flux_density ( linhall2_t *ctx, float *data_out );
225
226#ifdef __cplusplus
227}
228#endif
229#endif // LINHALL2_H
230 // linhall2
232
233// ------------------------------------------------------------------------ END
void linhall2_default_cfg(linhall2_t *ctx)
LIN Hall 2 default configuration function.
void linhall2_cfg_setup(linhall2_cfg_t *cfg)
LIN Hall 2 configuration object setup function.
err_t linhall2_read_an_pin_value(linhall2_t *ctx, uint16_t *data_out)
LIN Hall 2 read AN pin value function.
err_t linhall2_read_an_pin_voltage(linhall2_t *ctx, float *data_out)
LIN Hall 2 read AN pin voltage level function.
err_t linhall2_init(linhall2_t *ctx, linhall2_cfg_t *cfg)
LIN Hall 2 initialization function.
void linhal2_set_en_pin(linhall2_t *ctx, uint8_t pin_state)
LIN Hall 2 set EN pin state function.
err_t linhal2_get_flux_density(linhall2_t *ctx, float *data_out)
LIN Hall 2 read flux density function.
linhall2_return_value_t
LIN Hall 2 Click return value data.
Definition: linhall2.h:123
@ LINHALL2_OK
Definition: linhall2.h:124
@ LINHALL2_ERROR
Definition: linhall2.h:125
LIN Hall 2 Click configuration object.
Definition: linhall2.h:109
analog_in_resolution_t resolution
Definition: linhall2.h:113
float vref
Definition: linhall2.h:114
pin_name_t en
Definition: linhall2.h:111
pin_name_t an
Definition: linhall2.h:110
LIN Hall 2 Click context object.
Definition: linhall2.h:97
digital_out_t en
Definition: linhall2.h:98
analog_in_t adc
Definition: linhall2.h:100