tmc9660::TMC9660< CommType >::RamDebug Struct Reference

Subsystem for debug and data logging features. More...

#include <tmc9660.hpp>

Collaboration diagram for tmc9660::TMC9660< CommType >::RamDebug:

Public Member Functions
bool	init (uint32_t sample_count) noexcept
	Initialize and configure the RAMDebug feature (data logging).
bool	startCapture () noexcept
	Start capturing data using RAMDebug.
bool	readData (uint32_t index, uint32_t &data) noexcept
	Read a captured sample from RAMDebug buffer.
bool	getStatus (bool &is_running) noexcept
	Get the current state of the RAM debug engine.

Private Member Functions
	RamDebug (TMC9660 &parent) noexcept

Private Attributes
TMC9660 &	driver

Friends
class	TMC9660

Detailed Description

template<typename CommType>
struct tmc9660::TMC9660< CommType >::RamDebug

Subsystem for debug and data logging features.

Constructor & Destructor Documentation

RamDebug()

template<typename CommType >

tmc9660::TMC9660< CommType >::RamDebug::RamDebug ( TMC9660 & parent )

inlineexplicitprivatenoexcept

Member Function Documentation

getStatus()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::RamDebug::getStatus ( bool & is_running )

noexcept

Get the current state of the RAM debug engine.

Parameters

[out]

is_running

Will be set to true if capture is ongoing, false if stopped or idle.

Returns

true if the status was retrieved successfully.

init()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::RamDebug::init ( uint32_t sample_count )

noexcept

Initialize and configure the RAMDebug feature (data logging).

This sends a command to initialize the RAM debug system and reset any previous configurations.

Parameters

sample_count

Number of samples to collect in the buffer.

Returns

true if the RAM debug was initialized properly.

readData()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::RamDebug::readData ( uint32_t index, uint32_t & data )

noexcept

Read a captured sample from RAMDebug buffer.

Parameters

	index	Sample index to read (0-based).
[out]	data	Variable to store the 32-bit sample data.

Returns

true if the data was read successfully.

startCapture()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::RamDebug::startCapture ( )

noexcept

Start capturing data using RAMDebug.

Returns

true if the capture started successfully.

Friends And Related Symbol Documentation

TMC9660

template<typename CommType >

friend class TMC9660

friend

Member Data Documentation

driver

template<typename CommType >

TMC9660& tmc9660::TMC9660< CommType >::RamDebug::driver

private

---

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

• tmc9660.hpp