api doxygen classes - Alteriom/painlessMesh GitHub Wiki

📚 Class Reference

Complete class documentation automatically generated from painlessMesh source code using Doxygen.

�️ Interactive Documentation Viewer

📋 API Reference - Classes 🔗 Open in New Tab
<iframe src="https://alteriom.github.io/painlessMesh/api-reference/annotated.html" width="100%" height="700px" frameborder="0" style="border: 1px solid #d0d7de; border-radius: 6px; background: white;" loading="lazy" title="Doxygen Class Documentation">

📄 Your browser doesn't support iframes. Open documentation in new tab

</iframe>

🎯 Quick Access Links

Class Category Description Direct Link
Core Classes Main mesh networking functionality 📖 View Classes
Class Index Alphabetical class listing 📋 Browse Index
Class Hierarchy Inheritance relationships 🌳 View Hierarchy
Class Members All class methods and variables ⚙️ Browse Members

🔌 Key Classes by Category

🌐 Networking Core

⏰ Task Management

  • Scheduler - Task scheduling and timing
  • Task - Individual task representation

📦 Package System

🔧 Utilities

  • Logger - Debug and logging functionality
  • Buffer - Memory management utilities

💡 Usage Tips

🔍 Finding What You Need

  • Search by name: Use Ctrl+F to find specific classes
  • Browse by category: Use the hierarchy view for organized browsing
  • Check inheritance: See which classes extend others
  • View all members: Find all methods and properties for a class

📖 Reading Class Documentation

Each class page includes:

  • Brief description - What the class does
  • Detailed description - How it works and when to use it
  • Constructor documentation - How to create instances
  • Method documentation - All available functions
  • Member variables - Class properties and fields
  • Usage examples - Practical code samples

🎯 Quick Examples

// Core mesh operations
painlessMesh mesh;
mesh.init("MyMesh", "password", &scheduler, 5555);

// Task scheduling  
Task myTask(1000, TASK_FOREVER, &myCallback);
scheduler.addTask(myTask);

// Package messaging
SensorPackage sensor;
sensor.temperature = 25.5;
mesh.sendPackage(&sensor);

🚀 Next Steps

After reviewing the class documentation:

  1. Try examples - See practical usage in Basic Examples
  2. Read guides - Learn patterns in Core API Guide
  3. Check functions - Browse Function Reference
  4. View files - Explore File Reference

?> 💡 Tip: If the embedded documentation doesn't load, check the troubleshooting guide or use the direct links above.

⚠️ **GitHub.com Fallback** ⚠️