Betaflight Configurator

Betaflight Configurator is a crossplatform configuration tool for the Betaflight flight control system.

It runs as an application under different operating systems and allows you to configure the Betaflight software running on any supported Betaflight target. Downloads are available in Releases.

Various types of aircraft are supported by the tool and by Betaflight, e.g. quadcopters, hexacopters, octocopters and fixed-wing aircraft.

Authors

Betaflight Configurator is a fork of the Cleanflight Configurator with support for Betaflight instead of Cleanflight.

This configurator is the only configurator with support for Betaflight 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.

Installation

Standalone

We provide a standalone program for Windows, Linux, Mac and Android.

Download the installer from Releases.

Notes

Windows users

The minimum required version of windows is Windows 8.

MacOS X users

Changes to the security model used in the latest versions of MacOS X 10.14 (Mojave) and 10.15 (Catalina) mean that the operating system will show an error message ('"Betaflight Configurator.app" is damaged and can’t be opened. You should move it to the Trash.') when trying to install the application. To work around this, run the following command in a terminal after installing: sudo xattr -rd com.apple.quarantine /Applications/Betaflight\ Configurator.app.

Linux users

In most Linux distributions your user won't have access to serial interfaces by default. To add this access right type the following command in a terminal, log out your user and log in again:

sudo usermod -aG dialout ${USER}

Post-installation errors can be prevented by making sure the directory /usr/share/desktop-directories exists. To make sure it exists, run the following command before installing the package:

sudo mkdir /usr/share/desktop-directories/

The libatomic library must also be installed before installing Betaflight Configurator. (If the library is missing, the installation will succeed but Betaflight Configurator will not start.) Some Linux distributions (e.g. Fedora) will install it automatically. On Debian or Ubuntu you can install it as follows:

sudo apt install libatomic1

On Ubuntu 23.10 please follow these alternative steps for installation:

sudo echo "deb http://archive.ubuntu.com/ubuntu/ lunar universe" > /etc/apt/sources.list.d/lunar-repos-old.list
sudo apt update
sudo dpkg -i betaflight-configurator_10.10.0_amd64.deb
sudo apt-get -f install

Graphics Issues

If you experience graphics display problems or smudged/dithered fonts display issues in Betaflight Configurator, try invoking the betaflight-configurator executable file with the --disable-gpu command line switch. This will switch off hardware graphics acceleration. Likewise, setting your graphics card antialiasing option to OFF (e.g. FXAA parameter on NVidia graphics cards) might be a remedy as well.

Unstable Testing Versions

Unstable testing versions of the latest builds of the configurator for most platforms can be downloaded from here.

The future of the Configurator is moving to a PWA (Progressive Web Application). In this way it will be easier to maintain specially to support different devices like phones, tablets. etc. Is a work in progress but you can have access to the latest snapshot in PWA way without installing anything here (take into account that some things don't work and are in development).

Be aware that these versions are intended for testing / feedback only, and may be buggy or broken, and can cause flight controller settings to be corrupted. Caution is advised when using these versions.

Languages

Please do not submit pull requests for translation changes, but read and follow the instructions below!

Betaflight 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 first screen of the application.

App build via Vite (web)

Development

1. Install node.js (refer to .nvmrc for required version)
2. Install yarn: npm install yarn -g
3. Change to project folder and run yarn install.
4. Run yarn dev.

The web app will be available at http://localhost:8000 with full HMR.

Build Preview

1. Run yarn build.
2. Run yarn preview after build has finished.
3. Alternatively run yarn review to build and preview in one step.

The web app should behave directly as in production, available at http://localhost:8080.

App build via NW.js (windows/linux/macos) or Cordova (android)

Development

1. Install node.js (refer to .nvmrc for required version)
2. Install yarn: npm install yarn -g
3. (For Android platform only) Install Java JDK 8, Gradle and Android Studio (Android SDK at least level 19). On Windows you have to extract Gradle binaries to C:\Gradle and set up some environmental variables.

4. Change to project folder and run yarn install.
5. Run yarn start.

Running tests

yarn test

App build and release

The tasks are defined in gulpfile.js and can be run with through yarn:

yarn gulp <taskname> [[platform] [platform] ...]

List of possible values of <task-name>:

• dist copies all the JS and CSS files in the ./dist folder [2].
• apps builds the apps in the ./apps folder [1].
• debug builds debug version of the apps in the ./debug folder [1][3].
• 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). [2] For Android platform, dist task will generate folders and files in the ./dist_cordova folder. [3] For Android platform, you need to configure an emulator or to plug an Android device with USB debugging enabled

Build or release app for one specific platform

To build or release only for one specific platform you can append the plaform after the task-name. If no platform is provided, the build for the host platform is run.

• MacOS X use yarn gulp <task-name> --osx64
• Linux use yarn gulp <task-name> --linux64
• Windows use yarn gulp <task-name> --win64
• Android use yarn gulp <task-name> --android

Note: Support for cross-platform building is very limited due to the requirement for platform specific build tools. If in doubt, build on the target platform.

You can also use multiple platforms e.g. yarn gulp <taskname> --osx64 --linux64. Other platforms like --win32, --linux32 and --armv8 can be used too, but they are not officially supported, so use them at your own risk.

Leverage GitHub-Actions to build binaries

You can use the GitHub Actions tab in your fork to build binaries as well. Select Actions>Manual Build>Run Workflow. Choose your custom branch and click Run workflow. The workflow will dispatch in a few moments and upon completion, the build "Artifacts" will be available for download from within the workflow run.

Support and Developers Channel

There's a dedicated Discord server here:

https://discord.gg/n4E6ak4u3c

We also have a Facebook Group. Join us to get a place to talk about Betaflight, ask configuration questions, or just hang out with fellow pilots.

https://www.facebook.com/groups/betaflightgroup/

Etiquette: Don't ask to ask and please wait around long enough for a reply - sometimes people are out flying, asleep or at work and can't answer immediately.

Issue trackers

For Betaflight configurator issues raise them here

https://github.com/betaflight/betaflight-configurator/issues

For Betaflight firmware issues raise them here

https://github.com/betaflight/betaflight/issues

Technical details

The configurator is based on chrome.serial API running on Google Chrome/Chromium core.

Developers

We accept clean and reasonable patches, submit them!

Credits

ctn - primary author and maintainer of Baseflight Configurator from which Cleanflight Configurator project was forked.

Hydra - author and maintainer of Cleanflight Configurator from which this project was forked.