opto  2.0.0.0
opto.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 OPTO_H
36 #define OPTO_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_out.h"
53 #include "drv_digital_in.h"
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define OPTO_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.in4= MIKROBUS( mikrobus, MIKROBUS_AN ); \
67  cfg.in3= MIKROBUS( mikrobus, MIKROBUS_RST ); \
68  cfg.in2= MIKROBUS( mikrobus, MIKROBUS_CS ); \
69  cfg.in1= MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define OPTO_RETVAL uint8_t
77 
78 #define OPTO_OK 0x00
79 #define OPTO_INIT_ERROR 0xFF
80  // End group macro
83 // --------------------------------------------------------------- PUBLIC TYPES
92 typedef struct
93 {
94 
95  // Input pins
96 
97  digital_in_t in4;
98  digital_in_t in3;
99  digital_in_t in2;
100  digital_in_t in1;
101 
102 } opto_t;
103 
107 typedef struct
108 {
109  // Additional gpio pins
110 
111  pin_name_t in4;
112  pin_name_t in3;
113  pin_name_t in2;
114  pin_name_t in1;
115 
116 } opto_cfg_t;
117  // End types group
119 
120 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
121 
127 #ifdef __cplusplus
128 extern "C"{
129 #endif
130 
140 
149 
159 uint8_t opto_check_out1( opto_t *ctx );
160 
170 uint8_t opto_check_out2( opto_t *ctx );
171 
181 uint8_t opto_check_out3( opto_t *ctx );
182 
192 uint8_t opto_check_out4( opto_t *ctx );
193 
194 
195 #ifdef __cplusplus
196 }
197 #endif
198 #endif // _OPTO_H_
199  // End public_function group
202 
203 // ------------------------------------------------------------------------- END
opto_t::in4
digital_in_t in4
Definition: opto.h:97
opto_check_out4
uint8_t opto_check_out4(opto_t *ctx)
OUT4 Check function.
opto_cfg_t
Click configuration structure definition.
Definition: opto.h:108
opto_cfg_t::in2
pin_name_t in2
Definition: opto.h:113
opto_cfg_t::in4
pin_name_t in4
Definition: opto.h:111
opto_check_out3
uint8_t opto_check_out3(opto_t *ctx)
OUT3 Check function.
opto_cfg_t::in3
pin_name_t in3
Definition: opto.h:112
opto_check_out2
uint8_t opto_check_out2(opto_t *ctx)
OUT2 Check function.
opto_check_out1
uint8_t opto_check_out1(opto_t *ctx)
OUT1 Check function.
opto_t::in3
digital_in_t in3
Definition: opto.h:98
opto_t::in2
digital_in_t in2
Definition: opto.h:99
opto_cfg_setup
void opto_cfg_setup(opto_cfg_t *cfg)
Config Object Initialization function.
opto_cfg_t::in1
pin_name_t in1
Definition: opto.h:114
OPTO_RETVAL
#define OPTO_RETVAL
Definition: opto.h:76
opto_t
Click ctx object definition.
Definition: opto.h:93
opto_init
OPTO_RETVAL opto_init(opto_t *ctx, opto_cfg_t *cfg)
Initialization function.
opto_t::in1
digital_in_t in1
Definition: opto.h:100