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