silentstep4 2.1.0.0
Silent Step 4 Registers Settings

Settings for registers of Silent Step 4 Click driver. More...

Macros

#define SILENTSTEP4_IOIN_VERSION_MASK   0xFF000000ul
 Silent Step 4 version settings.
 
#define SILENTSTEP4_IOIN_VERSION_DEFAULT   0x40000000ul
 
#define SILENTSTEP4_PIN_EN   0x01
 Silent Step 4 PCA9538A pin mask.
 
#define SILENTSTEP4_PIN_SLEEP   0x02
 
#define SILENTSTEP4_PIN_DIAG0   0x04
 
#define SILENTSTEP4_PIN_DIAG1   0x08
 
#define SILENTSTEP4_PIN_OV   0x10
 
#define SILENTSTEP4_PCA9538A_DEFAULT_CONFIG   0xFC
 Silent Step 4 PCA9538A pin direction config.
 
#define SILENTSTEP4_DIR_CW   0
 Silent Step 4 direction setting.
 
#define SILENTSTEP4_DIR_CCW   1
 
#define SILENTSTEP4_PIN_STATE_LOW   0
 Silent Step 4 pin logic state setting.
 
#define SILENTSTEP4_PIN_STATE_HIGH   1
 
#define SILENTSTEP4_SPEED_VERY_SLOW   0
 Silent Step 4 device speed settings.
 
#define SILENTSTEP4_SPEED_SLOW   1
 
#define SILENTSTEP4_SPEED_MEDIUM   2
 
#define SILENTSTEP4_SPEED_FAST   3
 
#define SILENTSTEP4_SPEED_VERY_FAST   4
 
#define SILENTSTEP4_TOFF_MASK   0x0000000Ful
 Silent Step 4 off time settings.
 
#define SILENTSTEP4_TOFF_SHIFT   0
 
#define SILENTSTEP4_TOFF_DRIVER_DISABLE   0
 
#define SILENTSTEP4_TOFF_MIN   1
 
#define SILENTSTEP4_TOFF_DEFAULT   4
 
#define SILENTSTEP4_TOFF_MAX   15
 
#define SILENTSTEP4_MRES_MASK   0x0F000000ul
 Silent Step 4 step resolution settings.
 
#define SILENTSTEP4_MRES_SHIFT   24
 
#define SILENTSTEP4_MRES_256   0
 
#define SILENTSTEP4_MRES_128   1
 
#define SILENTSTEP4_MRES_64   2
 
#define SILENTSTEP4_MRES_32   3
 
#define SILENTSTEP4_MRES_16   4
 
#define SILENTSTEP4_MRES_8   5
 
#define SILENTSTEP4_MRES_4   6
 
#define SILENTSTEP4_MRES_2   7
 
#define SILENTSTEP4_MRES_FULLSTEP   8
 
#define SILENTSTEP4_IRUN_MASK   0x00000F00ul
 Silent Step 4 run current settings.
 
#define SILENTSTEP4_IRUN_SHIFT   8
 
#define SILENTSTEP4_IRUN_MIN   0
 
#define SILENTSTEP4_IRUN_DEFAULT   16
 
#define SILENTSTEP4_IRUN_MAX   31
 
#define SILENTSTEP4_DEVICE_ADDRESS_A1A0_00   0x70
 Silent Step 4 device address setting.
 
#define SILENTSTEP4_DEVICE_ADDRESS_A1A0_01   0x71
 
#define SILENTSTEP4_DEVICE_ADDRESS_A1A0_10   0x72
 
#define SILENTSTEP4_DEVICE_ADDRESS_A1A0_11   0x73
 
#define SILENTSTEP4_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
 Data sample selection.
 
#define SILENTSTEP4_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 

Detailed Description

Settings for registers of Silent Step 4 Click driver.

Macro Definition Documentation

◆ SILENTSTEP4_DEVICE_ADDRESS_A1A0_00

#define SILENTSTEP4_DEVICE_ADDRESS_A1A0_00   0x70

Silent Step 4 device address setting.

Specified setting for device slave address selection of Silent Step 4 Click driver.

◆ SILENTSTEP4_DEVICE_ADDRESS_A1A0_01

#define SILENTSTEP4_DEVICE_ADDRESS_A1A0_01   0x71

◆ SILENTSTEP4_DEVICE_ADDRESS_A1A0_10

#define SILENTSTEP4_DEVICE_ADDRESS_A1A0_10   0x72

◆ SILENTSTEP4_DEVICE_ADDRESS_A1A0_11

#define SILENTSTEP4_DEVICE_ADDRESS_A1A0_11   0x73

◆ SILENTSTEP4_DIR_CCW

#define SILENTSTEP4_DIR_CCW   1

◆ SILENTSTEP4_DIR_CW

#define SILENTSTEP4_DIR_CW   0

Silent Step 4 direction setting.

Specified setting for direction of Silent Step 4 Click driver.

◆ SILENTSTEP4_IOIN_VERSION_DEFAULT

#define SILENTSTEP4_IOIN_VERSION_DEFAULT   0x40000000ul

◆ SILENTSTEP4_IOIN_VERSION_MASK

#define SILENTSTEP4_IOIN_VERSION_MASK   0xFF000000ul

Silent Step 4 version settings.

Specified version settings of Silent Step 4 Click driver.

