README.md

   1 ![Betaflight](docs/assets/images/bf_logo.png)
   2
   3 [![Latest version](https://img.shields.io/github/v/release/betaflight/betaflight)](https://github.com/betaflight/betaflight/releases) [![Build](https://img.shields.io/github/actions/workflow/status/betaflight/betaflight/nightly.yml?branch=master)](https://github.com/betaflight/betaflight/actions/workflows/nightly.yml) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Join us on Discord!](https://img.shields.io/discord/868013470023548938)](https://discord.gg/n4E6ak4u3c)
   4
   5 Betaflight is flight controller software (firmware) used to fly multi-rotor craft and fixed wing craft.
   6
   7 This fork differs from Baseflight and Cleanflight in that it focuses on flight performance, leading-edge feature additions, and wide target support.
   8
   9 ## Events
  10
  11 | Date  | Event |
  12 | - | - |
  13 | 01-11-2022 | Firmware 4.4 Feature freeze |
  14
  15
  16 ## News
  17
  18 ### Requirements for the submission of new and updated targets
  19
  20 The following new requirements for pull requests adding new targets or modifying existing targets are put in place from now on:
  21
  22 1. Read the [hardware specification](https://github.com/betaflight/betaflight/blob/master/docs/Manufacturer%20Design%20Guidelines.md)
  23
  24 2. No new F3 based targets will be accepted;
  25
  26 3. 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;
  27
  28 4. 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.
  29
  30
  31 ## Features
  32
  33 Betaflight has the following features:
  34
  35 * 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)
  36 * DShot (150, 300 and 600), Multishot, Oneshot (125 and 42) and Proshot1000 motor protocol support
  37 * Blackbox flight recorder logging (to onboard flash or external microSD card where equipped)
  38 * Support for targets that use the STM32 F4, G4, F7 and H7 processors
  39 * PWM, PPM, SPI, and Serial (SBus, SumH, SumD, Spektrum 1024/2048, XBus, etc) RX connection with failsafe detection
  40 * Multiple telemetry protocols (CRSF, FrSky, HoTT smart-port, MSP, etc)
  41 * RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II, X8R, X4R-SB, & XSR
  42 * OSD support & configuration without needing third-party OSD software/firmware/comm devices
  43 * OLED Displays - Display information on: Battery voltage/current/mAh, profile, rate profile, mode, version, sensors, etc
  44 * In-flight manual PID tuning and rate adjustment
  45 * PID and filter tuning using sliders
  46 * Rate profiles and in-flight selection of them
  47 * Configurable serial ports for Serial RX, Telemetry, ESC telemetry, MSP, GPS, OSD, Sonar, etc - Use most devices on any port, softserial included
  48 * VTX support for Unify Pro and IRC Tramp
  49 * and MUCH, MUCH more.
  50
  51 ## Installation & Documentation
  52
  53 See: https://github.com/betaflight/betaflight/wiki
  54
  55 ## Support and Developers Channel
  56
  57 There's a dedicated Discord server here:
  58
  59 https://discord.gg/n4E6ak4u3c
  60
  61 We also have a Facebook Group. Join us to get a place to talk about Betaflight, ask configuration questions, or just hang out with fellow pilots.
  62
  63 https://www.facebook.com/groups/betaflightgroup/
  64
  65 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.
  66
  67 ## Configuration Tool
  68
  69 To configure Betaflight you should use the Betaflight-configurator GUI tool (Windows/OSX/Linux) which can be found here:
  70
  71 https://github.com/betaflight/betaflight-configurator/releases/latest
  72
  73 ## Contributing
  74
  75 Contributions are welcome and encouraged. You can contribute in many ways:
  76
  77 * implement a new feature in the firmware or in configurator (see [below](#Developers));
  78 * documentation updates and corrections;
  79 * How-To guides - received help? Help others!
  80 * bug reporting & fixes;
  81 * new feature ideas & suggestions;
  82 * provide a new translation for configurator, or help us maintain the existing ones (see [below](#Translators)).
  83
  84 The best place to start is the Betaflight Slack (registration [here](https://slack.betaflight.com/)). Next place is the github issue tracker:
  85
  86 https://github.com/betaflight/betaflight/issues
  87 https://github.com/betaflight/betaflight-configurator/issues
  88
  89 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!
  90
  91 If you want to contribute to our efforts financially, please consider making a donation to us through [PayPal](https://paypal.me/betaflight).
  92
  93 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).
  94
  95 ## Developers
  96
  97 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.
  98 Before starting to write code, please read our [development guidelines](docs/development/Development.md ) and [coding style definition](docs/development/CodingStyle.md).
  99
 100 GitHub actions are used to run automatic builds
 101
 102 ## Translators
 103
 104 We want to make Betaflight accessible for pilots who are not fluent in English, and for this reason we are currently maintaining translations into 21 languages for Betaflight Configurator: Català, Dansk, Deutsch, Español, Euskera, Français, Galego, Hrvatski, Bahasa Indonesia, Italiano, 日本語, 한국어, Latviešu, Português, Português Brasileiro, polski, Русский язык, Svenska, 简体中文, 繁體中文.
 105 We have got a team of volunteer translators who do this work, but additional translators are always welcome to share the workload, and we are keen to add additional languages. If you would like to help us with translations, you have got the following options:
 106 - if you help by suggesting some updates or improvements to translations in a language you are familiar with, head to [crowdin](https://crowdin.com/project/betaflight-configurator) and add your suggested translations there;
 107 - if you would like to start working on the translation for a new language, or take on responsibility for proof-reading the translation for a language you are very familiar with, please head to the Betaflight Discord chat (registration [here](https://discord.gg/n4E6ak4u3c)), and join the ['translation'](https://discord.com/channels/868013470023548938/1057773726915100702) channel - the people in there can help you to get a new language added, or set you up as a proof reader.
 108
 109 ## Hardware Issues
 110
 111 Betaflight does not manufacture or distribute their own hardware. While we are collaborating with and supported by a number of manufacturers, we do not do any kind of hardware support.
 112 If you encounter any hardware issues with your flight controller or another component, please contact the manufacturer or supplier of your hardware, or check RCGroups https://rcgroups.com/forums/showthread.php?t=2464844 to see if others with the same problem have found a solution.
 113
 114 ## Betaflight Releases
 115
 116 https://github.com/betaflight/betaflight/releases
 117
 118 ## Open Source / Contributors
 119
 120 Betaflight is software that is **open source** and is available free of charge without warranty to all users.
 121
 122 Betaflight is forked from Cleanflight, so thanks goes to all those whom have contributed to Cleanflight and its origins.
 123
 124 Origins for this fork (Thanks!):
 125 * **Alexinparis** (for MultiWii),
 126 * **timecop** (for Baseflight),
 127 * **Dominic Clifton** (for Cleanflight),
 128 * **borisbstyle** (for Betaflight), and
 129 * **Sambas** (for the original STM32F4 port).
 130
 131 The Betaflight Configurator is forked from Cleanflight Configurator and its origins.
 132
 133 Origins for Betaflight Configurator:
 134 * **Dominic Clifton** (for Cleanflight configurator), and
 135 * **ctn** (for the original Configurator).
 136
 137 Big thanks to current and past contributors:
 138 * Budden, Martin (martinbudden)
 139 * Bardwell, Joshua (joshuabardwell)
 140 * Blackman, Jason (blckmn)
 141 * ctzsnooze
 142 * Höglund, Anders (andershoglund)
 143 * Ledvina, Petr (ledvinap) - **IO code awesomeness!**
 144 * kc10kevin
 145 * Keeble, Gary (MadmanK)
 146 * Keller, Michael (mikeller) - **Configurator brilliance**
 147 * Kravcov, Albert (skaman82) - **Configurator brilliance**
 148 * MJ666
 149 * Nathan (nathantsoi)
 150 * ravnav
 151 * sambas - **bringing us the F4**
 152 * savaga
 153 * Stålheim, Anton (KiteAnton)
 154
 155 And many many others who haven't been mentioned....