bihall  2.0.0.0
bihall.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * 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 );
52 
58 #define BIHALL_RETVAL uint8_t
59 
60 #define BIHALL_OK 0x00
61 #define BIHALL_INIT_ERROR 0xFF
62 
69 #define BIHALL_MAG_POLE_NORTH 0
70 #define BIHALL_MAG_POLE_SOUTH 1
71  // End group macro
74 // --------------------------------------------------------------- PUBLIC TYPES
83 typedef struct
84 {
85  // Input pins
86 
87  digital_in_t int_pin;
88 
89 } bihall_t;
90 
94 typedef struct
95 {
96  // Additional gpio pins
97 
98  pin_name_t int_pin;
99 
100 } bihall_cfg_t;
101  // End types group
103 // ------------------------------------------------------------------ CONSTANTS // End constants group
112 // ------------------------------------------------------------------ VARIABLES // End variable group
120 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
121 
127 #ifdef __cplusplus
128 extern "C"{
129 #endif
130 
140 void bihall_cfg_setup ( bihall_cfg_t *cfg );
141 
151 
167 uint8_t bihall_det_mag_field ( bihall_t *ctx );
168 
169 
170 #ifdef __cplusplus
171 }
172 #endif
173 #endif // _BIHALL_H_
174  // End public_function group
177 
178 // ------------------------------------------------------------------------- END
BIHALL_RETVAL
#define BIHALL_RETVAL
Definition: bihall.h:58
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:87
bihall_cfg_setup
void bihall_cfg_setup(bihall_cfg_t *cfg)
Config Object Initialization function.
bihall_t
Click ctx object definition.
Definition: bihall.h:83
bihall_cfg_t::int_pin
pin_name_t int_pin
Definition: bihall.h:98
bihall_cfg_t
Click configuration structure definition.
Definition: bihall.h:94