ireclipse  2.0.0.0
ireclipse.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 IRECLIPSE_H
36 #define IRECLIPSE_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 IRECLIPSE_MAP_MIKROBUS( cfg, mikrobus ) \
65  cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
66 
72 #define IRECLIPSE_RETVAL uint8_t
73 
74 #define IRECLIPSE_OK 0x00
75 #define IRECLIPSE_INIT_ERROR 0xFF
76 
83 #define IRECLIPSE_LOW 0
84 #define IRECLIPSE_HIGH 1
85 
92 #define IRECLIPSE_START_CNT_VAL 0
93  // End group macro
96 // --------------------------------------------------------------- PUBLIC TYPES
105 typedef struct
106 {
107 
108  // Input pins
109 
110  digital_in_t int_pin;
111 
112 } ireclipse_t;
113 
117 typedef struct
118 {
119  // Additional gpio pins
120 
121  pin_name_t int_pin;
122 
124  // End types group
126 // ------------------------------------------------------------------ CONSTANTS // End constants group
135 // ------------------------------------------------------------------ VARIABLES // End variable group
143 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
144 
150 #ifdef __cplusplus
151 extern "C"{
152 #endif
153 
163 
172 
186 
187 #ifdef __cplusplus
188 }
189 #endif
190 #endif // _IRECLIPSE_H_
191  // End public_function group
194 
195 // ------------------------------------------------------------------------- END
ireclipse_cfg_setup
void ireclipse_cfg_setup(ireclipse_cfg_t *cfg)
Config Object Initialization function.
ireclipse_t
Click ctx object definition.
Definition: ireclipse.h:106
ireclipse_cfg_t::int_pin
pin_name_t int_pin
Definition: ireclipse.h:121
ireclipse_cfg_t
Click configuration structure definition.
Definition: ireclipse.h:118
ireclipse_int_status
uint8_t ireclipse_int_status(ireclipse_t *ctx)
Detecting states of IR beam from EE-SX198 photo interrupter sensor.
IRECLIPSE_RETVAL
#define IRECLIPSE_RETVAL
Definition: ireclipse.h:72
ireclipse_t::int_pin
digital_in_t int_pin
Definition: ireclipse.h:110
ireclipse_init
IRECLIPSE_RETVAL ireclipse_init(ireclipse_t *ctx, ireclipse_cfg_t *cfg)
Initialization function.