README.md

   1 ![Betaflight](https://raw.githubusercontent.com/wiki/betaflight/betaflight/images/betaflight/bf_logo.png)
   2
   3 Betaflight is flight controller software (firmware) used to fly multi-rotor craft and fixed wing craft.
   4
   5 This fork differs from Baseflight and Cleanflight in that it focuses on flight performance, leading-edge feature additions, and wide target support.
   6
   7 ## News
   8
   9 ### Betaflight 4.0
  10
  11 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:
  12
  13 - 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;
  14 - 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;
  15 - 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.
  16
  17 *(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.)*
  18
  19 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.
  20
  21
  22 To get the latest update from us, you can now also visit our webpage at <https://betaflight.com/>.
  23
  24 In addition to the drastic changes mentioned above, Betaflight 4.0 will have a number of other exciting new features and improvements:
  25
  26 - yet again improved flight performance;
  27 - 'Launch control' mode;
  28 - switchable profiles for the OSD layout.
  29
  30 ## Events
  31
  32 | Date  | Event |
  33 | - | - |
  34 | 01 March 2019 | Start of feature freeze / Release Candidate window for Betaflight 4.0 |
  35 | 01 April 2019 | Planned [release](https://github.com/betaflight/betaflight/milestone/20) date for Betaflight 4.0 |
  36
  37 ## Features
  38
  39 Betaflight has the following features:
  40
  41 * 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)
  42 * DShot (150, 300, 600 and 1200), Multishot, and Oneshot (125 and 42) motor protocol support
  43 * Blackbox flight recorder logging (to onboard flash or external microSD card where equipped)
  44 * Support for targets that use the STM32 F7, F4 and F3 processors
  45 * PWM, PPM, and Serial (SBus, SumH, SumD, Spektrum 1024/2048, XBus, etc) RX connection with failsafe detection
  46 * Multiple telemetry protocols (CSRF, FrSky, HoTT smart-port, MSP, etc)
  47 * RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II, X8R, X4R-SB, & XSR
  48 * OSD support & configuration without needing third-party OSD software/firmware/comm devices
  49 * OLED Displays - Display information on: Battery voltage/current/mAh, profile, rate profile, mode, version, sensors, etc
  50 * In-flight manual PID tuning and rate adjustment
  51 * Rate profiles and in-flight selection of them
  52 * Configurable serial ports for Serial RX, Telemetry, ESC telemetry, MSP, GPS, OSD, Sonar, etc - Use most devices on any port, softserial included
  53 * VTX support for Unify Pro and IRC Tramp
  54 * and MUCH, MUCH more.
  55
  56 ## Installation & Documentation
  57
  58 See: https://github.com/betaflight/betaflight/wiki
  59
  60 ## IRC Support and Developers Channel
  61
  62 There's a dedicated Slack chat channel here:
  63
  64 https://slack.betaflight.com/
  65
  66 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.
  67
  68 ## Configuration Tool
  69
  70 To configure Betaflight you should use the Betaflight-configurator GUI tool (Windows/OSX/Linux) that can be found here:
  71
  72 https://chrome.google.com/webstore/detail/betaflight-configurator/kdaghagfopacdngbohiknlhcocjccjao
  73
  74 The source for it is here:
  75
  76 https://github.com/betaflight/betaflight-configurator
  77
  78 ## Contributing
  79
  80 Contributions are welcome and encouraged.  You can contribute in many ways:
  81
  82 * Documentation updates and corrections.
  83 * How-To guides - received help? Help others!
  84 * Bug reporting & fixes.
  85 * New feature ideas & suggestions.
  86
  87 The best place to start is the IRC channel on gitter (see above), drop in, say hi. Next place is the github issue tracker:
  88
  89 https://github.com/betaflight/betaflight/issues
  90 https://github.com/betaflight/betaflight-configurator/issues
  91
  92 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!
  93
  94 ## Developers
  95
  96 Please refer to the development section in the `docs/development` folder.
  97
  98 TravisCI is used to run automatic builds
  99
 100 https://travis-ci.org/betaflight/betaflight
 101
 102 [![Build Status](https://travis-ci.org/betaflight/betaflight.svg?branch=master)](https://travis-ci.org/betaflight/betaflight)
 103
 104 ## Betaflight Releases
 105
 106 https://github.com/betaflight/betaflight/releases
 107
 108 ## Open Source / Contributors
 109
 110 Betaflight is software that is **open source** and is available free of charge without warranty to all users.
 111
 112 Betaflight is forked from Cleanflight, so thanks goes to all those whom have contributed to Cleanflight and its origins.
 113
 114 Origins for this fork (Thanks!):
 115 * **Alexinparis** (for MultiWii),
 116 * **timecop** (for Baseflight),
 117 * **Dominic Clifton** (for Cleanflight), and
 118 * **Sambas** (for the original STM32F4 port).
 119 * **borisbstyle** (Fork from Cleanflight).
 120
 121 The Betaflight Configurator is forked from Cleanflight Configurator and its origins.
 122
 123 Origins for Betaflight Configurator:
 124 * **Dominic Clifton** (for Cleanflight configurator), and
 125 * **ctn** (for the original Configurator).
 126
 127 Big thanks to current and past contributors:
 128 * Budden, Martin (martinbudden)
 129 * Bardwell, Joshua (joshuabardwell)
 130 * Blackman, Jason (blckmn)
 131 * ctzsnooze
 132 * Höglund, Anders (andershoglund)
 133 * Ledvina, Petr (ledvinap) - **IO code awesomeness!**
 134 * kc10kevin
 135 * Keeble, Gary (MadmanK)
 136 * Keller, Michael (mikeller) - **Configurator brilliance**
 137 * Kravcov, Albert (skaman82) - **Configurator brilliance**
 138 * MJ666
 139 * Nathan (nathantsoi)
 140 * ravnav
 141 * sambas - **bringing us the F4**
 142 * savaga
 143 * Stålheim, Anton (KiteAnton)
 144
 145 And many many others who haven't been mentioned....