TMC9660::ReferenceSearch Struct Reference

Subsystem for executing a reference search (homing) routine. More...

#include <TMC9660.hpp>

Collaboration diagram for TMC9660::ReferenceSearch:

Public Member Functions
bool	start () noexcept
	Start the reference search procedure.
bool	stop () noexcept
	Abort an ongoing reference search.
bool	getStatus (tmc9660::tmcl::ReferenceSearchStatus &status) noexcept
	Query the current reference search status code.

Private Member Functions
	ReferenceSearch (TMC9660 &parent) noexcept

Private Attributes
TMC9660 &	driver

Friends
class	TMC9660

Detailed Description

Subsystem for executing a reference search (homing) routine.

Constructor & Destructor Documentation

ReferenceSearch()

TMC9660::ReferenceSearch::ReferenceSearch ( TMC9660 &  parent )

inlineexplicitprivatenoexcept

Member Function Documentation

getStatus()

bool TMC9660::ReferenceSearch::getStatus ( tmc9660::tmcl::ReferenceSearchStatus &  status )

noexcept

Query the current reference search status code.

start()

bool TMC9660::ReferenceSearch::start ( )

noexcept

Start the reference search procedure.

stop()

bool TMC9660::ReferenceSearch::stop ( )

noexcept

Abort an ongoing reference search.

Friends And Related Symbol Documentation

TMC9660

friend class TMC9660

friend

Member Data Documentation

driver

TMC9660& TMC9660::ReferenceSearch::driver

private

---

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

• TMC9660.hpp
• TMC9660.cpp