TMC5160 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Public Attributes | List of all members
tmc5160::Config Struct Reference

Everything EnsureInitialized() writes to the chip. See docs/configuration.md. More...

#include <tmc5160_types.hpp>

Public Attributes

Mode mode {Mode::MotionController}
 SD_MODE strap the board uses.
 
Clock clock {}
 The clock source.
 
Motor motor {}
 Declared motor; required.
 
Board board {}
 Declared power stage; required.
 
uint32_t max_velocity_reg {0}
 Declared VMAX ceiling; 0 = only the register limit.
 
bool include_tolerance
 Reduce the current ceiling by the 5 percent full-scale tolerance.
 
Current current {}
 Run and hold current.
 
Standstill standstill {}
 Standstill behaviour.
 
Chopper chopper {}
 Chopper.
 
StealthChop stealth {}
 StealthChop.
 
Thresholds thresholds {}
 Velocity thresholds.
 
CoolStep cool {}
 CoolStep.
 
StallGuard stall {}
 StallGuard2.
 
DcStep dcstep {}
 DcStep.
 
Bridge bridge {}
 Gate drivers.
 
Protection protection {}
 Short protection.
 
Flags flags {}
 General flags.
 
Diag diag {}
 DIAG outputs.
 
RampProfile ramp {}
 Ramp registers.
 
Switches switches {}
 Reference switches.
 
Encoder encoder {}
 Encoder.
 
bool custom_table {false}
 true: write table (needs MSCNT = 0).
 
MicrostepTable table {}
 The microstep table.
 
UartOptions uart {}
 UART options.
 
SpiOptions spi {}
 SPI options.
 
Verify verify {Verify::None}
 Verification the start-up uses on its writes.
 
AckSet ack {}
 Acknowledgements.
 
bool begin_enabled {false}
 true: EnsureInitialized() leaves the driver enabled.
 

Detailed Description

Everything EnsureInitialized() writes to the chip. See docs/configuration.md.

Member Data Documentation

◆ include_tolerance

bool tmc5160::Config::include_tolerance
Initial value:
{
true}

Reduce the current ceiling by the 5 percent full-scale tolerance.


The documentation for this struct was generated from the following file: