multisteppertb67s101  2.0.0.0
multisteppertb67s101.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 MULTISTEPPERTB67S101_H
29 #define MULTISTEPPERTB67S101_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_i2c_master.h"
37 
58 #define MULTISTEPPERTB67S101_REG_INPUT 0x00
59 #define MULTISTEPPERTB67S101_REG_OUTPUT 0x01
60 #define MULTISTEPPERTB67S101_REG_POLARITY 0x02
61 #define MULTISTEPPERTB67S101_REG_CONFIG 0x03
62  // multisteppertb67s101_reg
64 
79 #define MULTISTEPPERTB67S101_PHASEA_PIN 0x02
80 #define MULTISTEPPERTB67S101_PHASEB_PIN 0x04
81 
86 #define MULTISTEPPERTB67S101_DEFAULT_CONFIG 0xF9
87 
92 #define MULTISTEPPERTB67S101_DIR_CW 0
93 #define MULTISTEPPERTB67S101_DIR_CCW 1
94 
99 #define MULTISTEPPERTB67S101_PIN_LOW_LEVEL 0
100 #define MULTISTEPPERTB67S101_PIN_HIGH_LEVEL 1
101 
106 #define MULTISTEPPERTB67S101_MODE_FULL_STEP 0x00
107 #define MULTISTEPPERTB67S101_MODE_HALF_STEP 0x01
108 #define MULTISTEPPERTB67S101_MODE_QUARTER_STEP 0x02
109 
114 #define MULTISTEPPERTB67S101_SPEED_VERY_SLOW 0
115 #define MULTISTEPPERTB67S101_SPEED_SLOW 1
116 #define MULTISTEPPERTB67S101_SPEED_MEDIUM 2
117 #define MULTISTEPPERTB67S101_SPEED_FAST 3
118 #define MULTISTEPPERTB67S101_SPEED_VERY_FAST 4
119 
125 #define MULTISTEPPERTB67S101_DEVICE_ADDRESS_A1A0_00 0x70
126 #define MULTISTEPPERTB67S101_DEVICE_ADDRESS_A1A0_01 0x71
127 #define MULTISTEPPERTB67S101_DEVICE_ADDRESS_A1A0_10 0x72
128 #define MULTISTEPPERTB67S101_DEVICE_ADDRESS_A1A0_11 0x73
129  // multisteppertb67s101_set
131 
146 #define MULTISTEPPERTB67S101_MAP_MIKROBUS( cfg, mikrobus ) \
147  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
148  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
149  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
150  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
151  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
152  cfg.clk = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
153  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
154  // multisteppertb67s101_map // multisteppertb67s101
157 
162 typedef struct
163 {
164  // Output pins
165  digital_out_t an;
166  digital_out_t int_pin;
167  digital_out_t clk;
168  digital_out_t en;
169  digital_out_t rst;
171  // Modules
172  i2c_master_t i2c;
174  // I2C slave address
175  uint8_t slave_address;
177  uint8_t step_mode;
178  uint8_t direction;
179 
181 
186 typedef struct
187 {
188  pin_name_t scl;
189  pin_name_t sda;
191  pin_name_t an;
192  pin_name_t int_pin;
193  pin_name_t clk;
194  pin_name_t en;
195  pin_name_t rst;
197  uint32_t i2c_speed;
198  uint8_t i2c_address;
201 
206 typedef enum
207 {
210 
212 
229 
244 
259 
273 err_t multisteppertb67s101_write_register ( multisteppertb67s101_t *ctx, uint8_t reg, uint8_t data_in );
274 
287 err_t multisteppertb67s101_read_register ( multisteppertb67s101_t *ctx, uint8_t reg, uint8_t *data_out );
288 
306 err_t multisteppertb67s101_drive_motor ( multisteppertb67s101_t *ctx, uint32_t steps, uint8_t speed );
307 
317 
327 
339 
351 
363 
375 
389 
401 
411 
412 #ifdef __cplusplus
413 }
414 #endif
415 #endif // MULTISTEPPERTB67S101_H
416  // multisteppertb67s101
418 
419 // ------------------------------------------------------------------------ END
multisteppertb67s101_t::en
digital_out_t en
Definition: multisteppertb67s101.h:168
multisteppertb67s101_disable_device
void multisteppertb67s101_disable_device(multisteppertb67s101_t *ctx)
Multi Stepper TB67S101 disable device function.
multisteppertb67s101_t::an
digital_out_t an
Definition: multisteppertb67s101.h:165
multisteppertb67s101_cfg_t::rst
pin_name_t rst
Definition: multisteppertb67s101.h:195
multisteppertb67s101_cfg_t::i2c_address
uint8_t i2c_address
Definition: multisteppertb67s101.h:198
multisteppertb67s101_set_ina2_pin
void multisteppertb67s101_set_ina2_pin(multisteppertb67s101_t *ctx, uint8_t state)
Multi Stepper TB67S101 set ina2 pin function.
multisteppertb67s101_set_direction
void multisteppertb67s101_set_direction(multisteppertb67s101_t *ctx, uint8_t dir)
Multi Stepper TB67S101 set direction function.
multisteppertb67s101_cfg_t::int_pin
pin_name_t int_pin
Definition: multisteppertb67s101.h:192
multisteppertb67s101_cfg_t::scl
pin_name_t scl
Definition: multisteppertb67s101.h:188
multisteppertb67s101_drive_motor
err_t multisteppertb67s101_drive_motor(multisteppertb67s101_t *ctx, uint32_t steps, uint8_t speed)
Multi Stepper TB67S101 driver motor function.
multisteppertb67s101_return_value_t
multisteppertb67s101_return_value_t
Multi Stepper TB67S101 Click return value data.
Definition: multisteppertb67s101.h:207
multisteppertb67s101_cfg_t::clk
pin_name_t clk
Definition: multisteppertb67s101.h:193
MULTISTEPPERTB67S101_OK
@ MULTISTEPPERTB67S101_OK
Definition: multisteppertb67s101.h:208
multisteppertb67s101_cfg_t::en
pin_name_t en
Definition: multisteppertb67s101.h:194
multisteppertb67s101_t::i2c
i2c_master_t i2c
Definition: multisteppertb67s101.h:172
multisteppertb67s101_t::clk
digital_out_t clk
Definition: multisteppertb67s101.h:167
multisteppertb67s101_read_register
err_t multisteppertb67s101_read_register(multisteppertb67s101_t *ctx, uint8_t reg, uint8_t *data_out)
Multi Stepper TB67S101 read register function.
multisteppertb67s101_t::int_pin
digital_out_t int_pin
Definition: multisteppertb67s101.h:166
multisteppertb67s101_set_step_mode
void multisteppertb67s101_set_step_mode(multisteppertb67s101_t *ctx, uint8_t mode)
Multi Stepper TB67S101 set step mode function.
multisteppertb67s101_set_ina1_pin
void multisteppertb67s101_set_ina1_pin(multisteppertb67s101_t *ctx, uint8_t state)
Multi Stepper TB67S101 set ina1 pin function.
multisteppertb67s101_t
Multi Stepper TB67S101 Click context object.
Definition: multisteppertb67s101.h:163
multisteppertb67s101_t::slave_address
uint8_t slave_address
Definition: multisteppertb67s101.h:175
MULTISTEPPERTB67S101_ERROR
@ MULTISTEPPERTB67S101_ERROR
Definition: multisteppertb67s101.h:209
multisteppertb67s101_init
err_t multisteppertb67s101_init(multisteppertb67s101_t *ctx, multisteppertb67s101_cfg_t *cfg)
Multi Stepper TB67S101 initialization function.
multisteppertb67s101_t::rst
digital_out_t rst
Definition: multisteppertb67s101.h:169
multisteppertb67s101_set_inb1_pin
void multisteppertb67s101_set_inb1_pin(multisteppertb67s101_t *ctx, uint8_t state)
Multi Stepper TB67S101 set inb1 pin function.
multisteppertb67s101_enable_device
void multisteppertb67s101_enable_device(multisteppertb67s101_t *ctx)
Multi Stepper TB67S101 enable device function.
multisteppertb67s101_t::step_mode
uint8_t step_mode
Definition: multisteppertb67s101.h:177
multisteppertb67s101_write_register
err_t multisteppertb67s101_write_register(multisteppertb67s101_t *ctx, uint8_t reg, uint8_t data_in)
Multi Stepper TB67S101 write register function.
multisteppertb67s101_set_inb2_pin
void multisteppertb67s101_set_inb2_pin(multisteppertb67s101_t *ctx, uint8_t state)
Multi Stepper TB67S101 set inb2 pin function.
multisteppertb67s101_cfg_setup
void multisteppertb67s101_cfg_setup(multisteppertb67s101_cfg_t *cfg)
Multi Stepper TB67S101 configuration object setup function.
multisteppertb67s101_cfg_t
Multi Stepper TB67S101 Click configuration object.
Definition: multisteppertb67s101.h:187
multisteppertb67s101_switch_direction
void multisteppertb67s101_switch_direction(multisteppertb67s101_t *ctx)
Multi Stepper TB67S101 switch direction function.
multisteppertb67s101_cfg_t::sda
pin_name_t sda
Definition: multisteppertb67s101.h:189
multisteppertb67s101_cfg_t::an
pin_name_t an
Definition: multisteppertb67s101.h:191
multisteppertb67s101_t::direction
uint8_t direction
Definition: multisteppertb67s101.h:178
multisteppertb67s101_default_cfg
err_t multisteppertb67s101_default_cfg(multisteppertb67s101_t *ctx)
Multi Stepper TB67S101 default configuration function.
multisteppertb67s101_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: multisteppertb67s101.h:197