Commander params: improve meta data for max flight time and wind

Signed-off-by: Silvan Fuhrer <silvan@auterion.com>
This commit is contained in:
Silvan Fuhrer 2023-01-30 16:41:26 +01:00
parent 6d84da5cf1
commit cbc4c35bcf

View File

@ -1,6 +1,6 @@
/****************************************************************************
*
* Copyright (c) 2013-2015 PX4 Development Team. All rights reserved.
* Copyright (c) 2013-2023 PX4 Development Team. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
@ -1025,12 +1025,11 @@ PARAM_DEFINE_FLOAT(COM_SPOOLUP_TIME, 1.0f);
* Wind speed warning threshold
*
* A warning is triggered if the currently estimated wind speed is above this value.
* Warning is sent periodically (every 1min).
* Warning is sent periodically (every 1 minute).
*
* A negative value disables the feature.
* Set to -1 to disable.
*
* @min -1
* @max 30
* @decimal 1
* @increment 0.1
* @group Commander
@ -1043,29 +1042,31 @@ PARAM_DEFINE_FLOAT(COM_WIND_WARN, -1.f);
*
* The vehicle aborts the current operation and returns to launch when
* the time since takeoff is above this value. It is not possible to resume the
* mission or switch to any mode other than RTL or Land.
* mission or switch to any auto mode other than RTL or Land. Taking over in any manual
* mode is still possible.
*
* Set a negative value to disable.
* Starting from 90% of the maximum flight time, a warning message will be sent
* every 1 minute with the remaining time until automatic RTL.
*
* Set to -1 to disable.
*
* @unit s
* @min -1
* @max 10000
* @value 0 Disable
* @group Commander
*/
PARAM_DEFINE_INT32(COM_FLT_TIME_MAX, -1);
/**
* Wind speed RLT threshold
* Wind speed RTL threshold
*
* Wind speed threshold above which an automatic return to launch is triggered
* and enforced as long as the threshold is exceeded.
* Wind speed threshold above which an automatic return to launch is triggered.
* It is not possible to resume the mission or switch to any auto mode other than
* RTL or Land if this threshold is exceeded. Taking over in any manual
* mode is still possible.
*
* A negative value disables the feature.
* Set to -1 to disable.
*
* @min -1
* @max 30
* @decimal 1
* @increment 0.1
* @group Commander