stepper24  2.1.0.0
Data Structures | Macros | Enumerations | Functions
stepper24.h File Reference

This file contains API for Stepper 24 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  stepper24_t
 Stepper 24 Click context object. More...
 
struct  stepper24_cfg_t
 Stepper 24 Click configuration object. More...
 

Macros

#define STEPPER24_REG_INPUT_0   0x00
 Stepper 24 PCA9555A registers. More...
 
#define STEPPER24_REG_INPUT_1   0x01
 
#define STEPPER24_REG_OUTPUT_0   0x02
 
#define STEPPER24_REG_OUTPUT_1   0x03
 
#define STEPPER24_REG_POLARITY_0   0x04
 
#define STEPPER24_REG_POLARITY_1   0x05
 
#define STEPPER24_REG_CONFIG_0   0x06
 
#define STEPPER24_REG_CONFIG_1   0x07
 
#define STEPPER24_P0_DMODE0_PIN   0x01
 Stepper 24 PCA9555A pin mask. More...
 
#define STEPPER24_P0_DMODE1_PIN   0x02
 
#define STEPPER24_P0_DMODE2_PIN   0x04
 
#define STEPPER24_P0_DECAY1_PIN   0x08
 
#define STEPPER24_P0_DECAY2_PIN   0x10
 
#define STEPPER24_P0_TRQ0_PIN   0x20
 
#define STEPPER24_P0_TRQ1_PIN   0x40
 
#define STEPPER24_P0_SLEEP_X_PIN   0x80
 
#define STEPPER24_P1_LO1_PIN   0x01
 
#define STEPPER24_P1_LO2_PIN   0x02
 
#define STEPPER24_P1_MO_PIN   0x04
 
#define STEPPER24_P1_RST_PIN   0x08
 
#define STEPPER24_P0_DEFAULT_CONFIG   0x00
 Stepper 24 PCA9555A pin direction config. More...
 
#define STEPPER24_P1_DEFAULT_CONFIG   0xF7
 
#define STEPPER24_DIR_CW   1
 Stepper 24 direction setting. More...
 
#define STEPPER24_DIR_CCW   0
 
#define STEPPER24_PIN_LOW_LEVEL   0
 Stepper 24 pin logic level setting. More...
 
#define STEPPER24_PIN_HIGH_LEVEL   1
 
#define STEPPER24_MODE_FULL_STEP   0x00
 Stepper 24 step resolution setting. More...
 
#define STEPPER24_MODE_1_OVER_8   0x01
 
#define STEPPER24_MODE_HALF_STEP_TYPE_B   0x02
 
#define STEPPER24_MODE_1_OVER_32   0x03
 
#define STEPPER24_MODE_HALF_STEP_TYPE_A   0x04
 
#define STEPPER24_MODE_1_OVER_16   0x05
 
#define STEPPER24_MODE_QUARTER_STEP   0x06
 
#define STEPPER24_MODE_MASK   0x07
 
#define STEPPER24_TORQUE_100_PCT   0x00
 Stepper 24 torque setting. More...
 
#define STEPPER24_TORQUE_75_PCT   0x01
 
#define STEPPER24_TORQUE_50_PCT   0x02
 
#define STEPPER24_TORQUE_25_PCT   0x03
 
#define STEPPER24_TORQUE_MASK   0x03
 
#define STEPPER24_DECAY_MIXED   0x00
 Stepper 24 decay setting. More...
 
#define STEPPER24_DECAY_SLOW   0x01
 
#define STEPPER24_DECAY_FAST   0x02
 
#define STEPPER24_DECAY_ADMD   0x03
 
#define STEPPER24_DECAY_MASK   0x03
 
#define STEPPER24_SPEED_VERY_SLOW   0
 Stepper 24 device speed settings. More...
 
#define STEPPER24_SPEED_SLOW   1
 
#define STEPPER24_SPEED_MEDIUM   2
 
#define STEPPER24_SPEED_FAST   3
 
#define STEPPER24_SPEED_VERY_FAST   4
 
#define STEPPER24_DEVICE_ADDRESS_A1A0_00   0x20
 Stepper 24 device address setting. More...
 
