Skip to content
oleost edited this page Apr 14, 2016 · 49 revisions

Cleanflight CLI variables related to navigation features

General/Shared Variables

Variable Description/Units Min Max
align_mag When using an external magnetometer sensor this should be set to actual sensor alignment relative to board. Values: DEFAULT, CW0, CW90, CW180, CW270, CW0FLIP, CW90FLIP, CW180FLIP, CW270FLIP
align_board_roll Board alignment on ROLL axis (deg * 10) -1800 3600
align_board_pitch Board alignment on PITCH axis (deg * 10) -1800 3600
align_board_yaw Board alignment on YAW axis (deg * 10) -1800 3600
gps_provider GPS hardware type: NMEA, UBLOX, NAZA, I2C-NAV
gps_nav_model GPS navigation model: LOW_G (Pedestrian), HIGH_G (Airborne<4G). Currently supported only of Ublox GPS modules. HIGH_G may increase accuracy, especially on fast and agile airplanes, but it requires much better satellite signal quality. Safe default is "LOW_G".
failsafe_procedure Failsafe type: SET-THR - set throttle to failsafe_throttle, RTH - execute RTH sequence if possible, land otherwise
max_angle_inclination_rll Maximum inclination in level mode (ROLL axis) 100 900
max_angle_inclination_pit Maximum inclination in level mode (PITCH axis) 100 900
inav_accz_unarmedcal Controls if inertial position estimator should compute gravity offset on accelerometer Z-axis dynamically when drone is unarmed. Mostly affects accuracy of altitude estimation and althold performace. No real reason to disable this feature. OFF ON
inav_use_gps_velned Defined if iNav should use velocity data provided by GPS module for doing position and speed estimation. If set to OFF iNav will fallback to calculating velocity from GPS coordinates. Using native velocity data may improve performance on some GPS modules. Some GPS modules introduce significant delay and using native velocity may actually result in much worse performance. Safe default is "OFF" OFF ON
inav_gps_delay GPS position and velocity data usually arrive with a delay. This parameter defines this delay. Default should be reasonable for most GPS receivers. 0 500
inav_gps_min_sats Minimum number of GPS satellites in view to consider GPS position valid. Some GPS receivers appeared to be very inaccurate with low satellite count. 5 10
inav_w_z_baro_p 0 10
inav_w_z_gps_p 0 10
inav_w_z_gps_v 0 10
inav_w_xy_gps_p 0 10
inav_w_xy_gps_v 0 10
inav_w_xy_dr_v 0 10
inav_w_z_res_v 0 10
inav_w_xy_res_v 0 10
inav_w_acc_bias 0 1
inav_max_eph_epv 0 9999
inav_baro_epv 0 9999
nav_alt_p
nav_alt_i
nav_alt_d
nav_vel_p
nav_vel_i
nav_vel_d
nav_navr_p
nav_navr_i
nav_navr_d
nav_use_midrc_for_althold OFF ON
nav_disarm_on_landing OFF ON
nav_extra_arming_safety If set to ON drone won't arm if no GPS fix OFF ON
nav_user_control_mode Defines how Pitch/Roll input from RC receiver affects flight in POSHOLD mode: ATTI - right stick controls attitude like in ANGLE mode; CRUISE - right stick controls velocity in forward and right direction.
nav_position_timeout If GPS fails wait for this much seconds before switching to emergency landing mode (0 - disable) 0 10
nav_wp_radius Waypoint radius. Waypoint would be considered reached if machine is within this radius 100 2000
nav_max_speed Maximum velocity firmware is allowed in full auto modes (POSHOLD, RTH, WP) 10 2000
nav_manual_speed Maximum velocity firmware is allowed when processing pilot input for POSHOLD/CRUISE control mode
nav_manual_climb_rate Maximum climb/descent rate firmware is allowed when processing pilot input for ALTHOLD control mode
nav_pos_hold_deadband 10 250
nav_alt_hold_deadband 10 250
nav_min_rth_distance
nav_rth_alt_mode Altitude control mode: CURRENT, EXTRA, FIXED, MAX, AT_LEAST
nav_rth_altitude
gyro_soft_lpf_hz Software-based filter to remove mechanical vibrations from the gyro signal. Value is cutoff frequency (Hz). For larger frames with bigger props set to lower value. Default 60Hz 0 200
acc_soft_lpf_hz Software-based filter to remove mechanical vibrations from the accelerometer measurements. Value is cutoff frequency (Hz). For larger frames with bigger props set to lower value. Default 15Hz 0 200
baro_use_median_filter
magzero_x
magzero_y
magzero_z
acczero_x
acczero_y
acczero_z
accgain_x
accgain_y
accgain_z

