Skip to content

docs: fix in-flight OSD menu nav-mode list and status string - #32

Open
sensei-hacker wants to merge 1 commit into
iNavFlight:masterfrom
sensei-hacker:docs/fix-osd-menu-nav-modes
Open

sensei-hacker wants to merge 1 commit into
iNavFlight:masterfrom
sensei-hacker:docs/fix-osd-menu-nav-modes

Conversation

@sensei-hacker

Copy link
Copy Markdown
Member

Hi @cabcrab — thanks for documenting the In-Flight OSD Menu (#18)! While cross-checking it against the firmware source, I noticed two small details that look like they may not match the merged code, and since the page is already live I've put together a proposed correction here. Could I ask you to check whether these are accurate?

  • NAV CRUISE as a qualifying mode: the Requirements section lists NAV CRUISE as a mode that satisfies the menu-open gate, but cmsIsNavModeActive() in src/main/cms/cms.c checks only POSHOLD, RTH, NAV WP, and ALTHOLD (cruise/course-hold was removed in commit 9d0a691e94). I've dropped NAV CRUISE from the qualifying-mode list and noted that it doesn't count on its own.
  • OSD status string: the page shows USE NAV MODE FOR MENU, but the firmware string OSD_MSG_MENU_NAV_REQ in src/main/io/osd.h is USE NAV MODES FOR MENU (plural). I've aligned it.

I checked these against maintenance-10.x with the help of an AI-based tool, so please treat any of the above as a question rather than a verdict — happy to adjust anything I've misread. And thank you again for the page!

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can describe a rule in plain language on the Rules page and Qodo drafts it for you

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Correct in-flight OSD menu navigation requirements and status text

📝 Documentation 🐞 Bug fix 🕐 Less than 5 minutes

Grey Divider

AI Description

• Corrects the navigation modes that permit opening the in-flight OSD menu.
• Aligns the documented OSD warning with the firmware’s pluralized status string.
High-Level Assessment

The current approach is optimal: directly align the published requirements and displayed message with firmware behavior. No architectural alternative is warranted for this narrowly scoped documentation correction.

Files changed (1) +3 / -3

Other (1) +3 / -3
in-flight-osd-menu.mdxCorrect qualifying navigation modes and OSD warning text +3/-3

Correct qualifying navigation modes and OSD warning text

• Replaces NAV CRUISE with the firmware-supported POSHOLD, RTH, NAV WP, and ALTHOLD modes, explicitly noting that NAV CRUISE alone is insufficient. Updates the displayed warning to the firmware’s exact 'USE NAV MODES FOR MENU' string.

docs/06-advanced-features/in-flight-osd-menu.mdx

@cabcrab

cabcrab commented Sep 20, 2026

Copy link
Copy Markdown
Contributor

Thanks for checking this, The OSD string is right. On NAV CRUISE, I think the original wording was actually fine: cruise holds altitude (it activates NAV_ALTHOLD_MODE alongside the heading hold), so it still opens the menu. What was removed in 9d0a691e94 is only the standalone course hold, which locks heading without holding altitude. So I'd keep CRUISE in the list, maybe noting that course hold alone doesn't count

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants