bihall
2.0.0.0
cmake
bihall
lib_bihall
include
bihall.h
Go to the documentation of this file.
1
/*
2
* MikroSDK - MikroE Software Development Kit
3
* Copyright© 2020 MikroElektronika d.o.o.
4
*
5
* Permission is hereby granted, free of charge, to any person
6
* obtaining a copy of this software and associated documentation
7
* files (the "Software"), to deal in the Software without restriction,
8
* including without limitation the rights to use, copy, modify, merge,
9
* publish, distribute, sublicense, and/or sell copies of the Software,
10
* and to permit persons to whom the Software is furnished to do so,
11
* subject to the following conditions:
12
*
13
* The above copyright notice and this permission notice shall be
14
* included in all copies or substantial portions of the Software.
15
*
16
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22
* OR OTHER DEALINGS IN THE SOFTWARE.
23
*/
24
33
// ----------------------------------------------------------------------------
34
35
#ifndef BIHALL_H
36
#define BIHALL_H
37
42
#ifdef PREINIT_SUPPORTED
43
#include "preinit.h"
44
#endif
45
46
#ifdef MikroCCoreVersion
47
#if MikroCCoreVersion >= 1
48
#include "delays.h"
49
#endif
50
#endif
51
52
#include "drv_digital_in.h"
53
54
// -------------------------------------------------------------- PUBLIC MACROS
64
#define BIHALL_MAP_MIKROBUS( cfg, mikrobus ) \
65
cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
66
72
#define BIHALL_RETVAL uint8_t
73
74
#define BIHALL_OK 0x00
75
#define BIHALL_INIT_ERROR 0xFF
76
83
#define BIHALL_MAG_POLE_NORTH 0
84
#define BIHALL_MAG_POLE_SOUTH 1
85
// End group macro
88
// --------------------------------------------------------------- PUBLIC TYPES
97
typedef
struct
98
{
99
// Input pins
100
101
digital_in_t
int_pin
;
102
103
}
bihall_t
;
104
108
typedef
struct
109
{
110
// Additional gpio pins
111
112
pin_name_t
int_pin
;
113
114
}
bihall_cfg_t
;
115
// End types group
117
// ------------------------------------------------------------------ CONSTANTS // End constants group
126
// ------------------------------------------------------------------ VARIABLES // End variable group
134
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
135
141
#ifdef __cplusplus
142
extern
"C"
{
143
#endif
144
154
void
bihall_cfg_setup
(
bihall_cfg_t
*cfg );
155
164
BIHALL_RETVAL
bihall_init
(
bihall_t
*ctx,
bihall_cfg_t
*cfg );
165
181
uint8_t
bihall_det_mag_field
(
bihall_t
*ctx );
182
183
184
#ifdef __cplusplus
185
}
186
#endif
187
#endif // _BIHALL_H_
188
// End public_function group
191
192
// ------------------------------------------------------------------------- END
BIHALL_RETVAL
#define BIHALL_RETVAL
Definition:
bihall.h:72
bihall_det_mag_field
uint8_t bihall_det_mag_field(bihall_t *ctx)
Detecting south & north pole magnetic fields status function.
bihall_init
BIHALL_RETVAL bihall_init(bihall_t *ctx, bihall_cfg_t *cfg)
Initialization function.
bihall_t::int_pin
digital_in_t int_pin
Definition:
bihall.h:101
bihall_cfg_setup
void bihall_cfg_setup(bihall_cfg_t *cfg)
Config Object Initialization function.
bihall_t
Click ctx object definition.
Definition:
bihall.h:98
bihall_cfg_t::int_pin
pin_name_t int_pin
Definition:
bihall.h:112
bihall_cfg_t
Click configuration structure definition.
Definition:
bihall.h:109
Generated by
1.8.20