BTN_ parameters¶
14 parameters in the BTN_ family. ArduCopter 4.7 only — other vehicles share many of these names but not always the same ranges or meanings.
BTN_ENABLE¶
Enable button reporting
This enables the button checking module. When this is disabled the parameters for setting button inputs are not visible
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
Disabled |
|
Enabled |
BTN_FUNC1¶
Button Pin 1 RC Channel function
Auxiliary RC Options function executed on pin change
User level |
Standard |
Values¶
Value |
Meaning |
|---|---|
|
Do Nothing |
|
FLIP Mode |
|
Simple Mode |
|
RTL |
|
Save Trim |
|
Save WP |
|
Camera Trigger |
|
RangeFinder Enable |
|
Fence Enable |
|
Super Simple Mode |
|
Acro Trainer |
|
Sprayer Enable |
|
AUTO Mode |
|
AUTOTUNE Mode |
|
LAND Mode |
|
Gripper |
|
Parachute Enable |
|
Parachute Release |
|
Parachute 3pos |
|
Auto Mission Reset |
|
AttCon Feed Forward |
|
AttCon Accel Limits |
|
Retract Mount1 |
|
Relay1 On/Off |
|
Landing Gear |
|
Lost Copter Sound |
|
Motor Emergency Stop |
|
Motor Interlock |
|
BRAKE Mode |
|
Relay2 On/Off |
|
Relay3 On/Off |
|
Relay4 On/Off |
|
THROW Mode |
|
ADSB Avoidance Enable |
|
PrecLoiter Enable |
|
Proximity Avoidance Enable |
|
ArmDisarm (4.1 and lower) |
|
SMARTRTL Mode |
|
InvertedFlight Enable |
|
Winch Enable |
|
Winch Control |
|
RC Override Enable |
|
User Function 1 |
|
User Function 2 |
|
User Function 3 |
|
ACRO Mode |
|
GUIDED Mode |
|
LOITER Mode |
|
FOLLOW Mode |
|
Clear Waypoints |
|
ZigZag Mode |
|
ZigZag SaveWP |
|
Compass Learn |
|
GPS Disable |
|
Relay5 On/Off |
|
Relay6 On/Off |
|
STABILIZE Mode |
|
POSHOLD Mode |
|
ALTHOLD Mode |
|
FLOWHOLD Mode |
|
CIRCLE Mode |
|
DRIFT Mode |
|
SurfaceTrackingUpDown |
|
STANDBY Mode |
|
RunCam Control |
|
RunCam OSD Control |
|
VisOdom Align |
|
Disarm |
|
ZigZag Auto |
|
AirMode |
|
Generator |
|
EKF Source Set |
|
VTX Power |
|
AUTO RTL |
|
KillIMU1 |
|
KillIMU2 |
|
Camera Mode Toggle |
|
EKF lane switch attempt |
|
EKF yaw reset |
|
GPS Disable Yaw |
|
use Custom Controller |
|
KillIMU3 |
|
Loweheiser starter |
|
SwitchExternalAHRS |
|
Retract Mount2 |
|
TURTLE Mode |
|
SIMPLE heading reset |
|
ArmDisarm (4.2 and higher) |
|
ArmDisarm with AirMode (4.2 and higher) |
|
Optflow Calibration |
|
Force IS_Flying |
|
Turbine Start(heli) |
|
FFT Tune |
|
Mount Yaw Lock |
|
Pause Stream Logging |
|
Arm/Emergency Motor Stop |
|
Camera Record Video |
|
Camera Zoom |
|
Camera Manual Focus |
|
Camera Auto Focus |
|
Calibrate Compasses |
|
Battery MPPT Enable |
|
Camera Image Tracking |
|
Camera Lens |
|
Mount LRF enable |
|
FlightMode Pause/Resume |
|
Test autotuned gains after tune is complete |
|
AHRS AutoTrim |
|
Mount Roll/Pitch Lock |
|
Mount POI Lock |
|
Mount1 Roll |
|
Mount1 Pitch |
|
Mount1 Yaw |
|
Mount2 Roll |
|
Mount2 Pitch |
|
Mount2 Yaw |
|
Loweheiser throttle |
|
Transmitter Tuning |
|
Scripting1 |
|
Scripting2 |
|
Scripting3 |
|
Scripting4 |
|
Scripting5 |
|
Scripting6 |
|
Scripting7 |
|
Scripting8 |
|
Scripting9 |
|
Scripting10 |
|
Scripting11 |
|
Scripting12 |
|
Scripting13 |
|
Scripting14 |
|
Scripting15 |
|
Scripting16 |
|
Stop-Restart Scripting |
BTN_FUNC2¶
Button Pin 2 RC Channel function
Auxiliary RC Options function executed on pin change
User level |
Standard |
Values¶
Value |
Meaning |
|---|---|
|
Do Nothing |
|
FLIP Mode |
|
Simple Mode |
|
RTL |
|
Save Trim |
|
Save WP |
|
Camera Trigger |
|
RangeFinder Enable |
|
Fence Enable |
|
Super Simple Mode |
|
Acro Trainer |
|
Sprayer Enable |
|
AUTO Mode |
|
AUTOTUNE Mode |
|
LAND Mode |
|
Gripper |
|
Parachute Enable |
|
Parachute Release |
|
Parachute 3pos |
|
Auto Mission Reset |
|
AttCon Feed Forward |
|
AttCon Accel Limits |
|
Retract Mount1 |
|
Relay1 On/Off |
|
Landing Gear |
|
Lost Copter Sound |
|
Motor Emergency Stop |
|
Motor Interlock |
|
BRAKE Mode |
|
Relay2 On/Off |
|
Relay3 On/Off |
|
Relay4 On/Off |
|
THROW Mode |
|
ADSB Avoidance Enable |
|
PrecLoiter Enable |
|
Proximity Avoidance Enable |
|
ArmDisarm (4.1 and lower) |
|
SMARTRTL Mode |
|
InvertedFlight Enable |
|
Winch Enable |
|
Winch Control |
|
RC Override Enable |
|
User Function 1 |
|
User Function 2 |
|
User Function 3 |
|
ACRO Mode |
|
GUIDED Mode |
|
LOITER Mode |
|
FOLLOW Mode |
|
Clear Waypoints |
|
ZigZag Mode |
|
ZigZag SaveWP |
|
Compass Learn |
|
GPS Disable |
|
Relay5 On/Off |
|
Relay6 On/Off |
|
STABILIZE Mode |
|
POSHOLD Mode |
|
ALTHOLD Mode |
|
FLOWHOLD Mode |
|
CIRCLE Mode |
|
DRIFT Mode |
|
SurfaceTrackingUpDown |
|
STANDBY Mode |
|
RunCam Control |
|
RunCam OSD Control |
|
VisOdom Align |
|
Disarm |
|
ZigZag Auto |
|
AirMode |
|
Generator |
|
EKF Source Set |
|
VTX Power |
|
AUTO RTL |
|
KillIMU1 |
|
KillIMU2 |
|
Camera Mode Toggle |
|
EKF lane switch attempt |
|
EKF yaw reset |
|
GPS Disable Yaw |
|
use Custom Controller |
|
KillIMU3 |
|
Loweheiser starter |
|
SwitchExternalAHRS |
|
Retract Mount2 |
|
TURTLE Mode |
|
SIMPLE heading reset |
|
ArmDisarm (4.2 and higher) |
|
ArmDisarm with AirMode (4.2 and higher) |
|
Optflow Calibration |
|
Force IS_Flying |
|
Turbine Start(heli) |
|
FFT Tune |
|
Mount Yaw Lock |
|
Pause Stream Logging |
|
Arm/Emergency Motor Stop |
|
Camera Record Video |
|
Camera Zoom |
|
Camera Manual Focus |
|
Camera Auto Focus |
|
Calibrate Compasses |
|
Battery MPPT Enable |
|
Camera Image Tracking |
|
Camera Lens |
|
Mount LRF enable |
|
FlightMode Pause/Resume |
|
Test autotuned gains after tune is complete |
|
AHRS AutoTrim |
|
Mount Roll/Pitch Lock |
|
Mount POI Lock |
|
Mount1 Roll |
|
Mount1 Pitch |
|
Mount1 Yaw |
|
Mount2 Roll |
|
Mount2 Pitch |
|
Mount2 Yaw |
|
Loweheiser throttle |
|
Transmitter Tuning |
|
Scripting1 |
|
Scripting2 |
|
Scripting3 |
|
Scripting4 |
|
Scripting5 |
|
Scripting6 |
|
Scripting7 |
|
Scripting8 |
|
Scripting9 |
|
Scripting10 |
|
Scripting11 |
|
Scripting12 |
|
Scripting13 |
|
Scripting14 |
|
Scripting15 |
|
Scripting16 |
|
Stop-Restart Scripting |
BTN_FUNC3¶
Button Pin 3 RC Channel function
Auxiliary RC Options function executed on pin change
User level |
Standard |
Values¶
Value |
Meaning |
|---|---|
|
Do Nothing |
|
FLIP Mode |
|
Simple Mode |
|
RTL |
|
Save Trim |
|
Save WP |
|
Camera Trigger |
|
RangeFinder Enable |
|
Fence Enable |
|
Super Simple Mode |
|
Acro Trainer |
|
Sprayer Enable |
|
AUTO Mode |
|
AUTOTUNE Mode |
|
LAND Mode |
|
Gripper |
|
Parachute Enable |
|
Parachute Release |
|
Parachute 3pos |
|
Auto Mission Reset |
|
AttCon Feed Forward |
|
AttCon Accel Limits |
|
Retract Mount1 |
|
Relay1 On/Off |
|
Landing Gear |
|
Lost Copter Sound |
|
Motor Emergency Stop |
|
Motor Interlock |
|
BRAKE Mode |
|
Relay2 On/Off |
|
Relay3 On/Off |
|
Relay4 On/Off |
|
THROW Mode |
|
ADSB Avoidance Enable |
|
PrecLoiter Enable |
|
Proximity Avoidance Enable |
|
ArmDisarm (4.1 and lower) |
|
SMARTRTL Mode |
|
InvertedFlight Enable |
|
Winch Enable |
|
Winch Control |
|
RC Override Enable |
|
User Function 1 |
|
User Function 2 |
|
User Function 3 |
|
ACRO Mode |
|
GUIDED Mode |
|
LOITER Mode |
|
FOLLOW Mode |
|
Clear Waypoints |
|
ZigZag Mode |
|
ZigZag SaveWP |
|
Compass Learn |
|
GPS Disable |
|
Relay5 On/Off |
|
Relay6 On/Off |
|
STABILIZE Mode |
|
POSHOLD Mode |
|
ALTHOLD Mode |
|
FLOWHOLD Mode |
|
CIRCLE Mode |
|
DRIFT Mode |
|
SurfaceTrackingUpDown |
|
STANDBY Mode |
|
RunCam Control |
|
RunCam OSD Control |
|
VisOdom Align |
|
Disarm |
|
ZigZag Auto |
|
AirMode |
|
Generator |
|
EKF Source Set |
|
VTX Power |
|
AUTO RTL |
|
KillIMU1 |
|
KillIMU2 |
|
Camera Mode Toggle |
|
EKF lane switch attempt |
|
EKF yaw reset |
|
GPS Disable Yaw |
|
use Custom Controller |
|
KillIMU3 |
|
Loweheiser starter |
|
SwitchExternalAHRS |
|
Retract Mount2 |
|
TURTLE Mode |
|
SIMPLE heading reset |
|
ArmDisarm (4.2 and higher) |
|
ArmDisarm with AirMode (4.2 and higher) |
|
Optflow Calibration |
|
Force IS_Flying |
|
Turbine Start(heli) |
|
FFT Tune |
|
Mount Yaw Lock |
|
Pause Stream Logging |
|
Arm/Emergency Motor Stop |
|
Camera Record Video |
|
Camera Zoom |
|
Camera Manual Focus |
|
Camera Auto Focus |
|
Calibrate Compasses |
|
Battery MPPT Enable |
|
Camera Image Tracking |
|
Camera Lens |
|
Mount LRF enable |
|
FlightMode Pause/Resume |
|
Test autotuned gains after tune is complete |
|
AHRS AutoTrim |
|
Mount Roll/Pitch Lock |
|
Mount POI Lock |
|
Mount1 Roll |
|
Mount1 Pitch |
|
Mount1 Yaw |
|
Mount2 Roll |
|
Mount2 Pitch |
|
Mount2 Yaw |
|
Loweheiser throttle |
|
Transmitter Tuning |
|
Scripting1 |
|
Scripting2 |
|
Scripting3 |
|
Scripting4 |
|
Scripting5 |
|
Scripting6 |
|
Scripting7 |
|
Scripting8 |
|
Scripting9 |
|
Scripting10 |
|
Scripting11 |
|
Scripting12 |
|
Scripting13 |
|
Scripting14 |
|
Scripting15 |
|
Scripting16 |
|
Stop-Restart Scripting |
BTN_FUNC4¶
Button Pin 4 RC Channel function
Auxiliary RC Options function executed on pin change
User level |
Standard |
Values¶
Value |
Meaning |
|---|---|
|
Do Nothing |
|
FLIP Mode |
|
Simple Mode |
|
RTL |
|
Save Trim |
|
Save WP |
|
Camera Trigger |
|
RangeFinder Enable |
|
Fence Enable |
|
Super Simple Mode |
|
Acro Trainer |
|
Sprayer Enable |
|
AUTO Mode |
|
AUTOTUNE Mode |
|
LAND Mode |
|
Gripper |
|
Parachute Enable |
|
Parachute Release |
|
Parachute 3pos |
|
Auto Mission Reset |
|
AttCon Feed Forward |
|
AttCon Accel Limits |
|
Retract Mount1 |
|
Relay1 On/Off |
|
Landing Gear |
|
Lost Copter Sound |
|
Motor Emergency Stop |
|
Motor Interlock |
|
BRAKE Mode |
|
Relay2 On/Off |
|
Relay3 On/Off |
|
Relay4 On/Off |
|
THROW Mode |
|
ADSB Avoidance Enable |
|
PrecLoiter Enable |
|
Proximity Avoidance Enable |
|
ArmDisarm (4.1 and lower) |
|
SMARTRTL Mode |
|
InvertedFlight Enable |
|
Winch Enable |
|
Winch Control |
|
RC Override Enable |
|
User Function 1 |
|
User Function 2 |
|
User Function 3 |
|
ACRO Mode |
|
GUIDED Mode |
|
LOITER Mode |
|
FOLLOW Mode |
|
Clear Waypoints |
|
ZigZag Mode |
|
ZigZag SaveWP |
|
Compass Learn |
|
GPS Disable |
|
Relay5 On/Off |
|
Relay6 On/Off |
|
STABILIZE Mode |
|
POSHOLD Mode |
|
ALTHOLD Mode |
|
FLOWHOLD Mode |
|
CIRCLE Mode |
|
DRIFT Mode |
|
SurfaceTrackingUpDown |
|
STANDBY Mode |
|
RunCam Control |
|
RunCam OSD Control |
|
VisOdom Align |
|
Disarm |
|
ZigZag Auto |
|
AirMode |
|
Generator |
|
EKF Source Set |
|
VTX Power |
|
AUTO RTL |
|
KillIMU1 |
|
KillIMU2 |
|
Camera Mode Toggle |
|
EKF lane switch attempt |
|
EKF yaw reset |
|
GPS Disable Yaw |
|
use Custom Controller |
|
KillIMU3 |
|
Loweheiser starter |
|
SwitchExternalAHRS |
|
Retract Mount2 |
|
TURTLE Mode |
|
SIMPLE heading reset |
|
ArmDisarm (4.2 and higher) |
|
ArmDisarm with AirMode (4.2 and higher) |
|
Optflow Calibration |
|
Force IS_Flying |
|
Turbine Start(heli) |
|
FFT Tune |
|
Mount Yaw Lock |
|
Pause Stream Logging |
|
Arm/Emergency Motor Stop |
|
Camera Record Video |
|
Camera Zoom |
|
Camera Manual Focus |
|
Camera Auto Focus |
|
Calibrate Compasses |
|
Battery MPPT Enable |
|
Camera Image Tracking |
|
Camera Lens |
|
Mount LRF enable |
|
FlightMode Pause/Resume |
|
Test autotuned gains after tune is complete |
|
AHRS AutoTrim |
|
Mount Roll/Pitch Lock |
|
Mount POI Lock |
|
Mount1 Roll |
|
Mount1 Pitch |
|
Mount1 Yaw |
|
Mount2 Roll |
|
Mount2 Pitch |
|
Mount2 Yaw |
|
Loweheiser throttle |
|
Transmitter Tuning |
|
Scripting1 |
|
Scripting2 |
|
Scripting3 |
|
Scripting4 |
|
Scripting5 |
|
Scripting6 |
|
Scripting7 |
|
Scripting8 |
|
Scripting9 |
|
Scripting10 |
|
Scripting11 |
|
Scripting12 |
|
Scripting13 |
|
Scripting14 |
|
Scripting15 |
|
Scripting16 |
|
Stop-Restart Scripting |
BTN_OPTIONS1¶
Button Pin 1 Options
Options for Pin 1. PWM input detects PWM above or below 1800/1200us instead of logic level. If PWM is not detected or is less than 800us or above 2200us the button will interpreted as low. Invert changes HIGH state to be logic low voltage on pin, or below 1200us, if PWM input.
User level |
Standard |
Bitmask¶
Value |
Meaning |
|---|---|
|
PWM Input |
|
InvertInput |
BTN_OPTIONS2¶
Button Pin 2 Options
Options for Pin 2. PWM input detects PWM above or below 1800/1200us instead of logic level. If PWM is not detected or is less than 800us or above 2200us the button will interpreted as low. Invert changes HIGH state to be logic low voltage on pin, or below 1200us, if PWM input.
User level |
Standard |
Bitmask¶
Value |
Meaning |
|---|---|
|
PWM Input |
|
InvertInput |
BTN_OPTIONS3¶
Button Pin 3 Options
Options for Pin 3. PWM input detects PWM above or below 1800/1200us instead of logic level. If PWM is not detected or is less than 800us or above 2200us the button will interpreted as low. Invert changes HIGH state to be logic low voltage on pin, or below 1200us, if PWM input.
Bitmask¶
Value |
Meaning |
|---|---|
|
PWM Input |
|
InvertInput |
BTN_OPTIONS4¶
Button Pin 4 Options
Options for Pin 4. PWM input detects PWM above or below 1800/1200us instead of logic level. If PWM is not detected or is less than 800us or above 2200us the button will interpreted as low. Invert changes HIGH state to be logic low voltage on pin, or below 1200us, if PWM input.
User level |
Standard |
Bitmask¶
Value |
Meaning |
|---|---|
|
PWM Input |
|
InvertInput |
BTN_PIN1¶
First button Pin
Digital pin number for first button input. Some common values are given, but see the Wiki’s “GPIOs” page for how to determine the pin number for a given autopilot.
Range |
|
User level |
Standard |
Values¶
Value |
Meaning |
|---|---|
|
Disabled |
|
AUXOUT1 |
|
AUXOUT2 |
|
AUXOUT3 |
|
AUXOUT4 |
|
AUXOUT5 |
|
AUXOUT6 |
BTN_PIN2¶
Second button Pin
Digital pin number for second button input. Some common values are given, but see the Wiki’s “GPIOs” page for how to determine the pin number for a given autopilot.
Range |
|
User level |
Standard |
Values¶
Value |
Meaning |
|---|---|
|
Disabled |
|
AUXOUT1 |
|
AUXOUT2 |
|
AUXOUT3 |
|
AUXOUT4 |
|
AUXOUT5 |
|
AUXOUT6 |
BTN_PIN3¶
Third button Pin
Digital pin number for third button input. Some common values are given, but see the Wiki’s “GPIOs” page for how to determine the pin number for a given autopilot.
Range |
|
User level |
Standard |
Values¶
Value |
Meaning |
|---|---|
|
Disabled |
|
AUXOUT1 |
|
AUXOUT2 |
|
AUXOUT3 |
|
AUXOUT4 |
|
AUXOUT5 |
|
AUXOUT6 |
BTN_PIN4¶
Fourth button Pin
Digital pin number for fourth button input. Some common values are given, but see the Wiki’s “GPIOs” page for how to determine the pin number for a given autopilot.
Range |
|
User level |
Standard |
Values¶
Value |
Meaning |
|---|---|
|
Disabled |
|
AUXOUT1 |
|
AUXOUT2 |
|
AUXOUT3 |
|
AUXOUT4 |
|
AUXOUT5 |
|
AUXOUT6 |
BTN_REPORT_SEND¶
Report send time
The duration in seconds that a BUTTON_CHANGE report is repeatedly sent to the GCS regarding a button changing state. Note that the BUTTON_CHANGE message is MAVLink2 only.
Range |
|
User level |
Standard |