docs/Cli.md

   1 # Command Line Interface (CLI)
   2
   3 Cleanflight has a command line interface (CLI) that can be used to change settings and configure the FC.
   4
   5 ## Accessing the CLI.
   6
   7 The CLI can be accessed via the GUI tool or via a terminal emulator connected to the CLI serial port.
   8
   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 cli_baudrate (115200 by default).
  11 3. Send a `#` character.
  12
  13 To save your settings type in 'save', saving will reboot the flight controller.
  14
  15 To exit the CLI without saving power off the flight controller or type in 'exit'.
  16
  17 To see a list of other commands type in 'help' and press return.
  18
  19 To dump your configuration (including the current profile), use the 'dump' command.
  20
  21 See the other documentation sections for details of the cli commands and settings that are available.
  22
  23 ## Backup via CLI
  24
  25 Disconnect main power, connect to cli via USB/FTDI.
  26
  27 dump using cli
  28
  29 `rate profile 0`
  30 `profile 0`
  31 `dump`
  32
  33 dump profiles using cli if you use them
  34
  35 `profile 1`
  36 `dump profile`
  37
  38 `profile 2`
  39 `dump profile`
  40
  41 dump rate profiles using cli if you use them
  42
  43 `rate profile 1`
  44 `dump rates`
  45
  46 `rate profile 2`
  47 `dump rates`
  48
  49 copy screen output to a file and save it.
  50
  51 ## Restore via CLI.
  52
  53 Use the cli `defaults` command first.
  54
  55 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.
  56
  57 Use the CLI and send all the output from the saved from the backup commands.
  58
  59 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.
  60
  61 You may find you have to copy/paste a few lines at a time.
  62
  63 Repeat the backup process again!
  64
  65 Compare the two backups to make sure you are happy with your restored settings.
  66
  67 Re-apply any new defaults as desired.
  68
  69