tmc51x0.hpp File Reference

Main TMC51x0 stepper motor driver interface and subsystem classes. More...

#include <cstdint>
#include <string>
#include "tmc51x0_comm_interface.hpp"
#include "registers/tmc51x0_registers.hpp"
#include "tmc51x0_result.hpp"
#include "tmc51x0_types.hpp"
#include "tmc51x0_version.h"
#include "../src/tmc51x0.ipp"

Include dependency graph for tmc51x0.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	tmc51x0::TMC51x0< CommType >
	Main class representing a TMC51x0 stepper motor driver (TMC5130 & TMC5160) More...
struct	tmc51x0::TMC51x0< CommType >::HardResetOptions
	Options for HardReset() More...
struct	tmc51x0::TMC51x0< CommType >::MotorCurrentDebugInfo
	Snapshot of motor-current related calculated/cached values. More...
struct	tmc51x0::TMC51x0< CommType >::RampControl
	Ramp control subsystem. More...
struct	tmc51x0::TMC51x0< CommType >::Switches
	Reference switches / endstops subsystem (SW_MODE / XLATCH) More...
struct	tmc51x0::TMC51x0< CommType >::Events
	Motion events / status outputs (X_COMPARE, RAMP_STAT clear) More...
struct	tmc51x0::TMC51x0< CommType >::MotorControl
	Motor control subsystem. More...
struct	tmc51x0::TMC51x0< CommType >::Thresholds
	Velocity thresholds / mode thresholds (TPWMTHRS, TCOOLTHRS, THIGH) More...
struct	tmc51x0::TMC51x0< CommType >::PowerStage
	Power stage + protection subsystem (DRV_CONF, SHORT_CONF) More...
struct	tmc51x0::TMC51x0< CommType >::Communication
	Communication subsystem. More...
struct	tmc51x0::TMC51x0< CommType >::Io
	Chip IO / mode pins / IOIN helpers. More...
struct	tmc51x0::TMC51x0< CommType >::Encoder
	Encoder subsystem. More...
struct	tmc51x0::TMC51x0< CommType >::Status
	Status / monitoring subsystem (read-only) More...
struct	tmc51x0::TMC51x0< CommType >::StallGuard
	StallGuard2 subsystem (COOLCONF/DRV_STATUS + SW_MODE interactions) More...
struct	tmc51x0::TMC51x0< CommType >::Tuning
	Tuning subsystem for automatic parameter optimization. More...
struct	tmc51x0::TMC51x0< CommType >::Homing
	Homing subsystem with automatic settings caching. More...
struct	tmc51x0::TMC51x0< CommType >::Homing::BoundsResult
struct	tmc51x0::TMC51x0< CommType >::Homing::HomeConfig
struct	tmc51x0::TMC51x0< CommType >::Homing::BoundsOptions
struct	tmc51x0::TMC51x0< CommType >::Printer
	Register printer subsystem for debugging. More...
struct	tmc51x0::TMC51x0< CommType >::UartConfig
	UART configuration subsystem. More...
struct	tmc51x0::TMC51x0< CommType >::WriteOnlyRegisters

Namespaces
namespace	tmc51x0

Macros
#define	TMC51X0_HEADER_INCLUDED

Functions
const char *	tmc51x0::GetDriverVersion () noexcept

Detailed Description

Main TMC51x0 stepper motor driver interface and subsystem classes.

Copyright

Copyright (c) 2024-2025 HardFOC. All rights reserved.

Macro Definition Documentation

TMC51X0_HEADER_INCLUDED

#define TMC51X0_HEADER_INCLUDED