Class representing a TMC26X stepper driver. More...

#include <TMC2660.h>

Public Member Functions
	TMC26XStepper (const int16_t in_steps, int16_t cs_pin, int16_t dir_pin, int16_t step_pin, uint16_t current, uint16_t resistor=100)
	Create a new representation of a stepper motor connected to a TMC26X stepper driver. More...

void	start ()
	Configure and start the TMC26X stepper driver. Before this is called the stepper driver is nonfunctional. More...

void	un_start ()
	Reset the stepper in unconfigured mode. More...

void	setSpeed (uint16_t whatSpeed)
	Set the rotation speed in RPM. More...

uint16_t	getSpeed ()
	Report the currently selected speed in RPM. More...

void	setMicrosteps (const int16_t in_steps)
	Set the number of microsteps in 2^i values (rounded) up to 256. More...

int16_t	getMicrosteps ()
	Return the effective current number of microsteps selected. More...

char	step (int16_t number_of_steps)
	Initiate a movement with the given number of steps. Positive values move in one direction, negative in the other. More...

char	move ()
	Central movement method. Must be called as often as possible in the loop function and is very fast. More...

char	isMoving ()
	Check whether the last movement command is done. More...

uint16_t	getStepsLeft ()
	Get the number of steps left in the current movement. More...

char	stop ()
	Stop the motor immediately. More...

void	setConstantOffTimeChopper (char constant_off_time, char blank_time, char fast_decay_time_setting, char sine_wave_offset, uint8_t use_current_comparator)
	Set and configure the classical Constant Off Timer Chopper. More...

void	setSpreadCycleChopper (char constant_off_time, char blank_time, char hysteresis_start, char hysteresis_end, char hysteresis_decrement)
	Sets and configures with spread cycle chopper. More...

void	setRandomOffTime (char value)
	Use random off time for noise reduction (0 for off, -1 for on). More...

void	setCurrent (uint16_t current)
	set the maximum motor current in mA (1000 is 1 Amp) Keep in mind this is the maximum peak Current. The RMS current will be 1/sqrt(2) smaller. The actual current can also be smaller by employing CoolStep. More...

uint16_t	getCurrent ()
	readout the motor maximum current in mA (1000 is an Amp) This is the maximum current. to get the current current - which may be affected by CoolStep us getCurrentCurrent() More...

void	setStallGuardThreshold (char stallguard_threshold, char stallguard_filter_enabled)
	set the StallGuard threshold in order to get sensible StallGuard readings. More...

char	getStallGuardThreshold ()
	reads out the StallGuard threshold More...

char	getStallGuardFilter ()
	returns the current setting of the StallGuard filter More...

void	setCoolStepConfiguration (uint16_t lower_SG_threshold, uint16_t SG_hysteresis, uint8_t current_decrement_step_size, uint8_t current_increment_step_size, uint8_t lower_current_limit)
	This method configures the CoolStep smart energy operation. You must have a proper StallGuard configuration for the motor situation (current, voltage, speed) in rder to use this feature. More...

void	setCoolStepEnabled (boolean enabled)
	enables or disables the CoolStep smart energy operation feature. It must be configured before enabling it. More...

boolean	isCoolStepEnabled ()
	check if the CoolStep feature is enabled More...

uint16_t	getCoolStepLowerSgThreshold ()
	returns the lower StallGuard threshold for the CoolStep operation More...

uint16_t	getCoolStepUpperSgThreshold ()
	returns the upper StallGuard threshold for the CoolStep operation More...

uint8_t	getCoolStepNumberOfSGReadings ()
	returns the number of StallGuard readings befor CoolStep adjusts the motor current. More...

uint8_t	getCoolStepCurrentIncrementSize ()
	returns the increment steps for the current for the CoolStep operation More...

uint8_t	getCoolStepLowerCurrentLimit ()
	returns the absolut minium current for the CoolStep operation More...

int16_t	getMotorPosition ()
	Get the current microstep position for phase A. More...

int16_t	getCurrentStallGuardReading ()
	Reads the current StallGuard value. More...

uint8_t	getCurrentCSReading ()
	Reads the current current setting value as fraction of the maximum current Returns values between 0 and 31, representing 1/32 to 32/32 (=1) More...

boolean	isCurrentScalingHalfed ()
	a convenience method to determine if the current scaling uses 0.31V or 0.165V as reference. More...

