Cross platform configuration tool for the Betaflight firmware
 
 
 
 
 
 
Go to file
Michael Keller ef67542524
Merge pull request #731 from ryanschwartz/patch-1
Add "button" to camera control modes.
2017-11-19 14:21:19 +13:00
_locales/en Add "button" to camera control modes. 2017-11-18 17:04:43 -06:00
css CF/BF - Add font-awesome. 2017-05-05 16:01:34 +12:00
images Added Windows and Mac icons files 2017-11-04 18:27:33 +11:00
js Merge pull request #721 from mikeller/remove_deleted_features 2017-11-12 11:32:38 +13:00
resources fix MAH label to mAh for correctness, as much as you can do with 6x5 pixels per character... 2017-09-07 20:45:10 +03:00
support Update svg_model_motors.rb 2015-11-11 17:20:31 +00:00
tabs Fixed off-by-one version checking bug in OSD tab. 2017-11-18 17:45:16 +13:00
.gitattributes Adding .gitattriutes file 2014-10-15 15:24:59 +01:00
.gitignore Added support for the FrSky FPort protocol. 2017-11-15 02:03:44 +13:00
.travis.yml Added files for travis build. 2017-11-14 16:00:02 +13:00
LICENSE Initial commit 2013-04-08 17:29:52 +02:00
README.md Added Windows and Mac icons files 2017-11-04 18:27:33 +11:00
changelog.html Update Changelog 2017-08-06 21:59:27 +02:00
eventPage.js CF/BF - Update configurator for API 1.33.0. 2017-05-05 16:00:38 +12:00
gulpfile.js Added files for travis build. 2017-11-14 16:00:02 +13:00
main.css add firmware version to top bar 2017-10-22 17:10:00 +02:00
main.html Adjust peripherals mode name in failsafe tab 2017-10-04 13:08:21 +02:00
main.js Refactored version display, made text congruent. 2017-10-23 09:49:21 +13:00
manifest.json Reconciled package.json to manifest.json. 2017-11-07 22:19:15 +13:00
package-lock.json Added Windows and Mac icons files 2017-11-04 18:27:33 +11:00
package.json Reconciled package.json to manifest.json. 2017-11-07 22:19:15 +13: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.

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

Via chrome webstore

available in the Chrome web store

  1. Visit 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.

Alternative way

  1. Clone the repo to any local directory or download it as zip.
  2. Extract to a folder and not the folder.
  3. Start Google Chrome.
  4. Click the 3-dots on the far right of the URL bar.
  5. Select "More Tools"
  6. Select "Extensions"
  7. Check the Developer Mode checkbox.
  8. Click on load unpacked extension.
  9. Point it to the folder you extracted the zip to.

How to use

You can find the Betaflight Configurator icon in your application tab "Apps"

Native app build via NW.js

Linux build is disabled currently because of unmet dependecies with some distros, it can be enabled in the gulpfile.js.

Development

  1. Install node.js
  2. Change to project folder and run npm install
  3. Run npm start

App build and release

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':

  • dist copies all the JS and CSS files in the ./dist folder
  • apps builds the apps in the ./apps folder
  • release zips up the apps into individual archives in the ./apps folder. Running this task on macOS or Linux requires Wine, since it's needed to set the icon for the Windows app.

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.