sundowndev
/
betaflight-configurator
mirror of https://github.com/sundowndev/betaflight-configurator.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Cross platform configuration tool for the Betaflight firmware
3,340 Commits
8 Branches
130 Tags
70 MiB
JavaScript 65.4%
HTML 16.4%
Less 8.5%
Inno Setup 8.2%
CSS 0.6%
Other 0.9%
 
 
 
 
 
 
Go to file
Michael Keller 07bdeb65e1
Merge pull request #810 from McGiverGim/bf-add_window_title 
Add Betaflight Configurator as window title
 		2017-12-22 18:35:30 +13:00
_locales Merge pull request #810 from McGiverGim/bf-add_window_title 2017-12-22 18:35:30 +13:00
css CF/BF - Add font-awesome. 2017-05-05 16:01:34 +12:00
images Highres dmg background image for retina displays 2017-11-25 18:45:03 +01:00
js Fixed problem with configurator hanging after 'exit' in CLI in Windows standalone. 2017-12-06 22:26:08 +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 More i18n, GUI Console 2017-12-19 09:28:04 +01:00
.gitattributes Adding .gitattriutes file 2014-10-15 15:24:59 +01:00
.gitignore Run app after debug build 2017-12-03 21:18:03 +01: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 Add help with translations 2017-12-17 09:09:41 +01:00
changelog.html Update Changelog 2017-08-06 21:59:27 +02:00
dmg-background.psd Added dmg-background.psd Photoshop file 2017-12-08 10:02:52 +01:00
eventPage.js Add Betaflight Configurator as window title 2017-12-21 19:18:04 +01:00
gulpfile.js Some cosmetic fixes for `gulpfile.js`. 2017-12-19 09:09:20 +13:00
main.css Remove style attribute from css 2017-12-13 17:31:10 +01:00
main.html i18n titles 2017-12-18 11:52:11 +01:00
main.js Merge pull request #806 from McGiverGim/bf-i18n_console 2017-12-21 14:27:41 +13:00
main_nwjs.html Fixed window hocks and enabled restore window state on startup 2017-12-08 17:19:21 +01:00
manifest.json Updated version to 10.0.1 after release. 2017-12-06 22:39:05 +13:00
package-lock.json Fixed references in package-lock.json. 2017-12-05 12:57:16 +13:00
package.json Add missing icon taskbar/window 2017-12-14 19:25:18 +01: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>:

  1. Optional, install gulp npm install --global gulp-cli.
  2. 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).

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

Languages

Betaflight Configurator has been translated to several languages. The application will be shown in 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, you can execute the program from the command line with the parameter --lang=en or you can create a script or a shortcut with this parameter included.

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.