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

Subsystem for entering low-power hibernation mode and configuring wake. More...

#include <tmc9660.hpp>

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

Classes
struct	PowerConfig
	Configuration structure for power management auto-configuration. More...

Public Member Functions
bool	enableWakePin (bool enable) noexcept
	Enable or disable the external wake-up pin.
bool	enterPowerDown (tmc9660::tmcl::PowerDownTimeout period) noexcept
	Put the chip into power-down mode for a set duration.
bool	configureAuto (const PowerConfig &config) noexcept
	Auto-configure power management parameters.

Private Member Functions
	Power (TMC9660 &parent) noexcept

Private Attributes
TMC9660 &	driver

Friends
class	TMC9660

Detailed Description

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

Subsystem for entering low-power hibernation mode and configuring wake.

The TMC9660 supports timed power-down and wake-on-pin. These features reduce power when idle.

• See the "Hibernation and Wakeup" section (datasheet page 101).
• Wake behavior depends on BOOT_CONFIG and external wiring.

Constructor & Destructor Documentation

Power()

template<typename CommType >

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

inlineexplicitprivatenoexcept

Member Function Documentation

configureAuto()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Power::configureAuto ( const PowerConfig & config )

noexcept

Auto-configure power management parameters.

Configures wake-up pin and power-down timeout based on high-level requirements.

Parameters

config

Power configuration (see PowerConfig)

Returns

true if all configurations succeeded, false otherwise

enableWakePin()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Power::enableWakePin ( bool enable )

noexcept

Enable or disable the external wake-up pin.

Parameters

enable

true = enable pin

Returns

true on success

• Parameter: ENABLE_WAKE_PIN

enterPowerDown()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Power::enterPowerDown ( tmc9660::tmcl::PowerDownTimeout period )

noexcept

Put the chip into power-down mode for a set duration.

Parameters

period

Enum selecting one of 6 durations (e.g. PERIOD_1 = 250 ms)

Returns

true on success

• Parameter: GO_TO_TIMEOUT_POWER_DOWN_STATE

Friends And Related Symbol Documentation

TMC9660

template<typename CommType >

friend class TMC9660

friend

Member Data Documentation

driver

template<typename CommType >

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

private

---

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

• tmc9660.hpp