Skip to content

Commit 9d09149

Browse files
committed
core: frontend: vehicle-setup: compass: improve descriptions
1 parent 5625874 commit 9d09149

File tree

4 files changed

+29
-28
lines changed

4 files changed

+29
-28
lines changed

core/frontend/src/components/vehiclesetup/configuration/compass/ArdupilotMavlinkCompassSetup.vue

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,8 @@
3838
</v-expansion-panel-header>
3939
<v-expansion-panel-content>
4040
<p>
41-
This does a full calibration of the compasses.
42-
It requires you to spin the vehicle around manually multiple times.
43-
You need to move the vehicle around in all 3 axis.
41+
Perform a full calibration of the selected compass(es) by manually spinning
42+
the vehicle around multiple times, about all 3 rotation axes.
4443
</p>
4544
<full-compass-calibrator :compasses="compasses" />
4645
</v-expansion-panel-content>
@@ -51,10 +50,9 @@
5150
</v-expansion-panel-header>
5251
<v-expansion-panel-content>
5352
<p>
54-
This does a "quick" calibration of your compass.
55-
You need to point your vehicle North,and then click the button.
56-
This results in a much less accurate calibration, but is also much faster.
57-
It can be a good starting point for calibration, followed by <b>CompassLearn</b>.
53+
Perform a quick, low-accuracy calibration of the compass(es) by pointing
54+
your vehicle North, then clicking the Calibrate button.
55+
It can be a good starting point for calibration, followed by <b>Compass Learn</b>.
5856
</p>
5957
<large-vehicle-compass-calibrator :compasses="compasses" />
6058
</v-expansion-panel-content>
@@ -66,9 +64,9 @@
6664
</v-expansion-panel-header>
6765
<v-expansion-panel-content>
6866
<p>
69-
This allows automatic "calibration" of compass offsets. You need to have a valid world position.
70-
In order to use this option, click the following button and then drive the vehicle around until
71-
you see the message <b>"CompassLearn: finished"</b>
67+
Automatically "learn" compass calibration offsets by driving the vehicle around until
68+
enough data has been collected, and <b>"CompassLearn: finished"</b> is displayed.
69+
A valid global region estimate is required.
7270
</p>
7371
<compass-learn :compasses="compasses" />
7472
</v-expansion-panel-content>
@@ -79,11 +77,14 @@
7977
</v-expansion-panel-header>
8078
<v-expansion-panel-content>
8179
<p>
82-
This used logs from previous flights to calibrate the compasses.
80+
Calibrate the compass(es) using a previous flight log.
8381
This usually gives the best results.
84-
While it is not currently implemented here. It can be done either in
85-
<a href="https://firmware.ardupilot.org/Tools/WebTools/">Ardupilot WebTools</a> and
86-
<a href="https://plotbeta.ardupilot.org/">LogViewer</a>.
82+
While it is not currently implemented here, the compass offset information can be
83+
determined in the Log Browser page. Press the green play button on a log file,
84+
click the three vertical dots in the sidebar, open the <b>Mag Fit Tool</b>,
85+
specify the general global region where the log was created, then click "Fit"
86+
for each compass you wish to calibrate. Resulting values can be copied across to
87+
the COMPASS_* autopilot parameters.
8788
</p>
8889
</v-expansion-panel-content>
8990
</v-expansion-panel>
@@ -122,8 +123,8 @@
122123
</v-tab>
123124
</draggable>
124125
<v-card outlined class="ml-auto mr-auto rounded-lg pa-3" style="max-width: 200px;">
125-
To change the order of the compasses, drag them up and down in this list using the drag handler.
126-
This Operation requires an autopilot restart.
126+
Click-and-drag the dots to change the priority of the compass options.
127+
Adjusted compass priorities are applied once the autopilot restarts.
127128
</v-card>
128129
<v-tab-item
129130
v-for="(compass, index) in compasses"
@@ -150,7 +151,7 @@
150151
/>
151152
</div>
152153
<div v-else>
153-
This Compass is not in use, move it higher in the list in order to be able to use it
154+
This Compass is not in use, drag it higher (by the dots) to be able to use it.
154155
</div>
155156
<b>External/Internal:</b>
156157
<v-btn class="ml-8 mb-4 mt-2" fab x-small @click="openParameterEditor(compass_extern_param[index])">
@@ -371,7 +372,7 @@ export default Vue.extend({
371372
calibration: CalibrationType.FULL_NO_WMM,
372373
color: 'var(--v-warning-darken1)',
373374
alert: 'warning',
374-
description: 'Calibrated, but without a known (detected or specified) global position, '
375+
description: 'Calibrated, but without a known (detected or specified) global region, '
375376
+ 'so no corrections were applied from the internal World Magnetic Model (WMM). '
376377
+ 'Consider retrying with a valid position to improve compass performance.',
377378
calibration_short: 'Calibrated (No WMM)',

core/frontend/src/components/vehiclesetup/configuration/compass/CompassLearn.vue

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@
2222
Compass Calibration Learning
2323
</v-card-title>
2424
<v-card-text>
25-
A valid position is required for Compass Learn to estimate the local world magnetic field.
25+
A valid global region is required for Compass Learn to estimate the local world magnetic field.
2626
<auto-coordinate-detector
2727
v-model="coordinates"
2828
/>
29-
Make sure you have a valid position, then click start and drive the vehicle around in
30-
manual mode until you see the message "CompassLearn: finished"
29+
Make sure you have a valid region/position specified, then click start and drive the vehicle around
30+
in manual mode until you see the message <b>"CompassLearn: finished"</b>.
3131
<v-divider />
3232
<v-alert
3333
v-if="status_text"

core/frontend/src/components/vehiclesetup/configuration/compass/FullCompassCalibrator.vue

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,18 @@
2020
<v-card-text class="pa-10">
2121
<span v-if="state === states.IDLE">
2222
<p>
23-
<strong> Onboard Compass Calibration</strong> is the regular calibration used
24-
for Ardupilot vehicles.
25-
It requires you to spin the vehicle aroung all axis, which allows it to calibrated the
23+
<strong>Onboard Compass Calibration</strong> is the regular calibration used
24+
for ArduPilot vehicles.
25+
It requires spinning the vehicle around all axes, which allows it to calibrate the
2626
readings to the expected local magnetic field.
2727
</p>
2828
<p>
29-
A Valid position is <strong>recomended</strong> for Onboard Calibration to estimate the
30-
local world magnetic field.
29+
A valid global region/position is <strong>recomended</strong> for Onboard Calibration to
30+
estimate the local world magnetic field.
3131
</p>
3232
</span>
3333
<span v-else-if="state === states.CALIBRATING">
34-
Spin your vehicle around all of its axis until the progress bar completes.
34+
Spin your vehicle around all of its axes until the progress bar completes.
3535
</span>
3636

3737
<auto-coordinate-detector

core/frontend/src/components/vehiclesetup/configuration/compass/LargeVehicleCompassCalibrator.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
Large Vehicle Compass Calibration
1919
</v-card-title>
2020
<v-card-text>
21-
A Valid position is required for Compass Learn to estimate the local world magnetic field.
21+
A valid global region/position is required to estimate the local world magnetic field.
2222
<auto-coordinate-detector
2323
v-model="coordinates"
2424
/>

0 commit comments

Comments
 (0)