uint16_t	getCurrentCurrent ()
	Reads the current current setting value and recalculates the absolute current in mA (1A would be 1000). This method calculates the currently used current setting (either by setting or by CoolStep) and reconstructs the current in mA by usinge the VSENSE and resistor value. This method uses floating point math - so it may not be the fastest. More...

boolean	isStallGuardOverThreshold ()
	checks if there is a StallGuard warning in the last status More...

char	getOverTemperature ()
	Return over temperature status of the last status readout return 0 is everything is OK, TMC26X_OVERTEMPERATURE_PREWARING if status is reached, TMC26X_OVERTEMPERATURE_SHUTDOWN is the chip is shutdown, -1 if the status is unknown. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout. More...

boolean	isShortToGroundA ()
	Is motor channel A shorted to ground detected in the last status readout. More...

boolean	isShortToGroundB ()
	Is motor channel B shorted to ground detected in the last status readout. More...

boolean	isOpenLoadA ()
	iIs motor channel A connected according to the last statu readout. More...

boolean	isOpenLoadB ()
	iIs motor channel A connected according to the last statu readout. More...

boolean	isStandStill ()
	Is chopper inactive since 2^20 clock cycles - defaults to ~0,08s. More...

boolean	isStallGuardReached ()
	checks if there is a StallGuard warning in the last status More...

void	setEnabled (boolean enabled)
	enables or disables the motor driver bridges. If disabled the motor can run freely. If enabled not. More...

boolean	isEnabled ()
	checks if the output bridges are enabled. If the bridges are not enabled the motor can run freely More...

void	readStatus (char read_value)
	Manually read out the status register This function sends a byte to the motor driver in order to get the current readout. The parameter read_value seletcs which value will get returned. If the read_vlaue changes in respect to the previous readout this method automatically send two bytes to the motor: one to set the redout and one to get the actual readout. So this method may take time to send and read one or two bits - depending on the previous readout. More...

int16_t	getResistor ()
	Returns the current sense resistor value in milliohm. The default value of ,15 Ohm will return 150. More...

void	debugLastStatus ()
	Prints out all the information that can be found in the last status read out - it does not force a status readout. The result is printed via Serial. More...

int16_t	version ()
	library version More...

Detailed Description

Class representing a TMC26X stepper driver.

To use one of these drivers in your code create an object of its class:

TMC26XStepper tmc_stepper = TMC26XStepper(200,1,2,3,500);

see TMC26XStepper(int16_t number_of_steps, int16_t cs_pin, int16_t dir_pin, int16_t step_pin, uint16_t rms_current)

Keep in mind that you need to start the driver with start() in order to configure the TMC26X.

The most important function is move(). It checks if the motor requires a step. It's important to call move() as often as possible in loop(). I suggest using a very fast loop routine and always call move() at the beginning or end.

To move you must set a movement speed with setSpeed(). The speed is a positive value, setting the RPM.

To really move the motor you have to call step() to tell the driver to move the motor the given number of steps in the given direction. Positive values move the motor in one direction, negative values in the other.

You can check with isMoving() if the motor is still moving or stop it abruptly with stop().

Constructor & Destructor Documentation

◆ TMC26XStepper()

TMC26XStepper::TMC26XStepper	(	const int16_t	in_steps,
		int16_t	cs_pin,
		int16_t	dir_pin,
		int16_t	step_pin,
		uint16_t	current,
		uint16_t	resistor = `100`
	)

Create a new representation of a stepper motor connected to a TMC26X stepper driver.

Main constructor. If in doubt use this. All parameters must be provided as described below.

Parameters

number_of_steps	Number of steps the motor has per rotation.
cs_pin	Arduino pin connected to the Client Select Pin (!CS) of the TMC26X for SPI.
dir_pin	Arduino pin connected to the DIR input of the TMC26X.
step_pin	Arduino pin connected to the STEP pin of the TMC26X.
rms_current	Maximum current to provide to the motor in mA (!). A value of 200 will send up to 200mA to the motor.
resistor	Current sense resistor in milli-Ohm, defaults to 0.15 Ohm (or 150 milli-Ohm) as in the TMC260 Arduino Shield.

You must also call TMC26XStepper.start() to configure the stepper driver for use.

By default the Constant Off Time chopper is used. See TMC26XStepper.setConstantOffTimeChopper() for details. This should work on most motors (YMMV). You may want to configure and use the Spread Cycle Chopper. See setSpreadCycleChopper().

