HF-TMC51x0 Driver (TMC5130 & TMC5160) 0.1.0-dev
Hardware Agnostic C++ Driver for the TMC51x0 (TMC5130 & TMC5160)
Loading...
Searching...
No Matches
tmc51x0::HomingSettingsCache Struct Reference

Cached settings for homing operations. More...

#include <tmc51x0_types.hpp>

Collaboration diagram for tmc51x0::HomingSettingsCache:
[legend]

Public Attributes

bool cached_stealthchop_enabled = false
 
bool stealthchop_was_modified = false
 
SW_MODE_Register cached_sw_mode {}
 
bool sw_mode_was_modified = false
 
RampMode cached_ramp_mode = RampMode::POSITIONING
 
float cached_max_speed = 0.0f
 
float cached_acceleration = 0.0f
 
float cached_deceleration = 0.0f
 
float cached_vstart = 0.0f
 
float cached_vstop = 0.0f
 
float cached_v1 = 0.0f
 
bool ramp_settings_were_modified = false
 
bool is_valid = false
 

Detailed Description

Cached settings for homing operations.

Stores only the settings that are modified during homing and need to be restored. Notes:

  • Motor currents may be temporarily reduced during sensorless homing / bounds finding (see BoundsOptions.current_reduction_factor/current_reduction_target_mA), but are restored via local RAII guards rather than this cache.
  • StallGuard config may be temporarily overridden via BoundsOptions.stallguard_override and restored by the homing routines when used as an override.

Member Data Documentation

◆ cached_acceleration

float tmc51x0::HomingSettingsCache::cached_acceleration = 0.0f

◆ cached_deceleration

float tmc51x0::HomingSettingsCache::cached_deceleration = 0.0f

◆ cached_max_speed

float tmc51x0::HomingSettingsCache::cached_max_speed = 0.0f

◆ cached_ramp_mode

RampMode tmc51x0::HomingSettingsCache::cached_ramp_mode = RampMode::POSITIONING

◆ cached_stealthchop_enabled

bool tmc51x0::HomingSettingsCache::cached_stealthchop_enabled = false

◆ cached_sw_mode

SW_MODE_Register tmc51x0::HomingSettingsCache::cached_sw_mode {}

◆ cached_v1

float tmc51x0::HomingSettingsCache::cached_v1 = 0.0f

◆ cached_vstart

float tmc51x0::HomingSettingsCache::cached_vstart = 0.0f

◆ cached_vstop

float tmc51x0::HomingSettingsCache::cached_vstop = 0.0f

◆ is_valid

bool tmc51x0::HomingSettingsCache::is_valid = false

◆ ramp_settings_were_modified

bool tmc51x0::HomingSettingsCache::ramp_settings_were_modified = false

◆ stealthchop_was_modified

bool tmc51x0::HomingSettingsCache::stealthchop_was_modified = false

◆ sw_mode_was_modified

bool tmc51x0::HomingSettingsCache::sw_mode_was_modified = false

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