stepper17.h File Reference

This file contains API for Stepper 17 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	stepper17_t
	Stepper 17 Click context object. More...
struct	stepper17_cfg_t
	Stepper 17 Click configuration object. More...

Macros
#define	STEPPER17_REG_INPUT_0   0x00
	Stepper 17 PCA9555A registers.
#define	STEPPER17_REG_INPUT_1   0x01
#define	STEPPER17_REG_OUTPUT_0   0x02
#define	STEPPER17_REG_OUTPUT_1   0x03
#define	STEPPER17_REG_POLARITY_0   0x04
#define	STEPPER17_REG_POLARITY_1   0x05
#define	STEPPER17_REG_CONFIG_0   0x06
#define	STEPPER17_REG_CONFIG_1   0x07
#define	STEPPER17_P0_DMODE0_PIN   0x01
	Stepper 17 PCA9555A pin mask.
#define	STEPPER17_P0_DMODE1_PIN   0x02
#define	STEPPER17_P0_DMODE2_PIN   0x04
#define	STEPPER17_P0_DECAY1_PIN   0x08
#define	STEPPER17_P0_DECAY2_PIN   0x10
#define	STEPPER17_P0_TRQ0_PIN   0x20
#define	STEPPER17_P0_TRQ1_PIN   0x40
#define	STEPPER17_P0_SLEEP_X_PIN   0x80
#define	STEPPER17_P1_LO1_PIN   0x01
#define	STEPPER17_P1_LO2_PIN   0x02
#define	STEPPER17_P1_MO_PIN   0x04
#define	STEPPER17_P0_DEFAULT_CONFIG   0x00
	Stepper 17 PCA9555A pin direction config.
#define	STEPPER17_P1_DEFAULT_CONFIG   0xFF
#define	STEPPER17_DIR_CW   1
	Stepper 17 direction setting.
#define	STEPPER17_DIR_CCW   0
#define	STEPPER17_PIN_LOW_LEVEL   0
	Stepper 17 pin logic level setting.
#define	STEPPER17_PIN_HIGH_LEVEL   1
#define	STEPPER17_MODE_FULL_STEP   0x00
	Stepper 17 step resolution setting.
#define	STEPPER17_MODE_1_OVER_8   0x01
#define	STEPPER17_MODE_HALF_STEP_TYPE_B   0x02
#define	STEPPER17_MODE_1_OVER_32   0x03
#define	STEPPER17_MODE_HALF_STEP_TYPE_A   0x04
#define	STEPPER17_MODE_1_OVER_16   0x05
#define	STEPPER17_MODE_QUARTER_STEP   0x06
#define	STEPPER17_MODE_MASK   0x07
#define	STEPPER17_TORQUE_100_PCT   0x00
	Stepper 17 torque setting.
#define	STEPPER17_TORQUE_75_PCT   0x01
#define	STEPPER17_TORQUE_50_PCT   0x02
#define	STEPPER17_TORQUE_25_PCT   0x03
#define	STEPPER17_TORQUE_MASK   0x03
#define	STEPPER17_DECAY_MIXED   0x00
	Stepper 17 decay setting.
#define	STEPPER17_DECAY_SLOW   0x01
#define	STEPPER17_DECAY_FAST   0x02
#define	STEPPER17_DECAY_ADMD   0x03
#define	STEPPER17_DECAY_MASK   0x03
#define	STEPPER17_SPEED_VERY_SLOW   0
	Stepper 17 device speed settings.
#define	STEPPER17_SPEED_SLOW   1
#define	STEPPER17_SPEED_MEDIUM   2
#define	STEPPER17_SPEED_FAST   3
#define	STEPPER17_SPEED_VERY_FAST   4
#define	STEPPER17_DEVICE_ADDRESS_A2A1A0_000   0x20
	Stepper 17 device address setting.
