Skip to content

docs: clarify rangefinder interfaces and availability - #11961

Open
T1mn wants to merge 1 commit into
iNavFlight:maintenance-10.xfrom
T1mn:codex/docs-rangefinder-availability
Open

T1mn wants to merge 1 commit into
iNavFlight:maintenance-10.xfrom
T1mn:codex/docs-rangefinder-availability

Conversation

@T1mn

@T1mn T1mn commented Sep 17, 2026

Copy link
Copy Markdown

The rangefinder guide mixes sensor interfaces with the interfaces implemented by INAV, and gives the same serial setup steps for dedicated rangefinder drivers and MSP input.

This update:

  • Uses the exact TOF10120_I2C CLI value and identifies the native TeraRanger Evo interface as I2C.
  • Moves the US-D1 V0 protocol to the radar section, with a link to the manufacturer's description.
  • Explains that a CLI option does not guarantee the driver is compiled in, including the current SRF10 default.
  • Documents the fixed 115200-baud Rangefinder port used by Benewake/NRA/USD1 and the separate MSP setup.

Validation: checked the CLI values, detection guards, serial initialization and MSP message routing against the current source; checked relative links and git diff --check. No firmware behavior changes or hardware tests.

@qodo-code-review

Copy link
Copy Markdown
Contributor

ⓘ Qodo reviews are paused because the subscription is no longer active. Ask your workspace admin to reactivate the subscription to resume reviews. Manage billing

@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 enable the Remediation agent and Qodo fixes findings in a dedicated fix PR

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

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

Copy link
Copy Markdown

PR Summary by Qodo

Clarify rangefinder interfaces and firmware availability

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Corrects rangefinder names, sensor categories, and supported INAV interfaces.
• Distinguishes compiled driver availability from exposed CLI configuration values.
• Documents dedicated serial and MSP port requirements separately.
Diagram

graph TD
  A["CLI Selection"] --> B{"Driver Available?"}
  B -->|No| C["No Detection"]
  B -->|Yes| D{"Interface Type"}
  D -->|I2C| E["I2C Bus"]
  D -->|Serial| F["Rangefinder Port"] --> G["115200 Sensor"]
  D -->|MSP| H["MSP Messages"]
Loading
High-Level Assessment

Keeping the corrections in the existing rangefinder guide is the best approach because interface choice, firmware availability, and port configuration are closely related user concerns. Splitting the material into separate guides or generating it from source metadata would add maintenance complexity without clear benefit for this focused documentation correction.

Files changed (1) +23 / -11

Documentation (1) +23 / -11
Rangefinder.mdCorrect rangefinder interfaces, availability, and serial setup +23/-11

Correct rangefinder interfaces, availability, and serial setup

• Clarifies exact CLI values, native sensor interfaces, protocol categories, and build-time driver availability, including SRF10's default status. Separates fixed 115200-baud dedicated Rangefinder-port drivers from MSP-based input and links the US-D1 protocol description.

docs/Rangefinder.md

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.

1 participant