By default a microstepping of 1/32 is used to provide a smooth motor run while still giving a good progression per step. Change stepping by sending setMicrosteps() a different value.

See also: start(), setMicrosteps()

Member Function Documentation

◆ start()

void TMC26XStepper::start ( )

Configure and start the TMC26X stepper driver. Before this is called the stepper driver is nonfunctional.

Configure the TMC26X stepper driver for the given values via SPI. Most member functions are non-functional if the driver has not been started, therefore it is best to call this in setup().

◆ un_start()

void TMC26XStepper::un_start ( )

Reset the stepper in unconfigured mode.

Allows start to be called again. It doesn't change the internal stepper configuration or the desired configuration. It just marks the stepper as not-yet-started. The stepper doesn't need to be reconfigured before starting again, and is not reset to any factory settings. It must be reset intentionally. (Hint: Normally you do not need this function)

◆ setSpeed()

void TMC26XStepper::setSpeed ( uint16_t whatSpeed )

Set the rotation speed in RPM.

Parameters

whatSpeed the desired speed in RPM.

◆ getSpeed()

uint16_t TMC26XStepper::getSpeed ( )

Report the currently selected speed in RPM.

See also: setSpeed()

◆ setMicrosteps()

void TMC26XStepper::setMicrosteps ( const int16_t in_steps )

Set the number of microsteps in 2^i values (rounded) up to 256.

This method sets the number of microsteps per step in 2^i interval. It accepts 1, 2, 4, 16, 32, 64, 128 or 256 as valid microsteps. Other values will be rounded down to the next smaller value (e.g., 3 gives a microstepping of 2). You can always check the current microstepping with getMicrosteps().

◆ getMicrosteps()

int16_t TMC26XStepper::getMicrosteps ( )

Return the effective current number of microsteps selected.

Always returns the effective number of microsteps. This may be different from the micro-steps set in setMicrosteps() since it is rounded to 2^i.

See also: setMicrosteps()

◆ step()

char TMC26XStepper::step ( int16_t number_of_steps )

Initiate a movement with the given number of steps. Positive values move in one direction, negative in the other.

Parameters

number_of_steps The number of steps to move the motor.

Returns: 0 if the motor was not moving and moves now. -1 if the motor is moving and the new steps could not be set.

If the previous movement is incomplete the function returns -1 and doesn't change the steps to move the motor. If the motor does not move it returns 0.

The movement direction is determined by the sign of the steps parameter. The motor direction in machine space cannot be determined, as it depends on the construction of the motor and how it functions in the drive system.

For safety, verify with isMoving() or even use stop() to stop the motor before giving it new step directions.

See also: isMoving(), getStepsLeft(), stop()

◆ move()

char TMC26XStepper::move ( )

Central movement method. Must be called as often as possible in the loop function and is very fast.

Check if the motor still has to move and whether the wait-to-step interval has expired, and manages the number of steps remaining to fulfill the current move command.

This function is implemented to be as fast as possible, so call it as often as possible in your loop. It should be invoked with as frequently and with as much regularity as possible.

This can be called even when the motor is known not to be moving. It will simply return.

The frequency with which this function is called determines the top stepping speed of the motor. It is recommended to call this using a hardware timer to ensure regular invocation.

See also: step()

◆ isMoving()

char TMC26XStepper::isMoving ( )

Check whether the last movement command is done.

Returns: 0 if the motor stops, -1 if the motor is moving.

Used to determine if the motor is ready for new movements.

See also: step(), move()

◆ getStepsLeft()

uint16_t TMC26XStepper::getStepsLeft ( )

Get the number of steps left in the current movement.

Returns: The number of steps left in the movement. Always positive.

◆ stop()

char TMC26XStepper::stop ( )

Stop the motor immediately.

Returns: -1 if the motor was moving and is really stoped or 0 if it was not moving at all.

This method directly and abruptly stops the motor and may be used as an emergency stop.

◆ setConstantOffTimeChopper()

void TMC26XStepper::setConstantOffTimeChopper	(	char	constant_off_time,
		char	blank_time,
		char	fast_decay_time_setting,
		char	sine_wave_offset,
		uint8_t	use_current_comparator
	)

Set and configure the classical Constant Off Timer Chopper.

Parameters

