multisteppertb67s269  2.0.0.0
Data Structures | Macros | Enumerations | Functions
multisteppertb67s269.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  multisteppertb67s269_t
 Multi Stepper TB67S269 Click context object. More...
 
struct  multisteppertb67s269_cfg_t
 Multi Stepper TB67S269 Click configuration object. More...
 

Macros

#define MULTISTEPPERTB67S269_REG_INPUT   0x00
 Multi Stepper TB67S269 PCA9538A registers. More...
 
#define MULTISTEPPERTB67S269_REG_OUTPUT   0x01
 
#define MULTISTEPPERTB67S269_REG_POLARITY   0x02
 
#define MULTISTEPPERTB67S269_REG_CONFIG   0x03
 
#define MULTISTEPPERTB67S269_DMODE0_PIN   0x01
 Multi Stepper TB67S269 PCA9538A pin mask. More...
 
#define MULTISTEPPERTB67S269_DMODE1_PIN   0x02
 
#define MULTISTEPPERTB67S269_DMODE2_PIN   0x04
 
#define MULTISTEPPERTB67S269_MO_PIN   0x40
 
#define MULTISTEPPERTB67S269_LO_PIN   0x80
 
#define MULTISTEPPERTB67S269_DEFAULT_CONFIG   0xF8
 Multi Stepper TB67S269 PCA9538A pin direction config. More...
 
#define MULTISTEPPERTB67S269_DIR_CW   0
 Multi Stepper TB67S269 direction setting. More...
 
#define MULTISTEPPERTB67S269_DIR_CCW   1
 
#define MULTISTEPPERTB67S269_PIN_LOW_LEVEL   0
 Multi Stepper TB67S269 pin logic level setting. More...
 
#define MULTISTEPPERTB67S269_PIN_HIGH_LEVEL   1
 
#define MULTISTEPPERTB67S269_MODE_STANDBY   0x00
 Multi Stepper TB67S269 step resolution setting. More...
 
#define MULTISTEPPERTB67S269_MODE_HALF_STEP_TYPE_B   0x01
 
#define MULTISTEPPERTB67S269_MODE_HALF_STEP_TYPE_A   0x02
 
#define MULTISTEPPERTB67S269_MODE_1_OVER_16   0x03
 
#define MULTISTEPPERTB67S269_MODE_FULL_STEP   0x04
 
#define MULTISTEPPERTB67S269_MODE_1_OVER_8   0x05
 
#define MULTISTEPPERTB67S269_MODE_QUARTER_STEP   0x06
 
#define MULTISTEPPERTB67S269_MODE_1_OVER_32   0x07
 
#define MULTISTEPPERTB67S269_MODE_BITS_MASK   0x07
 
#define MULTISTEPPERTB67S269_SPEED_VERY_SLOW   0
 Multi Stepper TB67S269 device speed settings. More...
 
#define MULTISTEPPERTB67S269_SPEED_SLOW   1
 
#define MULTISTEPPERTB67S269_SPEED_MEDIUM   2
 
#define MULTISTEPPERTB67S269_SPEED_FAST   3
 
#define MULTISTEPPERTB67S269_SPEED_VERY_FAST   4
 
#define MULTISTEPPERTB67S269_DEVICE_ADDRESS_A1A0_00   0x70
 Multi Stepper TB67S269 device address setting. More...
 
#define MULTISTEPPERTB67S269_DEVICE_ADDRESS_A1A0_01   0x71
 
#define MULTISTEPPERTB67S269_DEVICE_ADDRESS_A1A0_10   0x72
 
#define MULTISTEPPERTB67S269_DEVICE_ADDRESS_A1A0_11   0x73
 
#define MULTISTEPPERTB67S269_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  multisteppertb67s269_return_value_t { MULTISTEPPERTB67S269_OK = 0, MULTISTEPPERTB67S269_ERROR = -1 }
 Multi Stepper TB67S269 Click return value data. More...
 

Functions

void multisteppertb67s269_cfg_setup (multisteppertb67s269_cfg_t *cfg)
 Multi Stepper TB67S269 configuration object setup function. More...
 
err_t multisteppertb67s269_init (multisteppertb67s269_t *ctx, multisteppertb67s269_cfg_t *cfg)
 Multi Stepper TB67S269 initialization function. More...
 
err_t multisteppertb67s269_default_cfg (multisteppertb67s269_t *ctx)
 Multi Stepper TB67S269 default configuration function. More...
 
err_t multisteppertb67s269_write_register (multisteppertb67s269_t *ctx, uint8_t reg, uint8_t data_in)
 Multi Stepper TB67S269 write register function. More...
 
err_t multisteppertb67s269_read_register (multisteppertb67s269_t *ctx, uint8_t reg, uint8_t *data_out)
 Multi Stepper TB67S269 read register function. More...
 
err_t multisteppertb67s269_get_step_mode (multisteppertb67s269_t *ctx, uint8_t *mode)
 Multi Stepper TB67S269 get step mode function. More...
 
err_t multisteppertb67s269_set_step_mode (multisteppertb67s269_t *ctx, uint8_t mode)
 Multi Stepper TB67S269 set step mode function. More...
 
void multisteppertb67s269_drive_motor (multisteppertb67s269_t *ctx, uint32_t steps, uint8_t speed)
 Multi Stepper TB67S269 driver motor function. More...
 
void multisteppertb67s269_enable_device (multisteppertb67s269_t *ctx)
 Multi Stepper TB67S269 enable device function. More...
 
void multisteppertb67s269_disable_device (multisteppertb67s269_t *ctx)
 Multi Stepper TB67S269 disable device function. More...
 
void multisteppertb67s269_set_direction (multisteppertb67s269_t *ctx, uint8_t dir)
 Multi Stepper TB67S269 set direction function. More...
 
void multisteppertb67s269_switch_direction (multisteppertb67s269_t *ctx)
 Multi Stepper TB67S269 switch direction function. More...
 
void multisteppertb67s269_reset_device (multisteppertb67s269_t *ctx)
 Multi Stepper TB67S269 reset device function. More...
 
uint8_t multisteppertb67s269_get_int_pin (multisteppertb67s269_t *ctx)
 Multi Stepper TB67S269 get int pin function. More...
 
void multisteppertb67s269_set_clk_pin (multisteppertb67s269_t *ctx, uint8_t state)
 Multi Stepper TB67S269 set clk pin function. More...
 

Detailed Description

This file contains API for Multi Stepper TB67S269 Click Driver.

Enumeration Type Documentation

◆ multisteppertb67s269_return_value_t

Multi Stepper TB67S269 Click return value data.

Predefined enum values for driver return values.

Enumerator
MULTISTEPPERTB67S269_OK 
MULTISTEPPERTB67S269_ERROR