betaflight-configurator/README.md

86 lines
3.3 KiB
Markdown
Raw Normal View History

2016-06-13 16:50:36 +00:00
# Betaflight Configurator
2016-06-16 10:23:00 +00:00
![Betaflight](http://static.rcgroups.net/forums/attachments/6/1/0/3/7/6/a9088900-228-bf_logo.jpg)
2016-06-13 16:50:36 +00:00
Betaflight Configurator is a crossplatform configuration tool for the Betaflight flight control system.
2013-04-13 10:55:25 +00:00
2016-07-15 02:05:15 +00:00
It runs as an app within Google Chrome and allows you to configure the Betaflight software running on any [supported Betaflight target](https://github.com/betaflight/betaflight/tree/master/src/main/target).
2014-05-23 18:04:03 +00:00
2016-06-13 16:50:36 +00:00
Various types of aircraft are supported by the tool and by Betaflight, e.g. quadcopters, hexacopters, octocopters and fixed-wing aircraft.
2014-05-23 18:04:03 +00:00
## Authors
2016-06-16 10:20:15 +00:00
Betaflight Configurator is a [fork](#credits) of the Cleanflight Configurator with support for Betaflight instead of Cleanflight.
2014-05-23 18:04:03 +00:00
2016-06-16 05:51:53 +00:00
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](https://github.com/betaflight/betaflight/releases/).
2013-04-13 10:55:25 +00:00
## Installation
2016-07-15 02:05:15 +00:00
### Via chrome webstore
[![available in the Chrome web store](https://developer.chrome.com/webstore/images/ChromeWebStore_Badge_v2_206x58.png)](https://chrome.google.com/webstore/detail/betaflight-configurator/kdaghagfopacdngbohiknlhcocjccjao)
2016-07-15 02:05:15 +00:00
1. Visit [Chrome web store](https://chrome.google.com/webstore/detail/betaflight-configurator/kdaghagfopacdngbohiknlhcocjccjao)
2. Click **+ Add to Chrome**
2016-06-16 05:51:53 +00:00
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.
2014-07-20 00:01:39 +00:00
### 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
2013-04-13 10:55:25 +00:00
2016-06-16 05:51:53 +00:00
You can find the Betaflight Configurator icon in your application tab "Apps"
2014-01-25 20:21:57 +00:00
## 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
2014-02-15 16:35:41 +00:00
## Support
2017-08-16 03:19:57 +00:00
If you need help please reach out on the [betaflightgroup](https://betaflightgroup.slack.com) slack channel before raising issues on github. Register and [request slack access here](http://www.betaflight.tk).
2014-05-23 18:04:03 +00:00
### Issue trackers
2014-05-23 18:04:03 +00:00
2016-06-16 05:51:53 +00:00
For Betaflight configurator issues raise them here
2016-06-16 05:51:53 +00:00
https://github.com/betaflight/betaflight-configurator/issues
2016-06-16 05:51:53 +00:00
For Betaflight firmware issues raise them here
2014-05-23 18:04:03 +00:00
2016-06-16 05:51:53 +00:00
https://github.com/betaflight/betaflight/issues
2014-05-23 18:04:03 +00:00
## Technical details
2014-05-23 18:04:03 +00:00
The configurator is based on chrome.serial API running on Google Chrome/Chromium core.
## Developers
2014-05-23 18:04:03 +00:00
We accept clean and reasonable patches, submit them!
## Credits
2016-06-16 10:20:15 +00:00
ctn - primary author and maintainer of Baseflight Configurator from which Cleanflight Configurator project was forked.
2016-06-16 10:21:13 +00:00
2016-06-16 10:20:15 +00:00
Hydra - author and maintainer of Cleanflight Configurator from which this project was forked.