Improve blackbox DEBUG documentation#11239
Merged
sensei-hacker merged 1 commit intoiNavFlight:maintenance-9.xfrom Jan 11, 2026
Merged
Improve blackbox DEBUG documentation#11239sensei-hacker merged 1 commit intoiNavFlight:maintenance-9.xfrom
sensei-hacker merged 1 commit intoiNavFlight:maintenance-9.xfrom
Conversation
- Add missing SERVOS field to blackbox field list - Fix typo: "blackbox MOTOR" → "blackbox MOTORS" - Add new "Debug Mode Logging" section explaining debug_mode setting - Include examples of common debug modes (FLOW_RAW, LANDING, POS_EST, GPS, ALTITUDE) - Add CLI usage examples for debug mode - Reference Blackbox Internals.md for technical details - Mention OSD_DEBUG element for real-time display This helps users discover the debug logging functionality which was previously only documented in the technical Blackbox Internals document.
Contributor
PR Compliance Guide 🔍All compliance sections have been disabled in the configurations. |
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
Summary
Improves blackbox DEBUG documentation in
docs/Blackbox.mdto help users discover debug logging functionality.Changes
SERVOSfield to blackbox field listblackbox MOTOR→blackbox MOTORSdebug_modesettingMotivation
The
debug_modesetting and debug value logging were previously only documented in the technical "Blackbox Internals" document. This made it difficult for users to discover this powerful troubleshooting feature. This PR adds user-facing documentation with practical examples.Test Plan
Files Modified
docs/Blackbox.mdPR Type
Documentation
Description
Add missing
SERVOSfield to blackbox field listFix typo:
blackbox MOTOR→blackbox MOTORSAdd new "Debug Mode Logging" section with examples
Include CLI usage examples and OSD_DEBUG reference
Diagram Walkthrough
File Walkthrough
Blackbox.md
Enhance blackbox documentation with debug mode detailsdocs/Blackbox.md
SERVOSfield to the blackbox field list for servo outputlogging
blackbox MOTORtoblackbox MOTORSdebug_modesetting
POS_EST, GPS, ALTITUDE)
element