stepper11.h File Reference

This file contains API for Stepper 11 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	stepper11_t
	Stepper 11 Click context object. More...
struct	stepper11_cfg_t
	Stepper 11 Click configuration object. More...

Macros
#define	STEPPER11_REG_INPUT_PORT   0x00
	Stepper 11 description register.
#define	STEPPER11_REG_OUTPUT_PORT   0x01
#define	STEPPER11_REG_POLARITY   0x02
#define	STEPPER11_REG_CONFIGURATION   0x03
#define	STEPPER11_SPEED_SLOW   1
	Stepper 11 device speed settings.
#define	STEPPER11_SPEED_MEDIUM   2
#define	STEPPER11_SPEED_FAST   3
#define	STEPPER11_RESOLUTION_FULL   0x4
	Stepper 11 device resolution settings.
#define	STEPPER11_RESOLUTION_HALF_A   0x2
#define	STEPPER11_RESOLUTION_HALF_B   0x1
#define	STEPPER11_RESOLUTION_QUARTER   0x6
#define	STEPPER11_RESOLUTION_1div8   0x5
#define	STEPPER11_RESOLUTION_1div16   0x3
#define	STEPPER11_RESOLUTION_1div32   0x7
#define	STEPPER11_TORQUE_100   0x0
	Stepper 11 device torque settings.
#define	STEPPER11_TORQUE_70   0x1
#define	STEPPER11_TORQUE_50   0x2
#define	STEPPER11_TORQUE_30   0x3
#define	STEPPER11_SET_DEV_ADDR   0x70
	Stepper 11 device address setting.
#define	STEPPER11_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	stepper11_return_value_t { STEPPER11_OK = 0 , STEPPER11_ERROR = -1 }
	Stepper 11 Click return value data. More...

Functions
void	stepper11_cfg_setup (stepper11_cfg_t *cfg)
	Stepper 11 configuration object setup function.
err_t	stepper11_init (stepper11_t *ctx, stepper11_cfg_t *cfg)
	Stepper 11 initialization function.
err_t	stepper11_default_cfg (stepper11_t *ctx)
	Stepper 11 default configuration function.
err_t	stepper11_generic_write (stepper11_t *ctx, uint8_t reg, uint8_t tx_data)
	Stepper 11 I2C writing function.
err_t	stepper11_generic_read (stepper11_t *ctx, uint8_t reg, uint8_t *rx_data)
	Stepper 11 I2C reading function.
void	stepper11_set_direction (stepper11_t *ctx, uint8_t state)
	Set direction.
void	stepper11_set_enable (stepper11_t *ctx, uint8_t state)
	Set enable.
void	stepper11_set_reset (stepper11_t *ctx, uint8_t state)
	Set restart.
void	stepper11_set_clock (stepper11_t *ctx, uint8_t state)
	Set clock state.
uint8_t	stepper11_get_interrupt (stepper11_t *ctx)
	Get interrupt.
uint8_t	stepper11_get_diag (stepper11_t *ctx)
	Get anomaly detection flag.
uint8_t	stepper11_get_mo (stepper11_t *ctx)
	Get electrical angle monitoring signal.
uint8_t	stepper11_get_sd (stepper11_t *ctx)
	Get stall detection flag.
err_t	stepper11_set_step_resolution (stepper11_t *ctx, uint8_t step_res)
	Set step resolution.
err_t	stepper11_set_torque (stepper11_t *ctx, uint8_t torque)
	Set torque.
void	stepper11_move_motor_angle (stepper11_t *ctx, float degree, uint8_t speed)
	Move motor in angle value.
void	stepper11_move_motor_step (stepper11_t *ctx, uint16_t steps, uint8_t speed)
	Move motor in step value.

Detailed Description

This file contains API for Stepper 11 Click Driver.

Enumeration Type Documentation

stepper11_return_value_t

enum stepper11_return_value_t

Stepper 11 Click return value data.

Predefined enum values for driver return values.

Enumerator
STEPPER11_OK
STEPPER11_ERROR