Cross platform configuration tool for the Betaflight firmware
 
 
 
 
 
 
Go to file
Michael Keller bb555568e2
Fix missing OSD preview symbols (#1494)
Fix missing OSD preview symbols
2019-06-15 19:11:29 +12:00
.github Update stale / no-response bot configurations. 2019-05-27 23:30:28 +12:00
assets Add Croatian translation 2019-05-01 15:46:28 +02:00
libraries Fixed ownership of installed files on debian. 2019-03-24 11:52:59 +13:00
locales Add RSSI dBm warning to the OSD 2019-06-14 08:30:17 +02:00
resources Change arrow to small in vario OSD preview 2019-06-14 08:19:37 +02:00
src Fix missing OSD preview symbols 2019-06-15 08:28:15 +02:00
test fix CLI unit tests 2019-04-29 10:27:37 +02:00
.gitattributes Adding .gitattriutes file 2014-10-15 15:24:59 +01:00
.gitignore Added custom characters for stick overlays to fonts. 2019-01-27 13:46:11 +13:00
.travis.yml Moved from 'npm' to 'yarn'. 2019-04-30 23:57:35 +12:00
LICENSE Initial commit 2013-04-08 17:29:52 +02:00
README.md Fixed yarn install for production dependencies, fixed instructions for development. 2019-05-04 16:44:14 +12:00
azure-pipelines.yml Try rebase again 2019-04-28 12:05:36 +09:30
changelog.html Added 10.5.0 to changelog. 2019-04-10 00:24:18 +12:00
crowdin.yml Update Crowdin configuration file 2018-02-25 09:01:22 +13:00
gulpfile.js Fixed yarn production install. 2019-05-09 07:58:43 +12:00
manifest.json Incremented version to 10.6.0 after release. 2019-04-11 08:02:46 +12:00
package.json Fixed yarn production install. 2019-05-09 07:58:43 +12:00
yarn.lock Fixed yarn production install. 2019-05-09 07:58:43 +12:00

README.md

Betaflight Configurator

Betaflight

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

It runs as an app within Google Chrome and allows you to configure the Betaflight software running on any supported Betaflight target.

There is also now a standalone version available, since Google Chrome Apps are getting deprecated on platforms that aren't Chrome OS. 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

This is the default installation method, and at some point in the future this will become the only way available for most platforms. Please use this method whenever possible.

Download the installer from Releases.

Via Chrome Web Store

Deprecated, discouraged if a standalone version is available for your operating system.

available in the Chrome web store

  1. Visit the Betaflight Configurator product page in the Chrome web store
  2. 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 Betaflight documentation.

Unstable Testing Versions

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

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.

Native app build via NW.js

Development

  1. Install node.js
  2. Install yarn: npm install yarn -g
  3. Change to project folder and run yarn install.
  4. 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.
  • 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).

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, all the platforms will be done in sequence.

  • MacOS use yarn gulp <task-name> --osx64
  • Linux use yarn gulp <task-name> --linux64
  • Windows use yarn gulp <task-name> --win32
  • ChromeOS use yarn gulp <task-name> --chromeos

You can also use multiple platforms e.g. yarn gulp <taskname> --osx64 --linux64.

Languages

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 options menu of the application.

Notes

WebGL

Make sure Settings -> System -> "User hardware acceleration when available" is checked to achieve the best performance

Linux users

Dont forget to add your user into dialout group "sudo usermod -aG dialout YOUR_USERNAME" for serial access

Linux / MacOSX users

If you have 3D model animation problems, enable "Override software rendering list" in Chrome flags chrome://flags/#ignore-gpu-blacklist

Support

If you need help please reach out on the betaflightgroup slack channel before raising issues on github. Register and request slack access here.

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.

Crowdin