stspin220 2.1.0.0
stspin220.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 STSPIN220_H
29#define STSPIN220_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
39#ifdef PREINIT_SUPPORTED
40#include "preinit.h"
41#endif
42
43#ifdef MikroCCoreVersion
44 #if MikroCCoreVersion >= 1
45 #include "delays.h"
46 #endif
47#endif
48
49#include "drv_digital_out.h"
50#include "drv_digital_in.h"
51
72#define STSPIN220_DIR_CW 0
73#define STSPIN220_DIR_CCW 1
74
79#define STSPIN220_PIN_LOW_LEVEL 0
80#define STSPIN220_PIN_HIGH_LEVEL 1
81
86#define STSPIN220_SPEED_VERY_SLOW 0
87#define STSPIN220_SPEED_SLOW 1
88#define STSPIN220_SPEED_MEDIUM 2
89#define STSPIN220_SPEED_FAST 3
90#define STSPIN220_SPEED_VERY_FAST 4
91
92 // stspin220_set
93
108#define STSPIN220_MAP_MIKROBUS( cfg, mikrobus ) \
109 cfg.dir = MIKROBUS( mikrobus, MIKROBUS_AN ); \
110 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
111 cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
112 cfg.step = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
113 cfg.fault = MIKROBUS( mikrobus, MIKROBUS_INT )
114
115 // stspin220_map
116 // stspin220
117
122typedef struct
123{
124 digital_out_t dir;
125 digital_out_t rst;
126 digital_out_t en;
127 digital_out_t step;
129 digital_in_t fault;
132
137typedef struct
138{
139 pin_name_t dir;
140 pin_name_t rst;
141 pin_name_t en;
142 pin_name_t step;
143 pin_name_t fault;
146
157
174
189
201
217void stspin220_drive_motor ( stspin220_t *ctx, uint32_t steps, uint8_t speed );
218
228
238
249void stspin220_set_direction ( stspin220_t *ctx, uint8_t dir );
250
260
270
281void stspin220_set_rst_pin ( stspin220_t *ctx, uint8_t state );
282
292
303void stspin220_set_step_pin ( stspin220_t *ctx, uint8_t state );
304
305#ifdef __cplusplus
306}
307#endif
308#endif // STSPIN220_H
309
310 // stspin220
311
312// ------------------------------------------------------------------------ END
void stspin220_default_cfg(stspin220_t *ctx)
STSPIN220 default configuration function.
err_t stspin220_init(stspin220_t *ctx, stspin220_cfg_t *cfg)
STSPIN220 initialization function.
void stspin220_reset_device(stspin220_t *ctx)
STSPIN220 reset device function.
void stspin220_switch_direction(stspin220_t *ctx)
STSPIN220 switch direction function.
void stspin220_set_direction(stspin220_t *ctx, uint8_t dir)
STSPIN220 set direction function.
void stspin220_cfg_setup(stspin220_cfg_t *cfg)
STSPIN220 configuration object setup function.
void stspin220_set_rst_pin(stspin220_t *ctx, uint8_t state)
STSPIN220 set rst pin function.
void stspin220_set_step_pin(stspin220_t *ctx, uint8_t state)
STSPIN220 set step pin function.
void stspin220_drive_motor(stspin220_t *ctx, uint32_t steps, uint8_t speed)
STSPIN220 drive motor function.
void stspin220_enable_device(stspin220_t *ctx)
STSPIN220 enable device function.
void stspin220_disable_device(stspin220_t *ctx)
STSPIN220 disable device function.
uint8_t stspin220_get_fault_pin(stspin220_t *ctx)
STSPIN220 get fault pin function.
STSPIN220 Click configuration object.
Definition stspin220.h:138
pin_name_t step
Definition stspin220.h:142
pin_name_t dir
Definition stspin220.h:139
pin_name_t en
Definition stspin220.h:141
pin_name_t rst
Definition stspin220.h:140
pin_name_t fault
Definition stspin220.h:143
STSPIN220 Click context object.
Definition stspin220.h:123
digital_out_t step
Definition stspin220.h:127
digital_out_t en
Definition stspin220.h:126
digital_out_t rst
Definition stspin220.h:125
digital_in_t fault
Definition stspin220.h:129
digital_out_t dir
Definition stspin220.h:124
stspin220_return_value_t
STSPIN220 Click return value data.
Definition stspin220.h:152
@ STSPIN220_ERROR
Definition stspin220.h:154
@ STSPIN220_OK
Definition stspin220.h:153