bihall 2.0.0.0
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
38#include "drv_digital_in.h"
39
40// -------------------------------------------------------------- PUBLIC MACROS
50#define BIHALL_MAP_MIKROBUS( cfg, mikrobus ) \
51 cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
58#define BIHALL_RETVAL uint8_t
59
60#define BIHALL_OK 0x00
61#define BIHALL_INIT_ERROR 0xFF
69#define BIHALL_MAG_POLE_NORTH 0
70#define BIHALL_MAG_POLE_SOUTH 1 // End group macro
74// --------------------------------------------------------------- PUBLIC TYPES
83typedef struct
84{
85 // Input pins
86
87 digital_in_t int_pin;
88
89} bihall_t;
90
94typedef struct
95{
96 // Additional gpio pins
97
98 pin_name_t int_pin;
99
101 // End types group
103// ------------------------------------------------------------------ CONSTANTS // End constants group
112// ------------------------------------------------------------------ VARIABLES // End variable group
120// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
121
127#ifdef __cplusplus
128extern "C"{
129#endif
130
141
151
168
169
170#ifdef __cplusplus
171}
172#endif
173#endif // _BIHALL_H_
174 // End public_function group
177
178// ------------------------------------------------------------------------- END
#define BIHALL_RETVAL
Definition: bihall.h:58
void bihall_cfg_setup(bihall_cfg_t *cfg)
Config Object Initialization function.
uint8_t bihall_det_mag_field(bihall_t *ctx)
Detecting south & north pole magnetic fields status function.
BIHALL_RETVAL bihall_init(bihall_t *ctx, bihall_cfg_t *cfg)
Initialization function.
Click configuration structure definition.
Definition: bihall.h:95
pin_name_t int_pin
Definition: bihall.h:98
Click ctx object definition.
Definition: bihall.h:84
digital_in_t int_pin
Definition: bihall.h:87