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 "drv_digital_in.h"
39 
40 // -------------------------------------------------------------- PUBLIC MACROS
50 #define IRECLIPSE_MAP_MIKROBUS( cfg, mikrobus ) \
51  cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
52 
58 #define IRECLIPSE_RETVAL uint8_t
59 
60 #define IRECLIPSE_OK 0x00
61 #define IRECLIPSE_INIT_ERROR 0xFF
62 
69 #define IRECLIPSE_LOW 0
70 #define IRECLIPSE_HIGH 1
71 
78 #define IRECLIPSE_START_CNT_VAL 0
79  // End group macro
82 // --------------------------------------------------------------- PUBLIC TYPES
91 typedef struct
92 {
93 
94  // Input pins
95 
96  digital_in_t int_pin;
97 
98 } ireclipse_t;
99 
103 typedef struct
104 {
105  // Additional gpio pins
106 
107  pin_name_t int_pin;
108 
110  // End types group
112 // ------------------------------------------------------------------ CONSTANTS // End constants group
121 // ------------------------------------------------------------------ VARIABLES // End variable group
129 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
130 
136 #ifdef __cplusplus
137 extern "C"{
138 #endif
139 
149 
158 
172 
173 #ifdef __cplusplus
174 }
175 #endif
176 #endif // _IRECLIPSE_H_
177  // End public_function group
180 
181 // ------------------------------------------------------------------------- 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:92
ireclipse_cfg_t::int_pin
pin_name_t int_pin
Definition: ireclipse.h:107
ireclipse_cfg_t
Click configuration structure definition.
Definition: ireclipse.h:104
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:58
ireclipse_t::int_pin
digital_in_t int_pin
Definition: ireclipse.h:96
ireclipse_init
IRECLIPSE_RETVAL ireclipse_init(ireclipse_t *ctx, ireclipse_cfg_t *cfg)
Initialization function.