stepper5 2.1.0.0
Stepper 5 Device Settings

Settings for registers of Stepper 5 Click driver. More...

Macros

#define STEPPER5_IOIN_VERSION_MASK   0xFF000000ul
 Stepper 5 version settings.
 
#define STEPPER5_IOIN_VERSION_DEFAULT   0x20000000ul
 
#define STEPPER5_DIR_CW   0
 Stepper 5 direction setting.
 
#define STEPPER5_DIR_CCW   1
 
#define STEPPER5_PIN_STATE_LOW   0
 Stepper 5 pin logic state setting.
 
#define STEPPER5_PIN_STATE_HIGH   1
 
#define STEPPER5_SPEED_VERY_SLOW   0
 Stepper 5 device speed settings.
 
#define STEPPER5_SPEED_SLOW   1
 
#define STEPPER5_SPEED_MEDIUM   2
 
#define STEPPER5_SPEED_FAST   3
 
#define STEPPER5_SPEED_VERY_FAST   4
 
#define STEPPER5_GCONF_I_SCALE_ANALOG_INT_5V   0x00000000ul
 Stepper 5 GCONF register settings.
 
#define STEPPER5_GCONF_I_SCALE_ANALOG_EXT_VREF   0x00000001ul
 
#define STEPPER5_GCONF_INTERNAL_RSENSE_EXT   0x00000000ul
 
#define STEPPER5_GCONF_INTERNAL_RSENSE_INT   0x00000002ul
 
#define STEPPER5_GCONF_EN_SPREAD_CYCLE_SCHOP   0x00000000ul
 
#define STEPPER5_GCONF_EN_SPREAD_CYCLE_SCYCLE   0x00000004ul
 
#define STEPPER5_GCONF_SHAFT_INVERSE   0x00000008ul
 
#define STEPPER5_GCONF_INDEX_OTPW_FIRST_MSTEP   0x00000000ul
 
#define STEPPER5_GCONF_INDEX_OTPW_OVERTEMP   0x00000010ul
 
#define STEPPER5_GCONF_INDEX_STEP_OTPW   0x00000000ul
 
#define STEPPER5_GCONF_INDEX_STEP_INT   0x00000020ul
 
#define STEPPER5_GCONF_PDN_DISABLE_SSC_REDUCT   0x00000000ul
 
#define STEPPER5_GCONF_PDN_DISABLE_UART_EN   0x00000040ul
 
#define STEPPER5_GCONF_MSTEP_REG_SELECT_MS_PINS   0x00000000ul
 
#define STEPPER5_GCONF_MSTEP_REG_SELECT_MSTEP   0x00000080ul
 
#define STEPPER5_GCONF_MULTISTEP_FILT_DIS   0x00000000ul
 
#define STEPPER5_GCONF_MULTISTEP_FILT_EN   0x00000100ul
 
#define STEPPER5_GCONF_TEST_MODE_NORMAL   0x00000000ul
 
#define STEPPER5_GCONF_TEST_MODE_ENN   0x00000200ul
 
#define STEPPER5_TOFF_MASK   0x0000000Ful
 Stepper 5 off time settings.
 
#define STEPPER5_TOFF_SHIFT   0
 
#define STEPPER5_TOFF_DRIVER_DISABLE   0
 
#define STEPPER5_TOFF_MIN   1
 
#define STEPPER5_TOFF_DEFAULT   4
 
#define STEPPER5_TOFF_MAX   15
 
#define STEPPER5_MRES_MASK   0x0F000000ul
 Stepper 5 step resolution settings.
 
#define STEPPER5_MRES_SHIFT   24
 
#define STEPPER5_MRES_256   0
 
#define STEPPER5_MRES_128   1
 
#define STEPPER5_MRES_64   2
 
#define STEPPER5_MRES_32   3
 
#define STEPPER5_MRES_16   4
 
#define STEPPER5_MRES_8   5
 
#define STEPPER5_MRES_4   6
 
#define STEPPER5_MRES_2   7
 
#define STEPPER5_MRES_FULLSTEP   8
 
#define STEPPER5_IRUN_MASK   0x00000F00ul
 Stepper 5 run current settings.
 
#define STEPPER5_IRUN_SHIFT   8
 
#define STEPPER5_IRUN_MIN   0
 
#define STEPPER5_IRUN_DEFAULT   16
 
#define STEPPER5_IRUN_MAX   31
 
#define STEPPER5_UART_SYNC_BYTE   0x05
 Stepper 5 UART settings.
 
