optoencoder  2.0.0.0
optoencoder.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 OPTOENCODER_H
36 #define OPTOENCODER_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define OPTOENCODER_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.o1= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
67  cfg.o2= MIKROBUS( mikrobus, MIKROBUS_INT );
68 
74 #define OPTOENCODER_RETVAL uint8_t
75 
76 #define OPTOENCODER_OK 0x00
77 #define OPTOENCODER_INIT_ERROR 0xFF
78  // End group macro
81 // --------------------------------------------------------------- PUBLIC TYPES
90 typedef struct
91 {
92  // Input pins
93 
94  digital_in_t o1;
95  digital_in_t o2;
96 
97  uint8_t rotary_flag;
98  uint8_t o1_flag;
99  uint8_t o2_flag;
100  int16_t dev_rotation;
101 
102 } optoencoder_t;
103 
107 typedef struct
108 {
109  // Additional gpio pins
110 
111  pin_name_t o1;
112  pin_name_t o2;
113 
115  // End types group
117 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
118 
124 #ifdef __cplusplus
125 extern "C"{
126 #endif
127 
137 
146 
155 
164 
171 
180 
181 #ifdef __cplusplus
182 }
183 #endif
184 #endif // _OPTOENCODER_H_
185  // End public_function group
188 
189 // ------------------------------------------------------------------------- END
optoencoder_t
Click ctx object definition.
Definition: optoencoder.h:91
optoencoder_cfg_setup
void optoencoder_cfg_setup(optoencoder_cfg_t *cfg)
Config Object Initialization function.
optoencoder_t::dev_rotation
int16_t dev_rotation
Definition: optoencoder.h:100
optoencoder_cfg_t::o2
pin_name_t o2
Definition: optoencoder.h:112
optoencoder_init
OPTOENCODER_RETVAL optoencoder_init(optoencoder_t *ctx, optoencoder_cfg_t *cfg)
Initialization function.
optoencoder_get_o2
uint8_t optoencoder_get_o2(optoencoder_t *ctx)
Function for reading O2 state.
OPTOENCODER_RETVAL
#define OPTOENCODER_RETVAL
Definition: optoencoder.h:74
optoencoder_t::o1
digital_in_t o1
Definition: optoencoder.h:94
optoencoder_t::o1_flag
uint8_t o1_flag
Definition: optoencoder.h:98
optoencoder_t::rotary_flag
uint8_t rotary_flag
Definition: optoencoder.h:97
optoencoder_get_position
int16_t optoencoder_get_position(optoencoder_t *ctx)
Function for reading the position of the encoder.
optoencoder_t::o2_flag
uint8_t o2_flag
Definition: optoencoder.h:99
optoencoder_cfg_t
Click configuration structure definition.
Definition: optoencoder.h:108
optoencoder_init_dev
void optoencoder_init_dev(optoencoder_t *ctx)
Initialization function.
optoencoder_get_o1
uint8_t optoencoder_get_o1(optoencoder_t *ctx)
Function for reading O1 state.
optoencoder_cfg_t::o1
pin_name_t o1
Definition: optoencoder.h:111
optoencoder_t::o2
digital_in_t o2
Definition: optoencoder.h:95