README.md

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