API for configuring and manipulating Silent Step 2 Click driver. More...

Topics
	Silent Step 2 Registers List
	List of registers of Silent Step 2 Click driver.

	Silent Step 2 Registers Settings
	Settings for registers of Silent Step 2 Click driver.

	Silent Step 2 MikroBUS Map
	MikroBUS pin mapping of Silent Step 2 Click driver.

Functions
void	silentstep2_cfg_setup (silentstep2_cfg_t *cfg)
	Silent Step 2 configuration object setup function.

err_t	silentstep2_init (silentstep2_t ctx, silentstep2_cfg_t cfg)
	Silent Step 2 initialization function.

err_t	silentstep2_default_cfg (silentstep2_t *ctx)
	Silent Step 2 default configuration function.

err_t	silentstep2_reg_write (silentstep2_t *ctx, uint8_t reg, uint32_t data_in)
	Silent Step 2 data writing function.

err_t	silentstep2_reg_read (silentstep2_t ctx, uint8_t reg, uint32_t data_in)
	Silent Step 2 data reading function.

err_t	silentstep2_set_gconf (silentstep2_t *ctx, silentstep2_gconf_t gconf)
	Silent Step 2 sets global configuration function.

err_t	silentstep2_get_gstat (silentstep2_t ctx, uint32_t gstat)
	Silent Step 2 get global status function.

err_t	silentstep2_set_ihold_irun (silentstep2_t *ctx, uint8_t ihold, uint8_t irun, uint8_t ihold_delay)
	Silent Step 2 sets driver current control function.

err_t	silentstep2_set_tcoolthrs (silentstep2_t *ctx, uint32_t tcoolthrs)
	Silent Step 2 sets lower threshold velocity for switching on smart energy function.

err_t	silentstep2_set_thigh (silentstep2_t *ctx, uint32_t thigh)
	Silent Step 2 sets the velocity setting function.

err_t	silentstep2_set_mslut (silentstep2_t *ctx, uint8_t mslut_sel, uint32_t mslut)
	Silent Step 2 sets the microstep table entries function.

err_t	silentstep2_set_mslutsel (silentstep2_t *ctx, uint32_t lut_seg_str, uint32_t lut_width_sel)
	Silent Step 2 sets the microstep segments function.

err_t	silentstep2_set_mslutstart (silentstep2_t *ctx, uint32_t start_sin, uint32_t start_sin90)
	Silent Step 2 sets the absolute current microstep table function.

err_t	silentstep2_set_mstep_res (silentstep2_t *ctx, silentstep2_mres_t step_width)
	Silent Step 2 sets the micro step resolution function.

err_t	silentstep2_set_dedge (silentstep2_t *ctx, uint8_t dedge_en)
	Silent Step 2 sets the step impulsen function.

err_t	silentstep2_set_intpol (silentstep2_t *ctx, uint8_t intpol_en)
	Silent Step 2 enable the actual microstep resolution function.

err_t	silentstep2_set_tbl_blank_time (silentstep2_t *ctx, silentstep2_tbl_t tbl)
	Silent Step 2 enable the blank time select function.

err_t	silentstep2_set_h_end_strt (silentstep2_t *ctx, uint8_t chm, uint8_t h_end_offset, uint8_t hstrt_tfd)
	Silent Step 2 sets the chopper mode config function.

err_t	silentstep2_set_toff (silentstep2_t *ctx, uint8_t off_time)
	Silent Step 2 sets the off time and driver enable function.

err_t	silentstep2_set_coolconf (silentstep2_t *ctx, silentstep2_coolconf_t coolconf)
	Silent Step 2 sets the coolStep smart current control function.

err_t	silentstep2_set_pwmconf (silentstep2_t *ctx, silentstep2_pwmconf_t pwmconf)
	Silent Step 2 sets the voltage PWM Mode stealthChop function.

err_t	silentstep2_get_drv_status (silentstep2_t ctx, silentstep2_drv_status_t drv_status)
	Silent Step 2 get driver status error flags function.

err_t	silentstep2_port_exp_write (silentstep2_t *ctx, uint8_t reg, uint8_t data_in)
	Silent Step 2 port expander data writing function.

err_t	silentstep2_port_exp_read (silentstep2_t ctx, uint8_t reg, uint8_t data_out)
	Silent Step 2 port expander data reading function.

err_t	silentstep2_set_pins (silentstep2_t *ctx, uint8_t set_mask, uint8_t clr_mask)
	Silent Step 2 sets the pin states function.

err_t	silentstep2_get_diag0 (silentstep2_t ctx, uint8_t diag0)
	Silent Step 2 get the diagnostics output DIAG0 function.

