From 941cf6fa69e2589273f5141a7222b49393d2999e Mon Sep 17 00:00:00 2001 From: Adam M Rivera Date: Sat, 28 Apr 2012 12:14:17 -0500 Subject: [PATCH 1/3] Parameters.pde: Added more parameter comments. --- ArduCopter/Parameters.pde | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/ArduCopter/Parameters.pde b/ArduCopter/Parameters.pde index e59c1e8dfb..ced15fcee5 100644 --- a/ArduCopter/Parameters.pde +++ b/ArduCopter/Parameters.pde @@ -33,23 +33,55 @@ static const AP_Param::Info var_info[] PROGMEM = { // @Param: SONAR_ENABLE // @DisplayName: Enable Sonar // @Description: Setting this to true (1) will enable the sonar. Setting this to false(0) will disable the sonar + // @Values: 0,1 // @User: Standard GSCALAR(sonar_enabled, "SONAR_ENABLE"), GSCALAR(sonar_type, "SONAR_TYPE"), GSCALAR(battery_monitoring, "BATT_MONITOR"), + + // @Param: VOLT_DIVIDER + // @DisplayName: Voltage Divider + // @Description: TODO GSCALAR(volt_div_ratio, "VOLT_DIVIDER"), + GSCALAR(curr_amp_per_volt, "AMP_PER_VOLT"), GSCALAR(input_voltage, "INPUT_VOLTS"), GSCALAR(pack_capacity, "BATT_CAPACITY"), + + // @Param: MAG_ENABLE + // @DisplayName: Enable Compass + // @Description: Setting this to true (1) will enable the compass. Setting this to false(0) will disable the compass + // @Values: 0,1 + // @User: Standard GSCALAR(compass_enabled, "MAG_ENABLE"), + + // @Param: FLOW_ENABLE + // @DisplayName: Enable Optical Flow + // @Description: Setting this to true (1) will enable optical flow. Setting this to false(0) will disable optical flow + // @Values: 0,1 + // @User: Standard GSCALAR(optflow_enabled, "FLOW_ENABLE"), + + // @Param: LOW_VOLT + // @DisplayName: Low Voltage + // @Description: Set this to the voltage you want to represent low voltage + // @Range: 0 20 + // @Increment: .1 + // @User: Standard GSCALAR(low_voltage, "LOW_VOLT"), + + // @Param: SUPER_SIMPLE + // @DisplayName: Enable Super Simple Mode + // @Description: Setting this to true (1) will enable Super Simple Mode. Setting this to false(0) will disable Super Simple Mode + // @Values: 0,1 + // @User: Standard GSCALAR(super_simple, "SUPER_SIMPLE"), // @Param: RTL_LAND // @DisplayName: RTL Land // @Description: Setting this to true (1) will enable landing after RTL. Setting this to false(0) will disable landing after RTL. + // @Values: 0,1 // @User: Standard GSCALAR(rtl_land_enabled, "RTL_LAND"), @@ -65,6 +97,7 @@ static const AP_Param::Info var_info[] PROGMEM = { // @Param: RETRO_LOITER // @DisplayName: Retro Loiter // @Description: Setting this to true (1) will enable the Loiter from 2.0.49. Setting this to false(0) will use the most recent Loiter routines. + // @Values: 0,1 // @User: Standard GSCALAR(retro_loiter, "RETRO_LOITER"), From 40fdba441bd8f76a85a78a91ed62aee043239368 Mon Sep 17 00:00:00 2001 From: Adam M Rivera Date: Sat, 28 Apr 2012 20:35:22 -0500 Subject: [PATCH 2/3] Parameters.pde: Added value aliases to comments --- ArduCopter/Parameters.pde | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/ArduCopter/Parameters.pde b/ArduCopter/Parameters.pde index ced15fcee5..5d78f47b88 100644 --- a/ArduCopter/Parameters.pde +++ b/ArduCopter/Parameters.pde @@ -33,7 +33,7 @@ static const AP_Param::Info var_info[] PROGMEM = { // @Param: SONAR_ENABLE // @DisplayName: Enable Sonar // @Description: Setting this to true (1) will enable the sonar. Setting this to false(0) will disable the sonar - // @Values: 0,1 + // @Values: 0:Disabled,1:Enabled // @User: Standard GSCALAR(sonar_enabled, "SONAR_ENABLE"), @@ -52,14 +52,14 @@ static const AP_Param::Info var_info[] PROGMEM = { // @Param: MAG_ENABLE // @DisplayName: Enable Compass // @Description: Setting this to true (1) will enable the compass. Setting this to false(0) will disable the compass - // @Values: 0,1 + // @Values: 0:Disabled,1:Enabled // @User: Standard GSCALAR(compass_enabled, "MAG_ENABLE"), // @Param: FLOW_ENABLE // @DisplayName: Enable Optical Flow // @Description: Setting this to true (1) will enable optical flow. Setting this to false(0) will disable optical flow - // @Values: 0,1 + // @Values: 0:Disabled,1:Enabled // @User: Standard GSCALAR(optflow_enabled, "FLOW_ENABLE"), @@ -74,14 +74,14 @@ static const AP_Param::Info var_info[] PROGMEM = { // @Param: SUPER_SIMPLE // @DisplayName: Enable Super Simple Mode // @Description: Setting this to true (1) will enable Super Simple Mode. Setting this to false(0) will disable Super Simple Mode - // @Values: 0,1 + // @Values: 0:Disabled,1:Enabled // @User: Standard GSCALAR(super_simple, "SUPER_SIMPLE"), // @Param: RTL_LAND // @DisplayName: RTL Land // @Description: Setting this to true (1) will enable landing after RTL. Setting this to false(0) will disable landing after RTL. - // @Values: 0,1 + // @Values: 0:Disabled,1:Enabled // @User: Standard GSCALAR(rtl_land_enabled, "RTL_LAND"), @@ -97,7 +97,7 @@ static const AP_Param::Info var_info[] PROGMEM = { // @Param: RETRO_LOITER // @DisplayName: Retro Loiter // @Description: Setting this to true (1) will enable the Loiter from 2.0.49. Setting this to false(0) will use the most recent Loiter routines. - // @Values: 0,1 + // @Values: 0:Disabled,1:Enabled // @User: Standard GSCALAR(retro_loiter, "RETRO_LOITER"), From 56d3fa160164e7a7efd94095b81b4075c9e9ff0c Mon Sep 17 00:00:00 2001 From: Adam M Rivera Date: Sat, 28 Apr 2012 20:50:41 -0500 Subject: [PATCH 3/3] Parameters.pde/AP_MotorsHeli: Updated comments to leverage the new value aliases --- ArduCopter/Parameters.pde | 12 ++++++------ libraries/AP_Motors/AP_MotorsHeli.cpp | 6 ++++-- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/ArduCopter/Parameters.pde b/ArduCopter/Parameters.pde index 5d78f47b88..bba9b1519d 100644 --- a/ArduCopter/Parameters.pde +++ b/ArduCopter/Parameters.pde @@ -32,7 +32,7 @@ static const AP_Param::Info var_info[] PROGMEM = { // @Param: SONAR_ENABLE // @DisplayName: Enable Sonar - // @Description: Setting this to true (1) will enable the sonar. Setting this to false(0) will disable the sonar + // @Description: Setting this to Enabled(1) will enable the sonar. Setting this to Disabled(0) will disable the sonar // @Values: 0:Disabled,1:Enabled // @User: Standard GSCALAR(sonar_enabled, "SONAR_ENABLE"), @@ -51,14 +51,14 @@ static const AP_Param::Info var_info[] PROGMEM = { // @Param: MAG_ENABLE // @DisplayName: Enable Compass - // @Description: Setting this to true (1) will enable the compass. Setting this to false(0) will disable the compass + // @Description: Setting this to Enabled(1) will enable the compass. Setting this to Disabled(0) will disable the compass // @Values: 0:Disabled,1:Enabled // @User: Standard GSCALAR(compass_enabled, "MAG_ENABLE"), // @Param: FLOW_ENABLE // @DisplayName: Enable Optical Flow - // @Description: Setting this to true (1) will enable optical flow. Setting this to false(0) will disable optical flow + // @Description: Setting this to Enabled(1) will enable optical flow. Setting this to Disabled(0) will disable optical flow // @Values: 0:Disabled,1:Enabled // @User: Standard GSCALAR(optflow_enabled, "FLOW_ENABLE"), @@ -73,14 +73,14 @@ static const AP_Param::Info var_info[] PROGMEM = { // @Param: SUPER_SIMPLE // @DisplayName: Enable Super Simple Mode - // @Description: Setting this to true (1) will enable Super Simple Mode. Setting this to false(0) will disable Super Simple Mode + // @Description: Setting this to Enabled(1) will enable Super Simple Mode. Setting this to Disabled(0) will disable Super Simple Mode // @Values: 0:Disabled,1:Enabled // @User: Standard GSCALAR(super_simple, "SUPER_SIMPLE"), // @Param: RTL_LAND // @DisplayName: RTL Land - // @Description: Setting this to true (1) will enable landing after RTL. Setting this to false(0) will disable landing after RTL. + // @Description: Setting this to Enabled(1) will enable landing after RTL. Setting this to Disabled(0) will disable landing after RTL. // @Values: 0:Disabled,1:Enabled // @User: Standard GSCALAR(rtl_land_enabled, "RTL_LAND"), @@ -96,7 +96,7 @@ static const AP_Param::Info var_info[] PROGMEM = { // @Param: RETRO_LOITER // @DisplayName: Retro Loiter - // @Description: Setting this to true (1) will enable the Loiter from 2.0.49. Setting this to false(0) will use the most recent Loiter routines. + // @Description: Setting this to Enabled(1) will enable the Loiter from 2.0.49. Setting this to Disabled(0) will use the most recent Loiter routines. // @Values: 0:Disabled,1:Enabled // @User: Standard GSCALAR(retro_loiter, "RETRO_LOITER"), diff --git a/libraries/AP_Motors/AP_MotorsHeli.cpp b/libraries/AP_Motors/AP_MotorsHeli.cpp index 9678ea1145..16a42a0b9e 100644 --- a/libraries/AP_Motors/AP_MotorsHeli.cpp +++ b/libraries/AP_Motors/AP_MotorsHeli.cpp @@ -87,7 +87,8 @@ const AP_Param::GroupInfo AP_MotorsHeli::var_info[] PROGMEM = { // @Param: GYR_ENABLE // @DisplayName: External Gyro Enabled - // @Description: Setting this to true (1) will enable an external rudder gyro control. Setting this to false(0) will disable the external gyro control and will revert to internal rudder control. + // @Description: Setting this to Enabled(1) will enable an external rudder gyro control. Setting this to Disabled(0) will disable the external gyro control and will revert to internal rudder control. + // @Values: 0:Disabled,1:Enabled // @User: Standard AP_GROUPINFO("GYR_ENABLE", 9, AP_MotorsHeli, ext_gyro_enabled), @@ -108,7 +109,8 @@ const AP_Param::GroupInfo AP_MotorsHeli::var_info[] PROGMEM = { // @Param: SV_MAN // @DisplayName: Manual Servo Mode - // @Description: Setting this to true (1) will pass radio inputs directly to servos. Setting this to false(0) will enable Arducopter control of servos. + // @Description: Setting this to Enabled(1) will pass radio inputs directly to servos. Setting this to Disabled(0) will enable Arducopter control of servos. + // @Values: 0:Disabled,1:Enabled // @User: Standard AP_GROUPINFO("SV_MAN", 12, AP_MotorsHeli, servo_manual),