multisteppertb62261  2.0.0.0
multisteppertb62261.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 MULTISTEPPERTB62261_H
29 #define MULTISTEPPERTB62261_H
30 
31 #ifdef __cplusplus
32 extern "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_i2c_master.h"
51 
72 #define MULTISTEPPERTB62261_REG_INPUT 0x00
73 #define MULTISTEPPERTB62261_REG_OUTPUT 0x01
74 #define MULTISTEPPERTB62261_REG_POLARITY 0x02
75 #define MULTISTEPPERTB62261_REG_CONFIG 0x03
76  // multisteppertb62261_reg
78 
93 #define MULTISTEPPERTB62261_PHASEA_PIN 0x02
94 #define MULTISTEPPERTB62261_PHASEB_PIN 0x04
95 
100 #define MULTISTEPPERTB62261_DEFAULT_CONFIG 0xF9
101 
106 #define MULTISTEPPERTB62261_DIR_CW 0
107 #define MULTISTEPPERTB62261_DIR_CCW 1
108 
113 #define MULTISTEPPERTB62261_PIN_LOW_LEVEL 0
114 #define MULTISTEPPERTB62261_PIN_HIGH_LEVEL 1
115 
120 #define MULTISTEPPERTB62261_MODE_FULL_STEP 0x00
121 #define MULTISTEPPERTB62261_MODE_HALF_STEP 0x01
122 #define MULTISTEPPERTB62261_MODE_QUARTER_STEP 0x02
123 
128 #define MULTISTEPPERTB62261_SPEED_VERY_SLOW 0
129 #define MULTISTEPPERTB62261_SPEED_SLOW 1
130 #define MULTISTEPPERTB62261_SPEED_MEDIUM 2
131 #define MULTISTEPPERTB62261_SPEED_FAST 3
132 #define MULTISTEPPERTB62261_SPEED_VERY_FAST 4
133 
139 #define MULTISTEPPERTB62261_DEVICE_ADDRESS_A1A0_00 0x70
140 #define MULTISTEPPERTB62261_DEVICE_ADDRESS_A1A0_01 0x71
141 #define MULTISTEPPERTB62261_DEVICE_ADDRESS_A1A0_10 0x72
142 #define MULTISTEPPERTB62261_DEVICE_ADDRESS_A1A0_11 0x73
143  // multisteppertb62261_set
145 
160 #define MULTISTEPPERTB62261_MAP_MIKROBUS( cfg, mikrobus ) \
161  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
162  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
163  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
164  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
165  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
166  cfg.clk = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
167  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
168  // multisteppertb62261_map // multisteppertb62261
171 
176 typedef struct
177 {
178  // Output pins
179  digital_out_t an;
180  digital_out_t int_pin;
181  digital_out_t clk;
182  digital_out_t en;
183  digital_out_t rst;
185  // Modules
186  i2c_master_t i2c;
188  // I2C slave address
189  uint8_t slave_address;
191  uint8_t step_mode;
192  uint8_t direction;
193 
195 
200 typedef struct
201 {
202  pin_name_t scl;
203  pin_name_t sda;
205  pin_name_t an;
206  pin_name_t int_pin;
207  pin_name_t clk;
208  pin_name_t en;
209  pin_name_t rst;
211  uint32_t i2c_speed;
212  uint8_t i2c_address;
215 
220 typedef enum
221 {
224 
226 
243 
258 
273 
287 err_t multisteppertb62261_write_register ( multisteppertb62261_t *ctx, uint8_t reg, uint8_t data_in );
288 
301 err_t multisteppertb62261_read_register ( multisteppertb62261_t *ctx, uint8_t reg, uint8_t *data_out );
302 
320 err_t multisteppertb62261_drive_motor ( multisteppertb62261_t *ctx, uint32_t steps, uint8_t speed );
321 
331 
341 
353 
365 
377 
389 
403 
415 
425 
426 #ifdef __cplusplus
427 }
428 #endif
429 #endif // MULTISTEPPERTB62261_H
430  // multisteppertb62261
432 
433 // ------------------------------------------------------------------------ END
multisteppertb62261_disable_device
void multisteppertb62261_disable_device(multisteppertb62261_t *ctx)
Multi Stepper TB62261 disable device function.
multisteppertb62261_t::direction
uint8_t direction
Definition: multisteppertb62261.h:192
multisteppertb62261_cfg_t
Multi Stepper TB62261 Click configuration object.
Definition: multisteppertb62261.h:201
MULTISTEPPERTB62261_ERROR
@ MULTISTEPPERTB62261_ERROR
Definition: multisteppertb62261.h:223
multisteppertb62261_t::en
digital_out_t en
Definition: multisteppertb62261.h:182
multisteppertb62261_cfg_setup
void multisteppertb62261_cfg_setup(multisteppertb62261_cfg_t *cfg)
Multi Stepper TB62261 configuration object setup function.
multisteppertb62261_set_direction
void multisteppertb62261_set_direction(multisteppertb62261_t *ctx, uint8_t dir)
Multi Stepper TB62261 set direction function.
multisteppertb62261_t::an
digital_out_t an
Definition: multisteppertb62261.h:179
multisteppertb62261_t::clk
digital_out_t clk
Definition: multisteppertb62261.h:181
multisteppertb62261_t::int_pin
digital_out_t int_pin
Definition: multisteppertb62261.h:180
MULTISTEPPERTB62261_OK
@ MULTISTEPPERTB62261_OK
Definition: multisteppertb62261.h:222
multisteppertb62261_return_value_t
multisteppertb62261_return_value_t
Multi Stepper TB62261 Click return value data.
Definition: multisteppertb62261.h:221
multisteppertb62261_cfg_t::clk
pin_name_t clk
Definition: multisteppertb62261.h:207
multisteppertb62261_write_register
err_t multisteppertb62261_write_register(multisteppertb62261_t *ctx, uint8_t reg, uint8_t data_in)
Multi Stepper TB62261 write register function.
multisteppertb62261_t::slave_address
uint8_t slave_address
Definition: multisteppertb62261.h:189
multisteppertb62261_switch_direction
void multisteppertb62261_switch_direction(multisteppertb62261_t *ctx)
Multi Stepper TB62261 switch direction function.
multisteppertb62261_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: multisteppertb62261.h:211
multisteppertb62261_t::rst
digital_out_t rst
Definition: multisteppertb62261.h:183
multisteppertb62261_set_inb1_pin
void multisteppertb62261_set_inb1_pin(multisteppertb62261_t *ctx, uint8_t state)
Multi Stepper TB62261 set inb1 pin function.
multisteppertb62261_t::step_mode
uint8_t step_mode
Definition: multisteppertb62261.h:191
multisteppertb62261_drive_motor
err_t multisteppertb62261_drive_motor(multisteppertb62261_t *ctx, uint32_t steps, uint8_t speed)
Multi Stepper TB62261 driver motor function.
multisteppertb62261_cfg_t::en
pin_name_t en
Definition: multisteppertb62261.h:208
multisteppertb62261_read_register
err_t multisteppertb62261_read_register(multisteppertb62261_t *ctx, uint8_t reg, uint8_t *data_out)
Multi Stepper TB62261 read register function.
multisteppertb62261_enable_device
void multisteppertb62261_enable_device(multisteppertb62261_t *ctx)
Multi Stepper TB62261 enable device function.
multisteppertb62261_cfg_t::int_pin
pin_name_t int_pin
Definition: multisteppertb62261.h:206
multisteppertb62261_cfg_t::an
pin_name_t an
Definition: multisteppertb62261.h:205
multisteppertb62261_cfg_t::scl
pin_name_t scl
Definition: multisteppertb62261.h:202
multisteppertb62261_t
Multi Stepper TB62261 Click context object.
Definition: multisteppertb62261.h:177
multisteppertb62261_cfg_t::i2c_address
uint8_t i2c_address
Definition: multisteppertb62261.h:212
multisteppertb62261_init
err_t multisteppertb62261_init(multisteppertb62261_t *ctx, multisteppertb62261_cfg_t *cfg)
Multi Stepper TB62261 initialization function.
multisteppertb62261_set_step_mode
void multisteppertb62261_set_step_mode(multisteppertb62261_t *ctx, uint8_t mode)
Multi Stepper TB62261 set step mode function.
multisteppertb62261_default_cfg
err_t multisteppertb62261_default_cfg(multisteppertb62261_t *ctx)
Multi Stepper TB62261 default configuration function.
multisteppertb62261_t::i2c
i2c_master_t i2c
Definition: multisteppertb62261.h:186
multisteppertb62261_set_ina1_pin
void multisteppertb62261_set_ina1_pin(multisteppertb62261_t *ctx, uint8_t state)
Multi Stepper TB62261 set ina1 pin function.
multisteppertb62261_cfg_t::sda
pin_name_t sda
Definition: multisteppertb62261.h:203
multisteppertb62261_set_ina2_pin
void multisteppertb62261_set_ina2_pin(multisteppertb62261_t *ctx, uint8_t state)
Multi Stepper TB62261 set ina2 pin function.
multisteppertb62261_set_inb2_pin
void multisteppertb62261_set_inb2_pin(multisteppertb62261_t *ctx, uint8_t state)
Multi Stepper TB62261 set inb2 pin function.
multisteppertb62261_cfg_t::rst
pin_name_t rst
Definition: multisteppertb62261.h:209