#define STEPPER5_UART_SLAVE_ADDRESS   0x00
 
#define STEPPER5_UART_WRITE_BIT   0x80
 
#define STEPPER5_TX_DRV_BUFFER_SIZE   100
 Stepper 5 driver buffer size.
 
#define STEPPER5_RX_DRV_BUFFER_SIZE   300
 

Detailed Description

Settings for registers of Stepper 5 Click driver.

Macro Definition Documentation

◆ STEPPER5_DIR_CCW

#define STEPPER5_DIR_CCW   1

◆ STEPPER5_DIR_CW

#define STEPPER5_DIR_CW   0

Stepper 5 direction setting.

Specified setting for direction of Stepper 5 Click driver.

◆ STEPPER5_GCONF_EN_SPREAD_CYCLE_SCHOP

#define STEPPER5_GCONF_EN_SPREAD_CYCLE_SCHOP   0x00000000ul

◆ STEPPER5_GCONF_EN_SPREAD_CYCLE_SCYCLE

#define STEPPER5_GCONF_EN_SPREAD_CYCLE_SCYCLE   0x00000004ul

◆ STEPPER5_GCONF_I_SCALE_ANALOG_EXT_VREF

#define STEPPER5_GCONF_I_SCALE_ANALOG_EXT_VREF   0x00000001ul

◆ STEPPER5_GCONF_I_SCALE_ANALOG_INT_5V

#define STEPPER5_GCONF_I_SCALE_ANALOG_INT_5V   0x00000000ul

Stepper 5 GCONF register settings.

Specified setting for GCONF register of Stepper 5 Click driver.

◆ STEPPER5_GCONF_INDEX_OTPW_FIRST_MSTEP

#define STEPPER5_GCONF_INDEX_OTPW_FIRST_MSTEP   0x00000000ul

◆ STEPPER5_GCONF_INDEX_OTPW_OVERTEMP

#define STEPPER5_GCONF_INDEX_OTPW_OVERTEMP   0x00000010ul

◆ STEPPER5_GCONF_INDEX_STEP_INT

#define STEPPER5_GCONF_INDEX_STEP_INT   0x00000020ul

◆ STEPPER5_GCONF_INDEX_STEP_OTPW

#define STEPPER5_GCONF_INDEX_STEP_OTPW   0x00000000ul

◆ STEPPER5_GCONF_INTERNAL_RSENSE_EXT

#define STEPPER5_GCONF_INTERNAL_RSENSE_EXT   0x00000000ul

◆ STEPPER5_GCONF_INTERNAL_RSENSE_INT

#define STEPPER5_GCONF_INTERNAL_RSENSE_INT   0x00000002ul

◆ STEPPER5_GCONF_MSTEP_REG_SELECT_MS_PINS

#define STEPPER5_GCONF_MSTEP_REG_SELECT_MS_PINS   0x00000000ul

◆ STEPPER5_GCONF_MSTEP_REG_SELECT_MSTEP

#define STEPPER5_GCONF_MSTEP_REG_SELECT_MSTEP   0x00000080ul

◆ STEPPER5_GCONF_MULTISTEP_FILT_DIS

#define STEPPER5_GCONF_MULTISTEP_FILT_DIS   0x00000000ul

◆ STEPPER5_GCONF_MULTISTEP_FILT_EN

#define STEPPER5_GCONF_MULTISTEP_FILT_EN   0x00000100ul

◆ STEPPER5_GCONF_PDN_DISABLE_SSC_REDUCT

#define STEPPER5_GCONF_PDN_DISABLE_SSC_REDUCT   0x00000000ul

◆ STEPPER5_GCONF_PDN_DISABLE_UART_EN

#define STEPPER5_GCONF_PDN_DISABLE_UART_EN   0x00000040ul

◆ STEPPER5_GCONF_SHAFT_INVERSE

#define STEPPER5_GCONF_SHAFT_INVERSE   0x00000008ul

◆ STEPPER5_GCONF_TEST_MODE_ENN

#define STEPPER5_GCONF_TEST_MODE_ENN   0x00000200ul

◆ STEPPER5_GCONF_TEST_MODE_NORMAL

#define STEPPER5_GCONF_TEST_MODE_NORMAL   0x00000000ul

◆ STEPPER5_IOIN_VERSION_DEFAULT

#define STEPPER5_IOIN_VERSION_DEFAULT   0x20000000ul

