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 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define OPTOENCODER_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.o1= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
63  cfg.o2= MIKROBUS( mikrobus, MIKROBUS_INT );
64 
70 #define OPTOENCODER_RETVAL uint8_t
71 
72 #define OPTOENCODER_OK 0x00
73 #define OPTOENCODER_INIT_ERROR 0xFF
74  // End group macro
77 // --------------------------------------------------------------- PUBLIC TYPES
86 typedef struct
87 {
88  // Input pins
89 
90  digital_in_t o1;
91  digital_in_t o2;
92 
93  uint8_t rotary_flag;
94  uint8_t o1_flag;
95  uint8_t o2_flag;
96  int16_t dev_rotation;
97 
99 
103 typedef struct
104 {
105  // Additional gpio pins
106 
107  pin_name_t o1;
108  pin_name_t o2;
109 
111  // End types group
113 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
114 
120 #ifdef __cplusplus
121 extern "C"{
122 #endif
123 
133 
142 
151 
160 
167 
176 
177 #ifdef __cplusplus
178 }
179 #endif
180 #endif // _OPTOENCODER_H_
181  // End public_function group
184 
185 // ------------------------------------------------------------------------- END
optoencoder_t
Click ctx object definition.
Definition: optoencoder.h:87
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:96
optoencoder_cfg_t::o2
pin_name_t o2
Definition: optoencoder.h:108
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:70
optoencoder_t::o1
digital_in_t o1
Definition: optoencoder.h:90
optoencoder_t::o1_flag
uint8_t o1_flag
Definition: optoencoder.h:94
optoencoder_t::rotary_flag
uint8_t rotary_flag
Definition: optoencoder.h:93
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:95
optoencoder_cfg_t
Click configuration structure definition.
Definition: optoencoder.h:104
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:107
optoencoder_t::o2
digital_in_t o2
Definition: optoencoder.h:91