optoencoder3  2.0.0.0
optoencoder3.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 OPTOENCODER3_H
36 #define OPTOENCODER3_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 OPTOENCODER3_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.o1= MIKROBUS( mikrobus, MIKROBUS_AN ); \
63  cfg.o2= MIKROBUS( mikrobus, MIKROBUS_RST ); \
64  cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
65  cfg.o4= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
66  cfg.o3= MIKROBUS( mikrobus, MIKROBUS_INT );
67 
73 #define OPTOENCODER3_RETVAL uint8_t
74 
75 #define OPTOENCODER3_OK 0x00
76 #define OPTOENCODER3_INIT_ERROR 0xFF
77 
83 #define OPTOENCODER3_ENABLE 0
84 #define OPTOENCODER3_DISABLE 1
85 
91 #define OPTOENCODER3_PIN_ACTIVE 0
92 #define OPTOENCODER3_PIN_NOT_ACTIVE 1
93  // End group macro
96 // --------------------------------------------------------------- PUBLIC TYPES
105 typedef struct
106 {
107  // Output pins
108 
109  digital_out_t en;
110 
111  // Input pins
112 
113  digital_in_t o1;
114  digital_in_t o2;
115  digital_in_t o4;
116  digital_in_t o3;
117 
118  uint8_t dev_cnt;
121  uint8_t dev_stage;
122 
124 
128 typedef struct
129 {
130  // Additional gpio pins
131 
132  pin_name_t o1;
133  pin_name_t o2;
134  pin_name_t en;
135  pin_name_t o4;
136  pin_name_t o3;
137 
139 
143 typedef struct
144 {
145  uint8_t pin_o1;
146  uint8_t pin_o2;
147  uint8_t pin_o3;
148  uint8_t pin_o4;
149 
151  // End types group
153 
154 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
155 
161 #ifdef __cplusplus
162 extern "C"{
163 #endif
164 
174 
183 
191 void optoencoder3_enable ( optoencoder3_t *ctx, uint8_t active );
192 
201 
210 
219 
228 
237 
251 
258 
267 
268 
269 #ifdef __cplusplus
270 }
271 #endif
272 #endif // _OPTOENCODER3_H_
273  // End public_function group
276 
277 // ------------------------------------------------------------------------- END
optoencoder3_read_pin_o1
uint8_t optoencoder3_read_pin_o1(optoencoder3_t *ctx)
Functions for reading state of pin o1.
optoencoder3_t
Click ctx object definition.
Definition: optoencoder3.h:106
optoencoder3_pins_t::pin_o1
uint8_t pin_o1
Definition: optoencoder3.h:145
optoencoder3_cfg_setup
void optoencoder3_cfg_setup(optoencoder3_cfg_t *cfg)
Config Object Initialization function.
optoencoder3_t::o1
digital_in_t o1
Definition: optoencoder3.h:113
optoencoder3_t::o4
digital_in_t o4
Definition: optoencoder3.h:115
optoencoder3_cfg_t
Click configuration structure definition.
Definition: optoencoder3.h:129
optoencoder3_cfg_t::o4
pin_name_t o4
Definition: optoencoder3.h:135
optoencoder3_enable
void optoencoder3_enable(optoencoder3_t *ctx, uint8_t active)
Sets state of click.
optoencoder3_pins_t
Click pins state.
Definition: optoencoder3.h:144
optoencoder3_cnt
uint8_t optoencoder3_cnt(optoencoder3_t *ctx)
Functions for reading number of swipes.
pins
optoencoder3_pins_t pins
Definition: main.c:32
OPTOENCODER3_RETVAL
#define OPTOENCODER3_RETVAL
Definition: optoencoder3.h:73
optoencoder3_cfg_t::o3
pin_name_t o3
Definition: optoencoder3.h:136
optoencoder3_init
OPTOENCODER3_RETVAL optoencoder3_init(optoencoder3_t *ctx, optoencoder3_cfg_t *cfg)
Initialization function.
optoencoder3_t::o3
digital_in_t o3
Definition: optoencoder3.h:116
optoencoder3_t::o2
digital_in_t o2
Definition: optoencoder3.h:114
optoencoder3_pins_t::pin_o2
uint8_t pin_o2
Definition: optoencoder3.h:146
optoencoder3_read_pin_o2
uint8_t optoencoder3_read_pin_o2(optoencoder3_t *ctx)
Functions for reading state of pin o2.
optoencoder3_t::dev_swiping_dir
uint8_t dev_swiping_dir
Definition: optoencoder3.h:120
optoencoder3_read_all_pins
void optoencoder3_read_all_pins(optoencoder3_t *ctx, optoencoder3_pins_t *pins)
Sets state of all pins.
optoencoder3_read_pin_o4
uint8_t optoencoder3_read_pin_o4(optoencoder3_t *ctx)
Functions for reading state of pin o4.
optoencoder3_pins_t::pin_o4
uint8_t pin_o4
Definition: optoencoder3.h:148
optoencoder3_t::dev_stage
uint8_t dev_stage
Definition: optoencoder3.h:121
optoencoder3_cfg_t::o1
pin_name_t o1
Definition: optoencoder3.h:132
optoencoder3_t::dev_swipe_cnt
int8_t dev_swipe_cnt
Definition: optoencoder3.h:119
optoencoder3_pins_t::pin_o3
uint8_t pin_o3
Definition: optoencoder3.h:147
optoencoder3_t::dev_cnt
uint8_t dev_cnt
Definition: optoencoder3.h:118
optoencoder3_dir_cnt
int8_t optoencoder3_dir_cnt(optoencoder3_t *ctx)
Functions for reading number of swipe directions.
optoencoder3_read_pin_o3
uint8_t optoencoder3_read_pin_o3(optoencoder3_t *ctx)
Functions for reading state of pin o3.
optoencoder3_cfg_t::o2
pin_name_t o2
Definition: optoencoder3.h:133
optoencoder3_cfg_t::en
pin_name_t en
Definition: optoencoder3.h:134
optoencoder3_reset_counters
void optoencoder3_reset_counters(optoencoder3_t *ctx)
Functions for reseting counters.
optoencoder3_t::en
digital_out_t en
Definition: optoencoder3.h:109