194d03ed9a
Cordova integration and android platform : - Added cordova directory with required config - Added cordova applications generation in gulpfile - Added cordova development instructions - Used cordova plugins to simulate missing chrome api plugins (chrome.serial and chrome.fileSystem) - Added cordova clipboard support - Added android operating system and Cordova gui mode - Fixed some css and js files to make them working on Android as well as on computers - Added --skipdep argument to accelerate cordova build (gulp task) - Added a webview helper to help people to update the webview app of their device New options tab : - Added options tab replacing the options dropdown - Added option to switch between phones UI and computers UI Mobile interface and global interface improvements : - Simplified the structure of the header with flex css - Made headerbar and tab container responsive (compact headerbar and side menu) - All tabs are adapted to mobile interface (except firmware flasher) - The servos and adjustments tabs are not fully adapted but are "usable" - Improved header bar animation - Improved log expandation animation - Added swipe gesture to toggle side menu Fixes during the development : - Logo position - Dark mode - Auto connection - Error messages (cordova_chromeapi.js) - Responsive grid - Testing - Disconnection - Width of boxes inside the OSD tab - Fixed cli tab - OSD tab - Motor stop switch - White spaces in boxes - Dialogs size - Connect button state - Prevent tablet with a height larger than 575px to switch to computers ui - Fixed logging tab - Fixed code smell - Fixed yarn cordova plugin install issue - Fixed content_wrapper - Fixed vibrations when scrolling - Fixed scrolling bar alignment - Fixed dialogReportProblem height - Fixed rates logo - Fixed auto connection default value (true) - Fixed D to D max - Fixed dialogs Added required messages in locales/en/messages.json file |
||
|---|---|---|
| .github | ||
| assets | ||
| cordova | ||
| libraries | ||
| locales | ||
| resources | ||
| src | ||
| test | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .nvmrc | ||
| .sonarcloud.properties | ||
| .travis.yml | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
| azure-pipelines.yml | ||
| changelog.html | ||
| crowdin.yml | ||
| gulpfile.js | ||
| manifest.json | ||
| package.json | ||
| yarn.lock | ||
README.md
Betaflight Configurator
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.
Note for 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.
Via Chrome Web Store (for ChromeOS)
- Visit the Betaflight Configurator product page in the 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 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 (windows/linux/macos) or Cordova (android)
Development
- Install node.js (version 10 required)
- Install yarn:
npm install yarn -g - (For Android platform only) Install Java JDK 8, Gradle and Android Studio (Android SDK at least level 19)
- Change to project folder and run
yarn install. - 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
./distfolder [2]. - apps builds the apps in the
./appsfolder [1]. - debug builds debug version of the apps in the
./debugfolder [1][3]. - release zips up the apps into individual archives in the
./releasefolder [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 the ./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, all the platforms will be done in sequence.
- MacOS X 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 - Android use
yarn gulp <task-name> --android
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 first screen of the application.
Notes
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.
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}
Linux / MacOS X 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.