optoencoder2  2.0.0.0
optoencoder2.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 OPTOENCODER2_H
36 #define OPTOENCODER2_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define OPTOENCODER2_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.b_pin = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
53  cfg.a_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
54 
60 #define OPTOENCODER2_OK 0
61 #define OPTOENCODER2_ERROR -1
62  // End group macro
65 // --------------------------------------------------------------- PUBLIC TYPES
74 typedef struct
75 {
76  // Input pins
77  digital_in_t b_pin;
78  digital_in_t a_pin;
79 
80  uint32_t timeout_counter;
82 
84 
88 typedef struct
89 {
90  // Additional gpio pins
91  pin_name_t b_pin;
92  pin_name_t a_pin;
93 
95  // End types group
97 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
98 
104 #ifdef __cplusplus
105 extern "C"{
106 #endif
107 
117 
126 
139 
152 
164 
174 
194 uint8_t optoencoder2_isr ( optoencoder2_t *ctx, uint8_t n_cycles );
195 
196 #ifdef __cplusplus
197 }
198 #endif
199 #endif // _OPTOENCODER2_H_
200  // End public_function group
203 
204 // ------------------------------------------------------------------------- END
optoencoder2_t::position_counter
int32_t position_counter
Definition: optoencoder2.h:81
optoencoder2_init
err_t optoencoder2_init(optoencoder2_t *ctx, optoencoder2_cfg_t *cfg)
Initialization function.
optoencoder2_t::b_pin
digital_in_t b_pin
Definition: optoencoder2.h:77
optoencoder2_isr
uint8_t optoencoder2_isr(optoencoder2_t *ctx, uint8_t n_cycles)
Incrementing/decrementing encoder counter.
optoencoder2_cfg_t
Click configuration structure definition.
Definition: optoencoder2.h:89
optoencoder2_pwm_get
uint8_t optoencoder2_pwm_get(optoencoder2_t *ctx)
Getting PWM pin state.
optoencoder2_t
Click ctx object definition.
Definition: optoencoder2.h:75
optoencoder2_cfg_t::a_pin
pin_name_t a_pin
Definition: optoencoder2.h:92
optoencoder2_get_position
int32_t optoencoder2_get_position(optoencoder2_t *ctx)
Getting encoder position.
optoencoder2_int_get
uint8_t optoencoder2_int_get(optoencoder2_t *ctx)
Getting INT pin state.
optoencoder2_cfg_setup
void optoencoder2_cfg_setup(optoencoder2_cfg_t *cfg)
Config Object Initialization function.
optoencoder2_cfg_t::b_pin
pin_name_t b_pin
Definition: optoencoder2.h:91
optoencoder2_t::a_pin
digital_in_t a_pin
Definition: optoencoder2.h:78
optoencoder2_t::timeout_counter
uint32_t timeout_counter
Definition: optoencoder2.h:80
optoencoder2_zero_counter
void optoencoder2_zero_counter(optoencoder2_t *ctx)
Reset encoder counter.