reed  2.0.0.0
reed.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 REED_H
36 #define REED_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define REED_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.cs= MIKROBUS( mikrobus, MIKROBUS_CS );
53 
59 #define REED_RETVAL uint8_t
60 
61 #define REED_OK 0x00
62 #define REED_INIT_ERROR 0xFF
63 
69 #define REED_NO_MAGNETIC_FIELD 0
70 #define REED_MAGNETIC_FIELD_DETECTED 1
71  // End group macro
74 // --------------------------------------------------------------- PUBLIC TYPES
83 typedef struct
84 {
85  // Input pins
86 
87  digital_in_t cs;
88 
89 } reed_t;
90 
94 typedef struct
95 {
96  // Additional gpio pins
97 
98  pin_name_t cs;
99 
100 } reed_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 
139 void reed_cfg_setup ( reed_cfg_t *cfg );
140 
148 REED_RETVAL reed_init ( reed_t *ctx, reed_cfg_t *cfg );
149 
162 uint8_t reed_get_status ( reed_t *ctx );
163 
164 
165 #ifdef __cplusplus
166 }
167 #endif
168 #endif // _REED_H_
169  // End public_function group
172 
173 // ------------------------------------------------------------------------- END
uint8_t reed_get_status(reed_t *ctx)
Get sensor magnetic detected status function.
REED_RETVAL reed_init(reed_t *ctx, reed_cfg_t *cfg)
Initialization function.
Click ctx object definition.
Definition: reed.h:83
pin_name_t cs
Definition: reed.h:98
#define REED_RETVAL
Definition: reed.h:59
digital_in_t cs
Definition: reed.h:87
void reed_cfg_setup(reed_cfg_t *cfg)
Config Object Initialization function.
Click configuration structure definition.
Definition: reed.h:94