This file contains API for Stepper 3 Click Driver. More...

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

Data Structures
struct	stepper3_t
	Stepper 3 Click context object. More...

struct	stepper3_cfg_t
	Stepper 3 Click configuration object. More...

Macros
#define	STEPPER3_DIR_CW 0
	Stepper 3 direction setting.

#define	STEPPER3_DIR_CCW 1

#define	STEPPER3_PIN_LOW_LEVEL 0
	Stepper 3 pin logic level setting.

#define	STEPPER3_PIN_HIGH_LEVEL 1

#define	STEPPER3_MODE_FULL_STEP 0
	Stepper 3 step resolution setting.

#define	STEPPER3_MODE_HALF_STEP 1

#define	STEPPER3_MICROSTEP_NUM_PER_STEP 32
	Stepper 3 microstep setting.

#define	STEPPER3_SPEED_VERY_SLOW 0
	Stepper 3 device speed settings.

#define	STEPPER3_SPEED_SLOW 1

#define	STEPPER3_SPEED_MEDIUM 2

#define	STEPPER3_SPEED_FAST 3

#define	STEPPER3_SPEED_VERY_FAST 4

#define	STEPPER3_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	stepper3_return_value_t { STEPPER3_OK = 0 , STEPPER3_ERROR = -1 }
	Stepper 3 Click return value data. More...

Functions
void	stepper3_cfg_setup (stepper3_cfg_t *cfg)
	Stepper 3 configuration object setup function.

err_t	stepper3_init (stepper3_t ctx, stepper3_cfg_t cfg)
	Stepper 3 initialization function.

void	stepper3_set_ina_pin (stepper3_t *ctx, uint8_t state)
	Stepper 3 set ina pin function.

void	stepper3_set_inb_pin (stepper3_t *ctx, uint8_t state)
	Stepper 3 set inb pin function.

void	stepper3_set_inc_pin (stepper3_t *ctx, uint8_t state)
	Stepper 3 set inc pin function.

void	stepper3_set_ind_pin (stepper3_t *ctx, uint8_t state)
	Stepper 3 set ind pin function.

void	stepper3_set_step_mode (stepper3_t *ctx, uint8_t mode)
	Stepper 3 set step mode function.

void	stepper3_set_direction (stepper3_t *ctx, uint8_t dir)
	Stepper 3 set direction function.

void	stepper3_switch_direction (stepper3_t *ctx)
	Stepper 3 switch direction function.

void	stepper3_enable_device (stepper3_t *ctx)
	Stepper 3 enable device function.

void	stepper3_disable_device (stepper3_t *ctx)
	Stepper 3 disable device function.

void	stepper3_drive_motor (stepper3_t *ctx, uint32_t steps, uint8_t speed)
	Stepper 3 driver motor function.

Detailed Description

This file contains API for Stepper 3 Click Driver.

Enumeration Type Documentation

Stepper 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
STEPPER3_OK
STEPPER3_ERROR