README.md

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