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 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_in.h"
49 
50 // -------------------------------------------------------------- PUBLIC MACROS
60 #define IRECLIPSE_MAP_MIKROBUS( cfg, mikrobus ) \
61  cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
62 
68 #define IRECLIPSE_RETVAL uint8_t
69 
70 #define IRECLIPSE_OK 0x00
71 #define IRECLIPSE_INIT_ERROR 0xFF
72 
79 #define IRECLIPSE_LOW 0
80 #define IRECLIPSE_HIGH 1
81 
88 #define IRECLIPSE_START_CNT_VAL 0
89  // End group macro
92 // --------------------------------------------------------------- PUBLIC TYPES
101 typedef struct
102 {
103 
104  // Input pins
105 
106  digital_in_t int_pin;
107 
108 } ireclipse_t;
109 
113 typedef struct
114 {
115  // Additional gpio pins
116 
117  pin_name_t int_pin;
118 
120  // End types group
122 // ------------------------------------------------------------------ CONSTANTS // End constants group
131 // ------------------------------------------------------------------ VARIABLES // End variable group
139 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
140 
146 #ifdef __cplusplus
147 extern "C"{
148 #endif
149 
159 
168 
182 
183 #ifdef __cplusplus
184 }
185 #endif
186 #endif // _IRECLIPSE_H_
187  // End public_function group
190 
191 // ------------------------------------------------------------------------- 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:102
ireclipse_cfg_t::int_pin
pin_name_t int_pin
Definition: ireclipse.h:117
ireclipse_cfg_t
Click configuration structure definition.
Definition: ireclipse.h:114
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:68
ireclipse_t::int_pin
digital_in_t int_pin
Definition: ireclipse.h:106
ireclipse_init
IRECLIPSE_RETVAL ireclipse_init(ireclipse_t *ctx, ireclipse_cfg_t *cfg)
Initialization function.