Skip to content

Commit 4fb0fdb

Browse files
committed
update documentation to reflect experimental
1 parent 3633c75 commit 4fb0fdb

1 file changed

Lines changed: 19 additions & 31 deletions

File tree

docs/Terrain.md

Lines changed: 19 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,13 @@
11
# Terrain
2-
3-
<div style="
4-
background-color: #fff3e0;
5-
border-left: 5px solid #f57c00;
6-
border-radius: 4px;
7-
padding: 12px 16px;
8-
display: flex;
9-
align-items: center;
10-
gap: 10px;
11-
">
12-
<span style="font-size: 20px;">⚠️</span>
13-
<div>
14-
<strong style="color: #e65100;">Experimental</strong>
15-
<p style="margin: 2px 0 0 0; color: #bf360c; font-size: 14px;">
16-
This feature is experimental. Use it with caution.
17-
</p>
18-
</div>
19-
</div>
20-
21-
```mermaid
22-
flowchart TD
23-
SD[Terrain data on SD card]
24-
GPS[GPS position]
25-
BARO[Baro altitude]
26-
AGL[Computed AGL]
27-
28-
SD --> AGL
29-
GPS --> AGL
30-
BARO --> AGL
2+
```
3+
┌─────────────────────────────────────────────────┐
4+
│ ===Experimental=== │
5+
│ This feature is experimental. Use it with │
6+
│ caution. │
7+
└─────────────────────────────────────────────────┘
318
```
329

33-
This feature is available **only on H7-based flight controllers with an SD card** (preferably SDIO). Due to the high CPU load
10+
This feature is available **only on H7-based and F4-based flight controllers with an SD card** (preferably SDIO). Due to the high CPU load
3411
and SD card read speed requirements of terrain data processing, it is not supported on weaker hardware.
3512

3613
This feature in iNav determines the model’s altitude above ground level using preloaded elevation maps
@@ -82,4 +59,15 @@ them to display altitude above terrain.
8259
Finally, it is **strongly recommended to use only high-quality, branded SD cards** from reputable manufacturers. The terrain
8360
system is sensitive to SD card read speed and reliability, and low-quality or counterfeit cards may cause read errors,
8461
display dropouts, or automatic disabling of the feature during flight. Using a quality SD card significantly improves the
85-
stability and reliability of the terrain feature.
62+
stability and reliability of the terrain feature.
63+
64+
# TL;DR
65+
66+
- **H7/F4 flight controller** with SD card required
67+
- Format SD card using [SD Memory Card Formatter](https://www.sdcard.org/downloads/formatter/sd-memory-card-formatter-for-windows-download/) (max 4 GB partition)
68+
- Generate terrain data at https://terrain.ardupilot.org/ — select **SRTM1 (30 m)**
69+
- Delete `FREESPAC.E` from SD card root before copying files (use external card reader, not MSC)
70+
- Enable via CLI: `set terrain_enabled = ON` + `save`
71+
- Enable **Rangefinder distance** OSD element to see altitude above terrain
72+
- ⚠️ Displayed value is **informational only** — not used for navigation or altitude control
73+
- Use only **high-quality branded SD cards**

0 commit comments

Comments
 (0)