| blob | 75cb4667af0920068e93efb1beb2973b4b1f263c |
1 # Command Line Interface (CLI)
3 Cleanflight has a command line interface (CLI) that can be used to change settings and configure the FC.
5 ## Accessing the CLI.
7 The CLI can be accessed via the GUI tool or via a terminal emulator connected to the CLI serial port.
9 1. Connect your terminal emulator to the CLI serial port (which, by default, is the same as the MSP serial port)
10 2. Use the baudrate specified by msp_baudrate (115200 by default).
11 3. Send a `#` character.
13 To save your settings type in 'save', saving will reboot the flight controller.
15 To exit the CLI without saving power off the flight controller or type in 'exit'.
17 To see a list of other commands type in 'help' and press return.
19 To dump your configuration (including the current profile), use the 'dump' command.
21 See the other documentation sections for details of the cli commands and settings that are available.
23 ## Backup via CLI
25 Disconnect main power, connect to cli via USB/FTDI.
27 dump using cli
29 ```
30 rateprofile 0
31 profile 0
32 dump
33 ```
35 dump profiles using cli if you use them
37 ```
38 profile 1
39 dump profile
40 profile 2
41 dump profile
42 ```
44 dump rate profiles using cli if you use them
46 ```
47 rateprofile 1
48 dump rates
49 rateprofile 2
50 dump rates
51 ```
52 copy screen output to a file and save it.
54 ## Restore via CLI.
56 Use the cli `defaults` command first.
58 When restoring from a backup it is a good idea to do a dump of the latest defaults so you know what has changed - if you do this each time a firmware release is created youwill be able to see the cli changes between firmware versions. For instance, in December 2014 the default GPS navigation PIDs changed. If you blindly restore your backup you would not benefit from these new defaults.
60 Use the CLI and send all the output from the saved from the backup commands.
62 Do not send the file too fast, if you do the FC might not be able to keep up when using USART adapters (including built in ones) since there is no hardware serial flow control.
64 You may find you have to copy/paste a few lines at a time.
66 Repeat the backup process again!
68 Compare the two backups to make sure you are happy with your restored settings.
70 Re-apply any new defaults as desired.
72 ## CLI Command Reference
74 | Command | Description |
75 |----------------|------------------------------------------------|
76 | adjrange | show/set adjustment ranges settings |
77 | aux | show/set aux settings |
78 | cmix | design custom mixer |
79 | color | configure colors |
80 | defaults | reset to defaults and reboot |
81 | dump | print configurable settings in a pastable form |
82 | exit | |
83 | feature | list or -val or val |
84 | get | get variable value |
85 | gpspassthrough | passthrough gps to serial |
86 | help | |
87 | led | configure leds |
88 | map | mapping of rc channel order |
89 | mixer | mixer name or list |
90 | motor | get/set motor output value |
91 | profile | index (0 to 2) |
92 | rateprofile | index (0 to 2) |
93 | save | save and reboot |
94 | set | name=value or blank or * for list |
95 | status | show system status |
96 | version | |
98 ## CLI Variable Reference
100 | Variable | Description/Units | Min | Max | Default | Type | Datatype |
101 |-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|--------|---------------|--------------|----------|
102 | looptime | This is the main loop time (in us). Changing this affects PID effect with some PID controllers (see PID section for details). Default of 3500us/285Hz should work for everyone. Setting it to zero does not limit loop time, so it will go as fast as possible. | 0 | 9000 | 3500 | Master | UINT16 |
103 | emf_avoidance | Default value is 0 for 72MHz processor speed. Setting this to 1 increases the processor speed, to move the 6th harmonic away from 432MHz. | 0 | 1 | 0 | Master | UINT8 |
104 | mid_rc | This is an important number to set in order to avoid trimming receiver/transmitter. Most standard receivers will have this at 1500, however Futaba transmitters will need this set to 1520. A way to find out if this needs to be changed, is to clear all trim/subtrim on transmitter, and connect to GUI. Note the value most channels idle at - this should be the number to choose. Once midrc is set, use subtrim on transmitter to make sure all channels (except throttle of course) are centered at midrc value. | 1200 | 1700 | 1500 | Master | UINT16 |
105 | min_check | These are min/max values (in us) which, when a channel is smaller (min) or larger (max) than the value will activate various RC commands, such as arming, or stick configuration. Normally, every RC channel should be set so that min = 1000us, max = 2000us. On most transmitters this usually means 125% endpoints. Default check values are 100us above/below this value. | 0 | 2000 | 1100 | Master | UINT16 |
106 | max_check | These are min/max values (in us) which, when a channel is smaller (min) or larger (max) than the value will activate various RC commands, such as arming, or stick configuration. Normally, every RC channel should be set so that min = 1000us, max = 2000us. On most transmitters this usually means 125% endpoints. Default check values are 100us above/below this value. | 0 | 2000 | 1900 | Master | UINT16 |
107 | rssi_channel | | 0 | 18 | 0 | Master | INT8 |
108 | rssi_scale | | 1 | 255 | 30 | Master | UINT8 |
109 | input_filtering_mode | | 0 | 1 | 0 | Master | INT8 |
110 | min_throttle | These are min/max values (in us) that are sent to esc when armed. Defaults of 1150/1850 are OK for everyone, for use with AfroESC, they could be set to 1064/1864. | 0 | 2000 | 1150 | Master | UINT16 |
111 | max_throttle | These are min/max values (in us) that are sent to esc when armed. Defaults of 1150/1850 are OK for everyone, for use with AfroESC, they could be set to 1064/1864. | 0 | 2000 | 1850 | Master | UINT16 |
112 | min_command | This is the PWM value sent to ESCs when they are not armed. If ESCs beep slowly when powered up, try decreasing this value. It can also be used for calibrating all ESCs at once. | 0 | 2000 | 1000 | Master | UINT16 |
113 | servo_center_pulse | | 0 | 2000 | 1500 | Master | UINT16 |
114 | 3d_deadband_low | | 0 | 2000 | 1406 | Master | UINT16 |
115 | 3d_deadband_high | | 0 | 2000 | 1514 | Master | UINT16 |
116 | 3d_neutral | | 0 | 2000 | 1460 | Master | UINT16 |
117 | 3d_deadband_throttle | | 0 | 2000 | 50 | Master | UINT16 |
118 | motor_pwm_rate | Output frequency (in Hz) for motor pins. Defaults are 400Hz for motor. If setting above 500Hz, will switch to brushed (direct drive) motors mode. For example, setting to 8000 will use brushed mode at 8kHz switching frequency. Up to 32kHz is supported. Note, that in brushed mode, minthrottle is offset to zero. Default is 16000 for boards with brushed motors. | 50 | 32000 | 400 | Master | UINT16 |
119 | servo_pwm_rate | Output frequency (in Hz) servo pins. Default is 50Hz. When using tricopters or gimbal with digital servo, this rate can be increased. Max of 498Hz (for 500Hz pwm period), and min of 50Hz. Most digital servos will support for example 330Hz. | 50 | 498 | 50 | Master | UINT16 |
120 | retarded_arm | Disabled by default, enabling (setting to 1) allows disarming by throttle low + roll. This could be useful for non-acro tricopters, where default arming by yaw could move tail servo too much. | 0 | 1 | 0 | Master | UINT8 |
121 | disarm_kill_switch | Enabled by default. Disarms the motors independently of throttle value. Setting to 0 reverts to the old behaviour of disarming only when the throttle is low. Only applies when arming and disarming with an AUX channel. | 0 | 1 | 1 | Master | UINT8 |
122 | auto_disarm_delay | | 0 | 60 | 5 | Master | UINT8 |
123 | small_angle | If the copter tilt angle exceed this value the copter will refuse to arm. default is 25°. | 0 | 180 | 25 | Master | UINT8 |
124 | pid_at_min_throttle | If enabled, the copter will process the pid algorithm at minimum throttle. | 0 | 1 | 1 | Master | UINT8 |
125 | flaps_speed | | 0 | 100 | 0 | Master | UINT8 |
126 | fixedwing_althold_dir | | -1 | 1 | 1 | Master | INT8 |
127 | reboot_character | | 48 | 126 | 82 | Master | UINT8 |
128 | gps_provider | | 0 | 1 | 0 | Master | UINT8 |
129 | gps_sbas_mode | | 0 | 4 | 0 | Master | UINT8 |
130 | gps_auto_config | | 0 | 1 | 1 | Master | UINT8 |
131 | gps_auto_baud | | 0 | 1 | 0 | Master | UINT8 |
132 | gps_pos_p | | 0 | 200 | 15 | Profile | UINT8 |
133 | gps_pos_i | | 0 | 200 | 0 | Profile | UINT8 |
134 | gps_pos_d | | 0 | 200 | 0 | Profile | UINT8 |
135 | gps_posr_p | | 0 | 200 | 34 | Profile | UINT8 |
136 | gps_posr_i | | 0 | 200 | 14 | Profile | UINT8 |
137 | gps_posr_d | | 0 | 200 | 53 | Profile | UINT8 |
138 | gps_nav_p | | 0 | 200 | 25 | Profile | UINT8 |
139 | gps_nav_i | | 0 | 200 | 33 | Profile | UINT8 |
140 | gps_nav_d | | 0 | 200 | 83 | Profile | UINT8 |
141 | gps_wp_radius | | 0 | 2000 | 200 | Profile | UINT16 |
142 | nav_controls_heading | | 0 | 1 | 1 | Profile | UINT8 |
143 | nav_speed_min | | 10 | 2000 | 100 | Profile | UINT16 |
144 | nav_speed_max | | 10 | 2000 | 300 | Profile | UINT16 |
145 | nav_slew_rate | | 0 | 100 | 30 | Profile | UINT8 |
146 | serialrx_provider | When feature SERIALRX is enabled, this allows connection to several receivers which output data via digital interface resembling serial. See RX section. | 0 | 6 | 0 | Master | UINT8 |
147 | spektrum_sat_bind | | 0 | 10 | 0 | Master | UINT8 |
148 | telemetry_switch | Which aux channel to use to change serial output & baud rate (MSP / Telemetry). It disables automatic switching to Telemetry when armed. | 0 | 1 | 0 | Master | UINT8 |
149 | telemetry_inversion | | 0 | 1 | 0 | Master | UINT8 |
150 | frsky_default_lattitude | | -90 | 90 | 0 | Master | FLOAT |
151 | frsky_default_longitude | | -180 | 180 | 0 | Master | FLOAT |
152 | frsky_coordinates_format | | 0 | 1 | 0 | Master | UINT8 |
153 | frsky_unit | | 0 | 1 | 0 | Master | UINT8 |
154 | battery_capacity | | 0 | 20000 | 0 | Master | UINT16 |
155 | vbat_scale | Result is Vbatt in 0.1V steps. 3.3V = ADC Vref, 4095 = 12bit adc, 110 = 11:1 voltage divider (10k:1k) x 10 for 0.1V. Adjust this slightly if reported pack voltage is different from multimeter reading. You can get current voltage by typing "status"" in cli." | 0 | 255 | 110 | Master | UINT8 |
156 | vbat_max_cell_voltage | Maximum voltage per cell, used for auto-detecting battery voltage in 0.1V units, default is 43 (4.3V) | 10 | 50 | 43 | Master | UINT8 |
157 | vbat_min_cell_voltage | Minimum voltage per cell, this triggers battery out alarms, in 0.1V units, default is 33 (3.3V) | 10 | 50 | 33 | Master | UINT8 |
158 | vbat_warning_cell_voltage | | 10 | 50 | 35 | Master | UINT8 |
159 | current_meter_scale | This sets the output voltage to current scaling for the current sensor in 0.1 mV/A steps. 400 is 40mV/A such as the ACS756 sensor outputs. 183 is the setting for the Überdistro with a 0.25mOhm shunt. | -10000 | 10000 | 400 | Master | INT16 |
160 | current_meter_offset | This sets the output offset voltage of the current sensor in millivolts. | 0 | 3300 | 0 | Master | UINT16 |
161 | multiwii_current_meter_output | Default current output via MSP is in 0.01A steps. Setting this to 1 causes output in default multiwii scaling (1mA steps). | 0 | 1 | None defined! | Master | UINT8 |
162 | current_meter_type | | 0 | 2 | 1 | Master | UINT8 |
163 | align_gyro | When running on non-default hardware or adding support for new sensors/sensor boards, these values are used for sensor orientation. Default of zero means the driver determines alignment (and this generally means it's configured for standard hardware). Default orientation of X forward, Y right, Z up is 1. After that, the numbers are as follows, and mean sensor is rotated. CW0_DEG=1, CW90_DEG=2, CW180_DEG=3, CW270_DEG=4, CW0_DEG_FLIP=5, CW90_DEG_FLIP=6, CW180_DEG_FLIP=7, CW270_DEG_FLIP=8. This should cover all orientations. When carefully understood, these values can also be used to rotate (in 90deg steps) or flip the board. | 0 | 8 | 0 | Master | UINT8 |
164 | align_acc | When running on non-default hardware or adding support for new sensors/sensor boards, these values are used for sensor orientation. Default of zero means the driver determines alignment (and this generally means it's configured for standard hardware). Default orientation of X forward, Y right, Z up is 1. After that, the numbers are as follows, and mean sensor is rotated. CW0_DEG=1, CW90_DEG=2, CW180_DEG=3, CW270_DEG=4, CW0_DEG_FLIP=5, CW90_DEG_FLIP=6, CW180_DEG_FLIP=7, CW270_DEG_FLIP=8. This should cover all orientations. When carefully understood, these values can also be used to rotate (in 90deg steps) or flip the board. | 0 | 8 | 0 | Master | UINT8 |
165 | align_mag | When running on non-default hardware or adding support for new sensors/sensor boards, these values are used for sensor orientation. Default of zero means the driver determines alignment (and this generally means it's configured for standard hardware). Default orientation of X forward, Y right, Z up is 1. After that, the numbers are as follows, and mean sensor is rotated. CW0_DEG=1, CW90_DEG=2, CW180_DEG=3, CW270_DEG=4, CW0_DEG_FLIP=5, CW90_DEG_FLIP=6, CW180_DEG_FLIP=7, CW270_DEG_FLIP=8. This should cover all orientations. When carefully understood, these values can also be used to rotate (in 90deg steps) or flip the board. | 0 | 8 | 0 | Master | UINT8 |
166 | align_board_roll | Arbitrary board rotation in degrees, to allow mounting it sideways / upside down / rotated etc | -180 | 360 | 0 | Master | INT16 |
167 | align_board_pitch | Arbitrary board rotation in degrees, to allow mounting it sideways / upside down / rotated etc | -180 | 360 | 0 | Master | INT16 |
168 | align_board_yaw | Arbitrary board rotation in degrees, to allow mounting it sideways / upside down / rotated etc | -180 | 360 | 0 | Master | INT16 |
169 | max_angle_inclination | This setting controls max inclination (tilt) allowed in angle (level) mode. default 500 (50 degrees). | 100 | 900 | 500 | Master | UINT16 |
170 | gyro_lpf | Hardware lowpass filter for gyro. Allowed values depend on the driver - For example MPU6050 allows 5,10,20,42,98,188,256Hz, while MPU3050 doesn't allow 5Hz. If you have to set gyro lpf below 42Hz generally means the frame is vibrating too much, and that should be fixed first. Values outside of supported range will usually be ignored by drivers, and will configure lpf to default value of 42Hz. | 0 | 256 | 42 | Master | UINT16 |
171 | moron_threshold | When powering up, gyro bias is calculated. If the model is shaking/moving during this initial calibration, offsets are calculated incorrectly, and could lead to poor flying performance. This threshold (default of 32) means how much average gyro reading could differ before re-calibration is triggered. | 0 | 128 | 32 | Master | UINT8 |
172 | gyro_cmpf_factor | | 100 | 1000 | 600 | Master | UINT16 |
173 | gyro_cmpfm_factor | | 100 | 1000 | 250 | Master | UINT16 |
174 | alt_hold_deadband | | 1 | 250 | 40 | Profile | UINT8 |
175 | alt_hold_fast_change | | 0 | 1 | 1 | Profile | UINT8 |
176 | deadband | These are values (in us) by how much RC input can be different before it's considered valid. For transmitters with jitter on outputs, this value can be increased. Defaults are zero, but can be increased up to 10 or so if rc inputs twitch while idle. | 0 | 32 | 0 | Profile | UINT8 |
177 | yaw_deadband | These are values (in us) by how much RC input can be different before it's considered valid. For transmitters with jitter on outputs, this value can be increased. Defaults are zero, but can be increased up to 10 or so if rc inputs twitch while idle. | 0 | 100 | 0 | Profile | UINT8 |
178 | throttle_correction_value | The throttle_correction_value will be added to the throttle input. It will be maximal at the throttle_correction_angle and over, null when the copter is leveled and proportional in bewteen. The angle is set with 0.1 deg steps from 1 to 900, ie : 300 = 30.0 deg, 225 = 22.5 deg. | 0 | 150 | 0 | Profile | UINT8 |
179 | throttle_correction_angle | The throttle_correction_value will be added to the throttle input. It will be maximal at the throttle_correction_angle and over, null when the copter is leveled and proportional in bewteen. The angle is set with 0.1 deg steps from 1 to 900, ie : 300 = 30.0 deg, 225 = 22.5 deg. | 1 | 900 | 800 | Profile | UINT16 |
180 | yaw_control_direction | | -1 | 1 | 1 | Master | INT8 |
181 | yaw_direction | | -1 | 1 | 1 | Profile | INT8 |
182 | tri_unarmed_servo | On tricopter mix only, if this is set to 1, servo will always be correcting regardless of armed state. to disable this, set it to 0. | 0 | 1 | 1 | Profile | INT8 |
183 | default_rate_profile | Default = profile number | 0 | 2 | | Profile | UINT8 |
184 | rc_rate | | 0 | 250 | 90 | Rate Profile | UINT8 |
185 | rc_expo | | 0 | 100 | 65 | Rate Profile | UINT8 |
186 | thr_mid | | 0 | 100 | 50 | Rate Profile | UINT8 |
187 | thr_expo | | 0 | 100 | 0 | Rate Profile | UINT8 |
188 | roll_pitch_rate | | 0 | 100 | 0 | Rate Profile | UINT8 |
189 | yaw_rate | | 0 | 100 | 0 | Rate Profile | UINT8 |
190 | tpa_rate | | 0 | 100 | 0 | Rate Profile | UINT8 |
191 | tpa_breakpoint | | 1000 | 2000 | 1500 | Rate Profile | UINT16 |
192 | failsafe_delay | | 0 | 200 | 10 | Profile | UINT8 |
193 | failsafe_off_delay | | 0 | 200 | 200 | Profile | UINT8 |
194 | failsafe_throttle | | 1000 | 2000 | 1200 | Profile | UINT16 |
195 | failsafe_min_usec | | 100 | 2000 | 985 | Profile | UINT16 |
196 | failsafe_max_usec | | 100 | 3000 | 2115 | Profile | UINT16 |
197 | gimbal_flags | When feature SERVO_TILT is enabled, this can be a combination of the following numbers: 1=normal gimbal (default), 2=tiltmix gimbal, 4=in PPM (or SERIALRX) input mode, this will forward AUX1..4 RC inputs to PWM5..8 pins | 0 | 255 | 1 | Profile | UINT8 |
198 | acc_hardware | This is used to suggest which accelerometer driver should load, or to force no accelerometer in case gyro-only flight is needed. Default (0) will attempt to auto-detect among enabled drivers. Otherwise, to force a particular device, set it to 2 for ADXL345, 3 for MPU6050 integrated accelerometer, 4 for MMA8452, 5 for BMA280, 6 for LSM303DLHC, 7 for SPI_MPU6000, 8 for SPI_MPU6500 or 1 to disable accelerometer alltogether - resulting in gyro-only operation. | 0 | 9 | 0 | Master | UINT8 |
199 | acc_lpf_factor | | 0 | 250 | 4 | Profile | UINT8 |
200 | accxy_deadband | | 0 | 100 | 40 | Profile | UINT8 |
201 | accz_deadband | | 0 | 100 | 40 | Profile | UINT8 |
202 | accz_lpf_cutoff | | 1 | 20 | 5 | Profile | FLOAT |
203 | acc_unarmedcal | | 0 | 1 | 1 | Profile | UINT8 |
204 | acc_trim_pitch | | -300 | 300 | 0 | Profile | INT16 |
205 | acc_trim_roll | | -300 | 300 | 0 | Profile | INT16 |
206 | baro_tab_size | | 0 | 48 | 21 | Profile | UINT8 |
207 | baro_noise_lpf | | 0 | 1 | 0.6 | Profile | FLOAT |
208 | baro_cf_vel | | 0 | 1 | 0.985 | Profile | FLOAT |
209 | baro_cf_alt | | 0 | 1 | 0.965 | Profile | FLOAT |
210 | mag_hardware | | 0 | 3 | 0 | Master | UINT8 |
211 | mag_declination | Current location magnetic declination in format. For example, -6deg 37min, = for Japan. Leading zero in ddd not required. Get your local magnetic declination here: http://magnetic-declination.com/ | -18000 | 18000 | 0 | Profile | INT16 |
212 | pid_controller | | 0 | 4 | 0 | Profile | UINT8 |
213 | p_pitch | | 0 | 200 | 40 | Profile | UINT8 |
214 | i_pitch | | 0 | 200 | 30 | Profile | UINT8 |
215 | d_pitch | | 0 | 200 | 23 | Profile | UINT8 |
216 | p_roll | | 0 | 200 | 40 | Profile | UINT8 |
217 | i_roll | | 0 | 200 | 30 | Profile | UINT8 |
218 | d_roll | | 0 | 200 | 23 | Profile | UINT8 |
219 | p_yaw | | 0 | 200 | 85 | Profile | UINT8 |
220 | i_yaw | | 0 | 200 | 45 | Profile | UINT8 |
221 | d_yaw | | 0 | 200 | 0 | Profile | UINT8 |
222 | p_pitchf | | 0 | 100 | 2.5 | Profile | FLOAT |
223 | i_pitchf | | 0 | 100 | 0.6 | Profile | FLOAT |
224 | d_pitchf | | 0 | 100 | 0.06 | Profile | FLOAT |
225 | p_rollf | | 0 | 100 | 2.5 | Profile | FLOAT |
226 | i_rollf | | 0 | 100 | 0.6 | Profile | FLOAT |
227 | d_rollf | | 0 | 100 | 0.06 | Profile | FLOAT |
228 | p_yawf | | 0 | 100 | 8 | Profile | FLOAT |
229 | i_yawf | | 0 | 100 | 0.5 | Profile | FLOAT |
230 | d_yawf | | 0 | 100 | 0.05 | Profile | FLOAT |
231 | level_horizon | | 0 | 10 | 3 | Profile | FLOAT |
232 | level_angle | | 0 | 10 | 5 | Profile | FLOAT |
233 | sensitivity_horizon | | 0 | 250 | 75 | Profile | UINT8 |
234 | p_alt | | 0 | 200 | 50 | Profile | UINT8 |
235 | i_alt | | 0 | 200 | 0 | Profile | UINT8 |
236 | d_alt | | 0 | 200 | 0 | Profile | UINT8 |
237 | p_level | | 0 | 200 | 90 | Profile | UINT8 |
238 | i_level | | 0 | 200 | 10 | Profile | UINT8 |
239 | d_level | | 0 | 200 | 100 | Profile | UINT8 |
240 | p_vel | | 0 | 200 | 120 | Profile | UINT8 |
241 | i_vel | | 0 | 200 | 45 | Profile | UINT8 |
242 | d_vel | | 0 | 200 | 1 | Profile | UINT8 |
243 | blackbox_rate_num | | 1 | 32 | 1 | Master | UINT8 |
244 | blackbox_rate_denom | | 1 | 32 | 1 | Master | UINT8 |