iNavFlight / inav

INAV: Navigation-enabled flight control software
https://inavflight.github.io
GNU General Public License v3.0
3.21k stars 1.49k forks source link

Geozones.md #10466

Closed b14ckyy closed 1 week ago

b14ckyy commented 1 week ago

Documentation for the Geozones feature. Related to https://github.com/iNavFlight/inav-configurator/pull/2237

stronnag commented 1 week ago

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 commented 1 week ago

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 commented 1 week ago

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

stronnag commented 1 week ago

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
b14ckyy commented 1 week ago

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