multisteppertb67s209  2.0.0.0
multisteppertb67s209.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 MULTISTEPPERTB67S209_H
29 #define MULTISTEPPERTB67S209_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_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define MULTISTEPPERTB67S209_REG_INPUT 0x00
74 #define MULTISTEPPERTB67S209_REG_OUTPUT 0x01
75 #define MULTISTEPPERTB67S209_REG_POLARITY 0x02
76 #define MULTISTEPPERTB67S209_REG_CONFIG 0x03
77  // multisteppertb67s209_reg
79 
94 #define MULTISTEPPERTB67S209_DMODE0_PIN 0x01
95 #define MULTISTEPPERTB67S209_DMODE1_PIN 0x02
96 #define MULTISTEPPERTB67S209_DMODE2_PIN 0x04
97 #define MULTISTEPPERTB67S209_SMD1_PIN 0x10
98 #define MULTISTEPPERTB67S209_SMD0_PIN 0x20
99 #define MULTISTEPPERTB67S209_MO_PIN 0x40
100 #define MULTISTEPPERTB67S209_LO_PIN 0x80
101 
106 #define MULTISTEPPERTB67S209_DEFAULT_CONFIG 0xC8
107 
112 #define MULTISTEPPERTB67S209_DIR_CW 0
113 #define MULTISTEPPERTB67S209_DIR_CCW 1
114 
119 #define MULTISTEPPERTB67S209_PIN_LOW_LEVEL 0
120 #define MULTISTEPPERTB67S209_PIN_HIGH_LEVEL 1
121 
126 #define MULTISTEPPERTB67S209_MODE_STANDBY 0x00
127 #define MULTISTEPPERTB67S209_MODE_HALF_STEP_TYPE_B 0x01
128 #define MULTISTEPPERTB67S209_MODE_HALF_STEP_TYPE_A 0x02
129 #define MULTISTEPPERTB67S209_MODE_1_OVER_16 0x03
130 #define MULTISTEPPERTB67S209_MODE_FULL_STEP 0x04
131 #define MULTISTEPPERTB67S209_MODE_1_OVER_8 0x05
132 #define MULTISTEPPERTB67S209_MODE_QUARTER_STEP 0x06
133 #define MULTISTEPPERTB67S209_MODE_1_OVER_32 0x07
134 #define MULTISTEPPERTB67S209_MODE_BITS_MASK 0x07
135 
140 #define MULTISTEPPERTB67S209_SMD_MODE_FD_12p5_PERCENT 0x00
141 #define MULTISTEPPERTB67S209_SMD_MODE_FD_37p5_PERCENT 0x01
142 #define MULTISTEPPERTB67S209_SMD_MODE_FD_50_PERCENT 0x02
143 #define MULTISTEPPERTB67S209_SMD_MODE_FD_ONLY 0x03
144 #define MULTISTEPPERTB67S209_SMD_MODE_BITS_MASK 0x30
145 
150 #define MULTISTEPPERTB67S209_SPEED_VERY_SLOW 0
151 #define MULTISTEPPERTB67S209_SPEED_SLOW 1
152 #define MULTISTEPPERTB67S209_SPEED_MEDIUM 2
153 #define MULTISTEPPERTB67S209_SPEED_FAST 3
154 #define MULTISTEPPERTB67S209_SPEED_VERY_FAST 4
155 
161 #define MULTISTEPPERTB67S209_DEVICE_ADDRESS_A1A0_00 0x70
162 #define MULTISTEPPERTB67S209_DEVICE_ADDRESS_A1A0_01 0x71
163 #define MULTISTEPPERTB67S209_DEVICE_ADDRESS_A1A0_10 0x72
164 #define MULTISTEPPERTB67S209_DEVICE_ADDRESS_A1A0_11 0x73
165  // multisteppertb67s209_set
167 
182 #define MULTISTEPPERTB67S209_MAP_MIKROBUS( cfg, mikrobus ) \
183  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
184  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
185  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
186  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
187  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
188  cfg.clk = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
189  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
190  // multisteppertb67s209_map // multisteppertb67s209
193 
198 typedef struct
199 {
200  // Output pins
201  digital_out_t en;
202  digital_out_t an;
203  digital_out_t rst;
204  digital_out_t clk;
206  // Input pins
207  digital_in_t int_pin;
209  // Modules
210  i2c_master_t i2c;
212  // I2C slave address
213  uint8_t slave_address;
216 
221 typedef struct
222 {
223  pin_name_t scl;
224  pin_name_t sda;
226  pin_name_t en;
227  pin_name_t an;
228  pin_name_t rst;
229  pin_name_t clk;
230  pin_name_t int_pin;
232  uint32_t i2c_speed;
233  uint8_t i2c_address;
236 
241 typedef enum
242 {
245 
247 
264 
279 
294 
308 err_t multisteppertb67s209_write_register ( multisteppertb67s209_t *ctx, uint8_t reg, uint8_t data_in );
309 
322 err_t multisteppertb67s209_read_register ( multisteppertb67s209_t *ctx, uint8_t reg, uint8_t *data_out );
323 
336 
349 
362 
375 
391 void multisteppertb67s209_drive_motor ( multisteppertb67s209_t *ctx, uint32_t steps, uint8_t speed );
392 
402 
412 
424 
434 
444 
454 
466 
467 #ifdef __cplusplus
468 }
469 #endif
470 #endif // MULTISTEPPERTB67S209_H
471  // multisteppertb67s209
473 
474 // ------------------------------------------------------------------------ END
multisteppertb67s209_return_value_t
multisteppertb67s209_return_value_t
Multi Stepper TB67S209 Click return value data.
Definition: multisteppertb67s209.h:242
MULTISTEPPERTB67S209_OK
@ MULTISTEPPERTB67S209_OK
Definition: multisteppertb67s209.h:243
multisteppertb67s209_drive_motor
void multisteppertb67s209_drive_motor(multisteppertb67s209_t *ctx, uint32_t steps, uint8_t speed)
Multi Stepper TB67S209 driver motor function.
multisteppertb67s209_set_direction
void multisteppertb67s209_set_direction(multisteppertb67s209_t *ctx, uint8_t dir)
Multi Stepper TB67S209 set direction function.
multisteppertb67s209_enable_device
void multisteppertb67s209_enable_device(multisteppertb67s209_t *ctx)
Multi Stepper TB67S209 enable device function.
multisteppertb67s209_cfg_t::int_pin
pin_name_t int_pin
Definition: multisteppertb67s209.h:230
multisteppertb67s209_cfg_t::i2c_address
uint8_t i2c_address
Definition: multisteppertb67s209.h:233
multisteppertb67s209_set_smd_mode
err_t multisteppertb67s209_set_smd_mode(multisteppertb67s209_t *ctx, uint8_t mode)
Multi Stepper TB67S209 set smd mode function.
multisteppertb67s209_cfg_t::an
pin_name_t an
Definition: multisteppertb67s209.h:227
multisteppertb67s209_t::clk
digital_out_t clk
Definition: multisteppertb67s209.h:204
multisteppertb67s209_disable_device
void multisteppertb67s209_disable_device(multisteppertb67s209_t *ctx)
Multi Stepper TB67S209 disable device function.
multisteppertb67s209_cfg_setup
void multisteppertb67s209_cfg_setup(multisteppertb67s209_cfg_t *cfg)
Multi Stepper TB67S209 configuration object setup function.
multisteppertb67s209_cfg_t::sda
pin_name_t sda
Definition: multisteppertb67s209.h:224
multisteppertb67s209_default_cfg
err_t multisteppertb67s209_default_cfg(multisteppertb67s209_t *ctx)
Multi Stepper TB67S209 default configuration function.
multisteppertb67s209_cfg_t::clk
pin_name_t clk
Definition: multisteppertb67s209.h:229
multisteppertb67s209_t::slave_address
uint8_t slave_address
Definition: multisteppertb67s209.h:213
multisteppertb67s209_t
Multi Stepper TB67S209 Click context object.
Definition: multisteppertb67s209.h:199
multisteppertb67s209_t::en
digital_out_t en
Definition: multisteppertb67s209.h:201
multisteppertb67s209_t::rst
digital_out_t rst
Definition: multisteppertb67s209.h:203
multisteppertb67s209_cfg_t::scl
pin_name_t scl
Definition: multisteppertb67s209.h:223
multisteppertb67s209_reset_device
void multisteppertb67s209_reset_device(multisteppertb67s209_t *ctx)
Multi Stepper TB67S209 reset device function.
multisteppertb67s209_set_step_mode
err_t multisteppertb67s209_set_step_mode(multisteppertb67s209_t *ctx, uint8_t mode)
Multi Stepper TB67S209 set step mode function.
multisteppertb67s209_get_int_pin
uint8_t multisteppertb67s209_get_int_pin(multisteppertb67s209_t *ctx)
Multi Stepper TB67S209 get int pin function.
multisteppertb67s209_write_register
err_t multisteppertb67s209_write_register(multisteppertb67s209_t *ctx, uint8_t reg, uint8_t data_in)
Multi Stepper TB67S209 write register function.
multisteppertb67s209_get_step_mode
err_t multisteppertb67s209_get_step_mode(multisteppertb67s209_t *ctx, uint8_t *mode)
Multi Stepper TB67S209 get step mode function.
multisteppertb67s209_get_smd_mode
err_t multisteppertb67s209_get_smd_mode(multisteppertb67s209_t *ctx, uint8_t *mode)
Multi Stepper TB67S209 get smd mode function.
multisteppertb67s209_cfg_t
Multi Stepper TB67S209 Click configuration object.
Definition: multisteppertb67s209.h:222
MULTISTEPPERTB67S209_ERROR
@ MULTISTEPPERTB67S209_ERROR
Definition: multisteppertb67s209.h:244
multisteppertb67s209_set_clk_pin
void multisteppertb67s209_set_clk_pin(multisteppertb67s209_t *ctx, uint8_t state)
Multi Stepper TB67S209 set clk pin function.
multisteppertb67s209_t::an
digital_out_t an
Definition: multisteppertb67s209.h:202
multisteppertb67s209_switch_direction
void multisteppertb67s209_switch_direction(multisteppertb67s209_t *ctx)
Multi Stepper TB67S209 switch direction function.
multisteppertb67s209_read_register
err_t multisteppertb67s209_read_register(multisteppertb67s209_t *ctx, uint8_t reg, uint8_t *data_out)
Multi Stepper TB67S209 read register function.
multisteppertb67s209_cfg_t::en
pin_name_t en
Definition: multisteppertb67s209.h:226
multisteppertb67s209_t::int_pin
digital_in_t int_pin
Definition: multisteppertb67s209.h:207
multisteppertb67s209_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: multisteppertb67s209.h:232
multisteppertb67s209_cfg_t::rst
pin_name_t rst
Definition: multisteppertb67s209.h:228
multisteppertb67s209_t::i2c
i2c_master_t i2c
Definition: multisteppertb67s209.h:210
multisteppertb67s209_init
err_t multisteppertb67s209_init(multisteppertb67s209_t *ctx, multisteppertb67s209_cfg_t *cfg)
Multi Stepper TB67S209 initialization function.