◆ SILENTSTEP4_IRUN_DEFAULT

#define SILENTSTEP4_IRUN_DEFAULT   16

◆ SILENTSTEP4_IRUN_MASK

#define SILENTSTEP4_IRUN_MASK   0x00000F00ul

Silent Step 4 run current settings.

Specified setting for motor run current.

◆ SILENTSTEP4_IRUN_MAX

#define SILENTSTEP4_IRUN_MAX   31

◆ SILENTSTEP4_IRUN_MIN

#define SILENTSTEP4_IRUN_MIN   0

◆ SILENTSTEP4_IRUN_SHIFT

#define SILENTSTEP4_IRUN_SHIFT   8

◆ SILENTSTEP4_MRES_128

#define SILENTSTEP4_MRES_128   1

◆ SILENTSTEP4_MRES_16

#define SILENTSTEP4_MRES_16   4

◆ SILENTSTEP4_MRES_2

#define SILENTSTEP4_MRES_2   7

◆ SILENTSTEP4_MRES_256

#define SILENTSTEP4_MRES_256   0

◆ SILENTSTEP4_MRES_32

#define SILENTSTEP4_MRES_32   3

◆ SILENTSTEP4_MRES_4

#define SILENTSTEP4_MRES_4   6

◆ SILENTSTEP4_MRES_64

#define SILENTSTEP4_MRES_64   2

◆ SILENTSTEP4_MRES_8

#define SILENTSTEP4_MRES_8   5

◆ SILENTSTEP4_MRES_FULLSTEP

#define SILENTSTEP4_MRES_FULLSTEP   8

◆ SILENTSTEP4_MRES_MASK

#define SILENTSTEP4_MRES_MASK   0x0F000000ul

Silent Step 4 step resolution settings.

Specified setting for micro step resolution.

◆ SILENTSTEP4_MRES_SHIFT

#define SILENTSTEP4_MRES_SHIFT   24

◆ SILENTSTEP4_PCA9538A_DEFAULT_CONFIG

#define SILENTSTEP4_PCA9538A_DEFAULT_CONFIG   0xFC

Silent Step 4 PCA9538A pin direction config.

Specified PCA9538A pin direction config of Silent Step 4 Click driver.

◆ SILENTSTEP4_PIN_DIAG0

#define SILENTSTEP4_PIN_DIAG0   0x04

◆ SILENTSTEP4_PIN_DIAG1

#define SILENTSTEP4_PIN_DIAG1   0x08

◆ SILENTSTEP4_PIN_EN

#define SILENTSTEP4_PIN_EN   0x01

Silent Step 4 PCA9538A pin mask.

Specified PCA9538A pin mask of Silent Step 4 Click driver.

◆ SILENTSTEP4_PIN_OV

#define SILENTSTEP4_PIN_OV   0x10

◆ SILENTSTEP4_PIN_SLEEP

#define SILENTSTEP4_PIN_SLEEP   0x02

◆ SILENTSTEP4_PIN_STATE_HIGH

#define SILENTSTEP4_PIN_STATE_HIGH   1

◆ SILENTSTEP4_PIN_STATE_LOW

#define SILENTSTEP4_PIN_STATE_LOW   0

Silent Step 4 pin logic state setting.

Specified setting for pin logic state of Silent Step 4 Click driver.

◆ SILENTSTEP4_SET_DATA_SAMPLE_EDGE

#define SILENTSTEP4_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE

Data sample selection.

This macro sets data samples for SPI modules.

Note
Available only on Microchip PIC family devices. This macro will set data sampling for all SPI modules on MCU. Can be overwritten with silentstep4_init which will set SET_SPI_DATA_SAMPLE_MIDDLE by default on the mapped mikrobus.

◆ SILENTSTEP4_SET_DATA_SAMPLE_MIDDLE

#define SILENTSTEP4_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE

◆ SILENTSTEP4_SPEED_FAST

#define SILENTSTEP4_SPEED_FAST   3

◆ SILENTSTEP4_SPEED_MEDIUM

#define SILENTSTEP4_SPEED_MEDIUM   2

◆ SILENTSTEP4_SPEED_SLOW

#define SILENTSTEP4_SPEED_SLOW   1

◆ SILENTSTEP4_SPEED_VERY_FAST

#define SILENTSTEP4_SPEED_VERY_FAST   4

◆ SILENTSTEP4_SPEED_VERY_SLOW

#define SILENTSTEP4_SPEED_VERY_SLOW   0

Silent Step 4 device speed settings.

Specified setting for rotation speed.

◆ SILENTSTEP4_TOFF_DEFAULT

#define SILENTSTEP4_TOFF_DEFAULT   4

◆ SILENTSTEP4_TOFF_DRIVER_DISABLE

#define SILENTSTEP4_TOFF_DRIVER_DISABLE   0

◆ SILENTSTEP4_TOFF_MASK

#define SILENTSTEP4_TOFF_MASK   0x0000000Ful

Silent Step 4 off time settings.

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

◆ SILENTSTEP4_TOFF_MAX

#define SILENTSTEP4_TOFF_MAX   15

◆ SILENTSTEP4_TOFF_MIN

#define SILENTSTEP4_TOFF_MIN   1

◆ SILENTSTEP4_TOFF_SHIFT

#define SILENTSTEP4_TOFF_SHIFT   0