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

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

Data Structures
struct	stepper4_t
	Stepper 4 Click context object. More...

struct	stepper4_cfg_t
	Stepper 4 Click configuration object. More...

Macros
#define	STEPPER4_DIR_CW 0
	Stepper 4 direction setting.

#define	STEPPER4_DIR_CCW 1

#define	STEPPER4_PIN_LOW_LEVEL 0
	Stepper 4 pin logic level setting.

#define	STEPPER4_PIN_HIGH_LEVEL 1

#define	STEPPER4_SPEED_VERY_SLOW 0
	Stepper 4 device speed settings.

#define	STEPPER4_SPEED_SLOW 1

#define	STEPPER4_SPEED_MEDIUM 2

#define	STEPPER4_SPEED_FAST 3

#define	STEPPER4_SPEED_VERY_FAST 4

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

Enumerations
enum	stepper4_return_value_t { STEPPER4_OK = 0 , STEPPER4_ERROR = -1 }
	Stepper 4 Click return value data. More...

Functions
void	stepper4_cfg_setup (stepper4_cfg_t *cfg)
	Stepper 4 configuration object setup function.

err_t	stepper4_init (stepper4_t ctx, stepper4_cfg_t cfg)
	Stepper 4 initialization function.

void	stepper4_default_cfg (stepper4_t *ctx)
	Stepper 4 default configuration function.

void	stepper4_drive_motor (stepper4_t *ctx, uint32_t steps, uint8_t speed)
	Stepper 4 drive motor function.

void	stepper4_enable_device (stepper4_t *ctx)
	Stepper 4 enable device function.

void	stepper4_disable_device (stepper4_t *ctx)
	Stepper 4 disable device function.

void	stepper4_set_direction (stepper4_t *ctx, uint8_t dir)
	Stepper 4 set direction function.

void	stepper4_switch_direction (stepper4_t *ctx)
	Stepper 4 switch direction function.

void	stepper4_reset_device (stepper4_t *ctx)
	Stepper 4 reset device function.

uint8_t	stepper4_get_int_pin (stepper4_t *ctx)
	Stepper 4 get int pin function.

void	stepper4_set_step_pin (stepper4_t *ctx, uint8_t state)
	Stepper 4 set step pin function.

Detailed Description

This file contains API for Stepper 4 Click Driver.

Enumeration Type Documentation

Stepper 4 Click return value data.

Predefined enum values for driver return values.

Enumerator
STEPPER4_OK
STEPPER4_ERROR