multisteppertb67s261.h File Reference

This file contains API for Multi Stepper TB67S261 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures
struct	multisteppertb67s261_t
	Multi Stepper TB67S261 Click context object. More...
struct	multisteppertb67s261_cfg_t
	Multi Stepper TB67S261 Click configuration object. More...

Macros
#define	MULTISTEPPERTB67S261_REG_INPUT   0x00
	Multi Stepper TB67S261 PCA9538A registers.
#define	MULTISTEPPERTB67S261_REG_OUTPUT   0x01
#define	MULTISTEPPERTB67S261_REG_POLARITY   0x02
#define	MULTISTEPPERTB67S261_REG_CONFIG   0x03
#define	MULTISTEPPERTB67S261_PHASEA_PIN   0x02
	Multi Stepper TB67S261 PCA9538A pin mask.
#define	MULTISTEPPERTB67S261_PHASEB_PIN   0x04
#define	MULTISTEPPERTB67S261_DEFAULT_CONFIG   0xF9
	Multi Stepper TB67S261 PCA9538A pin direction config.
#define	MULTISTEPPERTB67S261_DIR_CW   0
	Multi Stepper TB67S261 direction setting.
#define	MULTISTEPPERTB67S261_DIR_CCW   1
#define	MULTISTEPPERTB67S261_PIN_LOW_LEVEL   0
	Multi Stepper TB67S261 pin logic level setting.
#define	MULTISTEPPERTB67S261_PIN_HIGH_LEVEL   1
#define	MULTISTEPPERTB67S261_MODE_FULL_STEP   0x00
	Multi Stepper TB67S261 step resolution setting.
#define	MULTISTEPPERTB67S261_MODE_HALF_STEP   0x01
#define	MULTISTEPPERTB67S261_MODE_QUARTER_STEP   0x02
#define	MULTISTEPPERTB67S261_SPEED_VERY_SLOW   0
	Multi Stepper TB67S261 device speed settings.
#define	MULTISTEPPERTB67S261_SPEED_SLOW   1
#define	MULTISTEPPERTB67S261_SPEED_MEDIUM   2
#define	MULTISTEPPERTB67S261_SPEED_FAST   3
#define	MULTISTEPPERTB67S261_SPEED_VERY_FAST   4
#define	MULTISTEPPERTB67S261_DEVICE_ADDRESS_A1A0_00   0x70
	Multi Stepper TB67S261 device address setting.
#define	MULTISTEPPERTB67S261_DEVICE_ADDRESS_A1A0_01   0x71
#define	MULTISTEPPERTB67S261_DEVICE_ADDRESS_A1A0_10   0x72
#define	MULTISTEPPERTB67S261_DEVICE_ADDRESS_A1A0_11   0x73
#define	MULTISTEPPERTB67S261_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	multisteppertb67s261_return_value_t { MULTISTEPPERTB67S261_OK = 0 , MULTISTEPPERTB67S261_ERROR = -1 }
	Multi Stepper TB67S261 Click return value data. More...

Functions
void	multisteppertb67s261_cfg_setup (multisteppertb67s261_cfg_t *cfg)
	Multi Stepper TB67S261 configuration object setup function.
err_t	multisteppertb67s261_init (multisteppertb67s261_t *ctx, multisteppertb67s261_cfg_t *cfg)
	Multi Stepper TB67S261 initialization function.
err_t	multisteppertb67s261_default_cfg (multisteppertb67s261_t *ctx)
	Multi Stepper TB67S261 default configuration function.
err_t	multisteppertb67s261_write_register (multisteppertb67s261_t *ctx, uint8_t reg, uint8_t data_in)
	Multi Stepper TB67S261 write register function.
err_t	multisteppertb67s261_read_register (multisteppertb67s261_t *ctx, uint8_t reg, uint8_t *data_out)
	Multi Stepper TB67S261 read register function.
err_t	multisteppertb67s261_drive_motor (multisteppertb67s261_t *ctx, uint32_t steps, uint8_t speed)
	Multi Stepper TB67S261 driver motor function.
void	multisteppertb67s261_enable_device (multisteppertb67s261_t *ctx)
	Multi Stepper TB67S261 enable device function.
void	multisteppertb67s261_disable_device (multisteppertb67s261_t *ctx)
	Multi Stepper TB67S261 disable device function.
void	multisteppertb67s261_set_ina1_pin (multisteppertb67s261_t *ctx, uint8_t state)
	Multi Stepper TB67S261 set ina1 pin function.
void	multisteppertb67s261_set_ina2_pin (multisteppertb67s261_t *ctx, uint8_t state)
	Multi Stepper TB67S261 set ina2 pin function.
void	multisteppertb67s261_set_inb1_pin (multisteppertb67s261_t *ctx, uint8_t state)
	Multi Stepper TB67S261 set inb1 pin function.
void	multisteppertb67s261_set_inb2_pin (multisteppertb67s261_t *ctx, uint8_t state)
	Multi Stepper TB67S261 set inb2 pin function.
void	multisteppertb67s261_set_step_mode (multisteppertb67s261_t *ctx, uint8_t mode)
	Multi Stepper TB67S261 set step mode function.
void	multisteppertb67s261_set_direction (multisteppertb67s261_t *ctx, uint8_t dir)
	Multi Stepper TB67S261 set direction function.
void	multisteppertb67s261_switch_direction (multisteppertb67s261_t *ctx)
	Multi Stepper TB67S261 switch direction function.

Detailed Description

This file contains API for Multi Stepper TB67S261 Click Driver.

Enumeration Type Documentation

multisteppertb67s261_return_value_t

enum multisteppertb67s261_return_value_t

Multi Stepper TB67S261 Click return value data.

Predefined enum values for driver return values.

Enumerator
MULTISTEPPERTB67S261_OK
MULTISTEPPERTB67S261_ERROR