Update rangefinder documentation#11268
Merged
sensei-hacker merged 2 commits intoiNavFlight:maintenance-9.xfrom Feb 8, 2026
Merged
Update rangefinder documentation#11268sensei-hacker merged 2 commits intoiNavFlight:maintenance-9.xfrom
sensei-hacker merged 2 commits intoiNavFlight:maintenance-9.xfrom
Conversation
- Clarify AGL definition: altitude Above Ground Level - Update features list: remove "experimental" labels, add GPS-free navigation - Expand hardware list: add VL53L1X, US42, BENEWAKE, FAKE - Add Surface mode section: explain terrain following for multirotors - Add configuration examples with CLI commands - Add optical flow integration section - Add comprehensive troubleshooting guide - Add references to wiki documentation Removes outdated "very limited" and "experimental" language that no longer reflects the mature state of rangefinder support in INAV.
Contributor
PR Compliance Guide 🔍All compliance sections have been disabled in the configurations. |
- Add guidance that nav_max_terrain_follow_alt must be less than inav_max_surface_altitude - Update troubleshooting to distinguish between operational limit and sensor range - Addresses Qodo bot suggestion for clarity This prevents users from configuring terrain following beyond the rangefinder's reliable range.
xznhj8129
pushed a commit
to xznhj8129/inav
that referenced
this pull request
Apr 4, 2026
…ngefinder-documentation Update rangefinder documentation
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
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
Updates
docs/Rangefinder.mdto reflect the current state of rangefinder support in INAV, removing outdated "experimental" labels and providing comprehensive configuration guidance.Changes
Testing
Documentation-only change - no code modifications.
Verified:
Documentation
This PR updates the technical documentation in
docs/Rangefinder.md.Related wiki documentation already merged:
Motivation
The existing documentation called rangefinder support "very limited" and labeled Surface mode as "experimental", which no longer reflects INAV's mature rangefinder capabilities after years of development and refinement.
PR Type
Documentation
Description
Comprehensive update removing outdated "experimental" labels
Reorganized hardware list with sensor categories and specifications
Added Surface mode terrain following documentation for multirotors
Included configuration examples and optical flow integration guide
Added troubleshooting section and constraint documentation
Diagram Walkthrough
File Walkthrough
Rangefinder.md
Complete rangefinder documentation overhaul with current featuresdocs/Rangefinder.md
explanation
Radar, Serial/External, and Development sensors
for multirotors only
position estimation weights
capability