zrzk
/
zr-v4
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

AP_Limits: reverted parameter doc changes

master
Andrew Tridgell 12 years ago
parent
b70f7f57ba
commit
6ee32ea872
4 changed files with 14 additions and 39 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 17
      libraries/AP_Limits/AP_Limit_Altitude.cpp
  2. 6
      libraries/AP_Limits/AP_Limit_GPSLock.cpp
  3. 13
      libraries/AP_Limits/AP_Limit_Geofence.cpp
  4. 17
      libraries/AP_Limits/AP_Limits.cpp

17
libraries/AP_Limits/AP_Limit_Altitude.cpp
Unescape View File

@ -13,28 +13,21 @@ @@ -13,28 +13,21 @@
const AP_Param::GroupInfo AP_Limit_Altitude::var_info[] PROGMEM = {
// @Param: ALT_ON
// @DisplayName: Enable altitude
// @Description: Setting this to Enabled(1) will enable the altitude.
// Setting this to Disabled(0) will disable the altitude
// @Description: Setting this to Enabled(1) will enable the altitude. Setting this to Disabled(0) will disable the altitude
// @Values: 0:Disabled,1:Enabled
// @User: Standard
AP_GROUPINFO("ALT_ON", 0, AP_Limit_Altitude, _enabled, 0),
// @Param: ALT_REQD
// @DisplayName: Require altitude
// @Description: Setting this to Enabled(1) will make being inside the
// altitude a required check before arming the vehicle.
// @Description: Setting this to Enabled(1) will make being inside the altitude a required check before arming the vehicle.
// @Values: 0:Disabled,1:Enabled
// @User: Standard
AP_GROUPINFO("ALT_REQ", 1, AP_Limit_Altitude, _required, 0),
// @Param: ALT_MIN
// @DisplayName: Minimum Altitude
// @Description: Minimum Altitude. Zero to disable. Sets a "floor" that
// your vehicle will try to stay above. IF the vehicle is crossing the
// threshold at speed, it will take a while to recover, so give yourself
// enough room. Caution: minimum altitude limits can cause unexpected
// behaviour, such as inability to land, or sudden takeoff. Read the wiki
// instructions before setting.
// @Description: Minimum Altitude. Zero to disable. Sets a "floor" that your vehicle will try to stay above. IF the vehicle is crossing the threshold at speed, it will take a while to recover, so give yourself enough room. Caution: minimum altitude limits can cause unexpected behaviour, such as inability to land, or sudden takeoff. Read the wiki instructions before setting.
// @Units: Meters
// @Range: 0 250000
// @Increment: 1
@ -43,9 +36,7 @@ const AP_Param::GroupInfo AP_Limit_Altitude::var_info[] PROGMEM = { @@ -43,9 +36,7 @@ const AP_Param::GroupInfo AP_Limit_Altitude::var_info[] PROGMEM = {
// @Param: ALT_MAX
// @DisplayName: Maximum Altitude
// @Description: Maximum Altitude. Zero to disable. Sets a "ceiling" that
// your vehicle will try to stay below. IF the vehicle is crossing the
// threshold at speed, it will take a while to recover.
// @Description: Maximum Altitude. Zero to disable. Sets a "ceiling" that your vehicle will try to stay below. IF the vehicle is crossing the threshold at speed, it will take a while to recover.
// @Units: Meters
// @Range: 0 250000
// @Increment: 1

6
libraries/AP_Limits/AP_Limit_GPSLock.cpp
Unescape View File

@ -13,16 +13,14 @@ @@ -13,16 +13,14 @@
const AP_Param::GroupInfo AP_Limit_GPSLock::var_info[] PROGMEM = {
// @Param: GPSLCK_ON
// @DisplayName: Enable gpslock
// @Description: Setting this to Enabled(1) will enable the gpslock.
// Setting this to Disabled(0) will disable the gpslock
// @Description: Setting this to Enabled(1) will enable the gpslock. Setting this to Disabled(0) will disable the gpslock
// @Values: 0:Disabled,1:Enabled
// @User: Standard
AP_GROUPINFO("GPSLCK_ON", 0, AP_Limit_GPSLock, _enabled, 0),
// @Param: GPSLCK_REQ
// @DisplayName: Require gpslock
// @Description: Setting this to Enabled(1) will make being inside the
// gpslock a required check before arming the vehicle.
// @Description: Setting this to Enabled(1) will make being inside the gpslock a required check before arming the vehicle.
// @Values: 0:Disabled,1:Enabled
// @User: Standard
AP_GROUPINFO("GPSLCK_REQ", 1, AP_Limit_GPSLock, _required, 0),

13
libraries/AP_Limits/AP_Limit_Geofence.cpp
Unescape View File

@ -12,33 +12,28 @@ @@ -12,33 +12,28 @@
const AP_Param::GroupInfo AP_Limit_Geofence::var_info[] PROGMEM = {
// @Param: FNC_ON
// @DisplayName: Enable Geofence
// @Description: Setting this to Enabled(1) will enable the geofence.
// Setting this to Disabled(0) will disable the geofence
// @Description: Setting this to Enabled(1) will enable the geofence. Setting this to Disabled(0) will disable the geofence
// @Values: 0:Disabled,1:Enabled
// @User: Standard
AP_GROUPINFO("FNC_ON", 0, AP_Limit_Geofence, _enabled, 0),
// @Param: FNC_REQ
// @DisplayName: Require Geofence
// @Description: Setting this to Enabled(1) will make being inside the
// geofence a required check before arming the vehicle.
// @Description: Setting this to Enabled(1) will make being inside the geofence a required check before arming the vehicle.
// @Values: 0:Disabled,1:Enabled
// @User: Standard
AP_GROUPINFO("FNC_REQ", 1, AP_Limit_Geofence, _required, 0),
// @Param: FNC_SMPL
// @DisplayName: Require Geofence
// @Description: "Simple" geofence (enabled - 1) is based on a radius from
// the home position, "Complex" (disabled - 0) define a complex fence by
// lat/long positions
// @Description: "Simple" geofence (enabled - 1) is based on a radius from the home position, "Complex" (disabled - 0) define a complex fence by lat/long positions
// @Values: 0:Disabled,1:Enabled
// @User: Standard
AP_GROUPINFO("FNC_SMPL", 2, AP_Limit_Geofence, _simple, 0),
// @Param: FNC_RAD
// @DisplayName: Require Geofence
// @Description: Radius of fenced area in meters. A value of 20 creates a
// 20-meter radius circle (40-meter diameter) from the home point.
// @Description: Radius of fenced area in meters. A value of 20 creates a 20-meter radius circle (40-meter diameter) from the home point.
// @Units: Meters
// @Range: 0 32767
// @Increment: 1

17
libraries/AP_Limits/AP_Limits.cpp
Unescape View File

@ -27,37 +27,28 @@ const AP_Param::GroupInfo AP_Limits::var_info[] PROGMEM = { @@ -27,37 +27,28 @@ const AP_Param::GroupInfo AP_Limits::var_info[] PROGMEM = {
// @Param: DEBUG
// @DisplayName: Enable Limits Debug
// @Description: Setting this to 1 will turn on debugging messages on the
// console and via MAVLink STATUSTEXT messages
// @Description: Setting this to 1 will turn on debugging messages on the console and via MAVLink STATUSTEXT messages
// @Values: 0:Disabled,1:Enabled
// @User: Standard
AP_GROUPINFO("DEBUG", 2, AP_Limits, _debug, 0),
// @Param: SAFETIME
// @DisplayName: Limits Safetime
// @Description: Automatic return of controls to pilot. Set to 0 to disable
// (full RTL) or a number of seconds after complete recovery to return the
// controls to the pilot in STABILIZE
// @Description: Automatic return of controls to pilot. Set to 0 to disable (full RTL) or a number of seconds after complete recovery to return the controls to the pilot in STABILIZE
// @Values: 0:Disabled,1-255:Seconds before returning control
// @User: Standard
AP_GROUPINFO("SAFETIME", 3, AP_Limits, _safetime, 0),
// @Param: CHANNEL
// @DisplayName: Limits Channel
// @Description: Channel for Limits on/off control. If channel exceeds
// LIMITS_ENABLE_PWM, it turns limits on, and vice-versa.
// @Description: Channel for Limits on/off control. If channel exceeds LIMITS_ENABLE_PWM, it turns limits on, and vice-versa.
// @Range: 1-8
// @User: Standard
AP_GROUPINFO("CHANNEL", 4, AP_Limits, _channel, 0),
// @Param: RECMODE
// @DisplayName: Limits Recovery Mode
// @Description: Select how Limits should "recover". Set to 0 for RTL-like
// mode, where the vehicle navigates back to home until it is "safe". Set
// to 1, for bounce-mode, where the vehicle will hold position when it hits
// a limit. RTL mode is better for large fenced areas, Bounce mode for
// smaller spaces. Note: RTL mode will cause the vehicle to yaw 180 degrees
// (turn around) to navigate towards home when it hits a limit.
// @Description: Select how Limits should "recover". Set to 0 for RTL-like mode, where the vehicle navigates back to home until it is "safe". Set to 1, for bounce-mode, where the vehicle will hold position when it hits a limit. RTL mode is better for large fenced areas, Bounce mode for smaller spaces. Note: RTL mode will cause the vehicle to yaw 180 degrees (turn around) to navigate towards home when it hits a limit.
// @Values: 0:RTL mode, 1: Bounce mode
// @User: Standard
AP_GROUPINFO("RECMODE", 5, AP_Limits, _recmode, 0),

Write Preview
Loading…
Cancel
Save