HF-TMC51x0 Documentation (TMC5130 & TMC5160)

Welcome! This directory contains step-by-step guides for installing, building, and using the HF-TMC51x0 library, which supports both TMC5130 and TMC5160 chips.

📚 Documentation Structure

Getting Started

  1. 🛠️ Installation – Prerequisites and how to obtain the source
  2. ⚡ Quick Start – Minimal working example to get you running
  3. 🔌 Hardware Setup – Wiring diagrams and pin connections

Integration

  1. 🔧 Platform Integration – Implement the CRTP communication interface for your platform
  2. ⚙️ Configuration – Configuration options and settings

Reference

  1. 📖 API Reference – Complete API documentation
  2. 💡 Examples – Detailed example walkthroughs

Advanced Features

  1. 📐 Unit Conversions – Converting between physical units and driver steps
  2. ⚙️ Motor Setup from Specifications – High-level motor configuration from physical parameters
  3. 🏠 Sensorless Homing – Homing without endstops using StallGuard2
  4. 🎯 Automatic Tuning – Intelligent StallGuard2 threshold optimization
  5. 🔧 Advanced Configuration – CoolStep, dcStep, freewheeling, and more
  6. 🔗 Multi-Chip Communication – SPI daisy chaining and UART multi-node addressing
  7. 📡 Communication Interface – Low-level SPI/UART communication details
  8. 🔌 GPIO Pin Configuration – Pin mapping, active levels, and mode pin setup
  9. 📝 Register Access – Direct register read/write and initialization flow
  10. 🔄 TMC5130 Support – Differences between TMC5130 and TMC5160

Troubleshooting

  1. 🐛 Troubleshooting – Common issues and solutions

🚀 Quick Start Path

New to TMC51x0? Follow this recommended path:

  1. Start with Installation to prepare your environment
  2. Follow Hardware Setup to wire your hardware
  3. Read Quick Start for a minimal working example and Result<T> error handling
  4. Check Platform Integration to implement the SPI/UART interface
  5. Explore Examples for progressively harder walkthroughs with explanations
  6. Refer to Troubleshooting when things don’t work as expected

💡 Need Help?

  • 🐛 Found a bug? Check the Troubleshooting guide
  • ❓ Have questions? Review the API Reference
  • 📝 Want to contribute? See the contributing guidelines in the main README

Navigation Next: Installation ->

Table of contents