Trinamic TMC26X Stepper Driver for Arduino: TMC26XStepper.h File Reference

Trinamic TMC26X Stepper Driver for Arduino

- Main Page
- Classes
- Files

- File List
- File Members

Classes | Defines
TMC26XStepper.h File Reference

Go to the source code of this file.

## Classes

class | TMC26XStepper
| Class representing a TMC26X stepper driver. More...

## Defines

#define | TMC26X_OVERTEMPERATURE_PREWARING 1
| return value for TMC26XStepper.getOverTemperature() if there is a overtemperature situation in the TMC chip
#define | TMC26X_OVERTEMPERATURE_SHUTDOWN 2
| return value for TMC26XStepper.getOverTemperature() if there is a overtemperature shutdown in the TMC chip
#define | TMC26X_READOUT_POSITION 0
#define | TMC26X_READOUT_STALLGUARD 1
#define | TMC26X_READOUT_CURRENT 3
#define | COOL_STEP_HALF_CS_LIMIT 0
#define | COOL_STEP_QUARTDER_CS_LIMIT 1

## Define Documentation

#define COOL_STEP_HALF_CS_LIMIT 0

Define to set the minimum current for CoolStep operation to 1/2 of the selected CS minium.

See also:
  setCoolStepConfiguration()

Definition at line 70 of file TMC26XStepper.h.

#define COOL_STEP_QUARTDER_CS_LIMIT 1

Define to set the minimum current for CoolStep operation to 1/4 of the selected CS minium.

See also:
  setCoolStepConfiguration()

Definition at line 75 of file TMC26XStepper.h.

#define TMC26X_OVERTEMPERATURE_PREWARING 1

return value for TMC26XStepper.getOverTemperature() if there is a overtemperature situation in the TMC chip

This warning indicates that the TCM chip is too warm. It is still working but some parameters may be inferior. You should do something against it.

Definition at line 39 of file TMC26XStepper.h.

#define TMC26X_OVERTEMPERATURE_SHUTDOWN 2

return value for TMC26XStepper.getOverTemperature() if there is a overtemperature shutdown in the TMC chip

This warning indicates that the TCM chip is too warm to operate and has shut down to prevent damage. It will stop working until it cools down again. If you encouter this situation you must do something against it. Like reducing the current or improving the PCB layout and/or heat management.

Definition at line 47 of file TMC26XStepper.h.

#define TMC26X_READOUT_CURRENT 3

Selects to read out the current current setting (acc. to CoolStep) and the upper bits of the StallGuard value from the motor.

See also:
  readStatus(), setCurrent()

Definition at line 64 of file TMC26XStepper.h.

#define TMC26X_READOUT_POSITION 0

Selects to readout the microstep position from the motor.

See also:
  readStatus()

Definition at line 54 of file TMC26XStepper.h.

#define TMC26X_READOUT_STALLGUARD 1

Selects to read out the StallGuard value of the motor.

See also:
  readStatus()

Definition at line 59 of file TMC26XStepper.h.