README.md

   1 ![Important Notice: Support for STM32F3 based flight controllers was dropped in Betaflight 4.1. (This includes all boards with 'F3' in the name.)](docs/assets/images/stm32f3_retirement_notice.svg)
   2
   3 (Please see the [note](#end-of-active-development-for-stm32f3-based-flight-controllers) below.)
   4
   5
   6 ![Betaflight](docs/assets/images/bf_logo.png)
   7
   8 [![Build Status](https://travis-ci.com/betaflight/betaflight.svg?branch=master)](https://travis-ci.com/betaflight/betaflight)
   9
  10 Betaflight is flight controller software (firmware) used to fly multi-rotor craft and fixed wing craft.
  11
  12 This fork differs from Baseflight and Cleanflight in that it focuses on flight performance, leading-edge feature additions, and wide target support.
  13
  14 ## Events
  15
  16 | Date  | Event |
  17 | - | - |
  18 | 25 March 2020 | Deadline for pull request submission into 4.2 |
  19 | 1 April 2020 | Start of feature freeze / Release Candidate window for Betaflight 4.2 |
  20 | 1 May 2020 | Planned [release](https://github.com/betaflight/betaflight/milestone/38) date for Betaflight 4.2 |
  21
  22
  23 ## News
  24
  25 ### Requirements for the submission of new and updated targets
  26
  27 The following new requirements for pull requests adding new targets or modifying existing targets are put in place from now on:
  28
  29 1. No new F3 based targets will be accepted;
  30
  31 2. For any new target that is to be added, only a Unified Target config into https://github.com/betaflight/unified-targets/tree/master/configs/default needs to be submitted. See the [instructions](https://github.com/betaflight/betaflight/blob/master/docs/TargetMaintenance/CreatingAUnifiedTarget.md) for how to create a Unified Target configuration. If there is no Unified Target for the MCU type of the new target (see instructions above), then a 'legacy' format target definition into `src/main/target/` has to be submitted as well;
  32
  33 3. For changes to existing targets, the change needs to be applied to the Unified Target config in https://github.com/betaflight/unified-targets/tree/master/configs/default. If no Unified Target configuration for the target exists, a new Unified Target configuration will have to be created and submitted. If there is no Unified Target for the MCU type of the new target (see instructions above), then an update to the 'legacy' format target definition in `src/main/target/` has to be submitted alongside the update to the Unified Target configuration.
  34
  35
  36 ### End of active development for STM32F3 based flight controllers
  37
  38 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.
  39
  40 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.
  41
  42 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.
  43
  44 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.
  45
  46
  47 ## Features
  48
  49 Betaflight has the following features:
  50
  51 * 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)
  52 * DShot (150, 300, 600 and 1200), Multishot, and Oneshot (125 and 42) motor protocol support
  53 * Blackbox flight recorder logging (to onboard flash or external microSD card where equipped)
  54 * Support for targets that use the STM32 F7, F4 and F3 processors
  55 * PWM, PPM, and Serial (SBus, SumH, SumD, Spektrum 1024/2048, XBus, etc) RX connection with failsafe detection
  56 * Multiple telemetry protocols (CSRF, FrSky, HoTT smart-port, MSP, etc)
  57 * RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II, X8R, X4R-SB, & XSR
  58 * OSD support & configuration without needing third-party OSD software/firmware/comm devices
  59 * OLED Displays - Display information on: Battery voltage/current/mAh, profile, rate profile, mode, version, sensors, etc
  60 * In-flight manual PID tuning and rate adjustment
  61 * Rate profiles and in-flight selection of them
  62 * Configurable serial ports for Serial RX, Telemetry, ESC telemetry, MSP, GPS, OSD, Sonar, etc - Use most devices on any port, softserial included
  63 * VTX support for Unify Pro and IRC Tramp
  64 * and MUCH, MUCH more.
  65
  66 ## Installation & Documentation
  67
  68 See: https://github.com/betaflight/betaflight/wiki
  69
  70 ## Support and Developers Channel
  71
  72 There's a dedicated Slack chat channel here:
  73
  74 https://slack.betaflight.com/
  75
  76 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.
  77
  78 ## Configuration Tool
  79
  80 To configure Betaflight you should use the Betaflight-configurator GUI tool (Windows/OSX/Linux) which can be found here:
  81
  82 https://github.com/betaflight/betaflight-configurator/releases/latest
  83
  84 ## Contributing
  85
  86 Contributions are welcome and encouraged. You can contribute in many ways:
  87
  88 * Implement a new feature in the firmware or in configurator (see [below](#Developers)).
  89 * Documentation updates and corrections.
  90 * How-To guides - received help? Help others!
  91 * Bug reporting & fixes.
  92 * New feature ideas & suggestions.
  93 * Provide a new translation for configurator, or help us maintain the existing ones.
  94
  95 The best place to start is the Betaflight Slack (registration [here](https://slack.betaflight.com/)). Next place is the github issue tracker:
  96
  97 https://github.com/betaflight/betaflight/issues
  98 https://github.com/betaflight/betaflight-configurator/issues
  99
 100 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!
 101
 102 If you want to contribute to our efforts financially, please consider making a donation to us through [PayPal](https://paypal.me/betaflight).
 103
 104 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).
 105
 106 ## Developers
 107
 108 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.
 109 Before starting to write code, please read our [development guidelines](docs/development/Development.md ) and [coding style definition](docs/development/CodingStyle.md).
 110
 111 TravisCI is used to run automatic builds
 112
 113 https://travis-ci.com/betaflight/betaflight
 114
 115 [![Build Status](https://travis-ci.com/betaflight/betaflight.svg?branch=master)](https://travis-ci.com/betaflight/betaflight)
 116
 117 ## Betaflight Releases
 118
 119 https://github.com/betaflight/betaflight/releases
 120
 121 ## Open Source / Contributors
 122
 123 Betaflight is software that is **open source** and is available free of charge without warranty to all users.
 124
 125 Betaflight is forked from Cleanflight, so thanks goes to all those whom have contributed to Cleanflight and its origins.
 126
 127 Origins for this fork (Thanks!):
 128 * **Alexinparis** (for MultiWii),
 129 * **timecop** (for Baseflight),
 130 * **Dominic Clifton** (for Cleanflight),
 131 * **borisbstyle** (for Betaflight), and
 132 * **Sambas** (for the original STM32F4 port).
 133
 134 The Betaflight Configurator is forked from Cleanflight Configurator and its origins.
 135
 136 Origins for Betaflight Configurator:
 137 * **Dominic Clifton** (for Cleanflight configurator), and
 138 * **ctn** (for the original Configurator).
 139
 140 Big thanks to current and past contributors:
 141 * Budden, Martin (martinbudden)
 142 * Bardwell, Joshua (joshuabardwell)
 143 * Blackman, Jason (blckmn)
 144 * ctzsnooze
 145 * Höglund, Anders (andershoglund)
 146 * Ledvina, Petr (ledvinap) - **IO code awesomeness!**
 147 * kc10kevin
 148 * Keeble, Gary (MadmanK)
 149 * Keller, Michael (mikeller) - **Configurator brilliance**
 150 * Kravcov, Albert (skaman82) - **Configurator brilliance**
 151 * MJ666
 152 * Nathan (nathantsoi)
 153 * ravnav
 154 * sambas - **bringing us the F4**
 155 * savaga
 156 * Stålheim, Anton (KiteAnton)
 157
 158 And many many others who haven't been mentioned....