Cleanflight Configurator is a crossplatform configuration tool for the Cleanflight flight control system.
It allows you to configure the Cleanflight software running on any supported Cleanflight target.
Various types of aircraft are supported by the tool and by Cleanflight, e.g. quadcopters, hexacopters, octocopters and fixed-wing aircraft.
There is also now a standalone version available. The old Google Chrome Apps version of this software will be removed by Google on platforms other than Chrome OS.
Downloads are available in Releases page on GitHub.
Cleanflight Configurator was originally a fork of Baseflight Configurator with support for Cleanflight instead of Baseflight.
This configurator is the only configurator with support for Cleanflight specific features. It will likely require that you run the latest firmware on the flight controller. If you are experiencing any problems please make sure you are running the latest firmware version.
Download the installer from Releases.
- Visit Chrome web store
- Click + Add to Chrome
Please note - the application will automatically update itself when new versions are released. Please ensure you maintain configuration backups as described in the Cleanflight documentation.
- Clone the configurator repository (from Github) to any local directory or download it as zip.
- Extract to a folder and not the folder.
- Start Google Chrome.
- Click the 3-dots on the far right of the URL bar.
- Select "More Tools"
- Select "Extensions"
- Check the Developer Mode checkbox.
- Click on load unpacked extension.
- Point it to the folder you extracted the zip to.
You can find the Cleanflight Configurator icon in your application tab "Apps"
Linux build is disabled currently because of unmet dependecies with some distros, it can be enabled in the gulpfile.js
.
- Install node.js
- Change to project folder and run
npm install
. - Run
npm start
.
npm test
The tasks are defined in gulpfile.js
and can be run either via gulp <task-name>
(if the command is in PATH or via ../node_modules/gulp/bin/gulp.js <task-name>
:
- Optional, install gulp
npm install --global gulp-cli
. - Run
gulp <taskname> [[platform] [platform] ...]
.
List of possible values of <task-name>
:
- dist copies all the JS and CSS files in the
./dist
folder. - apps builds the apps in the
./apps
folder [1]. - debug builds debug version of the apps in the
./debug
folder [1]. - release zips up the apps into individual archives in the
./release
folder [1].
[1] Running this task on macOS or Linux requires Wine, since it's needed to set the icon for the Windows app (build for specific platform to avoid errors).
To build or release only for one specific platform you can append the plaform after the task-name
.
If no platform is provided, all the platforms will be done in sequence.
- MacOS use
gulp <task-name> --osx64
- Linux use
gulp <task-name> --linux64
- Windows use
gulp <task-name> --win32
You can also use multiple platforms e.g. gulp <taskname> --osx64 --linux64
.
Cleanflight Configurator has been translated into several languages. The application will try to detect and use your system language if a translation into this language is available. You can help translating the application into your language.
If you prefer to have the application in English or any other language, you can select your desired language in the options menu of the application.
Make sure Settings -> System -> "User hardware acceleration when available" is checked to achieve the best performance
If connecting Cleanflight Configurator to your flight controller's USB port does not work out-of-the box, follow this check-list:
- After connecting,
sudo dmesg
should print a message similar tousb 2-1.1: new full-speed USB device number 17 using ehci-pci
. If not, there may be a problem with your cable/FC. - FCs with USB Virtual Com Port (VCP) usually use USB CDC (Communications Device Class) ACM (Abstract Control Model) protocol. The driver
cdc_acm
(kernel optionCONFIG_USB_ACM
) should pick up the device,cdc_acm 2-1.1:1.0: ttyACM0: USB ACM device
should appear insudo dmesg
. - The device file (usually
/dev/ttyACM0
) needs to be writeable by your user account. This is best achieved by creating a udev rule/etc/udev/rules.d/90-ttyACM-group-plugdev.rules
that containsKERNEL=="ttyACM[0-9]", GROUP="plugdev"
and ensuring you are in theplugdev
group usingsudo usermod -aG plugdev YOUR_USERNAME
. Re-plug the device / logout & login for changes to take effect.
If you have 3D model animation problems, enable "Override software rendering list" in Chrome flags chrome://flags/#ignore-gpu-blacklist
If you need help please reach out on the cleanflight slack channel before raising issues on github. Register and request slack access here.
For Cleanflight configurator issues raise them here
https://github.com/cleanflight/cleanflight-configurator/issues
For Cleanflight firmware issues raise them here
https://github.com/cleanflight/cleanflight/issues
There is an IRC channel for Cleanflight, here: irc://irc.freenode.net/#cleanflight
The configurator is based on chrome.serial API running on Google Chrome/Chromium core.
We accept clean and reasonable patches, submit them!
Dominic Clifton/hydra - maintainer of the Cleanflight firmware and configurator. ctn - primary author and maintainer of Baseflight Configurator from which Cleanflight Configurator project was forked.