Skip to content

docs: compass calibration time is configurable, not fixed at 30 s - #27

Open
Raffi1202 wants to merge 1 commit into
iNavFlight:masterfrom
Raffi1202:docs/mag-calibration-time
Open

Raffi1202 wants to merge 1 commit into
iNavFlight:masterfrom
Raffi1202:docs/mag-calibration-time

Conversation

@Raffi1202

Copy link
Copy Markdown
Contributor

Problem

mag_calibration_time has shipped in 9.1 and 10.x for a long time (default 30, range 20 to 120 seconds), but two pages describe the magnetometer calibration as taking a fixed 30 seconds:

  • docs/04-inav-configurator/calibration-tab.mdx:84 — "You have 30 seconds to hold the copter in the air"
  • docs/04-inav-configurator/calibration-tab.mdx:92 — "After 30 seconds, the flight controller will sound a single beep"
  • docs/05-core-features/compass.mdx:200 — "Within 30 seconds, hold the aircraft in the air"
  • docs/05-core-features/compass.mdx:217 — "After 30 seconds, the flight controller will sound a single beep"

Someone who raises the value follows the text, stops moving the aircraft after 30 seconds and ends up with a half-finished calibration.

Change

Those four sentences now name the setting and its range instead of a fixed number. Wording only, no restructuring, and the other "30 seconds" mentions in the docs (gyro auto-calibration, autoland wind estimation, PID tuning) are untouched because they are unrelated.

Source

mag_calibration_time in docs/Settings.md on both release/9.1 and maintenance-10.x: default 30, min 20, max 120, "Adjust how long time the Calibration of mag will last."

mag_calibration_time has shipped in 9.1 and 10.x for a long time
(default 30, range 20 to 120), but the calibration tab and compass pages
still state 30 seconds as a fixed duration. Someone who raises the value
reads that the beep comes after 30 seconds and stops moving the aircraft
too early.
@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 start a comment with 'qodo' or '@qodo' to chat about any finding

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

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

Copy link
Copy Markdown

PR Summary by Qodo

Document configurable compass calibration duration

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Documents mag_calibration_time defaults and supported range for compass calibration.
• Aligns completion-beep guidance with the configured calibration duration.
High-Level Assessment

The inline documentation approach is appropriate because users need the configurable timing details while following calibration instructions. Linking only to the settings reference was considered but would make the operational guidance less immediate.

Files changed (2) +4 / -4

Documentation (2) +4 / -4
calibration-tab.mdxClarify configurable magnetometer calibration timing +2/-2

Clarify configurable magnetometer calibration timing

• Documents 'mag_calibration_time', its default and supported range, and notes that the Configurator countdown follows the flight controller. Updates the completion-beep guidance to depend on the configured duration.

docs/04-inav-configurator/calibration-tab.mdx

compass.mdxUse configured duration in compass calibration instructions +2/-2

Use configured duration in compass calibration instructions

• Reframes the Configurator calibration window around 'mag_calibration_time', including its default and range. Clarifies that stick-command calibration completes when the configured time elapses.

docs/05-core-features/compass.mdx

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