Mirror/betaflight
1
0
Fork 0
mirror of https://github.com/betaflight/betaflight.git synced 2025-07-17 05:15:25 +03:00
Code Issues Wiki Activity

Update documentation to advise users to maintain configuration backups.

Browse source
This commit is contained in:
Dominic Clifton 2015-01-05 15:41:00 +00:00
parent 26a398c315
commit 636a0f906b
3 changed files with 81 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/Configuration.md
View file

@ -1,16 +1,17 @@
# Configuration
Cleanflight is configured primarilty using the Cleanflight Configurator GUI.
Both the command line interface and gui are accessible by connecting to a serial port on the target,
Both the command line interface and GUI are accessible by connecting to a serial port on the target,
be it a USB virtual serial port, physical hardware UART port or a softserial port.
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.
The GUI cannot currently configure all aspects of the system, the CLI must be used to enable or configure
some features and settings.
See the Serial section for more information.
See the Board specific sections for details of the serial ports available on the board you are using.
__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.__
## GUI
@ -21,18 +22,14 @@ can be used to interact with the CLI.
[Cleanflight Configurator on Chrome store](https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb)
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.
Old versions of the configurator can be downloaded from the configurator releases page: https://github.com/cleanflight/cleanflight-configurator/releases
See the README file that comes with the configurator for installation instructions.
## CLI
Cleanflight can also be configured by a command line interface.
The CLI can be accessed via the GUI tool or by sending a single '#' character to the main serial port.
To exit the CLI without saving power off the flight controller or type in 'exit'.
To see a list of commands type in 'help' and press return.
To dump your configuration (including the current profile), use the 'dump' command.
See the other documentation sections for details of the cli commands and settings that are available.
See the CLI section of the documentation for more details.