ArduPilot / ArduPilot/WebTools

MagFit tools terminology and UI suggestions

Open
#120 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
62
Forks
92
Avg merge
1d 23h
Merged PRs (30d)
2

Description

I was trying to use the Magfit tool and got a little confused perhaps due to terminology and layout.

In the first sentence is says, "predicted field from the World Magnetic Model"... but from then on in the web page it uses the synonym "Expected"... I guess this "Expected" is the same as "predicted"? Maybe we should change the first paragraph to also be "expected"?

The wording in the "Expected vs measured body frame magnetic field" section is a bit confusing. The "No motor comp" box surrounding the "Offsets", "Offsets and scale" and "Offset and iron" makes me think that checking these boxes will perhaps enable motor compensation? .. I don't think this is what it does though. Maybe "No motor comp" should be changed to, "Calculate Calibration with:"
![image](https://github.com/ArduPilot/WebTools/assets/1498098/e890d2d2-c51d-4d8d-8237-7a536ca91d75)

I guess there's no way to *not* graph the Expected? It might be good to have a checked box for this as well in the renamed, "Graph" section above.

For some reason I was unable to check the "Offsets and scale" and "Offsets and iron" checkboxes but there's no explanation as to why I can't.

The "Offsets No motor comp" label beside some graphs is unclear whether we're talking about existing offsets or new calculated offsets. I'm pretty sure it's the new ones but let's not make users have to try and figure this out.
![image](https://github.com/ArduPilot/WebTools/assets/1498098/905c71aa-96bb-47a5-9461-420452d622be)

By the way, the tool tip above "Fit error" reuses the word "Fit" without any explanation of what it means in this context. Perhaps it should be changed from, "First plot is error of selected fit over time" to "First plot shows the error (e.g. difference) over time between the selected calibrations and the expected world magnetic model."

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the MagFit tool UI and the sections labeled "Expected vs measured body frame magnetic field," "Graph," and "Fit error." Review the terminology, calibration checkbox behavior, graph labels, and tooltips against the reported confusion. Done means the labels and explanations are unambiguous and the reported checkbox behavior is understood or addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.