err_t	silentstep2_get_diag1 (silentstep2_t ctx, uint8_t diag1)
	Silent Step 2 get the diagnostics output DIAG1 function.

err_t	silentstep2_switch_off (silentstep2_t *ctx)
	Silent Step 2 sets the power OFF function.

err_t	silentstep2_input_enable (silentstep2_t *ctx)
	Silent Step 2 enable input function.

void	silentstep2_set_direction (silentstep2_t *ctx, uint8_t dir)
	Silent Step 2 sets the clockwise or counterclockwise direction movement function.

void	silentstep2_set_step (silentstep2_t *ctx, uint8_t step)
	Silent Step 2 set the step pin state function.

err_t	silentstep2_make_one_step (silentstep2_t *ctx, uint8_t step_speed)
	Silent Step 2 make the one step function.

err_t	silentstep2_rotate_by_angle (silentstep2_t *ctx, uint8_t step_speed, float angle, uint16_t res_360)
	Silent Step 2 rotates the shaft through a desired angle function.

uint8_t	silentstep2_get_interrupt (silentstep2_t *ctx)
	Silent Step 2 get the interrupt function.

Detailed Description

API for configuring and manipulating Silent Step 2 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ silentstep2_cfg_setup()

void silentstep2_cfg_setup ( silentstep2_cfg_t * cfg )

Silent Step 2 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See silentstep2_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ silentstep2_default_cfg()

err_t silentstep2_default_cfg ( silentstep2_t * ctx )

Silent Step 2 default configuration function.

This function executes a default configuration of Silent Step 2 click board.

Parameters

[in] ctx : Click context object. See silentstep2_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ silentstep2_get_diag0()

err_t silentstep2_get_diag0	(	silentstep2_t *	ctx,
		uint8_t *	diag0 )

Silent Step 2 get the diagnostics output DIAG0 function.

This function reads the diagnostics output DIAG0 pin state of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	diag0	: DIAG0 pin state.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_get_diag1()

err_t silentstep2_get_diag1	(	silentstep2_t *	ctx,
		uint8_t *	diag1 )

Silent Step 2 get the diagnostics output DIAG1 function.

This function reads the diagnostics output DIAG1 pin state of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	diag1	: DIAG1 pin state.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_get_drv_status()

err_t silentstep2_get_drv_status	(	silentstep2_t *	ctx,
		silentstep2_drv_status_t *	drv_status )

Silent Step 2 get driver status error flags function.

This function reads the stallguard2 value and driver status error flags of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[out]	drv_status	: Driver status error object. See silentstep2_drv_status_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_get_gstat()

err_t silentstep2_get_gstat	(	silentstep2_t *	ctx,
		uint32_t *	gstat )

Silent Step 2 get global status function.

This function reads the global status data value of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[out]	gstat	: Global status flags.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_get_interrupt()

uint8_t silentstep2_get_interrupt ( silentstep2_t * ctx )

Silent Step 2 get the interrupt function.

This function reads state of the interrupt (INT) pin of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in] ctx : Click context object. See silentstep2_t object definition for detailed explanation.

Returns

0 - Low pin state,
1 - High pin state. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_init()

err_t silentstep2_init	(	silentstep2_t *	ctx,
		silentstep2_cfg_t *	cfg )

Silent Step 2 initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters

[out]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See silentstep2_cfg_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_input_enable()

err_t silentstep2_input_enable ( silentstep2_t * ctx )

Silent Step 2 enable input function.

This function perform device power ON by enabling the inputs of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in] ctx : Click context object. See silentstep2_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_make_one_step()

err_t silentstep2_make_one_step	(	silentstep2_t *	ctx,
		uint8_t	step_speed )

Silent Step 2 make the one step function.

This function is used to make one step of the desired speed of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	step_speed	: Step speed percent.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_port_exp_read()

err_t silentstep2_port_exp_read	(	silentstep2_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out )

Silent Step 2 port expander data reading function.

This function reads a desired data byte from the selected register of the PCA9538A, Low-voltage 8-bit I2C-bus I/O port with interrupt and reset on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	reg	: Register address.
[out]	data_out	: Output read data.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_port_exp_write()