Multirotor

Variable Description/Units Min Max
nav_mc_bank_angle Maximum banking angle (deg) that multicopter navigation is allowed to set. Machine must be able to satisfy this angle without loosing altitude 15 45
nav_mc_hover_thr Multicopter hover throttle hint for altitude controller. Should be set to approximate throttle value when drone is hovering. 1000 2000
nav_mc_min_fly_thr Max throttle value treated as one of the conditions for landing detection. Must be sufficiently low to guarantee the "not flying" state even with full battery, but high enough for Altitude Hold controller to reach it. 1000 2000
throttle_tilt_comp_str Can be used in ANGLE and HORIZON mode and will automatically boost throttle when banking. Setting is in percentage, 0=disabled. 0 100
nav_pos_p Controls how fast the drone will fly towards the target position. This is a multiplier to convert displacement to target velocity
nav_pos_i Controls deceleration time. Measured in 1/100 sec. Expected hold position is placed at a distance calculated as decelerationTime * currentVelocity
nav_pos_d
nav_posr_p P gain of Position-Rate (Velocity to Acceleration) PID controller. Higher P means stronger response when position error occurs. Too much P might cause "nervous" behavior and oscillations 0 255
nav_posr_i I gain of Position-Rate (Velocity to Acceleration) PID controller. Used for drift compensation (caused by wind for example). Higher I means stronger response to drift. Too much I gain might cause target overshot 0 255
nav_posr_d D gain of Position-Rate (Velocity to Acceleration) PID controller. It can damp P and I. Increasing D might help when drone overshoots target. 0 255

Fixed-Wing

Variable Description/Units Min Max
nav_fw_cruise_thr
nav_fw_min_thr
nav_fw_max_thr
nav_fw_bank_angle
nav_fw_climb_angle
nav_fw_dive_angle
nav_fw_pitch2thr
nav_fw_roll2pitch
nav_fw_loiter_radius

WIKI TOPICS

Wiki Home Page

INAV Version Release Notes

7.1.0 Release Notes
7.0.0 Release Notes
6.0.0 Release Notes
5.1 Release notes
5.0.0 Release Notes
4.1.0 Release Notes
4.0.0 Release Notes
3.0.0 Release Notes
2.6.0 Release Notes
2.5.1 Release notes
2.5.0 Release Notes
2.4.0 Release Notes
2.3.0 Release Notes
2.2.1 Release Notes
2.2.0 Release Notes
2.1.0 Release Notes
2.0.0 Release Notes
1.9.1 Release notes
1.9.0 Release notes
1.8.0 Release notes
1.7.3 Release notes
Older Release Notes

QUICK START GUIDES

Getting started with iNav
Fixed Wing Guide
Howto: CC3D flight controller, minimOSD , telemetry and GPS for fixed wing
Howto: CC3D flight controller, minimOSD, GPS and LTM telemetry for fixed wing
INAV for BetaFlight users
launch mode
Multirotor guide
YouTube video guides
DevDocs Getting Started.md
DevDocs INAV_Fixed_Wing_Setup_Guide.pdf
DevDocs Safety.md

Connecting to INAV

Bluetooth setup to configure your flight controller
DevDocs Wireless Connections (BLE, TCP and UDP).md\

Flashing and Upgrading

Boards, Targets and PWM allocations
Upgrading from an older version of INAV to the current version
DevDocs Installation.md
DevDocs USB Flashing.md

Setup Tab
Live 3D Graphic & Pre-Arming Checks

Calibration Tab
Accelerometer, Compass, & Optic Flow Calibration

