multisteppertb67s269  2.0.0.0
multisteppertb67s269.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 MULTISTEPPERTB67S269_H
29 #define MULTISTEPPERTB67S269_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 MULTISTEPPERTB67S269_REG_INPUT 0x00
60 #define MULTISTEPPERTB67S269_REG_OUTPUT 0x01
61 #define MULTISTEPPERTB67S269_REG_POLARITY 0x02
62 #define MULTISTEPPERTB67S269_REG_CONFIG 0x03
63  // multisteppertb67s269_reg
65 
80 #define MULTISTEPPERTB67S269_DMODE0_PIN 0x01
81 #define MULTISTEPPERTB67S269_DMODE1_PIN 0x02
82 #define MULTISTEPPERTB67S269_DMODE2_PIN 0x04
83 #define MULTISTEPPERTB67S269_MO_PIN 0x40
84 #define MULTISTEPPERTB67S269_LO_PIN 0x80
85 
90 #define MULTISTEPPERTB67S269_DEFAULT_CONFIG 0xF8
91 
96 #define MULTISTEPPERTB67S269_DIR_CW 0
97 #define MULTISTEPPERTB67S269_DIR_CCW 1
98 
103 #define MULTISTEPPERTB67S269_PIN_LOW_LEVEL 0
104 #define MULTISTEPPERTB67S269_PIN_HIGH_LEVEL 1
105 
110 #define MULTISTEPPERTB67S269_MODE_STANDBY 0x00
111 #define MULTISTEPPERTB67S269_MODE_HALF_STEP_TYPE_B 0x01
112 #define MULTISTEPPERTB67S269_MODE_HALF_STEP_TYPE_A 0x02
113 #define MULTISTEPPERTB67S269_MODE_1_OVER_16 0x03
114 #define MULTISTEPPERTB67S269_MODE_FULL_STEP 0x04
115 #define MULTISTEPPERTB67S269_MODE_1_OVER_8 0x05
116 #define MULTISTEPPERTB67S269_MODE_QUARTER_STEP 0x06
117 #define MULTISTEPPERTB67S269_MODE_1_OVER_32 0x07
118 #define MULTISTEPPERTB67S269_MODE_BITS_MASK 0x07
119 
124 #define MULTISTEPPERTB67S269_SPEED_VERY_SLOW 0
125 #define MULTISTEPPERTB67S269_SPEED_SLOW 1
126 #define MULTISTEPPERTB67S269_SPEED_MEDIUM 2
127 #define MULTISTEPPERTB67S269_SPEED_FAST 3
128 #define MULTISTEPPERTB67S269_SPEED_VERY_FAST 4
129 
135 #define MULTISTEPPERTB67S269_DEVICE_ADDRESS_A1A0_00 0x70
136 #define MULTISTEPPERTB67S269_DEVICE_ADDRESS_A1A0_01 0x71
137 #define MULTISTEPPERTB67S269_DEVICE_ADDRESS_A1A0_10 0x72
138 #define MULTISTEPPERTB67S269_DEVICE_ADDRESS_A1A0_11 0x73
139  // multisteppertb67s269_set
141 
156 #define MULTISTEPPERTB67S269_MAP_MIKROBUS( cfg, mikrobus ) \
157  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
158  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
159  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
160  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
161  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
162  cfg.clk = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
163  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
164  // multisteppertb67s269_map // multisteppertb67s269
167 
172 typedef struct
173 {
174  // Output pins
175  digital_out_t en;
176  digital_out_t an;
177  digital_out_t rst;
178  digital_out_t clk;
180  // Input pins
181  digital_in_t int_pin;
183  // Modules
184  i2c_master_t i2c;
186  // I2C slave address
187  uint8_t slave_address;
190 
195 typedef struct
196 {
197  pin_name_t scl;
198  pin_name_t sda;
200  pin_name_t en;
201  pin_name_t an;
202  pin_name_t rst;
203  pin_name_t clk;
204  pin_name_t int_pin;
206  uint32_t i2c_speed;
207  uint8_t i2c_address;
210 
215 typedef enum
216 {
219 
221 
238 
253 
268 
282 err_t multisteppertb67s269_write_register ( multisteppertb67s269_t *ctx, uint8_t reg, uint8_t data_in );
283 
296 err_t multisteppertb67s269_read_register ( multisteppertb67s269_t *ctx, uint8_t reg, uint8_t *data_out );
297 
310 
323 
339 void multisteppertb67s269_drive_motor ( multisteppertb67s269_t *ctx, uint32_t steps, uint8_t speed );
340 
350 
360 
372 
382 
392 
402 
414 
415 #ifdef __cplusplus
416 }
417 #endif
418 #endif // MULTISTEPPERTB67S269_H
419  // multisteppertb67s269
421 
422 // ------------------------------------------------------------------------ END
multisteppertb67s269_set_clk_pin
void multisteppertb67s269_set_clk_pin(multisteppertb67s269_t *ctx, uint8_t state)
Multi Stepper TB67S269 set clk pin function.
MULTISTEPPERTB67S269_OK
@ MULTISTEPPERTB67S269_OK
Definition: multisteppertb67s269.h:217
multisteppertb67s269_switch_direction
void multisteppertb67s269_switch_direction(multisteppertb67s269_t *ctx)
Multi Stepper TB67S269 switch direction function.
multisteppertb67s269_t::clk
digital_out_t clk
Definition: multisteppertb67s269.h:178
multisteppertb67s269_read_register
err_t multisteppertb67s269_read_register(multisteppertb67s269_t *ctx, uint8_t reg, uint8_t *data_out)
Multi Stepper TB67S269 read register function.
multisteppertb67s269_enable_device
void multisteppertb67s269_enable_device(multisteppertb67s269_t *ctx)
Multi Stepper TB67S269 enable device function.
multisteppertb67s269_cfg_t::int_pin
pin_name_t int_pin
Definition: multisteppertb67s269.h:204
multisteppertb67s269_default_cfg
err_t multisteppertb67s269_default_cfg(multisteppertb67s269_t *ctx)
Multi Stepper TB67S269 default configuration function.
multisteppertb67s269_cfg_t::en
pin_name_t en
Definition: multisteppertb67s269.h:200
multisteppertb67s269_t::slave_address
uint8_t slave_address
Definition: multisteppertb67s269.h:187
multisteppertb67s269_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: multisteppertb67s269.h:206
multisteppertb67s269_get_step_mode
err_t multisteppertb67s269_get_step_mode(multisteppertb67s269_t *ctx, uint8_t *mode)
Multi Stepper TB67S269 get step mode function.
multisteppertb67s269_cfg_t::scl
pin_name_t scl
Definition: multisteppertb67s269.h:197
multisteppertb67s269_t::en
digital_out_t en
Definition: multisteppertb67s269.h:175
multisteppertb67s269_cfg_t::rst
pin_name_t rst
Definition: multisteppertb67s269.h:202
multisteppertb67s269_write_register
err_t multisteppertb67s269_write_register(multisteppertb67s269_t *ctx, uint8_t reg, uint8_t data_in)
Multi Stepper TB67S269 write register function.
multisteppertb67s269_cfg_t::an
pin_name_t an
Definition: multisteppertb67s269.h:201
multisteppertb67s269_t::rst
digital_out_t rst
Definition: multisteppertb67s269.h:177
multisteppertb67s269_cfg_t
Multi Stepper TB67S269 Click configuration object.
Definition: multisteppertb67s269.h:196
multisteppertb67s269_set_step_mode
err_t multisteppertb67s269_set_step_mode(multisteppertb67s269_t *ctx, uint8_t mode)
Multi Stepper TB67S269 set step mode function.
multisteppertb67s269_get_int_pin
uint8_t multisteppertb67s269_get_int_pin(multisteppertb67s269_t *ctx)
Multi Stepper TB67S269 get int pin function.
multisteppertb67s269_t::an
digital_out_t an
Definition: multisteppertb67s269.h:176
multisteppertb67s269_disable_device
void multisteppertb67s269_disable_device(multisteppertb67s269_t *ctx)
Multi Stepper TB67S269 disable device function.
multisteppertb67s269_cfg_t::clk
pin_name_t clk
Definition: multisteppertb67s269.h:203
multisteppertb67s269_t
Multi Stepper TB67S269 Click context object.
Definition: multisteppertb67s269.h:173
multisteppertb67s269_t::int_pin
digital_in_t int_pin
Definition: multisteppertb67s269.h:181
multisteppertb67s269_cfg_t::i2c_address
uint8_t i2c_address
Definition: multisteppertb67s269.h:207
multisteppertb67s269_set_direction
void multisteppertb67s269_set_direction(multisteppertb67s269_t *ctx, uint8_t dir)
Multi Stepper TB67S269 set direction function.
multisteppertb67s269_reset_device
void multisteppertb67s269_reset_device(multisteppertb67s269_t *ctx)
Multi Stepper TB67S269 reset device function.
MULTISTEPPERTB67S269_ERROR
@ MULTISTEPPERTB67S269_ERROR
Definition: multisteppertb67s269.h:218
multisteppertb67s269_t::i2c
i2c_master_t i2c
Definition: multisteppertb67s269.h:184
multisteppertb67s269_init
err_t multisteppertb67s269_init(multisteppertb67s269_t *ctx, multisteppertb67s269_cfg_t *cfg)
Multi Stepper TB67S269 initialization function.
multisteppertb67s269_drive_motor
void multisteppertb67s269_drive_motor(multisteppertb67s269_t *ctx, uint32_t steps, uint8_t speed)
Multi Stepper TB67S269 driver motor function.
multisteppertb67s269_cfg_setup
void multisteppertb67s269_cfg_setup(multisteppertb67s269_cfg_t *cfg)
Multi Stepper TB67S269 configuration object setup function.
multisteppertb67s269_cfg_t::sda
pin_name_t sda
Definition: multisteppertb67s269.h:198
multisteppertb67s269_return_value_t
multisteppertb67s269_return_value_t
Multi Stepper TB67S269 Click return value data.
Definition: multisteppertb67s269.h:216