constant_off_time	The off time setting controls the minimum chopper frequency. For most applications an off time within the range of 5μs to 20μs will fit. Setting this parameter to zero completely disables all driver transistors and the motor can free-wheel. 0: chopper off, 1:15: off time setting (1 will work with minimum blank time of 24 clocks)
blank_time	Comparator blank time. This duration needs to safely cover the duration of the switching event and the ringing on the sense resistor. For most low current drivers, a setting of 1 or 2 is good. For high current applications with large MOSFETs, a setting of 2 or 3 will be required. 0 (min setting) … (3) amx setting
fast_decay_time_setting	Fast decay time setting. Controls the portion of fast decay for each chopper cycle. 0: slow decay only, 1…15: duration of fast decay phase
sine_wave_offset	Sine wave offset. Controls the sine wave offset. A positive offset corrects for zero crossing error. -3…-1: negative offset, 0: no offset,1…12: positive offset
use_curreent_comparator	Selects usage of the current comparator for termination of the fast decay cycle. If current comparator is enabled, it terminates the fast decay cycle in case the current reaches a higher negative value than the actual positive value. (0 disable, -1 enable).

The classic constant off time chopper uses a fixed portion of fast decay following each on phase. While the duration of the on time is determined by the chopper comparator, the fast decay time needs to be set by the user in a way, that the current decay is enough for the driver to be able to follow the falling slope of the sine wave, and on the other hand it should not be too long, in order to minimize motor current ripple and power dissipation. This best can be tuned using an oscilloscope or trying out motor smoothness at different velocities. A good starting value is a fast decay time setting similar to the slow decay time setting. After tuning of the fast decay time, the offset should be determined, in order to have a smooth zero transition. This is necessary, because the fast decay phase leads to the absolute value of the motor current being lower than the target current (see figure 17). If the zero offset is too low, the motor stands still for a short moment during current zero crossing, if it is set too high, it makes a larger microstep. Typically, a positive offset setting is required for optimum operation.

See also: setSpreadCycleChoper() for other alternatives.; setRandomOffTime() for spreading the noise over a wider spectrum

◆ setSpreadCycleChopper()

void TMC26XStepper::setSpreadCycleChopper	(	char	constant_off_time,
		char	blank_time,
		char	hysteresis_start,
		char	hysteresis_end,
		char	hysteresis_decrement
	)

Sets and configures with spread cycle chopper.

Parameters

constant_off_time	The off time setting controls the minimum chopper frequency. For most applications an off time within the range of 5μs to 20μs will fit. Setting this parameter to zero completely disables all driver transistors and the motor can free-wheel. 0: chopper off, 1:15: off time setting (1 will work with minimum blank time of 24 clocks)
blank_time	Selects the comparator blank time. This time needs to safely cover the switching event and the duration of the ringing on the sense resistor. For most low current drivers, a setting of 1 or 2 is good. For high current applications with large MOSFETs, a setting of 2 or 3 will be required. 0 (min setting) … (3) amx setting
hysteresis_start	Hysteresis start setting. Please remark, that this value is an offset to the hysteresis end value. 1 … 8
hysteresis_end	Hysteresis end setting. Sets the hysteresis end value after a number of decrements. Decrement interval time is controlled by hysteresis_decrement. The sum hysteresis_start + hysteresis_end must be <16. At a current setting CS of max. 30 (amplitude reduced to 240), the sum is not limited.
hysteresis_decrement	Hysteresis decrement setting. This setting determines the slope of the hysteresis during on time and during fast decay time. 0 (fast decrement) … 3 (slow decrement).

The spreadCycle chopper scheme (pat.fil.) is a precise and simple to use chopper principle, which automatically determines the optimum fast decay portion for the motor. Anyhow, a number of settings can be made in order to optimally fit the driver to the motor. Each chopper cycle is comprised of an on-phase, a slow decay phase, a fast decay phase and a second slow decay phase. The slow decay phases limit the maximum chopper frequency and are important for low motor and driver power dissipation. The hysteresis start setting limits the chopper frequency by forcing the driver to introduce a minimum amount of current ripple into the motor coils. The motor inductivity determines the ability to follow a changing motor current. The duration of the on- and fast decay phase needs to cover at least the blank time, because the current comparator is disabled during this time.

See also: setRandomOffTime() for spreading the noise over a wider spectrum

◆ setRandomOffTime()

void TMC26XStepper::setRandomOffTime ( char value )

Use random off time for noise reduction (0 for off, -1 for on).

Parameters

value 0 for off, -1 for on