#define	STEPPER17_DEVICE_ADDRESS_A2A1A0_001   0x21
#define	STEPPER17_DEVICE_ADDRESS_A2A1A0_010   0x22
#define	STEPPER17_DEVICE_ADDRESS_A2A1A0_011   0x23
#define	STEPPER17_DEVICE_ADDRESS_A2A1A0_100   0x24
#define	STEPPER17_DEVICE_ADDRESS_A2A1A0_101   0x25
#define	STEPPER17_DEVICE_ADDRESS_A2A1A0_110   0x26
#define	STEPPER17_DEVICE_ADDRESS_A2A1A0_111   0x27
#define	STEPPER17_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	stepper17_return_value_t { STEPPER17_OK = 0 , STEPPER17_ERROR = -1 }
	Stepper 17 Click return value data. More...

Functions
void	stepper17_cfg_setup (stepper17_cfg_t *cfg)
	Stepper 17 configuration object setup function.
err_t	stepper17_init (stepper17_t *ctx, stepper17_cfg_t *cfg)
	Stepper 17 initialization function.
err_t	stepper17_default_cfg (stepper17_t *ctx)
	Stepper 17 default configuration function.
err_t	stepper17_write_register (stepper17_t *ctx, uint8_t reg, uint8_t data_in)
	Stepper 17 write register function.
err_t	stepper17_read_register (stepper17_t *ctx, uint8_t reg, uint8_t *data_out)
	Stepper 17 read register function.
err_t	stepper17_get_step_mode (stepper17_t *ctx, uint8_t *mode)
	Stepper 17 get step mode function.
err_t	stepper17_set_step_mode (stepper17_t *ctx, uint8_t mode)
	Stepper 17 set step mode function.
err_t	stepper17_get_torque (stepper17_t *ctx, uint8_t *torque)
	Stepper 17 get torque function.
err_t	stepper17_set_torque (stepper17_t *ctx, uint8_t torque)
	Stepper 17 set torque function.
err_t	stepper17_get_decay (stepper17_t *ctx, uint8_t *decay)
	Stepper 17 get decay function.
err_t	stepper17_set_decay (stepper17_t *ctx, uint8_t decay)
	Stepper 17 set decay function.
err_t	stepper17_get_sleep_x_pin (stepper17_t *ctx, uint8_t *state)
	Stepper 17 get sleep x pin function.
err_t	stepper17_set_sleep_x_pin (stepper17_t *ctx, uint8_t state)
	Stepper 17 set sleep x pin function.
err_t	stepper17_get_lo1_pin (stepper17_t *ctx, uint8_t *state)
	Stepper 17 get lo1 pin function.
err_t	stepper17_get_lo2_pin (stepper17_t *ctx, uint8_t *state)
	Stepper 17 get lo2 pin function.
err_t	stepper17_get_mo_pin (stepper17_t *ctx, uint8_t *state)
	Stepper 17 get mo pin function.
void	stepper17_drive_motor (stepper17_t *ctx, uint32_t steps, uint8_t speed)
	Stepper 17 driver motor function.
void	stepper17_enable_device (stepper17_t *ctx)
	Stepper 17 enable device function.
void	stepper17_disable_device (stepper17_t *ctx)
	Stepper 17 disable device function.
void	stepper17_set_direction (stepper17_t *ctx, uint8_t dir)
	Stepper 17 set direction function.
void	stepper17_switch_direction (stepper17_t *ctx)
	Stepper 17 switch direction function.
void	stepper17_reset_device (stepper17_t *ctx)
	Stepper 17 reset device function.
uint8_t	stepper17_get_int_pin (stepper17_t *ctx)
	Stepper 17 get int pin function.
void	stepper17_set_clk_pin (stepper17_t *ctx, uint8_t state)
	Stepper 17 set clk pin function.

Detailed Description

This file contains API for Stepper 17 Click Driver.

Enumeration Type Documentation

stepper17_return_value_t

enum stepper17_return_value_t

Stepper 17 Click return value data.

Predefined enum values for driver return values.

Enumerator
STEPPER17_OK
STEPPER17_ERROR