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 
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_out.h"
49 #include "drv_digital_in.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define OPTO_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.in4= MIKROBUS( mikrobus, MIKROBUS_AN ); \
63  cfg.in3= MIKROBUS( mikrobus, MIKROBUS_RST ); \
64  cfg.in2= MIKROBUS( mikrobus, MIKROBUS_CS ); \
65  cfg.in1= MIKROBUS( mikrobus, MIKROBUS_INT )
66 
72 #define OPTO_RETVAL uint8_t
73 
74 #define OPTO_OK 0x00
75 #define OPTO_INIT_ERROR 0xFF
76  // End group macro
79 // --------------------------------------------------------------- PUBLIC TYPES
88 typedef struct
89 {
90 
91  // Input pins
92 
93  digital_in_t in4;
94  digital_in_t in3;
95  digital_in_t in2;
96  digital_in_t in1;
97 
98 } opto_t;
99 
103 typedef struct
104 {
105  // Additional gpio pins
106 
107  pin_name_t in4;
108  pin_name_t in3;
109  pin_name_t in2;
110  pin_name_t in1;
111 
112 } opto_cfg_t;
113  // End types group
115 
116 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
117 
123 #ifdef __cplusplus
124 extern "C"{
125 #endif
126 
136 
145 
155 uint8_t opto_check_out1( opto_t *ctx );
156 
166 uint8_t opto_check_out2( opto_t *ctx );
167 
177 uint8_t opto_check_out3( opto_t *ctx );
178 
188 uint8_t opto_check_out4( opto_t *ctx );
189 
190 
191 #ifdef __cplusplus
192 }
193 #endif
194 #endif // _OPTO_H_
195  // End public_function group
198 
199 // ------------------------------------------------------------------------- END
opto_t::in4
digital_in_t in4
Definition: opto.h:93
opto_check_out4
uint8_t opto_check_out4(opto_t *ctx)
OUT4 Check function.
opto_cfg_t
Click configuration structure definition.
Definition: opto.h:104
opto_cfg_t::in2
pin_name_t in2
Definition: opto.h:109
opto_cfg_t::in4
pin_name_t in4
Definition: opto.h:107
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:108
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:94
opto_t::in2
digital_in_t in2
Definition: opto.h:95
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:110
OPTO_RETVAL
#define OPTO_RETVAL
Definition: opto.h:72
opto_t
Click ctx object definition.
Definition: opto.h:89
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:96