In a constant off time chopper scheme both coil choppers run freely, i.e. are not synchronized. The frequency of each chopper mainly depends on the coil current and the position dependant motor coil inductivity, thus it depends on the microstep position. With some motors a slightly audible beat can occur between the chopper frequencies, especially when they are near to each other. This typically occurs at a few microstep positions within each quarter wave. This effect normally is not audible when compared to mechanical noise generated by ball bearings, etc. Further factors which can cause a similar effect are a poor layout of sense resistor GND connection. In order to minimize the effect of a beat between both chopper frequencies, an internal random generator is provided. It modulates the slow decay time setting when switched on. The random off time feature further spreads the chopper spectrum, reducing electromagnetic emission on single frequencies.

◆ setCurrent()

void TMC26XStepper::setCurrent ( uint16_t current )

set the maximum motor current in mA (1000 is 1 Amp) Keep in mind this is the maximum peak Current. The RMS current will be 1/sqrt(2) smaller. The actual current can also be smaller by employing CoolStep.

Parameters

current the maximum motor current in mA

See also: getCurrent(), getCurrentCurrent()

◆ getCurrent()

uint16_t TMC26XStepper::getCurrent ( )

readout the motor maximum current in mA (1000 is an Amp) This is the maximum current. to get the current current - which may be affected by CoolStep us getCurrentCurrent()

Returns: the maximum motor current in milli amps

See also: getCurrentCurrent()

◆ setStallGuardThreshold()

void TMC26XStepper::setStallGuardThreshold	(	char	stallguard_threshold,
		char	stallguard_filter_enabled
	)

set the StallGuard threshold in order to get sensible StallGuard readings.

Parameters

stallguard_threshold	-64 … 63 the StallGuard threshold
stallguard_filter_enabled	0 if the filter is disabled, -1 if it is enabled

The StallGuard threshold is used to optimize the StallGuard reading to sensible values. It should be at 0 at the maximum allowable load on the otor (but not before). = is a good starting point (and the default) If you get Stall Gaurd readings of 0 without any load or with too little laod increase the value. If you get readings of 1023 even with load decrease the setting.

If you switch on the filter the StallGuard reading is only updated each 4th full step to reduce the noise in the reading.

See also: getCurrentStallGuardReading() to read out the current value.

◆ getStallGuardThreshold()

char TMC26XStepper::getStallGuardThreshold ( )

reads out the StallGuard threshold

Returns: a number between -64 and 63.

◆ getStallGuardFilter()

char TMC26XStepper::getStallGuardFilter ( )

returns the current setting of the StallGuard filter

Returns: 0 if not set, -1 if set

◆ setCoolStepConfiguration()

void TMC26XStepper::setCoolStepConfiguration	(	uint16_t	lower_SG_threshold,
		uint16_t	SG_hysteresis,
		uint8_t	current_decrement_step_size,
		uint8_t	current_increment_step_size,
		uint8_t	lower_current_limit
	)

This method configures the CoolStep smart energy operation. You must have a proper StallGuard configuration for the motor situation (current, voltage, speed) in rder to use this feature.

Parameters

lower_SG_threshold	Sets the lower threshold for stallGuard2TM reading. Below this value, the motor current becomes increased. Allowed values are 0...480
SG_hysteresis	Sets the distance between the lower and the upper threshold for stallGuard2TM reading. Above the upper threshold (which is lower_SG_threshold+SG_hysteresis+1) the motor current becomes decreased. Allowed values are 0...480
current_decrement_step_size	Sets the current decrement steps. If the StallGuard value is above the threshold the current gets decremented by this step size. 0...32
current_increment_step_size	Sets the current increment step. The current becomes incremented for each measured stallGuard2TM value below the lower threshold. 0...8
lower_current_limit	Sets the lower motor current limit for coolStepTM operation by scaling the CS value. Values can be COOL_STEP_HALF_CS_LIMIT, COOL_STEP_QUARTER_CS_LIMIT The CoolStep smart energy operation automatically adjust the current sent into the motor according to the current load, read out by the StallGuard in order to provide the optimum torque with the minimal current consumption. You configure the CoolStep current regulator by defining upper and lower bounds of StallGuard readouts. If the readout is above the limit the current gets increased, below the limit the current gets decreased. You can specify the upper an lower threshold of the StallGuard readout in order to adjust the current. You can also set the number of StallGuard readings neccessary above or below the limit to get a more stable current adjustement. The current adjustement itself is configured by the number of steps the current gests in- or decreased and the absolut minimum current (1/2 or 1/4th otf the configured current).

