From 28746e84aea50402fbf9e255da89c9e9029dc744 Mon Sep 17 00:00:00 2001 From: Randy Mackay Date: Thu, 28 Sep 2023 11:07:39 +0900 Subject: [PATCH] AP_Scripting: winch-control gets .md file --- .../{winch-test.lua => winch-control.lua} | 0 .../AP_Scripting/applets/winch-control.md | 20 +++++++++++++++++++ 2 files changed, 20 insertions(+) rename libraries/AP_Scripting/applets/{winch-test.lua => winch-control.lua} (100%) create mode 100644 libraries/AP_Scripting/applets/winch-control.md diff --git a/libraries/AP_Scripting/applets/winch-test.lua b/libraries/AP_Scripting/applets/winch-control.lua similarity index 100% rename from libraries/AP_Scripting/applets/winch-test.lua rename to libraries/AP_Scripting/applets/winch-control.lua diff --git a/libraries/AP_Scripting/applets/winch-control.md b/libraries/AP_Scripting/applets/winch-control.md new file mode 100644 index 0000000000..9238faf7f3 --- /dev/null +++ b/libraries/AP_Scripting/applets/winch-control.md @@ -0,0 +1,20 @@ +# Winch Control + +Allows the winch to be deployed or retracted at a fixed speed using an auxiliary switch + +# Parameters + +WINCH_RATE_UP : rate (in m/s) when retracting line +WINCH_RATE_DN : rate (in m/s) when deploying line +WINCH_RC_FUNC : RCn_OPTION number to use to control winch rate. Default is 300 (Scripting1) + +# How To Use + +1. set RCx_OPTION to 300 to enable controlling the winch rate from an auxiliary switch +2. set WINCH_RATE_UP to the fixed retract speed (in m/s) +3. set WINCH_RATE_DN to the fixed release speed (in m/s) +4. raise the RC auxiliary switch to retract the winch's line +5. lower the RC auxiliary switch to deploy the winch's line +6. center the RC auxiliary switch to stop the winch + +Alternatively Mission Planner's Aux Function screen can be used in place of an actual RC switch