#define STEPPER24_DEVICE_ADDRESS_A1A0_01   0x21
 
#define STEPPER24_DEVICE_ADDRESS_A1A0_10   0x22
 
#define STEPPER24_DEVICE_ADDRESS_A1A0_11   0x23
 
#define STEPPER24_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  stepper24_return_value_t { STEPPER24_OK = 0, STEPPER24_ERROR = -1 }
 Stepper 24 Click return value data. More...
 

Functions

void stepper24_cfg_setup (stepper24_cfg_t *cfg)
 Stepper 24 configuration object setup function. More...
 
err_t stepper24_init (stepper24_t *ctx, stepper24_cfg_t *cfg)
 Stepper 24 initialization function. More...
 
err_t stepper24_default_cfg (stepper24_t *ctx)
 Stepper 24 default configuration function. More...
 
err_t stepper24_write_register (stepper24_t *ctx, uint8_t reg, uint8_t data_in)
 Stepper 24 write register function. More...
 
err_t stepper24_read_register (stepper24_t *ctx, uint8_t reg, uint8_t *data_out)
 Stepper 24 read register function. More...
 
err_t stepper24_get_step_mode (stepper24_t *ctx, uint8_t *mode)
 Stepper 24 get step mode function. More...
 
err_t stepper24_set_step_mode (stepper24_t *ctx, uint8_t mode)
 Stepper 24 set step mode function. More...
 
err_t stepper24_get_torque (stepper24_t *ctx, uint8_t *torque)
 Stepper 24 get torque function. More...
 
err_t stepper24_set_torque (stepper24_t *ctx, uint8_t torque)
 Stepper 24 set torque function. More...
 
err_t stepper24_get_decay (stepper24_t *ctx, uint8_t *decay)
 Stepper 24 get decay function. More...
 
err_t stepper24_set_decay (stepper24_t *ctx, uint8_t decay)
 Stepper 24 set decay function. More...
 
err_t stepper24_get_sleep_x_pin (stepper24_t *ctx, uint8_t *state)
 Stepper 24 get sleep x pin function. More...
 
err_t stepper24_set_sleep_x_pin (stepper24_t *ctx, uint8_t state)
 Stepper 24 set sleep x pin function. More...
 
err_t stepper24_get_lo1_pin (stepper24_t *ctx, uint8_t *state)
 Stepper 24 get lo1 pin function. More...
 
err_t stepper24_get_lo2_pin (stepper24_t *ctx, uint8_t *state)
 Stepper 24 get lo2 pin function. More...
 
err_t stepper24_get_mo_pin (stepper24_t *ctx, uint8_t *state)
 Stepper 24 get mo pin function. More...
 
err_t stepper24_get_rst_pin (stepper24_t *ctx, uint8_t *state)
 Stepper 24 get RST pin function. More...
 
err_t stepper24_set_rst_pin (stepper24_t *ctx, uint8_t state)
 Stepper 24 set RST pin function. More...
 
err_t stepper24_reset_device (stepper24_t *ctx)
 Stepper 24 reset device function. More...
 
void stepper24_drive_motor (stepper24_t *ctx, uint32_t steps, uint8_t speed)
 Stepper 24 driver motor function. More...
 
void stepper24_enable_device (stepper24_t *ctx)
 Stepper 24 enable device function. More...
 
void stepper24_disable_device (stepper24_t *ctx)
 Stepper 24 disable device function. More...
 
void stepper24_set_direction (stepper24_t *ctx, uint8_t dir)
 Stepper 24 set direction function. More...
 
void stepper24_switch_direction (stepper24_t *ctx)
 Stepper 24 switch direction function. More...
 
uint8_t stepper24_get_int_pin (stepper24_t *ctx)
 Stepper 24 get int pin function. More...
 
void stepper24_set_clk_pin (stepper24_t *ctx, uint8_t state)
 Stepper 24 set clk pin function. More...
 

Detailed Description

This file contains API for Stepper 24 Click Driver.

Enumeration Type Documentation

◆ stepper24_return_value_t

Stepper 24 Click return value data.

Predefined enum values for driver return values.

Enumerator
STEPPER24_OK 
STEPPER24_ERROR