From 636a0f906b23e553c61bada990593d48c6de23a5 Mon Sep 17 00:00:00 2001 From: Dominic Clifton Date: Mon, 5 Jan 2015 15:41:00 +0000 Subject: [PATCH] Update documentation to advise users to maintain configuration backups. --- docs/Cli.md | 69 +++++++++++++++++++++++++++++++++++++++++++ docs/Configuration.md | 23 +++++++-------- docs/Installation.md | 46 ++--------------------------- 3 files changed, 81 insertions(+), 57 deletions(-) create mode 100644 docs/Cli.md diff --git a/docs/Cli.md b/docs/Cli.md new file mode 100644 index 000000000..3c1fc6830 --- /dev/null +++ b/docs/Cli.md @@ -0,0 +1,69 @@ +# Command Line Interface (CLI) + +Cleanflight has a command line interface (CLI) that can be used to change settings and configure the FC. + +## Accessing the CLI. + +The CLI can be accessed via the GUI tool or via a terminal emulator connected to the CLI serial port. + +1. Connect your terminal emulator to the CLI serial port (which, by default, is the same as the MSP serial port) +2. Use the baudrate specified by cli_baudrate (115200 by default). +3. Send a `#` character. + +To save your settings type in 'save', saving will reboot the flight controller. + +To exit the CLI without saving power off the flight controller or type in 'exit'. + +To see a list of other 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. + +## Backup via CLI + +Disconnect main power, connect to cli via USB/FTDI. + +dump using cli + +`rate profile 0` +`profile 0` +`dump` + +dump profiles using cli if you use them + +`profile 1` +`dump profile` + +`profile 2` +`dump profile` + +dump rate profiles using cli if you use them + +`rate profile 1` +`dump rates` + +`rate profile 2` +`dump rates` + +copy screen output to a file and save it. + +## Restore via CLI. + +Use the cli `defaults` command first. + +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. + +Use the CLI and send all the output from the saved from the backup commands. + +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. + +You may find you have to copy/paste a few lines at a time. + +Repeat the backup process again! + +Compare the two backups to make sure you are happy with your restored settings. + +Re-apply any new defaults as desired. + + diff --git a/docs/Configuration.md b/docs/Configuration.md index 1cb988622..5cbc38111 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -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. diff --git a/docs/Installation.md b/docs/Installation.md index 0eb18ae67..c276e49c7 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -12,48 +12,6 @@ See the board specific flashing instructions. When upgrading be sure to backup / dump your existing settings. Some firmware releases are not backwards compatible and default settings are restored when the FC detects an out of date configuration. -## Backup process +## Backup/Restore process -disconnect main power, connect to cli via USB/FTDI. - -dump using cli - -`rate profile 0` -`profile 0` -`dump` - -dump profiles using cli if you use them - -`profile 1` -`dump profile` - -`profile 2` -`dump profile` - -dump rate profiles using cli if you use them - -`rate profile 1` -`dump rates` - -`rate profile 2` -`dump rates` - -copy screen output to a file and save it. - -## Restore process - -Use the cli `defaults` command first. - -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. - -Use the CLI and send all the output from the saved from the backup commands. - -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. - -You may find you have to copy/paste a few lines at a time. - -Repeat the backup process again! - -Compare the two backups to make sure you are happy with your restored settings. - -Re-apply any new defaults as desired. +See the CLI section of the docs for details on how to backup and restore your configuration via the CLI.