Merge pull request #11320 from MrTucks/patch-2
[betaflight.git] / docs / Configuration.md
blobde33d415668f1b6741bc68083f3e6aeed27adda7
1 # Configuration
3 Cleanflight is configured primarily using the Cleanflight Configurator GUI.
5 Both the command line interface and GUI are accessible by connecting to a serial port on the target,
6 be it a USB virtual serial port, physical hardware UART port or a SoftSerial port.
8 See the Serial section for more information and see the Board specific sections for details of the serial ports available on the board you are using.
10 The GUI cannot currently configure all aspects of the system, the CLI must be used to enable or configure
11 some features and settings.
13 __Due to ongoing development, the fact that the GUI cannot yet backup all your settings and automatic chrome updates of the GUI app it is highly advisable to backup your settings (using the CLI) so that when a new version of the configurator or firmware is released you can re-apply your settings.__
16 ## GUI
18 ![Cleanflight Gui](Screenshots/cleanflight-gui.png)
20 The GUI tool is the preferred way of configuration.  The GUI tool also includes a terminal which
21 can be used to interact with the CLI.
23 [Cleanflight Configurator on Chrome store](https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb)
25 If you cannot use the latest version of the GUI to access the FC due to firmware compatibility issues you can still access the FC via the CLI to backup your settings, or you can install an old version of the configurator.
27 Old versions of the configurator can be downloaded from the configurator releases page: https://github.com/cleanflight/cleanflight-configurator/releases
28 See the README file that comes with the configurator for installation instructions.
31 ## CLI
33 Cleanflight can also be configured by a command line interface.
35 See the [CLI section](Cli.md) of the documentation for more details.