atbetaflight/README.md

117 lines
4.8 KiB
Markdown
Raw Normal View History

2017-06-30 03:41:17 -07:00
![BetaFlight Notice, version 3.2 will be the last version of Betaflight to support STM32F1 based flight controllers, this includes NAZE, CC3D (original) and CJMCU like flight controllers](https://raw.githubusercontent.com/wiki/betaflight/betaflight/images/betaflight/bf3_2_notice.png)
![BetaFlight](https://raw.githubusercontent.com/wiki/betaflight/betaflight/images/betaflight/bf_logo.png)
2015-06-26 03:40:50 -07:00
2017-01-04 19:10:43 -08:00
Betaflight is flight controller software (firmware) used to fly multi-rotor craft and fixed wing craft.
2014-04-20 19:27:28 -07:00
This fork differs from Baseflight and Cleanflight in that it focuses on flight performance, leading-edge feature additions, and wide target support.
2014-04-20 19:27:28 -07:00
2017-01-04 19:10:43 -08:00
## Features
2014-04-10 15:18:21 -07:00
2017-01-04 19:10:43 -08:00
Betaflight has the following features:
2014-12-10 08:54:44 -08:00
2017-01-06 14:55:29 -08:00
* Multi-color RGB LED strip support (each LED can be a different color using variable length WS2811 Addressable RGB strips - use for Orientation Indicators, Low Battery Warning, Flight Mode Status, Initialization Troubleshooting, etc)
2017-01-12 02:57:33 -08:00
* DShot (150, 300, 600 and 1200), Multishot, and Oneshot (125 and 42) motor protocol support
* Blackbox flight recorder logging (to onboard flash or external microSD card where equipped)
2017-01-04 19:10:43 -08:00
* Support for targets that use the STM32 F7, F4, F3 and F1 processors
* PWM, PPM, and Serial (SBus, SumH, SumD, Spektrum 1024/2048, XBus, etc) RX connection with failsafe detection
* Multiple telemetry protocols (CSRF, FrSky, HoTT smart-port, MSP, etc)
* RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II, X8R, X4R-SB, & XSR
* OSD support & configuration without needing third-party OSD software/firmware/comm devices
* OLED Displays - Display information on: Battery voltage/current/mAh, profile, rate profile, mode, version, sensors, etc
* In-flight manual PID tuning and rate adjustment
* Rate profiles and in-flight selection of them
2017-01-12 02:57:33 -08:00
* Configurable serial ports for Serial RX, Telemetry, ESC telemetry, MSP, GPS, OSD, Sonar, etc - Use most devices on any port, softserial included
* VTX support for Unify Pro and IRC Tramp
* and MUCH, MUCH more.
2017-01-04 19:10:43 -08:00
## Installation & Documentation
2014-06-06 18:59:25 -07:00
2017-08-24 02:29:11 -07:00
See: https://github.com/betaflight/betaflight/wiki
2014-06-06 18:59:25 -07:00
## IRC Support and Developers Channel
2017-01-04 19:10:43 -08:00
There's a dedicated Slack chat channel here:
2014-06-06 18:59:25 -07:00
2017-01-04 19:28:41 -08:00
http://www.betaflight.tk/
2014-06-06 18:59:25 -07:00
2014-12-23 05:58:17 -08:00
Etiquette: Don't ask to ask and please wait around long enough for a reply - sometimes people are out flying, asleep or at work and can't answer immediately.
2014-06-06 18:59:25 -07:00
## Configuration Tool
To configure Betaflight you should use the Betaflight-configurator GUI tool (Windows/OSX/Linux) that can be found here:
2014-06-06 18:59:25 -07:00
https://chrome.google.com/webstore/detail/betaflight-configurator/kdaghagfopacdngbohiknlhcocjccjao
The source for it is here:
https://github.com/betaflight/betaflight-configurator
2014-06-06 18:59:25 -07:00
## Contributing
2014-04-10 15:18:21 -07:00
2015-01-16 03:32:59 -08:00
Contributions are welcome and encouraged. You can contribute in many ways:
2014-12-23 05:58:17 -08:00
* Documentation updates and corrections.
* How-To guides - received help? Help others!
* Bug reporting & fixes.
* New feature ideas & suggestions.
2014-12-23 05:58:17 -08:00
The best place to start is the IRC channel on gitter (see above), drop in, say hi. Next place is the github issue tracker:
2014-12-23 05:58:17 -08:00
https://github.com/betaflight/betaflight/issues
https://github.com/betaflight/betaflight-configurator/issues
2014-12-23 05:58:17 -08:00
Before creating new issues please check to see if there is an existing one, search first otherwise you waste peoples time when they could be coding instead!
## Developers
Please refer to the development section in the `docs/development` folder.
2014-12-23 05:58:17 -08:00
TravisCI is used to run automatic builds
2014-12-23 05:58:17 -08:00
https://travis-ci.org/betaflight/betaflight
2014-12-23 05:58:17 -08:00
[![Build Status](https://travis-ci.org/betaflight/betaflight.svg?branch=master)](https://travis-ci.org/betaflight/betaflight)
2014-12-23 05:58:17 -08:00
## Betaflight Releases
2017-01-04 19:10:43 -08:00
https://github.com/betaflight/betaflight/releases
2014-12-23 05:58:17 -08:00
2016-08-26 19:47:51 -07:00
## Open Source / Contributors
2016-08-26 16:55:01 -07:00
Betaflight is software that is **open source** and is available free of charge without warranty to all users.
Betaflight is forked from Cleanflight, so thanks goes to all those whom have contributed to Cleanflight and its origins.
Origins for this fork (Thanks!):
* **Alexinparis** (for MultiWii),
* **timecop** (for Baseflight),
* **Dominic Clifton** (for Cleanflight), and
* **Sambas** (for the original STM32F4 port).
2017-08-24 02:29:11 -07:00
The Betaflight Configurator is forked from Cleanflight Configurator and its origins.
2016-08-26 16:55:01 -07:00
Origins for Betaflight Configurator:
* **Dominic Clifton** (for Cleanflight configurator), and
2017-08-24 02:29:11 -07:00
* **ctn** (for the original Configurator).
2016-08-26 16:55:01 -07:00
Big thanks to current and past contributors:
2016-08-26 16:57:11 -07:00
* Budden, Martin (martinbudden)
* Bardwell, Joshua (joshuabardwell)
* Blackman, Jason (blckmn)
* ctzsnooze
2017-08-24 02:29:11 -07:00
* Höglund, Anders (andershoglund)
2017-09-27 05:37:29 -07:00
* Ledvina, Petr (ledvinap) - **IO code awesomeness!**
2016-08-26 16:57:11 -07:00
* kc10kevin
* Keeble, Gary (MadmanK)
2016-08-26 16:58:07 -07:00
* Keller, Michael (mikeller) - **Configurator brilliance**
* Kravcov, Albert (skaman82) - **Configurator brilliance**
2016-08-26 16:57:11 -07:00
* MJ666
* Nathan (nathantsoi)
* ravnav
2016-08-26 16:58:07 -07:00
* sambas - **bringing us the F4**
2016-08-26 16:57:11 -07:00
* savaga
* Stålheim, Anton (KiteAnton)
2016-08-26 16:55:01 -07:00
And many many others who haven't been mentioned....