See also: COOL_STEP_HALF_CS_LIMIT, COOL_STEP_QUARTER_CS_LIMIT

◆ setCoolStepEnabled()

void TMC26XStepper::setCoolStepEnabled ( boolean enabled )

enables or disables the CoolStep smart energy operation feature. It must be configured before enabling it.

Parameters

enabled true if CoolStep should be enabled, false if not.

See also: setCoolStepConfiguration()

◆ isCoolStepEnabled()

boolean TMC26XStepper::isCoolStepEnabled ( )

check if the CoolStep feature is enabled

See also: setCoolStepEnabled()

◆ getCoolStepLowerSgThreshold()

uint16_t TMC26XStepper::getCoolStepLowerSgThreshold ( )

returns the lower StallGuard threshold for the CoolStep operation

See also: setCoolStepConfiguration()

◆ getCoolStepUpperSgThreshold()

uint16_t TMC26XStepper::getCoolStepUpperSgThreshold ( )

returns the upper StallGuard threshold for the CoolStep operation

See also: setCoolStepConfiguration()

◆ getCoolStepNumberOfSGReadings()

uint8_t TMC26XStepper::getCoolStepNumberOfSGReadings ( )

returns the number of StallGuard readings befor CoolStep adjusts the motor current.

See also: setCoolStepConfiguration()

◆ getCoolStepCurrentIncrementSize()

uint8_t TMC26XStepper::getCoolStepCurrentIncrementSize ( )

returns the increment steps for the current for the CoolStep operation

See also: setCoolStepConfiguration()

◆ getCoolStepLowerCurrentLimit()

uint8_t TMC26XStepper::getCoolStepLowerCurrentLimit ( )

returns the absolut minium current for the CoolStep operation

See also: setCoolStepConfiguration(); COOL_STEP_HALF_CS_LIMIT, COOL_STEP_QUARTER_CS_LIMIT

◆ getMotorPosition()

int16_t TMC26XStepper::getMotorPosition ( )

Get the current microstep position for phase A.

Returns: The current microstep position for phase A 0…255

Keep in mind that this routine reads and writes a value via SPI - so this may take a bit time.

◆ getCurrentStallGuardReading()

int16_t TMC26XStepper::getCurrentStallGuardReading ( )

Reads the current StallGuard value.

Returns: The current StallGuard value, lesser values indicate higher load, 0 means stall detected. Keep in mind that this routine reads and writes a value via SPI - so this may take a bit time.

See also: setStallGuardThreshold() for tuning the readout to sensible ranges.

◆ getCurrentCSReading()

uint8_t TMC26XStepper::getCurrentCSReading ( )

Reads the current current setting value as fraction of the maximum current Returns values between 0 and 31, representing 1/32 to 32/32 (=1)

See also: setCoolStepConfiguration()

◆ isCurrentScalingHalfed()

boolean TMC26XStepper::isCurrentScalingHalfed ( )

a convenience method to determine if the current scaling uses 0.31V or 0.165V as reference.

Returns: false if 0.13V is the reference voltage, true if 0.165V is used.

◆ getCurrentCurrent()

uint16_t TMC26XStepper::getCurrentCurrent ( )

Reads the current current setting value and recalculates the absolute current in mA (1A would be 1000). This method calculates the currently used current setting (either by setting or by CoolStep) and reconstructs the current in mA by usinge the VSENSE and resistor value. This method uses floating point math - so it may not be the fastest.

See also: getCurrentCSReading(), getResistor(), isCurrentScalingHalfed(), getCurrent()

◆ isStallGuardOverThreshold()

boolean TMC26XStepper::isStallGuardOverThreshold ( )

checks if there is a StallGuard warning in the last status

Returns: 0 if there was no warning, -1 if there was some warning. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.

See also: setStallGuardThreshold() for tuning the readout to sensible ranges.

◆ getOverTemperature()

char TMC26XStepper::getOverTemperature ( )

Return over temperature status of the last status readout return 0 is everything is OK, TMC26X_OVERTEMPERATURE_PREWARING if status is reached, TMC26X_OVERTEMPERATURE_SHUTDOWN is the chip is shutdown, -1 if the status is unknown. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.

◆ isShortToGroundA()

boolean TMC26XStepper::isShortToGroundA ( )

