stepper4  2.1.0.0
stepper4.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 STEPPER4_H
29 #define STEPPER4_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 
68 #define STEPPER4_DIR_CW 0
69 #define STEPPER4_DIR_CCW 1
70 
75 #define STEPPER4_PIN_LOW_LEVEL 0
76 #define STEPPER4_PIN_HIGH_LEVEL 1
77 
82 #define STEPPER4_SPEED_VERY_SLOW 0
83 #define STEPPER4_SPEED_SLOW 1
84 #define STEPPER4_SPEED_MEDIUM 2
85 #define STEPPER4_SPEED_FAST 3
86 #define STEPPER4_SPEED_VERY_FAST 4
87  // stepper4_set
89 
104 #define STEPPER4_MAP_MIKROBUS( cfg, mikrobus ) \
105  cfg.dir = MIKROBUS( mikrobus, MIKROBUS_AN ); \
106  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
107  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
108  cfg.step = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
109  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
110  // stepper4_map // stepper4
113 
118 typedef struct
119 {
120  digital_out_t dir;
121  digital_out_t rst;
122  digital_out_t en;
123  digital_out_t step;
125  digital_in_t int_pin;
127 } stepper4_t;
128 
133 typedef struct
134 {
135  pin_name_t dir;
136  pin_name_t rst;
137  pin_name_t en;
138  pin_name_t step;
139  pin_name_t int_pin;
142 
147 typedef enum
148 {
150  STEPPER4_ERROR = -1
151 
153 
170 
185 
197 
213 void stepper4_drive_motor ( stepper4_t *ctx, uint32_t steps, uint8_t speed );
214 
224 
234 
245 void stepper4_set_direction ( stepper4_t *ctx, uint8_t dir );
246 
256 
266 
276 
287 void stepper4_set_step_pin ( stepper4_t *ctx, uint8_t state );
288 
289 #ifdef __cplusplus
290 }
291 #endif
292 #endif // STEPPER4_H
293  // stepper4
295 
296 // ------------------------------------------------------------------------ END
stepper4_cfg_t::rst
pin_name_t rst
Definition: stepper4.h:136
stepper4_enable_device
void stepper4_enable_device(stepper4_t *ctx)
Stepper 4 enable device function.
stepper4_cfg_t
Stepper 4 Click configuration object.
Definition: stepper4.h:134
stepper4_get_int_pin
uint8_t stepper4_get_int_pin(stepper4_t *ctx)
Stepper 4 get int pin function.
stepper4_t::en
digital_out_t en
Definition: stepper4.h:122
stepper4_default_cfg
void stepper4_default_cfg(stepper4_t *ctx)
Stepper 4 default configuration function.
stepper4_t
Stepper 4 Click context object.
Definition: stepper4.h:119
stepper4_return_value_t
stepper4_return_value_t
Stepper 4 Click return value data.
Definition: stepper4.h:148
stepper4_init
err_t stepper4_init(stepper4_t *ctx, stepper4_cfg_t *cfg)
Stepper 4 initialization function.
stepper4_drive_motor
void stepper4_drive_motor(stepper4_t *ctx, uint32_t steps, uint8_t speed)
Stepper 4 drive motor function.
stepper4_t::step
digital_out_t step
Definition: stepper4.h:123
stepper4_cfg_t::dir
pin_name_t dir
Definition: stepper4.h:135
stepper4_cfg_setup
void stepper4_cfg_setup(stepper4_cfg_t *cfg)
Stepper 4 configuration object setup function.
stepper4_cfg_t::int_pin
pin_name_t int_pin
Definition: stepper4.h:139
stepper4_set_direction
void stepper4_set_direction(stepper4_t *ctx, uint8_t dir)
Stepper 4 set direction function.
stepper4_disable_device
void stepper4_disable_device(stepper4_t *ctx)
Stepper 4 disable device function.
STEPPER4_OK
@ STEPPER4_OK
Definition: stepper4.h:149
stepper4_cfg_t::step
pin_name_t step
Definition: stepper4.h:138
stepper4_t::rst
digital_out_t rst
Definition: stepper4.h:121
stepper4_switch_direction
void stepper4_switch_direction(stepper4_t *ctx)
Stepper 4 switch direction function.
stepper4_set_step_pin
void stepper4_set_step_pin(stepper4_t *ctx, uint8_t state)
Stepper 4 set step pin function.
STEPPER4_ERROR
@ STEPPER4_ERROR
Definition: stepper4.h:150
stepper4_reset_device
void stepper4_reset_device(stepper4_t *ctx)
Stepper 4 reset device function.
stepper4_t::dir
digital_out_t dir
Definition: stepper4.h:120
stepper4_t::int_pin
digital_in_t int_pin
Definition: stepper4.h:125
stepper4_cfg_t::en
pin_name_t en
Definition: stepper4.h:137