opto2  2.0.0.0
opto2.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 OPTO2_H
36 #define OPTO2_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define OPTO2_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.in4= MIKROBUS( mikrobus, MIKROBUS_AN ); \
53  cfg.in3= MIKROBUS( mikrobus, MIKROBUS_RST ); \
54  cfg.in2= MIKROBUS( mikrobus, MIKROBUS_CS ); \
55  cfg.in1= MIKROBUS( mikrobus, MIKROBUS_INT );
56 
62 #define OPTO2_RETVAL uint8_t
63 
64 #define OPTO2_OK 0x00
65 #define OPTO2_INIT_ERROR 0xFF
66  // End group macro
69 // --------------------------------------------------------------- PUBLIC TYPES
78 typedef struct
79 {
80  // Input pins
81 
82  digital_in_t in4;
83  digital_in_t in3;
84  digital_in_t in2;
85  digital_in_t in1;
86 
87 } opto2_t;
88 
92 typedef struct
93 {
94  // Additional gpio pins
95 
96  pin_name_t in4;
97  pin_name_t in3;
98  pin_name_t in2;
99  pin_name_t in1;
100 
101 } opto2_cfg_t;
102  // End types group
104 
105 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
106 
112 #ifdef __cplusplus
113 extern "C"{
114 #endif
115 
124 void opto2_cfg_setup ( opto2_cfg_t *cfg );
125 
134 
142 uint8_t opto2_check_out1 ( opto2_t *ctx );
143 
151 uint8_t opto2_check_out2 ( opto2_t *ctx );
152 
160 uint8_t opto2_check_out3 ( opto2_t *ctx );
161 
169 uint8_t opto2_check_out4 ( opto2_t *ctx );
170 
171 #ifdef __cplusplus
172 }
173 #endif
174 #endif // _OPTO2_H_
175  // End public_function group
178 
179 // ------------------------------------------------------------------------- END
opto2_cfg_t::in2
pin_name_t in2
Definition: opto2.h:98
opto2_check_out3
uint8_t opto2_check_out3(opto2_t *ctx)
OUT3 Check function.
opto2_t::in1
digital_in_t in1
Definition: opto2.h:85
opto2_t::in4
digital_in_t in4
Definition: opto2.h:82
opto2_check_out4
uint8_t opto2_check_out4(opto2_t *ctx)
OUT4 Check function.
OPTO2_RETVAL
#define OPTO2_RETVAL
Definition: opto2.h:62
opto2_check_out1
uint8_t opto2_check_out1(opto2_t *ctx)
OUT1 Check function.
opto2_check_out2
uint8_t opto2_check_out2(opto2_t *ctx)
OUT2 Check function.
opto2_t::in2
digital_in_t in2
Definition: opto2.h:84
opto2_cfg_setup
void opto2_cfg_setup(opto2_cfg_t *cfg)
Config Object Initialization function.
opto2_t
Click ctx object definition.
Definition: opto2.h:78
opto2_cfg_t::in3
pin_name_t in3
Definition: opto2.h:97
opto2_cfg_t
Click configuration structure definition.
Definition: opto2.h:92
opto2_cfg_t::in1
pin_name_t in1
Definition: opto2.h:99
opto2_cfg_t::in4
pin_name_t in4
Definition: opto2.h:96
opto2_init
OPTO2_RETVAL opto2_init(opto2_t *ctx, opto2_cfg_t *cfg)
Initialization function.
opto2_t::in3
digital_in_t in3
Definition: opto2.h:83