TMC9660::RamDebug Struct Reference

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

#include <TMC9660.hpp>

Collaboration diagram for TMC9660::RamDebug:

Public Member Functions
bool	init (uint32_t sampleCount) 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 &isRunning) 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

Subsystem for debug and data logging features.

Constructor & Destructor Documentation

RamDebug()

TMC9660::RamDebug::RamDebug ( TMC9660 &  parent )

inlineexplicitprivatenoexcept

Member Function Documentation

getStatus()

bool TMC9660::RamDebug::getStatus ( bool &  isRunning )

noexcept

Get the current state of the RAM debug engine.

Parameters

[out]

isRunning

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

Returns

true if the status was retrieved successfully.

init()

bool TMC9660::RamDebug::init ( uint32_t  sampleCount )

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

sampleCount

Number of samples to collect in the buffer.

Returns

true if the RAM debug was initialized properly.

readData()

bool TMC9660::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()

bool TMC9660::RamDebug::startCapture ( )

noexcept

Start capturing data using RAMDebug.

Returns

true if the capture started successfully.

Friends And Related Symbol Documentation

TMC9660

friend class TMC9660

friend

Member Data Documentation

driver

TMC9660& TMC9660::RamDebug::driver

private

---

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

• TMC9660.hpp
• TMC9660.cpp