docs(sim_sih): link Hawkeye visualizer, add stub page#27159
Merged
hamishwillee merged 2 commits intomainfrom Apr 22, 2026
Merged
docs(sim_sih): link Hawkeye visualizer, add stub page#27159hamishwillee merged 2 commits intomainfrom
hamishwillee merged 2 commits intomainfrom
Conversation
Replaces jMAVSim display-only mode references in the SIH page with Hawkeye, which is purpose-built for this role and actively maintained. The 3D visualization section now covers the hawkeye command, the port alignment with SIH (UDP 19410), and links out to the full Hawkeye documentation. Adds a short sim_hawkeye/index.md stub covering what Hawkeye is, install on macOS and Linux, and basic SIH usage. Everything else (multi-vehicle, ULog replay, HUD modes, CLI reference) lives at px4.github.io/Hawkeye and is linked from the stub, so PX4 docs don't carry the maintenance burden of two parallel sources. Also updates the port reference table: UDP 19410 is now labeled "Hawkeye visualizer" instead of "jMAVSim display-only", and adds the page to SUMMARY.md nested under SIH Simulation.
|
No broken links found in changed files. |
hamishwillee
approved these changes
Apr 22, 2026
Contributor
hamishwillee
left a comment
hamishwillee
left a comment
There was a problem hiding this comment.
@mrpollo Looks good. Did a minor subedit and added some comments just FYI if you are interested in why.
What I'd love to see is an update to the container to include hawkeye, followed by a corresponding update to https://docs.px4.io/main/en/simulation/px4_simulation_quickstart
Thoughts? Not blocking this PR though.
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
2 participants
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.
Replaces the superseded #26965 with a slimmer version. That PR added 9 deep Hawkeye documentation pages plus 35 screenshots and animations directly into the PX4 user guide. After conversations with @hamishwillee, we agreed the deep documentation should live in the Hawkeye repo so PX4 docs don't carry the maintenance burden of two parallel sources. The Hawkeye docs are now live at px4.github.io/Hawkeye.
This PR adds only what PX4 readers actually need: a short pointer page, the SIH integration details, and the jMAVSim → Hawkeye swap in the SIH docs.
Changes:
docs/en/sim_sih/index.md— replaces the jMAVSim display-only section with a Hawkeye section covering thehawkeyecommand, UDP 19410 port alignment, and a link to the full Hawkeye docs. The port reference table now labels UDP 19410 as "Hawkeye visualizer" instead of "jMAVSim display-only".docs/en/sim_hawkeye/index.md— new stub page (~65 lines) with what Hawkeye is, install one-liners for macOS and Linux, the SIH quickstart, and links out to the hosted docs for multi-vehicle, ULog replay, HUD, and CLI reference.docs/en/SUMMARY.md— adds the stub as a single entry nested under SIH Simulation.