err_t silentstep2_port_exp_write	(	silentstep2_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

Silent Step 2 port expander data writing function.

This function writes a desired data byte to the selected register of the PCA9538A, Low-voltage 8-bit I2C-bus I/O port with interrupt and reset on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	reg	: Register address.
[in]	data_in	: Data to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_reg_read()

err_t silentstep2_reg_read	(	silentstep2_t *	ctx,
		uint8_t	reg,
		uint32_t *	data_in )

Silent Step 2 data reading function.

This function reads a desired data byte from the selected register of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	reg	: Register address.
[out]	data_out	: Output read data.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_reg_write()

err_t silentstep2_reg_write	(	silentstep2_t *	ctx,
		uint8_t	reg,
		uint32_t	data_in )

Silent Step 2 data writing function.

This function writes a desired data byte to the selected register of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	reg	: Register address.
[in]	data_in	: Data to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_rotate_by_angle()

err_t silentstep2_rotate_by_angle	(	silentstep2_t *	ctx,
		uint8_t	step_speed,
		float	angle,
		uint16_t	res_360 )

Silent Step 2 rotates the shaft through a desired angle function.

This function rotates the shaft through a desired step speed and angle of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	step_speed	: Step speed percent.
[in]	angle	: Angle of rotation.
[in]	res_360	: Resolution of steps per revolution.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_coolconf()

err_t silentstep2_set_coolconf	(	silentstep2_t *	ctx,
		silentstep2_coolconf_t	coolconf )

Silent Step 2 sets the coolStep smart current control function.

This function sets the coolStep smart current control and stallGuard2 configuration data of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	coolconf	: CoolStep smart current control object. See silentstep2_coolconf_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_dedge()

err_t silentstep2_set_dedge	(	silentstep2_t *	ctx,
		uint8_t	dedge_en )

Silent Step 2 sets the step impulsen function.

This function enable/disable step impulse at each step edge to reduce step frequency requirement of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	dedge_en	: Enable/disable step impulse.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_direction()

void silentstep2_set_direction	(	silentstep2_t *	ctx,
		uint8_t	dir )

Silent Step 2 sets the clockwise or counterclockwise direction movement function.

This function selects the direction of movement of the of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	dir	: Direction of movement.

Returns: Nothing.

Note: None.

◆ silentstep2_set_gconf()

err_t silentstep2_set_gconf	(	silentstep2_t *	ctx,
		silentstep2_gconf_t	gconf )

Silent Step 2 sets global configuration function.

This function sets global configuration of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	gconf	: Global configuration object. See silentstep2_gconf_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_h_end_strt()

err_t silentstep2_set_h_end_strt	(	silentstep2_t *	ctx,
		uint8_t	chm,
		uint8_t	h_end_offset,
		uint8_t	hstrt_tfd )

Silent Step 2 sets the chopper mode config function.

This function sets the chopper mode, hysteresis low value/sine wave offset and hysteresis start value/fast decay time setting of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	chm	: Chopper mode select.
[in]	h_end_offset	: Hysteresis low value/sine wave offset.
[in]	hstrt_tfd	: Hysteresis start value/fast decay time setting.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_ihold_irun()

err_t silentstep2_set_ihold_irun	(	silentstep2_t *	ctx,
		uint8_t	ihold,
		uint8_t	irun,
		uint8_t	ihold_delay )

Silent Step 2 sets driver current control function.

This function sets the desired value of the driver's current control of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	ihold	: Standstill current.
[in]	irun	: Motor run current.
[in]	ihold_delay	: Delay per current reduction step.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_intpol()

err_t silentstep2_set_intpol	(	silentstep2_t *	ctx,
		uint8_t	intpol_en )

Silent Step 2 enable the actual microstep resolution function.

This function enable the actual microstep resolution becomes extrapolated to 256 microsteps for smoothest motor operation of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	intpol_en	: Enable/disable interpolation to 256 microsteps.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_mslut()

err_t silentstep2_set_mslut	(	silentstep2_t *	ctx,
		uint8_t	mslut_sel,
		uint32_t	mslut )

Silent Step 2 sets the microstep table entries function.

This function sets the differential coding for the first quarter of a wave for switching on smart energy coolStep and stallGuard feature of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	mslut_num	: Microstep table selection.
[in]	mslut	: Microstep table entries.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_mslutsel()

err_t silentstep2_set_mslutsel	(	silentstep2_t *	ctx,
		uint32_t	lut_seg_str,
		uint32_t	lut_width_sel )

Silent Step 2 sets the microstep segments function.

This function sets the desired data values to define four segments within each quarter MSLUT wave of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	lut_seg_str	: LUT segment.
[in]	lut_width_sel	: LUT width select.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_mslutstart()

err_t silentstep2_set_mslutstart	(	silentstep2_t *	ctx,
		uint32_t	start_sin,
		uint32_t	start_sin90 )

Silent Step 2 sets the absolute current microstep table function.

This function sets the absolute current microstep table entry at 0 and at positions 256 of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	start_sin	: Current microstep table entry at 0 positions.
[in]	start_sin90	: Current microstep table entry at 256 positions.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_mstep_res()

err_t silentstep2_set_mstep_res	(	silentstep2_t *	ctx,
		silentstep2_mres_t	step_width )

Silent Step 2 sets the micro step resolution function.

This function sets the desired micro step resolution of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	step_width	: Step width, reduced microstep resolution. See silentstep2_mres_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_pins()

err_t silentstep2_set_pins	(	silentstep2_t *	ctx,
		uint8_t	set_mask,
		uint8_t	clr_mask )

Silent Step 2 sets the pin states function.

This function sets and clears the value of the selected pins of the PCA9538A, Low-voltage 8-bit I2C-bus I/O port with interrupt and reset on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	set_mask	: Pin set mask.
[in]	clr_mask	: Pin clear mask.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_pwmconf()

err_t silentstep2_set_pwmconf	(	silentstep2_t *	ctx,
		silentstep2_pwmconf_t	pwmconf )

Silent Step 2 sets the voltage PWM Mode stealthChop function.

This function sets the voltage PWM Mode stealthChop of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	coolconf	: Voltage PWM Mode stealthChop object. See silentstep2_pwmconf_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_step()

void silentstep2_set_step	(	silentstep2_t *	ctx,
		uint8_t	step )

Silent Step 2 set the step pin state function.

This function sets the step (STP) pin state of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	step	: Step (STP) pin state.

Returns: Nothing.

Note: None.

◆ silentstep2_set_tbl_blank_time()

err_t silentstep2_set_tbl_blank_time	(	silentstep2_t *	ctx,
		silentstep2_tbl_t	tbl )

Silent Step 2 enable the blank time select function.

This function enable the comparator blank time to 16, 24, 36 or 54 clocks to 256 microsteps for smoothest motor operation of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	intpol_en	: Blank time select. See silentstep2_tbl_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_tcoolthrs()

err_t silentstep2_set_tcoolthrs	(	silentstep2_t *	ctx,
		uint32_t	tcoolthrs )

Silent Step 2 sets lower threshold velocity for switching on smart energy function.

This function sets the lower threshold velocity for switching on smart energy coolStep and stallGuard feature of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	tcoolthrs	: Lower threshold velocity.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_thigh()

err_t silentstep2_set_thigh	(	silentstep2_t *	ctx,
		uint32_t	thigh )

Silent Step 2 sets the velocity setting function.

This velocity setting allows velocity-dependent switching into a different chopper mode and full stepping to maximize torque (unsigned). of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	thigh	: Velocity setting.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_set_toff()

err_t silentstep2_set_toff	(	silentstep2_t *	ctx,
		uint8_t	off_time )

Silent Step 2 sets the off time and driver enable function.

This function sets the off time setting controls duration of slow decay phase of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in]	ctx	: Click context object. See silentstep2_t object definition for detailed explanation.
[in]	off_time	: Off time and driver enable.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ silentstep2_switch_off()

