multisteppertb67s261  2.0.0.0
multisteppertb67s261.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 MULTISTEPPERTB67S261_H
29 #define MULTISTEPPERTB67S261_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
59 #define MULTISTEPPERTB67S261_REG_INPUT 0x00
60 #define MULTISTEPPERTB67S261_REG_OUTPUT 0x01
61 #define MULTISTEPPERTB67S261_REG_POLARITY 0x02
62 #define MULTISTEPPERTB67S261_REG_CONFIG 0x03
63  // multisteppertb67s261_reg
65 
80 #define MULTISTEPPERTB67S261_PHASEA_PIN 0x02
81 #define MULTISTEPPERTB67S261_PHASEB_PIN 0x04
82 
87 #define MULTISTEPPERTB67S261_DEFAULT_CONFIG 0xF9
88 
93 #define MULTISTEPPERTB67S261_DIR_CW 0
94 #define MULTISTEPPERTB67S261_DIR_CCW 1
95 
100 #define MULTISTEPPERTB67S261_PIN_LOW_LEVEL 0
101 #define MULTISTEPPERTB67S261_PIN_HIGH_LEVEL 1
102 
107 #define MULTISTEPPERTB67S261_MODE_FULL_STEP 0x00
108 #define MULTISTEPPERTB67S261_MODE_HALF_STEP 0x01
109 #define MULTISTEPPERTB67S261_MODE_QUARTER_STEP 0x02
110 
115 #define MULTISTEPPERTB67S261_SPEED_VERY_SLOW 0
116 #define MULTISTEPPERTB67S261_SPEED_SLOW 1
117 #define MULTISTEPPERTB67S261_SPEED_MEDIUM 2
118 #define MULTISTEPPERTB67S261_SPEED_FAST 3
119 #define MULTISTEPPERTB67S261_SPEED_VERY_FAST 4
120 
126 #define MULTISTEPPERTB67S261_DEVICE_ADDRESS_A1A0_00 0x70
127 #define MULTISTEPPERTB67S261_DEVICE_ADDRESS_A1A0_01 0x71
128 #define MULTISTEPPERTB67S261_DEVICE_ADDRESS_A1A0_10 0x72
129 #define MULTISTEPPERTB67S261_DEVICE_ADDRESS_A1A0_11 0x73
130  // multisteppertb67s261_set
132 
147 #define MULTISTEPPERTB67S261_MAP_MIKROBUS( cfg, mikrobus ) \
148  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
149  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
150  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
151  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
152  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
153  cfg.clk = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
154  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
155  // multisteppertb67s261_map // multisteppertb67s261
158 
163 typedef struct
164 {
165  // Output pins
166  digital_out_t an;
167  digital_out_t int_pin;
168  digital_out_t clk;
169  digital_out_t en;
170  digital_out_t rst;
172  // Modules
173  i2c_master_t i2c;
175  // I2C slave address
176  uint8_t slave_address;
178  uint8_t step_mode;
179  uint8_t direction;
180 
182 
187 typedef struct
188 {
189  pin_name_t scl;
190  pin_name_t sda;
192  pin_name_t an;
193  pin_name_t int_pin;
194  pin_name_t clk;
195  pin_name_t en;
196  pin_name_t rst;
198  uint32_t i2c_speed;
199  uint8_t i2c_address;
202 
207 typedef enum
208 {
211 
213 
230 
245 
260 
274 err_t multisteppertb67s261_write_register ( multisteppertb67s261_t *ctx, uint8_t reg, uint8_t data_in );
275 
288 err_t multisteppertb67s261_read_register ( multisteppertb67s261_t *ctx, uint8_t reg, uint8_t *data_out );
289 
307 err_t multisteppertb67s261_drive_motor ( multisteppertb67s261_t *ctx, uint32_t steps, uint8_t speed );
308 
318 
328 
340 
352 
364 
376 
390 
402 
412 
413 #ifdef __cplusplus
414 }
415 #endif
416 #endif // MULTISTEPPERTB67S261_H
417  // multisteppertb67s261
419 
420 // ------------------------------------------------------------------------ END
multisteppertb67s261_cfg_t::rst
pin_name_t rst
Definition: multisteppertb67s261.h:196
multisteppertb67s261_cfg_t::sda
pin_name_t sda
Definition: multisteppertb67s261.h:190
multisteppertb67s261_cfg_setup
void multisteppertb67s261_cfg_setup(multisteppertb67s261_cfg_t *cfg)
Multi Stepper TB67S261 configuration object setup function.
multisteppertb67s261_set_ina2_pin
void multisteppertb67s261_set_ina2_pin(multisteppertb67s261_t *ctx, uint8_t state)
Multi Stepper TB67S261 set ina2 pin function.
multisteppertb67s261_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: multisteppertb67s261.h:198
multisteppertb67s261_t::an
digital_out_t an
Definition: multisteppertb67s261.h:166
multisteppertb67s261_set_ina1_pin
void multisteppertb67s261_set_ina1_pin(multisteppertb67s261_t *ctx, uint8_t state)
Multi Stepper TB67S261 set ina1 pin function.
multisteppertb67s261_read_register
err_t multisteppertb67s261_read_register(multisteppertb67s261_t *ctx, uint8_t reg, uint8_t *data_out)
Multi Stepper TB67S261 read register function.
multisteppertb67s261_enable_device
void multisteppertb67s261_enable_device(multisteppertb67s261_t *ctx)
Multi Stepper TB67S261 enable device function.
multisteppertb67s261_set_direction
void multisteppertb67s261_set_direction(multisteppertb67s261_t *ctx, uint8_t dir)
Multi Stepper TB67S261 set direction function.
multisteppertb67s261_cfg_t::scl
pin_name_t scl
Definition: multisteppertb67s261.h:189
MULTISTEPPERTB67S261_ERROR
@ MULTISTEPPERTB67S261_ERROR
Definition: multisteppertb67s261.h:210
multisteppertb67s261_set_inb1_pin
void multisteppertb67s261_set_inb1_pin(multisteppertb67s261_t *ctx, uint8_t state)
Multi Stepper TB67S261 set inb1 pin function.
multisteppertb67s261_cfg_t::i2c_address
uint8_t i2c_address
Definition: multisteppertb67s261.h:199
multisteppertb67s261_write_register
err_t multisteppertb67s261_write_register(multisteppertb67s261_t *ctx, uint8_t reg, uint8_t data_in)
Multi Stepper TB67S261 write register function.
multisteppertb67s261_drive_motor
err_t multisteppertb67s261_drive_motor(multisteppertb67s261_t *ctx, uint32_t steps, uint8_t speed)
Multi Stepper TB67S261 driver motor function.
multisteppertb67s261_return_value_t
multisteppertb67s261_return_value_t
Multi Stepper TB67S261 Click return value data.
Definition: multisteppertb67s261.h:208
multisteppertb67s261_disable_device
void multisteppertb67s261_disable_device(multisteppertb67s261_t *ctx)
Multi Stepper TB67S261 disable device function.
multisteppertb67s261_cfg_t::int_pin
pin_name_t int_pin
Definition: multisteppertb67s261.h:193
multisteppertb67s261_set_inb2_pin
void multisteppertb67s261_set_inb2_pin(multisteppertb67s261_t *ctx, uint8_t state)
Multi Stepper TB67S261 set inb2 pin function.
multisteppertb67s261_cfg_t
Multi Stepper TB67S261 Click configuration object.
Definition: multisteppertb67s261.h:188
multisteppertb67s261_t::i2c
i2c_master_t i2c
Definition: multisteppertb67s261.h:173
multisteppertb67s261_switch_direction
void multisteppertb67s261_switch_direction(multisteppertb67s261_t *ctx)
Multi Stepper TB67S261 switch direction function.
multisteppertb67s261_t::clk
digital_out_t clk
Definition: multisteppertb67s261.h:168
multisteppertb67s261_t::int_pin
digital_out_t int_pin
Definition: multisteppertb67s261.h:167
multisteppertb67s261_cfg_t::clk
pin_name_t clk
Definition: multisteppertb67s261.h:194
multisteppertb67s261_t
Multi Stepper TB67S261 Click context object.
Definition: multisteppertb67s261.h:164
multisteppertb67s261_cfg_t::en
pin_name_t en
Definition: multisteppertb67s261.h:195
multisteppertb67s261_t::slave_address
uint8_t slave_address
Definition: multisteppertb67s261.h:176
multisteppertb67s261_t::rst
digital_out_t rst
Definition: multisteppertb67s261.h:170
multisteppertb67s261_cfg_t::an
pin_name_t an
Definition: multisteppertb67s261.h:192
multisteppertb67s261_t::step_mode
uint8_t step_mode
Definition: multisteppertb67s261.h:178
multisteppertb67s261_set_step_mode
void multisteppertb67s261_set_step_mode(multisteppertb67s261_t *ctx, uint8_t mode)
Multi Stepper TB67S261 set step mode function.
MULTISTEPPERTB67S261_OK
@ MULTISTEPPERTB67S261_OK
Definition: multisteppertb67s261.h:209
multisteppertb67s261_t::en
digital_out_t en
Definition: multisteppertb67s261.h:169
multisteppertb67s261_init
err_t multisteppertb67s261_init(multisteppertb67s261_t *ctx, multisteppertb67s261_cfg_t *cfg)
Multi Stepper TB67S261 initialization function.
multisteppertb67s261_default_cfg
err_t multisteppertb67s261_default_cfg(multisteppertb67s261_t *ctx)
Multi Stepper TB67S261 default configuration function.
multisteppertb67s261_t::direction
uint8_t direction
Definition: multisteppertb67s261.h:179