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 ### End of active development for STM32F3 based flight controllers
  15
  16 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.
  17
  18 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.
  19
  20 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.
  21
  22 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.
  23
  24
  25 ### Embargo on new targets for Betaflight 4.0
  26
  27 As [announced earlier](https://github.com/betaflight/betaflight#betaflight-40), Betaflight 4.0 will introduce a radically new way to define targets. At the moment, we are making the changes necessary for this, and this requires some changes to how targets are defined in the 'legacy' way. Because of this, any pull request opened against `master` that introduces a new target is likely to be outdated by the time it has been reviewed. This means extra work for the target maintainer and the reviewers, for little or no benefit.
  28
  29 Because of this, the following embargo is put in place:
  30
  31 1. From 30/12/2018 on until the release of Betaflight 4.0 (scheduled for 01/04/2019), no pull requests that introduce new targets against `master` are accepted. Because any such pull requests will be outdated by the time 4.0 is released, they will be closed;
  32
  33 2. During the time that 1. is in place, pull requests adding new targets (in 3.5 format) against the `3.5.x-maintenance` branch will be considered. This is an exception to the rule that all pull requests must be opened against `master`. This exception only applies to pull requests containing no other changes than a new target and a documentation page for the new target. These new targets will be included in upcoming 3.5 maintenance releases;
  34
  35 3. Targets added under the exception in 2. will have to be ported into 4.0 before 4.0 is released. The format that these targets will have in 4.0 is yet to be determined, and instructions for porting the targets will have to be written, but we expect the maintainers of these targets to make themselves available to assist with this task when the time comes. Please follow the news and updates that are posted to https://betaflight.com/ or the [Betaflight GitHub page](https://github.com/betaflight/betaflight) to keep track of when action is required.
  36
  37
  38 ### Betaflight 4.0
  39
  40 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:
  41
  42 - 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;
  43 - 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;
  44 - 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.
  45
  46 *(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.)*
  47
  48 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.
  49
  50
  51 To get the latest update from us, you can now also visit our webpage at <https://betaflight.com/>.
  52
  53 In addition to the drastic changes mentioned above, Betaflight 4.0 will have a number of other exciting new features and improvements:
  54
  55 - yet again improved flight performance;
  56 - 'Launch control' mode;
  57 - switchable profiles for the OSD layout.
  58
  59 ## Events
  60
  61 | Date  | Event |
  62 | - | - |
  63 | 01 March 2019 | Start of feature freeze / Release Candidate window for Betaflight 4.0 |
  64 | 01 April 2019 | Planned [release](https://github.com/betaflight/betaflight/milestone/20) date for Betaflight 4.0 |
  65
  66 ## Features
  67
  68 Betaflight has the following features:
  69
  70 * 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)
  71 * DShot (150, 300, 600 and 1200), Multishot, and Oneshot (125 and 42) motor protocol support
  72 * Blackbox flight recorder logging (to onboard flash or external microSD card where equipped)
  73 * Support for targets that use the STM32 F7, F4 and F3 processors
  74 * PWM, PPM, and Serial (SBus, SumH, SumD, Spektrum 1024/2048, XBus, etc) RX connection with failsafe detection
  75 * Multiple telemetry protocols (CSRF, FrSky, HoTT smart-port, MSP, etc)
  76 * RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II, X8R, X4R-SB, & XSR
  77 * OSD support & configuration without needing third-party OSD software/firmware/comm devices
  78 * OLED Displays - Display information on: Battery voltage/current/mAh, profile, rate profile, mode, version, sensors, etc
  79 * In-flight manual PID tuning and rate adjustment
  80 * Rate profiles and in-flight selection of them
  81 * Configurable serial ports for Serial RX, Telemetry, ESC telemetry, MSP, GPS, OSD, Sonar, etc - Use most devices on any port, softserial included
  82 * VTX support for Unify Pro and IRC Tramp
  83 * and MUCH, MUCH more.
  84
  85 ## Installation & Documentation
  86
  87 See: https://github.com/betaflight/betaflight/wiki
  88
  89 ## IRC Support and Developers Channel
  90
  91 There's a dedicated Slack chat channel here:
  92
  93 https://slack.betaflight.com/
  94
  95 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.
  96
  97 ## Configuration Tool
  98
  99 To configure Betaflight you should use the Betaflight-configurator GUI tool (Windows/OSX/Linux) that can be found here:
 100
 101 https://chrome.google.com/webstore/detail/betaflight-configurator/kdaghagfopacdngbohiknlhcocjccjao
 102
 103 The source for it is here:
 104
 105 https://github.com/betaflight/betaflight-configurator
 106
 107 ## Contributing
 108
 109 Contributions are welcome and encouraged.  You can contribute in many ways:
 110
 111 * Documentation updates and corrections.
 112 * How-To guides - received help? Help others!
 113 * Bug reporting & fixes.
 114 * New feature ideas & suggestions.
 115
 116 The best place to start is the Betaflight Slack (registration [here](https://slack.betaflight.com/). Next place is the github issue tracker:
 117
 118 https://github.com/betaflight/betaflight/issues
 119 https://github.com/betaflight/betaflight-configurator/issues
 120
 121 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!
 122
 123 ## Developers
 124
 125 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.
 126 Before starting to write code, please read our [development guidelines](docs/development/Development.md ) and [coding style definition](docs/development/CodingStyle.md).
 127
 128 TravisCI is used to run automatic builds
 129
 130 https://travis-ci.org/betaflight/betaflight
 131
 132 [![Build Status](https://travis-ci.org/betaflight/betaflight.svg?branch=master)](https://travis-ci.org/betaflight/betaflight)
 133
 134 ## Betaflight Releases
 135
 136 https://github.com/betaflight/betaflight/releases
 137
 138 ## Open Source / Contributors
 139
 140 Betaflight is software that is **open source** and is available free of charge without warranty to all users.
 141
 142 Betaflight is forked from Cleanflight, so thanks goes to all those whom have contributed to Cleanflight and its origins.
 143
 144 Origins for this fork (Thanks!):
 145 * **Alexinparis** (for MultiWii),
 146 * **timecop** (for Baseflight),
 147 * **Dominic Clifton** (for Cleanflight),
 148 * **borisbstyle** (for Betaflight), and
 149 * **Sambas** (for the original STM32F4 port).
 150
 151 The Betaflight Configurator is forked from Cleanflight Configurator and its origins.
 152
 153 Origins for Betaflight Configurator:
 154 * **Dominic Clifton** (for Cleanflight configurator), and
 155 * **ctn** (for the original Configurator).
 156
 157 Big thanks to current and past contributors:
 158 * Budden, Martin (martinbudden)
 159 * Bardwell, Joshua (joshuabardwell)
 160 * Blackman, Jason (blckmn)
 161 * ctzsnooze
 162 * Höglund, Anders (andershoglund)
 163 * Ledvina, Petr (ledvinap) - **IO code awesomeness!**
 164 * kc10kevin
 165 * Keeble, Gary (MadmanK)
 166 * Keller, Michael (mikeller) - **Configurator brilliance**
 167 * Kravcov, Albert (skaman82) - **Configurator brilliance**
 168 * MJ666
 169 * Nathan (nathantsoi)
 170 * ravnav
 171 * sambas - **bringing us the F4**
 172 * savaga
 173 * Stålheim, Anton (KiteAnton)
 174
 175 And many many others who haven't been mentioned....