HF-Core Platform 0.1.0-dev
Hardware-Agnostic Handler Layer & RTOS Utilities for HardFOC
Loading...
Searching...
No Matches
Tmc5160CtrlPins Struct Reference

Shared helper holding TMC5160 host-side control pin references. More...

#include <Tmc5160Handler.h>

Public Member Functions

BaseGpio * get (tmc51x0::TMC51x0CtrlPin pin) noexcept
 Resolve a TMC51x0CtrlPin enum to the corresponding BaseGpio pointer.
 

Public Attributes

BaseGpio & enable
 DRV_ENN enable pin (active LOW disables driver)
 
BaseGpio * diag0 {nullptr}
 Optional DIAG0 diagnostic pin.
 
BaseGpio * diag1 {nullptr}
 Optional DIAG1 diagnostic pin.
 

Detailed Description

Shared helper holding TMC5160 host-side control pin references.

The TMC5160 requires at minimum an EN (enable) pin. Additional optional pins include DIAG0, DIAG1 for diagnostics, and STEP/DIR for external step/dir mode.

Member Function Documentation

◆ get()

BaseGpio * Tmc5160CtrlPins::get ( tmc51x0::TMC51x0CtrlPin pin)
inlinenoexcept

Resolve a TMC51x0CtrlPin enum to the corresponding BaseGpio pointer.

Returns
Pointer to BaseGpio, or nullptr if pin not configured.

Member Data Documentation

◆ diag0

BaseGpio* Tmc5160CtrlPins::diag0 {nullptr}

Optional DIAG0 diagnostic pin.

◆ diag1

BaseGpio* Tmc5160CtrlPins::diag1 {nullptr}

Optional DIAG1 diagnostic pin.

◆ enable

BaseGpio& Tmc5160CtrlPins::enable

DRV_ENN enable pin (active LOW disables driver)


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