optoencoder5  2.1.0.0
optoencoder5.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 OPTOENCODER5_H
29 #define OPTOENCODER5_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 
67 #define OPTOENCODER5_OUT_STATE_SWITCH_OPEN 0
68 #define OPTOENCODER5_OUT_STATE_SWITCH_CLOSED 1
69  // optoencoder5_set
71 
86 #define OPTOENCODER5_MAP_MIKROBUS( cfg, mikrobus ) \
87  cfg.on = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
88  cfg.out = MIKROBUS( mikrobus, MIKROBUS_INT )
89  // optoencoder5_map // optoencoder5
92 
97 typedef struct
98 {
99  digital_out_t on;
100  digital_in_t out;
103 
108 typedef struct
109 {
110  pin_name_t on;
111  pin_name_t out;
114 
119 typedef enum
120 {
122  OPTOENCODER5_ERROR = -1
123 
125 
142 
157 
168 
179 
191 
192 #ifdef __cplusplus
193 }
194 #endif
195 #endif // OPTOENCODER5_H
196  // optoencoder5
198 
199 // ------------------------------------------------------------------------ END
optoencoder5_return_value_t
optoencoder5_return_value_t
Opto Encoder 5 Click return value data.
Definition: optoencoder5.h:120
optoencoder5_get_out_state
uint8_t optoencoder5_get_out_state(optoencoder5_t *ctx)
Opto Encoder 5 get state function.
optoencoder5_cfg_t
Opto Encoder 5 Click configuration object.
Definition: optoencoder5.h:109
optoencoder5_cfg_t::out
pin_name_t out
Definition: optoencoder5.h:111
optoencoder5_t
Opto Encoder 5 Click context object.
Definition: optoencoder5.h:98
optoencoder5_disable
void optoencoder5_disable(optoencoder5_t *ctx)
Opto Encoder 5 disable function.
OPTOENCODER5_ERROR
@ OPTOENCODER5_ERROR
Definition: optoencoder5.h:122
OPTOENCODER5_OK
@ OPTOENCODER5_OK
Definition: optoencoder5.h:121
optoencoder5_t::on
digital_out_t on
Definition: optoencoder5.h:99
optoencoder5_cfg_setup
void optoencoder5_cfg_setup(optoencoder5_cfg_t *cfg)
Opto Encoder 5 configuration object setup function.
optoencoder5_cfg_t::on
pin_name_t on
Definition: optoencoder5.h:110
optoencoder5_t::out
digital_in_t out
Definition: optoencoder5.h:100
optoencoder5_init
err_t optoencoder5_init(optoencoder5_t *ctx, optoencoder5_cfg_t *cfg)
Opto Encoder 5 initialization function.
optoencoder5_enable
void optoencoder5_enable(optoencoder5_t *ctx)
Opto Encoder 5 enable function.