Copter: further explain even if RTL_ALT set to zero, copter still climb to 2m… #8799
Conversation
chobitsfan
force-pushed
the
pr_rtl_alt_comment
branch
2 times, most recently
from
60eb8e3
to
ce5a1ff
Compare
|
Yes, you are right |
…mb to 2m above ground
chobitsfan
force-pushed
the
pr_rtl_alt_comment
branch
from
ce5a1ff
to
42a000c
Compare
There was a problem hiding this comment.
@amilcarlucas Referring code constants in user descriptions is a bad idea, please don't ask people to do that.
@chobitsfan What do you think of my inline suggestion? Am I missing something?
| @@ -108,7 +108,7 @@ const AP_Param::Info Copter::var_info[] = { | |||
| #if MODE_RTL_ENABLED == ENABLED | |||
| // @Param: RTL_ALT | |||
| // @DisplayName: RTL Altitude | |||
| // @Description: The minimum relative altitude the model will move to before Returning to Launch. Set to zero to return at current altitude. | |||
| // @Description: The minimum relative altitude the model will move to before Returning to Launch. Set to zero to return at current altitude. Copter still climb to 2m above ground if its current altitude lower than 2m (defined as RTL_ALT_MIN in config.h) | |||
| // @Units: cm | |||
| // @Range: 0 8000 | |||
There was a problem hiding this comment.
Why don't we change the range to start at 200 instead (and remove the part about zero)?
The description could probably be improved to something like The minimum altitude above home the vehicle will move to before Returning to Launch. If TERRAIN_FOLLOW is enabled and terrain data is available, vehicle will follow terrain at the altitude set here.
|
Consolidated changes and merged, thanks! |
|
@OXINARF If the value of the constant changes in the code.. the description will go out of sync with the real value (i.e. 3m instead of 2m) What is the rationale behind your request? |
|
I actually agree with @OXINARF. The parameter descriptions are really for regular users, not for developers. |
… above ground
In current description of RTL_ALT, it states "Set to zero to return at current altitude". But if current altitude of a copter is below 2m above ground, it will climb up to 2m (defined as RTL_ALT_MIN in config.h) rather than "current altitude"). It works well outdoor, but when a copter fly indoor, it may hit ceiling. And user will feel confused about why copter climb up with RTL_ALT = 0.