Is motor channel A shorted to ground detected in the last status readout.

Returns: true is yes, false if not. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.

◆ isShortToGroundB()

boolean TMC26XStepper::isShortToGroundB ( )

Is motor channel B shorted to ground detected in the last status readout.

Returns: true is yes, false if not. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.

◆ isOpenLoadA()

boolean TMC26XStepper::isOpenLoadA ( )

iIs motor channel A connected according to the last statu readout.

Returns: true is yes, false if not. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.

◆ isOpenLoadB()

boolean TMC26XStepper::isOpenLoadB ( )

iIs motor channel A connected according to the last statu readout.

Returns: true is yes, false if not. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.

◆ isStandStill()

boolean TMC26XStepper::isStandStill ( )

Is chopper inactive since 2^20 clock cycles - defaults to ~0,08s.

Returns: true is yes, false if not. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.

◆ isStallGuardReached()

boolean TMC26XStepper::isStallGuardReached ( )

checks if there is a StallGuard warning in the last status

Returns: 0 if there was no warning, -1 if there was some warning. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.

See also: isStallGuardOverThreshold() TODO why?; setStallGuardThreshold() for tuning the readout to sensible ranges.

◆ setEnabled()

void TMC26XStepper::setEnabled ( boolean enabled )

enables or disables the motor driver bridges. If disabled the motor can run freely. If enabled not.

Parameters

enabled a boolean value true if the motor should be enabled, false otherwise.

◆ isEnabled()

boolean TMC26XStepper::isEnabled ( )

checks if the output bridges are enabled. If the bridges are not enabled the motor can run freely

Returns: true if the bridges and by that the motor driver are enabled, false if not.

See also: setEnabled()

◆ readStatus()

void TMC26XStepper::readStatus ( char read_value )

Manually read out the status register This function sends a byte to the motor driver in order to get the current readout. The parameter read_value seletcs which value will get returned. If the read_vlaue changes in respect to the previous readout this method automatically send two bytes to the motor: one to set the redout and one to get the actual readout. So this method may take time to send and read one or two bits - depending on the previous readout.

Parameters

read_value selects which value to read out (0..3). You can use the defines TMC26X_READOUT_POSITION, TMC_262_READOUT_STALLGUARD, or TMC_262_READOUT_CURRENT

See also: TMC26X_READOUT_POSITION, TMC_262_READOUT_STALLGUARD, TMC_262_READOUT_CURRENT

◆ getResistor()

int16_t TMC26XStepper::getResistor ( )

Returns the current sense resistor value in milliohm. The default value of ,15 Ohm will return 150.

◆ debugLastStatus()

void TMC26XStepper::debugLastStatus ( )

Prints out all the information that can be found in the last status read out - it does not force a status readout. The result is printed via Serial.

◆ version()

int16_t TMC26XStepper::version ( )

library version

Returns: the version number as int.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TMC26XStepper()

Member Function Documentation

◆ start()

◆ un_start()

◆ setSpeed()

◆ getSpeed()

◆ setMicrosteps()

◆ getMicrosteps()

◆ step()

◆ move()

◆ isMoving()

◆ getStepsLeft()

◆ stop()

◆ setConstantOffTimeChopper()

◆ setSpreadCycleChopper()

◆ setRandomOffTime()

◆ setCurrent()

◆ getCurrent()

◆ setStallGuardThreshold()

◆ getStallGuardThreshold()

◆ getStallGuardFilter()

◆ setCoolStepConfiguration()

◆ setCoolStepEnabled()

◆ isCoolStepEnabled()

◆ getCoolStepLowerSgThreshold()

◆ getCoolStepUpperSgThreshold()

◆ getCoolStepNumberOfSGReadings()

◆ getCoolStepCurrentIncrementSize()

◆ getCoolStepLowerCurrentLimit()

◆ getMotorPosition()

◆ getCurrentStallGuardReading()

◆ getCurrentCSReading()

◆ isCurrentScalingHalfed()

◆ getCurrentCurrent()

◆ isStallGuardOverThreshold()

◆ getOverTemperature()

◆ isShortToGroundA()

◆ isShortToGroundB()

◆ isOpenLoadA()

◆ isOpenLoadB()

◆ isStandStill()

◆ isStallGuardReached()

◆ setEnabled()

◆ isEnabled()

◆ readStatus()

◆ getResistor()

◆ debugLastStatus()

◆ version()