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 ### New requirements for the submission of new and updated targets
  15
  16 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'.
  17
  18 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.
  19
  20 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.
  21
  22 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:
  23
  24 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);
  25
  26 All subsequent rules exclude F3 based targets:
  27
  28 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;
  29
  30 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.
  31
  32
  33 ### End of active development for STM32F3 based flight controllers
  34
  35 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.
  36
  37 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.
  38
  39 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.
  40
  41 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.
  42
  43
  44 ### Betaflight 4.0
  45
  46 As you might have learned from the [Betaflight GitHub page](https://github.com/betaflight/betaflight), our next release will be 4.0. Betaflight 4.0 will be the culmination of years of work that started in 2016 with the introduction of remappable resources, and it will drastically change the way how Betaflight is built and distributed. To you as the user, not much in how you download and install the Betaflight firmware will change, but you will get some noticeable improvements:
  47
  48 - we’ll have to spend less time on maintaining and releasing the firmware, meaning that we’ll have more time to work on new and exciting features;
  49 - manufacturers will have an easy way to release custom configurations for all of their boards and ready-to-fly (including RX setup and tuning) craft based on original Betaflight firmware - you will no longer be stuck on using old firmware, or recreating your configuration from scratch;
  50 - the tinkerers amongst you will be able to share Betaflight firmware with your home built improvements amongst your friends without having to build and distribute separate targets for everybody’s board.
  51
  52 *(These changes are planned for F4 and F7, F3’s flash space limitations mean we won’t be able to fit all of this in.)*
  53
  54 We are almost there with the implementation of these changes, but since they are quite complex, and getting ‘almost there’ doesn’t buy us much, we have decided that we need to take more time to complete them, make sure the way users can use the firmware still works as expected, and properly test the new firmware. For this reason we have decided to **postpone the planned release date for Betaflight to 01 April 2019**. We will keep doing monthly releases of Betaflight 3.5 with bugfixes and new / updated targets in the meantime.
  55
  56
  57 To get the latest update from us, you can now also visit our webpage at <https://betaflight.com/>.
  58
  59 In addition to the drastic changes mentioned above, Betaflight 4.0 will have a number of other exciting new features and improvements:
  60
  61 - yet again improved flight performance;
  62 - 'Launch control' mode;
  63 - switchable profiles for the OSD layout.
  64
  65 ## Events
  66
  67 | Date  | Event |
  68 | - | - |
  69 | 01 March 2019 | Start of feature freeze / Release Candidate window for Betaflight 4.0 |
  70 | 01 April 2019 | Planned [release](https://github.com/betaflight/betaflight/milestone/20) date for Betaflight 4.0 |
  71
  72 ## Features
  73
  74 Betaflight has the following features:
  75
  76 * 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)
  77 * DShot (150, 300, 600 and 1200), Multishot, and Oneshot (125 and 42) motor protocol support
  78 * Blackbox flight recorder logging (to onboard flash or external microSD card where equipped)
  79 * Support for targets that use the STM32 F7, F4 and F3 processors
  80 * PWM, PPM, and Serial (SBus, SumH, SumD, Spektrum 1024/2048, XBus, etc) RX connection with failsafe detection
  81 * Multiple telemetry protocols (CSRF, FrSky, HoTT smart-port, MSP, etc)
  82 * RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II, X8R, X4R-SB, & XSR
  83 * OSD support & configuration without needing third-party OSD software/firmware/comm devices
  84 * OLED Displays - Display information on: Battery voltage/current/mAh, profile, rate profile, mode, version, sensors, etc
  85 * In-flight manual PID tuning and rate adjustment
  86 * Rate profiles and in-flight selection of them
  87 * Configurable serial ports for Serial RX, Telemetry, ESC telemetry, MSP, GPS, OSD, Sonar, etc - Use most devices on any port, softserial included
  88 * VTX support for Unify Pro and IRC Tramp
  89 * and MUCH, MUCH more.
  90
  91 ## Installation & Documentation
  92
  93 See: https://github.com/betaflight/betaflight/wiki
  94
  95 ## Support and Developers Channel
  96
  97 There's a dedicated Slack chat channel here:
  98
  99 https://slack.betaflight.com/
 100
 101 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.
 102
 103 ## Configuration Tool
 104
 105 To configure Betaflight you should use the Betaflight-configurator GUI tool (Windows/OSX/Linux) which can be found here:
 106
 107 https://github.com/betaflight/betaflight-configurator/releases/latest
 108
 109 ## Contributing
 110
 111 Contributions are welcome and encouraged. You can contribute in many ways:
 112
 113 * Documentation updates and corrections.
 114 * How-To guides - received help? Help others!
 115 * Bug reporting & fixes.
 116 * New feature ideas & suggestions.
 117
 118 The best place to start is the Betaflight Slack (registration [here](https://slack.betaflight.com/). Next place is the github issue tracker:
 119
 120 https://github.com/betaflight/betaflight/issues
 121 https://github.com/betaflight/betaflight-configurator/issues
 122
 123 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!
 124
 125 If you want to contribute to our efforts financially, please consider making a donation to us through [PayPal](https://paypal.me/betaflight).
 126
 127 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).
 128
 129 ## Developers
 130
 131 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.
 132 Before starting to write code, please read our [development guidelines](docs/development/Development.md ) and [coding style definition](docs/development/CodingStyle.md).
 133
 134 TravisCI is used to run automatic builds
 135
 136 https://travis-ci.org/betaflight/betaflight
 137
 138 [![Build Status](https://travis-ci.org/betaflight/betaflight.svg?branch=master)](https://travis-ci.org/betaflight/betaflight)
 139
 140 ## Betaflight Releases
 141
 142 https://github.com/betaflight/betaflight/releases
 143
 144 ## Open Source / Contributors
 145
 146 Betaflight is software that is **open source** and is available free of charge without warranty to all users.
 147
 148 Betaflight is forked from Cleanflight, so thanks goes to all those whom have contributed to Cleanflight and its origins.
 149
 150 Origins for this fork (Thanks!):
 151 * **Alexinparis** (for MultiWii),
 152 * **timecop** (for Baseflight),
 153 * **Dominic Clifton** (for Cleanflight),
 154 * **borisbstyle** (for Betaflight), and
 155 * **Sambas** (for the original STM32F4 port).
 156
 157 The Betaflight Configurator is forked from Cleanflight Configurator and its origins.
 158
 159 Origins for Betaflight Configurator:
 160 * **Dominic Clifton** (for Cleanflight configurator), and
 161 * **ctn** (for the original Configurator).
 162
 163 Big thanks to current and past contributors:
 164 * Budden, Martin (martinbudden)
 165 * Bardwell, Joshua (joshuabardwell)
 166 * Blackman, Jason (blckmn)
 167 * ctzsnooze
 168 * Höglund, Anders (andershoglund)
 169 * Ledvina, Petr (ledvinap) - **IO code awesomeness!**
 170 * kc10kevin
 171 * Keeble, Gary (MadmanK)
 172 * Keller, Michael (mikeller) - **Configurator brilliance**
 173 * Kravcov, Albert (skaman82) - **Configurator brilliance**
 174 * MJ666
 175 * Nathan (nathantsoi)
 176 * ravnav
 177 * sambas - **bringing us the F4**
 178 * savaga
 179 * Stålheim, Anton (KiteAnton)
 180
 181 And many many others who haven't been mentioned....