README.md

   1 ![Important Notice: Betaflight 4.0 will be the last release to include support for STM32F3 based flight controllers. (This includes all boards with 'F3' in the name.)](docs/assets/images/stm32f3_retirement_notice.svg)
   2
   3 (Please see the [note](https://github.com/betaflight/betaflight#end-of-active-development-for-stm32f3-based-flight-controllers) below.)
   4
   5
   6 ![Betaflight](docs/assets/images/bf_logo.png)
   7
   8 Betaflight is flight controller software (firmware) used to fly multi-rotor craft and fixed wing craft.
   9
  10 This fork differs from Baseflight and Cleanflight in that it focuses on flight performance, leading-edge feature additions, and wide target support.
  11
  12 ## News
  13
  14 ### Betaflight 4.1
  15
  16 For Betaflight 4.0 we announced the advent of Unified Targets, and with them the capability to change all of the hardware resources on all (F4 and F7) targets. Unified Targets have been used successfully by testers since Betaflight 4.0 has been released, and users using the new bidirectional Dshot protocol have been using configurable resources to make this protocol work on their targets since then.
  17
  18 But we were still not happy with the way that users had to use Unified Targets: The target specific hardware configuration had to be applied after the firmware was flashed, and re-applied every time the configuration was reset to defaults - we wanted to make the Unified Targets as easy to use as the existing 'legacy' targets are.
  19
  20 We have figured out a way to make this work, and are currently working on implementing the required changes in the firmware and in Betaflight configurator, but it is taking longer to complete than we had anticipated. To allow us to get the integration of Unified Targets completed, **we have shifted the release date for Betaflight 4.1 to 01 October 2019**. Until then we will keep doing monthly releases of Betaflight 4.0 with bugfixes and new / updated targets.
  21
  22 To get the latest update from us, you can now also visit our webpage at https://betaflight.com/.
  23
  24
  25 ### New requirements for the submission of new and updated targets
  26
  27 As [announced earlier](https://github.com/betaflight/betaflight#betaflight-40), Betaflight 4.0 is introducing a radically new way to define targets, the so-called 'Unified Targets'.
  28
  29 This new approach makes it possible to use the same firmware binary (the so called 'Unified Target firmware') for all boards that share the same MCU type (only supported on F4 and F7). Manufacturers will be able to add support for new boards by simply publishing a new configuration (the so called 'Unified Target configuration') for their new board. Users can then simply load the already published Unified Target firmware and the new Unified Target configuration onto their new board to get it to work.
  30
  31 Work to give users a simple way to flash unified targets in Betaflight configurator still needs to be done, so Betaflight 4.0 will be released with targets done in the 'legacy' way. But the plan is to add support for seamless use of Unified Targets into Betaflight configurator after Betaflight 4.0 has been released, and convert all of the existing F4 and F7 targets to the new format before the release of Betaflight 4.1.
  32
  33 In order to be prepared for this move, the following new requirements for pull requests adding new targets or modifying existing targets are put in place from now on:
  34
  35 1. After the release of Betaflight 4.0.0, new F3 based targets can only be added into the `4.0.x-maintenance` branch. This ties in with the release of firmware for F3 based targets [ending after 4.0](https://github.com/betaflight/betaflight#end-of-active-development-for-stm32f3-based-flight-controllers);
  36
  37 All subsequent rules exclude F3 based targets:
  38
  39 2. For any new target that is to be added, both a 'legacy' format target definition into `src/main/target/` and a new Unified Target config into `unified_targets/configs/` need to be submitted. See the [instructions](https://github.com/betaflight/betaflight/blob/master/unified_targets/docs/CreatingAUnifiedTarget.md) for how to create a Unified Target configuration;
  40
  41 3. For changes to existing targets, the change needs to be applied to both the 'legacy' format target definition in `src/main/target/` and a new Unified Target config in `unified_targets/configs/`. If no Unified Target configuration for the target exists, a new Unified Target configuration will have to be created and submitted alongside the proposed change.
  42
  43
  44 ### End of active development for STM32F3 based flight controllers
  45
  46 For a while now, development of Betaflight for flight controllers based on the STM32F3 chip has been hampered by a severe limitation that this chip has: Unlike the STM32F4 and STM32F7 models, the STM32F3 versions that are used on flight controllers have only a very limited amount of flash space available to fit the firmware into. This has meant that, starting from around version 3.3, the majority of the new features that were developed for Betaflight could not be added to STM32F3 based boards. Even worse, due to improvement in basic features, other more and more of the less commonly used features had to be removed from these flight controllers, and a number of them are at a point where they only support the bare minimum of functionality required to make them fly.
  47
  48 This means that, even if we kept supporting STM32F3 based boards in future releases, there would only be little advantage in this, as there simply is no space left on STM32F3 to add any of the new features that these releases will contain.
  49
  50 For this reason, and because the effort required to remove features from STM32F3 based flight controllers on a weekly basis is cutting into the time that we have to actually develop new features, we have decided to drop support for STM32F3 based flight controllers after the last release of 4.0.
  51
  52 This does not mean that it won't be possible to use these flight controllers after this point in time - they will still work fine when used with the last release of 4.0, just as there are thousands of users who are still enjoying their STM32F1 based flight controllers with Betaflight 3.2.5. We will also strive to keep these versions supported in new releases of configurator, so that users still using these flight controllers will be able to configure them with the same configurator that they use to configure their STM32F4 and STM32F7 based boards.
  53
  54
  55 ## Events
  56
  57 | Date  | Event |
  58 | - | - |
  59 | 01 September 2019 | Start of feature freeze / Release Candidate window for Betaflight 4.1 |
  60 | 01 October 2019 | Planned [release](https://github.com/betaflight/betaflight/milestone/30) date for Betaflight 4.1 |
  61
  62 ## Features
  63
  64 Betaflight has the following features:
  65
  66 * 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)
  67 * DShot (150, 300, 600 and 1200), Multishot, and Oneshot (125 and 42) motor protocol support
  68 * Blackbox flight recorder logging (to onboard flash or external microSD card where equipped)
  69 * Support for targets that use the STM32 F7, F4 and F3 processors
  70 * PWM, PPM, and Serial (SBus, SumH, SumD, Spektrum 1024/2048, XBus, etc) RX connection with failsafe detection
  71 * Multiple telemetry protocols (CSRF, FrSky, HoTT smart-port, MSP, etc)
  72 * RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II, X8R, X4R-SB, & XSR
  73 * OSD support & configuration without needing third-party OSD software/firmware/comm devices
  74 * OLED Displays - Display information on: Battery voltage/current/mAh, profile, rate profile, mode, version, sensors, etc
  75 * In-flight manual PID tuning and rate adjustment
  76 * Rate profiles and in-flight selection of them
  77 * Configurable serial ports for Serial RX, Telemetry, ESC telemetry, MSP, GPS, OSD, Sonar, etc - Use most devices on any port, softserial included
  78 * VTX support for Unify Pro and IRC Tramp
  79 * and MUCH, MUCH more.
  80
  81 ## Installation & Documentation
  82
  83 See: https://github.com/betaflight/betaflight/wiki
  84
  85 ## Support and Developers Channel
  86
  87 There's a dedicated Slack chat channel here:
  88
  89 https://slack.betaflight.com/
  90
  91 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.
  92
  93 ## Configuration Tool
  94
  95 To configure Betaflight you should use the Betaflight-configurator GUI tool (Windows/OSX/Linux) which can be found here:
  96
  97 https://github.com/betaflight/betaflight-configurator/releases/latest
  98
  99 ## Contributing
 100
 101 Contributions are welcome and encouraged. You can contribute in many ways:
 102
 103 * Documentation updates and corrections.
 104 * How-To guides - received help? Help others!
 105 * Bug reporting & fixes.
 106 * New feature ideas & suggestions.
 107
 108 The best place to start is the Betaflight Slack (registration [here](https://slack.betaflight.com/). Next place is the github issue tracker:
 109
 110 https://github.com/betaflight/betaflight/issues
 111 https://github.com/betaflight/betaflight-configurator/issues
 112
 113 Before creating new issues please check to see if there is an existing one, search first otherwise you waste people's time when they could be coding instead!
 114
 115 If you want to contribute to our efforts financially, please consider making a donation to us through [PayPal](https://paypal.me/betaflight).
 116
 117 If you want to contribute financially on an ongoing basis, you should consider becoming a patron for us on [Patreon](https://www.patreon.com/betaflight).
 118
 119 ## Developers
 120
 121 Contribution of bugfixes and new features is encouraged. Please be aware that we have a thorough review process for pull requests, and be prepared to explain what you want to achieve with your pull request.
 122 Before starting to write code, please read our [development guidelines](docs/development/Development.md ) and [coding style definition](docs/development/CodingStyle.md).
 123
 124 TravisCI is used to run automatic builds
 125
 126 https://travis-ci.com/betaflight/betaflight
 127
 128 [![Build Status](https://travis-ci.com/betaflight/betaflight.svg?branch=master)](https://travis-ci.com/betaflight/betaflight)
 129
 130 ## Betaflight Releases
 131
 132 https://github.com/betaflight/betaflight/releases
 133
 134 ## Open Source / Contributors
 135
 136 Betaflight is software that is **open source** and is available free of charge without warranty to all users.
 137
 138 Betaflight is forked from Cleanflight, so thanks goes to all those whom have contributed to Cleanflight and its origins.
 139
 140 Origins for this fork (Thanks!):
 141 * **Alexinparis** (for MultiWii),
 142 * **timecop** (for Baseflight),
 143 * **Dominic Clifton** (for Cleanflight),
 144 * **borisbstyle** (for Betaflight), and
 145 * **Sambas** (for the original STM32F4 port).
 146
 147 The Betaflight Configurator is forked from Cleanflight Configurator and its origins.
 148
 149 Origins for Betaflight Configurator:
 150 * **Dominic Clifton** (for Cleanflight configurator), and
 151 * **ctn** (for the original Configurator).
 152
 153 Big thanks to current and past contributors:
 154 * Budden, Martin (martinbudden)
 155 * Bardwell, Joshua (joshuabardwell)
 156 * Blackman, Jason (blckmn)
 157 * ctzsnooze
 158 * Höglund, Anders (andershoglund)
 159 * Ledvina, Petr (ledvinap) - **IO code awesomeness!**
 160 * kc10kevin
 161 * Keeble, Gary (MadmanK)
 162 * Keller, Michael (mikeller) - **Configurator brilliance**
 163 * Kravcov, Albert (skaman82) - **Configurator brilliance**
 164 * MJ666
 165 * Nathan (nathantsoi)
 166 * ravnav
 167 * sambas - **bringing us the F4**
 168 * savaga
 169 * Stålheim, Anton (KiteAnton)
 170
 171 And many many others who haven't been mentioned....