Esp32TmcMutex Class Reference

ESP32 FreeRTOS mutex wrapper for TMC51x0 driver. More...

#include <esp32_tmc_mutex.hpp>

Public Member Functions
	Esp32TmcMutex () noexcept
	~Esp32TmcMutex () noexcept
	Esp32TmcMutex (const Esp32TmcMutex &)=delete
Esp32TmcMutex &	operator= (const Esp32TmcMutex &)=delete
SemaphoreHandle_t	native_handle () const noexcept
	Get native FreeRTOS semaphore handle.
bool	is_valid () const noexcept
	Check if mutex is valid.

Private Attributes
SemaphoreHandle_t	handle_

Detailed Description

ESP32 FreeRTOS mutex wrapper for TMC51x0 driver.

RAII wrapper around FreeRTOS mutex (semaphore) for thread-safe TMC driver access. Automatically creates mutex on construction and deletes on destruction.

Constructor & Destructor Documentation

Esp32TmcMutex() [1/2]

Esp32TmcMutex::Esp32TmcMutex ( )

inlinenoexcept

~Esp32TmcMutex()

Esp32TmcMutex::~Esp32TmcMutex ( )

inlinenoexcept

Esp32TmcMutex() [2/2]

Esp32TmcMutex::Esp32TmcMutex ( const Esp32TmcMutex & )

delete

Member Function Documentation

is_valid()

bool Esp32TmcMutex::is_valid ( ) const

inlinenoexcept

Check if mutex is valid.

Here is the caller graph for this function:

native_handle()

SemaphoreHandle_t Esp32TmcMutex::native_handle ( ) const

inlinenoexcept

Get native FreeRTOS semaphore handle.

Here is the caller graph for this function:

operator=()

Esp32TmcMutex & Esp32TmcMutex::operator= ( const Esp32TmcMutex & )

delete

Member Data Documentation

handle_

SemaphoreHandle_t Esp32TmcMutex::handle_

private

---

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

• esp32_tmc_mutex.hpp