HF-TMC51x0 Driver (TMC5130 & TMC5160) 0.1.0-dev
Hardware Agnostic C++ Driver for the TMC51x0 (TMC5130 & TMC5160)
Loading...
Searching...
No Matches
tmc51x0::TMC51x0< CommType >::Printer Struct Reference

Register printer subsystem for debugging. More...

#include <tmc51x0.hpp>

Collaboration diagram for tmc51x0::TMC51x0< CommType >::Printer:
[legend]

Public Member Functions

 Printer (TMC51x0 &driver) noexcept
 Construct printer subsystem.
 
void PrintGconf () noexcept
 Print GCONF register.
 
void PrintGstat () noexcept
 Print GSTAT register (read and clear)
 
void PrintRampStat () noexcept
 Print RAMP_STAT register.
 
void PrintDrvStatus () noexcept
 Print DRV_STATUS register.
 
void PrintChopconf () noexcept
 Print CHOPCONF register.
 
void PrintPwmconf () noexcept
 Print PWMCONF register.
 
void PrintPwmScale () noexcept
 Print PWM_SCALE register.
 
void PrintSwMode () noexcept
 Print SW_MODE register.
 
void PrintIoin () noexcept
 Print IOIN register.
 
void PrintAll () noexcept
 Print all common registers.
 

Private Member Functions

void PrintRegisterField (const char *name, uint32_t value, const char *format="0x%08X") noexcept
 

Private Attributes

TMC51x0driver_
 

Detailed Description

template<typename CommType>
struct tmc51x0::TMC51x0< CommType >::Printer

Register printer subsystem for debugging.

Prints register values using the communication interface's LogDebug() method. All methods use TMC51X0_LOG_DEBUG() macro which respects TMC51X0_DISABLE_DEBUG_LOGGING.

Constructor & Destructor Documentation

◆ Printer()

template<typename CommType >
tmc51x0::TMC51x0< CommType >::Printer::Printer ( TMC51x0 & driver)
inlineexplicitnoexcept

Construct printer subsystem.

Parameters
driverReference to parent TMC51x0 driver instance

Member Function Documentation

◆ PrintAll()

template<typename CommType >
void tmc51x0::TMC51x0< CommType >::Printer::PrintAll ( )
noexcept

Print all common registers.

◆ PrintChopconf()

template<typename CommType >
void tmc51x0::TMC51x0< CommType >::Printer::PrintChopconf ( )
noexcept

Print CHOPCONF register.

◆ PrintDrvStatus()

template<typename CommType >
void tmc51x0::TMC51x0< CommType >::Printer::PrintDrvStatus ( )
noexcept

Print DRV_STATUS register.

◆ PrintGconf()

template<typename CommType >
void tmc51x0::TMC51x0< CommType >::Printer::PrintGconf ( )
noexcept

Print GCONF register.

◆ PrintGstat()

template<typename CommType >
void tmc51x0::TMC51x0< CommType >::Printer::PrintGstat ( )
noexcept

Print GSTAT register (read and clear)

◆ PrintIoin()

template<typename CommType >
void tmc51x0::TMC51x0< CommType >::Printer::PrintIoin ( )
noexcept

Print IOIN register.

◆ PrintPwmconf()

template<typename CommType >
void tmc51x0::TMC51x0< CommType >::Printer::PrintPwmconf ( )
noexcept

Print PWMCONF register.

◆ PrintPwmScale()

template<typename CommType >
void tmc51x0::TMC51x0< CommType >::Printer::PrintPwmScale ( )
noexcept

Print PWM_SCALE register.

◆ PrintRampStat()

template<typename CommType >
void tmc51x0::TMC51x0< CommType >::Printer::PrintRampStat ( )
noexcept

Print RAMP_STAT register.

◆ PrintRegisterField()

template<typename CommType >
void tmc51x0::TMC51x0< CommType >::Printer::PrintRegisterField ( const char * name,
uint32_t value,
const char * format = "0x%08X" )
privatenoexcept

◆ PrintSwMode()

template<typename CommType >
void tmc51x0::TMC51x0< CommType >::Printer::PrintSwMode ( )
noexcept

Print SW_MODE register.

Member Data Documentation

◆ driver_

template<typename CommType >
TMC51x0& tmc51x0::TMC51x0< CommType >::Printer::driver_
private

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