The canonical Best Practices guide lives in the AkiraSDK submodule.

To avoid duplicating content that evolves with the SDK, this guide is maintained in AkiraSDK. Refer to it directly — the local copy in the submodule is always in sync.

Where to Find Best Practices

Location Path
Online (canonical) github.com/ArturR0k3r/AkiraSDK — BEST_PRACTICES.md
Local submodule AkiraSDK/docs/BEST_PRACTICES.md

Topics Covered

  • Main Loop — How to structure main(), polling, yielding with delay()
  • Memory Management — Static buffers, avoiding stack overflows, mem_alloc() checks
  • Display Optimization — Dirty-region tracking, avoiding full redraws
  • GPIO & Input Polling — Debouncing, edge detection patterns
  • Sensor Reading — Rate limiting, averaging
  • Error Handling — Defensive guards, graceful degradation
  • Power Efficiency — Sleep patterns, wakeup sources
  • Code Organization — File layout, naming conventions

Copyright © 2025-2026 AkiraOS Project. Licensed under GNU GPL v3.