err_t silentstep2_switch_off ( silentstep2_t * ctx )

Silent Step 2 sets the power OFF function.

This function sets the power stage switched OFF of the TMC2130, high performance driver IC for two phase stepper motors on the Silent Step 2 Click board™.

Parameters

[in] ctx : Click context object. See silentstep2_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ silentstep2_cfg_setup()

◆ silentstep2_default_cfg()

◆ silentstep2_get_diag0()

◆ silentstep2_get_diag1()

◆ silentstep2_get_drv_status()

◆ silentstep2_get_gstat()

◆ silentstep2_get_interrupt()

◆ silentstep2_init()

◆ silentstep2_input_enable()

◆ silentstep2_make_one_step()

◆ silentstep2_port_exp_read()

◆ silentstep2_port_exp_write()

◆ silentstep2_reg_read()

◆ silentstep2_reg_write()

◆ silentstep2_rotate_by_angle()

◆ silentstep2_set_coolconf()

◆ silentstep2_set_dedge()

◆ silentstep2_set_direction()

◆ silentstep2_set_gconf()

◆ silentstep2_set_h_end_strt()

◆ silentstep2_set_ihold_irun()

◆ silentstep2_set_intpol()

◆ silentstep2_set_mslut()

◆ silentstep2_set_mslutsel()

◆ silentstep2_set_mslutstart()

◆ silentstep2_set_mstep_res()

◆ silentstep2_set_pins()

◆ silentstep2_set_pwmconf()

◆ silentstep2_set_step()

◆ silentstep2_set_tbl_blank_time()

◆ silentstep2_set_tcoolthrs()

◆ silentstep2_set_thigh()

◆ silentstep2_set_toff()

◆ silentstep2_switch_off()