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

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

Data Structures
struct	stepper2_t
	Stepper 2 Click context object. More...

struct	stepper2_cfg_t
	Stepper 2 Click configuration object. More...

Macros
#define	STEPPER2_PIN_STATE_LOW 0
	Stepper 2 pin logic state setting.

#define	STEPPER2_PIN_STATE_HIGH 1

#define	STEPPER2_DIR_CCW 0
	Stepper 2 direction setting.

#define	STEPPER2_DIR_CW 1

#define	STEPPER2_MODE_FULL_STEP 0
	Stepper 2 step resolution setting.

#define	STEPPER2_MODE_HALF_STEP 1

#define	STEPPER2_MODE_QUARTER_STEP 2

#define	STEPPER2_MODE_1_OVER_8_STEP 3

#define	STEPPER2_MICROSTEP_NUM_PER_STEP 32
	Stepper 2 microstep setting.

#define	STEPPER2_SPEED_VERY_SLOW 0
	Stepper 2 device speed settings.

#define	STEPPER2_SPEED_SLOW 1

#define	STEPPER2_SPEED_MEDIUM 2

#define	STEPPER2_SPEED_FAST 3

#define	STEPPER2_SPEED_VERY_FAST 4

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

Enumerations
enum	stepper2_return_value_t { STEPPER2_OK = 0 , STEPPER2_ERROR = -1 }
	Stepper 2 Click return value data. More...

Functions
void	stepper2_cfg_setup (stepper2_cfg_t *cfg)
	Stepper 2 configuration object setup function.

err_t	stepper2_init (stepper2_t ctx, stepper2_cfg_t cfg)
	Stepper 2 initialization function.

void	stepper2_default_cfg (stepper2_t *ctx)
	Stepper 2 default configuration function.

void	stepper2_drive_motor (stepper2_t *ctx, uint32_t steps, uint8_t speed)
	Stepper 2 driver motor function.

void	stepper2_enable_reset (stepper2_t *ctx)
	Stepper 2 enable reset function.

void	stepper2_disable_reset (stepper2_t *ctx)
	Stepper 2 disable reset function.

void	stepper2_enable_sleep (stepper2_t *ctx)
	Stepper 2 enable sleep function.

void	stepper2_disable_sleep (stepper2_t *ctx)
	Stepper 2 disable sleep function.

void	stepper2_enable_device (stepper2_t *ctx)
	Stepper 2 enable device function.

void	stepper2_disable_device (stepper2_t *ctx)
	Stepper 2 disable device function.

void	stepper2_set_direction (stepper2_t *ctx, uint8_t dir)
	Stepper 2 set direction function.

void	stepper2_switch_direction (stepper2_t *ctx)
	Stepper 2 switch direction function.

void	stepper2_set_step_pin (stepper2_t *ctx, uint8_t state)
	Stepper 2 set step pin function.

Detailed Description

This file contains API for Stepper 2 Click Driver.

Enumeration Type Documentation

Stepper 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
STEPPER2_OK
STEPPER2_ERROR