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

#include <TMC9660.hpp>

Collaboration diagram for TMC9660::Power:

[legend]

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.

Private Member Functions
	Power (TMC9660 &parent) noexcept

Private Attributes
TMC9660 &	driver

Friends
class	TMC9660

Detailed Description

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()

TMC9660::Power::Power ( TMC9660 & parent )

inlineexplicitprivatenoexcept

Member Function Documentation

◆ enableWakePin()

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

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

friend class TMC9660

friend

Member Data Documentation

◆ driver

TMC9660& TMC9660::Power::driver

private

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

Public Member Functions

Private Member Functions

Private Attributes

Friends