Skip to content

History / Debugging

Revisions

  • feat(docs): update API documentation for enhanced clarity and functionality This commit updates the API documentation with expanded details, examples, and usage patterns for the MagisV2 flight controller system. Key changes include: - **BMS.md**: Expanded details on battery parameter retrieval and usage patterns. - **Debugging.md**: Improved explanations of debugging functionalities including monitor functions and black box logging. - **FC-Config.md**: Detailed descriptions of PID configuration, failsafe settings, and position control functions. - **FC-Control.md**: Clarified flight status, mode functions, and command operations with code examples. - **FC-Data.md**: Elaborated data access methods for sensors and state estimation parameters. - **Home.md** & **Introduction.md**: Added references to new modules like RGB-LED and updated navigation structure. - **Motor.md**: Enhanced motor control interface guidelines, focused on initialization and runtime behavior. - **Oled.md**: Comprehensive guide to using OLED in both system and user modes with graphics and text rendering. - **Peripherals.md**: Detailed GPIO, ADC, and PWM controls, with practical setup and operational examples. - **PlutoPilot.md**: Revised lifecycle hooks explanation and their typical use cases in drone applications. - **RC-Interface.md**: Explained RC data reading and command injection for manual and autonomous control. - **RGB-LED.md**: New detailed documentation on controlling addressable WS2812B LED strips. - **RxConfig.md**: Describes receiver type selection and channel mapping for various flight modes. - **Scheduler-Timer.md**: Provides insights into task scheduling and timing utilities, aiding real-time operations. - **Serial-IO.md**: Updated UART, I2C, and SPI communication protocols with initialization and data transmission examples. - **Status-LED.md**: Instructions for utilizing onboard LEDs for status indication and feedback. - **XRanging.md**: Guidelines on laser ranging sensor utilization for obstacle detection and avoidance. These enhancements aim to provide developers with a clear understanding of the API features, facilitating efficient integration and development of drone applications.

    @mechash mechash committed Jul 21, 2026
  • add structured API documentation with Introduction and section-wise markdown files

    @hrisabhy hrisabhy committed Nov 14, 2025