optoencoder4  2.1.0.0
optoencoder4.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef OPTOENCODER4_H
29 #define OPTOENCODER4_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 
72 #define OPTOENCODER4_MAP_MIKROBUS( cfg, mikrobus ) \
73  cfg.out = MIKROBUS( mikrobus, MIKROBUS_AN ); \
74  cfg.our = MIKROBUS( mikrobus, MIKROBUS_INT )
75  // optoencoder4_map // optoencoder4
78 
83 typedef struct
84 {
85  digital_in_t out;
86  digital_in_t our;
89 
94 typedef struct
95 {
96  pin_name_t out;
97  pin_name_t our;
100 
105 typedef enum
106 {
108  OPTOENCODER4_ERROR = -1
109 
111 
128 
143 
154 
165 
166 #ifdef __cplusplus
167 }
168 #endif
169 #endif // OPTOENCODER4_H
170  // optoencoder4
172 
173 // ------------------------------------------------------------------------ END
optoencoder4_return_value_t
optoencoder4_return_value_t
Opto Encoder 4 Click return value data.
Definition: optoencoder4.h:106
optoencoder4_init
err_t optoencoder4_init(optoencoder4_t *ctx, optoencoder4_cfg_t *cfg)
Opto Encoder 4 initialization function.
optoencoder4_cfg_t
Opto Encoder 4 Click configuration object.
Definition: optoencoder4.h:95
optoencoder4_get_our_pin
uint8_t optoencoder4_get_our_pin(optoencoder4_t *ctx)
Opto Encoder 4 get our pin function.
optoencoder4_t
Opto Encoder 4 Click context object.
Definition: optoencoder4.h:84
optoencoder4_cfg_setup
void optoencoder4_cfg_setup(optoencoder4_cfg_t *cfg)
Opto Encoder 4 configuration object setup function.
optoencoder4_t::out
digital_in_t out
Definition: optoencoder4.h:85
optoencoder4_cfg_t::our
pin_name_t our
Definition: optoencoder4.h:97
OPTOENCODER4_ERROR
@ OPTOENCODER4_ERROR
Definition: optoencoder4.h:108
optoencoder4_get_out_pin
uint8_t optoencoder4_get_out_pin(optoencoder4_t *ctx)
Opto Encoder 4 get out pin function.
optoencoder4_t::our
digital_in_t our
Definition: optoencoder4.h:86
OPTOENCODER4_OK
@ OPTOENCODER4_OK
Definition: optoencoder4.h:107
optoencoder4_cfg_t::out
pin_name_t out
Definition: optoencoder4.h:96