HF-WS2812 Documentation

Welcome! This directory contains step-by-step guides for installing, configuring, and using the HF-WS2812 library.

📚 Documentation Structure

Getting Started

  1. 🛠️ Installation – How to integrate the component into your ESP-IDF project
  2. ⚡ Quick Start – Minimal working example to get you running
  3. 🔌 Hardware Setup – Wiring diagrams and pin connections

Integration

  1. 🔧 Platform Integration – ESP32 RMT integration and platform-specific details
  2. ⚙️ Configuration – Kconfig options and runtime configuration

Reference

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

Troubleshooting

  1. 🐛 Troubleshooting – Common issues and solutions

🚀 Quick Start Path

New to WS2812 LEDs? Follow this recommended path:

  1. Start with Installation to integrate the component
  2. Follow Hardware Setup to wire your LED strip
  3. Read Quick Start for a minimal working example
  4. Check Configuration for customization options
  5. Explore Examples for more advanced usage

💡 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 ➡️ Installation

Table of contents