◆ STEPPER5_IOIN_VERSION_MASK

#define STEPPER5_IOIN_VERSION_MASK   0xFF000000ul

Stepper 5 version settings.

Specified version settings of Stepper 5 Click driver.

◆ STEPPER5_IRUN_DEFAULT

#define STEPPER5_IRUN_DEFAULT   16

◆ STEPPER5_IRUN_MASK

#define STEPPER5_IRUN_MASK   0x00000F00ul

Stepper 5 run current settings.

Specified setting for motor run current.

◆ STEPPER5_IRUN_MAX

#define STEPPER5_IRUN_MAX   31

◆ STEPPER5_IRUN_MIN

#define STEPPER5_IRUN_MIN   0

◆ STEPPER5_IRUN_SHIFT

#define STEPPER5_IRUN_SHIFT   8

◆ STEPPER5_MRES_128

#define STEPPER5_MRES_128   1

◆ STEPPER5_MRES_16

#define STEPPER5_MRES_16   4

◆ STEPPER5_MRES_2

#define STEPPER5_MRES_2   7

◆ STEPPER5_MRES_256

#define STEPPER5_MRES_256   0

◆ STEPPER5_MRES_32

#define STEPPER5_MRES_32   3

◆ STEPPER5_MRES_4

#define STEPPER5_MRES_4   6

◆ STEPPER5_MRES_64

#define STEPPER5_MRES_64   2

◆ STEPPER5_MRES_8

#define STEPPER5_MRES_8   5

◆ STEPPER5_MRES_FULLSTEP

#define STEPPER5_MRES_FULLSTEP   8

◆ STEPPER5_MRES_MASK

#define STEPPER5_MRES_MASK   0x0F000000ul

Stepper 5 step resolution settings.

Specified setting for micro step resolution.

◆ STEPPER5_MRES_SHIFT

#define STEPPER5_MRES_SHIFT   24

◆ STEPPER5_PIN_STATE_HIGH

#define STEPPER5_PIN_STATE_HIGH   1

◆ STEPPER5_PIN_STATE_LOW

#define STEPPER5_PIN_STATE_LOW   0

Stepper 5 pin logic state setting.

Specified setting for pin logic state of Stepper 5 Click driver.

◆ STEPPER5_RX_DRV_BUFFER_SIZE

#define STEPPER5_RX_DRV_BUFFER_SIZE   300

◆ STEPPER5_SPEED_FAST

#define STEPPER5_SPEED_FAST   3

◆ STEPPER5_SPEED_MEDIUM

#define STEPPER5_SPEED_MEDIUM   2

◆ STEPPER5_SPEED_SLOW

#define STEPPER5_SPEED_SLOW   1

◆ STEPPER5_SPEED_VERY_FAST

#define STEPPER5_SPEED_VERY_FAST   4

◆ STEPPER5_SPEED_VERY_SLOW

#define STEPPER5_SPEED_VERY_SLOW   0

Stepper 5 device speed settings.

Specified setting for rotation speed.

◆ STEPPER5_TOFF_DEFAULT

#define STEPPER5_TOFF_DEFAULT   4

◆ STEPPER5_TOFF_DRIVER_DISABLE

#define STEPPER5_TOFF_DRIVER_DISABLE   0

◆ STEPPER5_TOFF_MASK

#define STEPPER5_TOFF_MASK   0x0000000Ful

Stepper 5 off time settings.

Specified setting for off time that controls duration of slow decay phase.

◆ STEPPER5_TOFF_MAX

#define STEPPER5_TOFF_MAX   15

◆ STEPPER5_TOFF_MIN

#define STEPPER5_TOFF_MIN   1

◆ STEPPER5_TOFF_SHIFT

#define STEPPER5_TOFF_SHIFT   0

◆ STEPPER5_TX_DRV_BUFFER_SIZE

#define STEPPER5_TX_DRV_BUFFER_SIZE   100

Stepper 5 driver buffer size.

Specified size of driver ring buffer.

Note
Increase buffer size if needed.

◆ STEPPER5_UART_SLAVE_ADDRESS

#define STEPPER5_UART_SLAVE_ADDRESS   0x00

◆ STEPPER5_UART_SYNC_BYTE

#define STEPPER5_UART_SYNC_BYTE   0x05

Stepper 5 UART settings.

Specified UART settings of Stepper 5 Click driver.

◆ STEPPER5_UART_WRITE_BIT

#define STEPPER5_UART_WRITE_BIT   0x80