README.md

   1 ![Betaflight](docs/assets/images/bf_logo.png)
   2
   3 [![Build Status](https://travis-ci.com/betaflight/betaflight.svg?branch=master)](https://travis-ci.com/betaflight/betaflight)
   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
  14
  15 ## News
  16
  17 ### Requirements for the submission of new and updated targets
  18
  19 The following new requirements for pull requests adding new targets or modifying existing targets are put in place from now on:
  20
  21 1. No new F3 based targets will be accepted;
  22
  23 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;
  24
  25 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.
  26
  27
  28 ## Features
  29
  30 Betaflight has the following features:
  31
  32 * 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)
  33 * DShot (150, 300, 600 and 1200), Multishot, and Oneshot (125 and 42) motor protocol support
  34 * Blackbox flight recorder logging (to onboard flash or external microSD card where equipped)
  35 * Support for targets that use the STM32 F7, F4 and F3 processors
  36 * PWM, PPM, and Serial (SBus, SumH, SumD, Spektrum 1024/2048, XBus, etc) RX connection with failsafe detection
  37 * Multiple telemetry protocols (CSRF, FrSky, HoTT smart-port, MSP, etc)
  38 * RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II, X8R, X4R-SB, & XSR
  39 * OSD support & configuration without needing third-party OSD software/firmware/comm devices
  40 * OLED Displays - Display information on: Battery voltage/current/mAh, profile, rate profile, mode, version, sensors, etc
  41 * In-flight manual PID tuning and rate adjustment
  42 * Rate profiles and in-flight selection of them
  43 * Configurable serial ports for Serial RX, Telemetry, ESC telemetry, MSP, GPS, OSD, Sonar, etc - Use most devices on any port, softserial included
  44 * VTX support for Unify Pro and IRC Tramp
  45 * and MUCH, MUCH more.
  46
  47 ## Installation & Documentation
  48
  49 See: https://github.com/betaflight/betaflight/wiki
  50
  51 ## Support and Developers Channel
  52
  53 There's a dedicated Slack chat channel here:
  54
  55 https://slack.betaflight.com/
  56
  57 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.
  58
  59 ## Configuration Tool
  60
  61 To configure Betaflight you should use the Betaflight-configurator GUI tool (Windows/OSX/Linux) which can be found here:
  62
  63 https://github.com/betaflight/betaflight-configurator/releases/latest
  64
  65 ## Contributing
  66
  67 Contributions are welcome and encouraged. You can contribute in many ways:
  68
  69 * implement a new feature in the firmware or in configurator (see [below](#Developers));
  70 * documentation updates and corrections;
  71 * How-To guides - received help? Help others!
  72 * bug reporting & fixes;
  73 * new feature ideas & suggestions;
  74 * provide a new translation for configurator, or help us maintain the existing ones (see [below](#Translators)).
  75
  76 The best place to start is the Betaflight Slack (registration [here](https://slack.betaflight.com/)). Next place is the github issue tracker:
  77
  78 https://github.com/betaflight/betaflight/issues
  79 https://github.com/betaflight/betaflight-configurator/issues
  80
  81 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!
  82
  83 If you want to contribute to our efforts financially, please consider making a donation to us through [PayPal](https://paypal.me/betaflight).
  84
  85 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).
  86
  87 ## Developers
  88
  89 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.
  90 Before starting to write code, please read our [development guidelines](docs/development/Development.md ) and [coding style definition](docs/development/CodingStyle.md).
  91
  92 TravisCI is used to run automatic builds
  93
  94 https://travis-ci.com/betaflight/betaflight
  95
  96 [![Build Status](https://travis-ci.com/betaflight/betaflight.svg?branch=master)](https://travis-ci.com/betaflight/betaflight)
  97
  98 ## Translators
  99
 100 We want to make Betaflight accessible for pilots who are not fluent in English, and for this reason we are currently maintaining translations into 18 languages for Betaflight Configurator: Català, Deutsch, Español, Euskera, Français, Galego, Hrvatski, Bahasa Indonesia, Italiano, 日本語, 한국어, Latviešu, Português, Português Brasileiro, polski, Русский язык, Svenska, 简体中文.
 101 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:
 102 - 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;
 103 - 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 Slack (registration [here](https://slack.betaflight.com/)), and join the '#team\_translation' channel - the people in there can help you to get a new language added, or set you up as a proof reader.
 104
 105 ## Betaflight Releases
 106
 107 https://github.com/betaflight/betaflight/releases
 108
 109 ## Open Source / Contributors
 110
 111 Betaflight is software that is **open source** and is available free of charge without warranty to all users.
 112
 113 Betaflight is forked from Cleanflight, so thanks goes to all those whom have contributed to Cleanflight and its origins.
 114
 115 Origins for this fork (Thanks!):
 116 * **Alexinparis** (for MultiWii),
 117 * **timecop** (for Baseflight),
 118 * **Dominic Clifton** (for Cleanflight),
 119 * **borisbstyle** (for Betaflight), and
 120 * **Sambas** (for the original STM32F4 port).
 121
 122 The Betaflight Configurator is forked from Cleanflight Configurator and its origins.
 123
 124 Origins for Betaflight Configurator:
 125 * **Dominic Clifton** (for Cleanflight configurator), and
 126 * **ctn** (for the original Configurator).
 127
 128 Big thanks to current and past contributors:
 129 * Budden, Martin (martinbudden)
 130 * Bardwell, Joshua (joshuabardwell)
 131 * Blackman, Jason (blckmn)
 132 * ctzsnooze
 133 * Höglund, Anders (andershoglund)
 134 * Ledvina, Petr (ledvinap) - **IO code awesomeness!**
 135 * kc10kevin
 136 * Keeble, Gary (MadmanK)
 137 * Keller, Michael (mikeller) - **Configurator brilliance**
 138 * Kravcov, Albert (skaman82) - **Configurator brilliance**
 139 * MJ666
 140 * Nathan (nathantsoi)
 141 * ravnav
 142 * sambas - **bringing us the F4**
 143 * savaga
 144 * Stålheim, Anton (KiteAnton)
 145
 146 And many many others who haven't been mentioned....