Alignment Tool Tab
Adjust mount angle of FC & Compass

Ports Tab
Map Devices to UART Serial Ports

Receiver Tab
Set protocol and channel mapping

Mixer

Mixer Tab
Custom mixes for exotic setups
DevDocs Mixer.md

Outputs

DevDocs ESC and servo outputs.md
DevDocs Servo.md

Modes

Modes
Navigation modes
Navigation Mode: Return to Home
DevDocs Controls.md
DevDocs INAV_Modes.pdf
DevDocs Navigation.md

Configuration

Sensor auto detect and hardware failure detection

Failsafe

Failsafe
DevDocs Failsafe.md

PID Tuning

EZ-Tune
PID Attenuation and scaling
Fixed Wing Tuning for INAV 3.0
Tune INAV PIFF controller for fixedwing
DevDocs Autotune - fixedwing.md
DevDocs INAV PID Controller.md
DevDocs INAV_Wing_Tuning_Masterclass.pdf
DevDocs PID tuning.md
DevDocs Profiles.md

GPS

GPS and Compass setup
GPS Failsafe and Glitch Protection

OSD and VTx

DevDocs Betaflight 4.3 compatible OSD.md
OSD custom messages
OSD Hud and ESP32 radars
DevDocs OSD.md
DevDocs VTx.md

LED Strip

DevDocs LedStrip.md

ADVANCED

Advanced Tuning

Fixed Wing Autolaunch
DevDocs INAV_Autolaunch.pdf

Programming

DevDocs Programming Framework.md

Adjustments

DevDocs Inflight Adjustments.md

Mission Control

iNavFlight Missions
DevDocs Safehomes.md

Tethered Logging

Log when FC is connected via USB

Blackbox

DevDocs Blackbox.md
INAV blackbox variables
DevDocs USB_Mass_Storage_(MSC)_mode.md

CLI

iNav CLI variables
DevDocs Cli.md
DevDocs Settings.md

VTOL

DevDocs MixerProfile.md
DevDocs VTOL.md

TROUBLESHOOTING

"Something" is disabled Reasons
Blinkenlights
Pixel OSD FAQs
TROUBLESHOOTING
Why do I have limited servo throw in my airplane

ADTL TOPICS, FEATURES, DEV INFO

AAT Automatic Antenna Tracker
Building custom firmware
Default values for different type of aircrafts
Features safe to add and remove to fit your needs.
Developer info
INAV MSP frames changelog
INAV Remote Management, Control and Telemetry
Lightweight Telemetry (LTM)
Making a new Virtualbox to make your own INAV
MSP Navigation Messages
MSP V2
OrangeRX LRS RX and OMNIBUS F4
Rate Dynamics
Target and Sensor support
UAV Interconnect Bus
Ublox 3.01 firmware and Galileo
DevDocs 1wire.md
DevDocs ADSB.md
DevDocs Battery.md
DevDocs Buzzer.md
DevDocs Channel forwarding.md
DevDocs Display.md
DevDocs Fixed Wing Landing.md
DevDocs GPS_fix_estimation.md
DevDocs LED pin PWM.md
DevDocs Lights.md
DevDocs OSD Joystick.md
DevDocs Servo Gimbal.md
DevDocs Temperature sensors.md

OLD LEGACY INFO

Supported boards
DevDocs Boards.md
Legacy Mixers
Legacy target ChebuzzF3
Legacy target Colibri RACE
Legacy target Motolab
Legacy target Omnibus F3
Legacy target Paris Air Hero 32
Legacy target Paris Air Hero 32 F3
Legacy target Sparky
Legacy target SPRacingF3
Legacy target SPRacingF3EVO
Legacy target SPRacingF3EVO_1SS
DevDocs Configuration.md
Request form new PRESET
DevDocs Introduction.md
Welcome to INAV, useful links and products
iNav Telemetry
DevDocs Rangefinder.md
DevDocs Rssi.md
DevDocs Runcam device.md
DevDocs Serial.md
DevDocs Telemetry.md
DevDocs Rx.md
DevDocs Spektrum bind.md

Clone this wiki locally