Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Geozones.md #10466

Merged
merged 17 commits into from
Nov 15, 2024
Merged

Geozones.md #10466

merged 17 commits into from
Nov 15, 2024

Conversation

b14ckyy
Copy link
Collaborator

@b14ckyy b14ckyy commented Nov 14, 2024

Documentation for the Geozones feature. Related to iNavFlight/inav-configurator#2237

@stronnag
Copy link
Collaborator

Looking good. Can you add a CLI section as the user will need some of this, for example:

geozone_detection_distance = 50000
Allowed range: 0 - 1000000

geozone_avoid_altitude_range = 5000
Allowed range: 0 - 1000000

geozone_safe_altitude_distance = 1000
Allowed range: 0 - 10000

geozone_safehome_as_inclusive = OFF
Allowed values: OFF, ON

geozone_safehome_zone_action = NONE
Allowed values: NONE, AVOID, POS_HOLD, RTH

geozone_mr_stop_distance = 15000
Allowed range: 0 - 100000

geozone_no_way_home_action = RTH
Allowed values: RTH, EMRG_LAND

As well as the management commands:

geozone reset
geozone vertex reset

geozone id type shape minalt maxalt amsl action
geozone vertex zoneid vertexid latitude longitude

@stronnag
Copy link
Collaborator

On reflection, the get / set options are already in Settings.md, so there is no point in duplicating them.

But the "management" commands are not otherwise documented.

@b14ckyy
Copy link
Collaborator Author

b14ckyy commented Nov 14, 2024

Good point and for the "Additional Settings" I will add the CLI parameter names as well

added missing CLI commands and array field
@stronnag
Copy link
Collaborator

Your definition for geozone is obsolete, a altitude reference parameter has been added after maxalt
0 = relative, 1 = AMSL

geozone id type shape minalt maxalt is_amsl action

added AMSL to geozone fields
@b14ckyy
Copy link
Collaborator Author

b14ckyy commented Nov 14, 2024

Thanks for that. in your example it misses: vertices count: 0-126 at the end.
Should be correct in the doc now.

@b14ckyy b14ckyy added this to the 8.0 milestone Nov 14, 2024
@b14ckyy b14ckyy merged commit 0308c89 into iNavFlight:master Nov 15, 2024
1 check passed
@b14ckyy b14ckyy deleted the Geozones.md branch November 15, 2024 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants