README.md

   1 # Cleanflight
   2
   3 Clean-code version of baseflight flight-controller - flight controllers are used to fly multi-rotor craft and fixed wing craft.
   4
   5 This fork differs from baseflight in that it attempts to use modern software development practices which result in:
   6
   7 1. greater reliability through code robustness and automated testing.
   8 2. easier maintainance through code cleanliness.
   9 3. easier to develop new features.
  10 4. easier to re-use code though code de-coupling and modularisation.
  11
  12 The MultiWii software, from which baseflight originated, violates many good software development best-practices. Hopefully this fork will go some way to address them. If you see any bad code in this fork please immediately raise an issue so it can be fixed, or better yet submit a pull request.
  13
  14 ## Additional Features
  15
  16 Cleanflight also has additional features not found in baseflight.
  17
  18 * 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, etc)
  19 * Oneshot ESC support.
  20 * Blackbox flight recorder logging (to onboard flash or external SD card).
  21 * Support for additional targets that use the STM32F3 processors (baseflight only supports STM32F1).
  22 * Support for the TauLabs Sparky board (~$35 STM32F303 I2C sensors, based board with acc/gyro/compass and baro!)
  23 * Support for the OpenPilot CC3D board. (~$20 STM32F103 board, SPI acc/gyro)
  24 * Support for the CJMCU nano quadcopter board.
  25 * Support for developer breakout boards: (Port103R, EUSTM32F103RC, Olimexino, STM32F3Discovery).
  26 * Support for more than 8 RC channels - (e.g. 16 Channels via FrSky X4RSB SBus).
  27 * Support for N-Position switches via flexible channel ranges - not just 3 like baseflight or 3/6 in MultiWii
  28 * Lux's new PID (uses float values internally, resistant to looptime variation).
  29 * Simultaneous Bluetooth configuration and OSD.
  30 * Better PWM and PPM input and failsafe detection than baseflight.
  31 * Better FrSky Telemetry than baseflight.
  32 * MSP Telemetry.
  33 * RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II and X8R.
  34 * Autotune - ported from BradWii, experimental - feedback welcomed.
  35 * OLED Displays - Display information on: Battery voltage, profile, rate profile, version, sensors, RC, etc.
  36 * In-flight manual PID tuning and rate adjustment.
  37 * Rate profiles and in-flight selection of them.
  38 * Graupner PPM failsafe.
  39 * Graupner HoTT telemetry.
  40 * Multiple simultantious telemetry providers.
  41 * Configurable serial ports for Serial RX, Telemetry, MSP, GPS - Use most devices on any port, softserial too.
  42 + more many minor bug fixes.
  43
  44 For a list of features, changes and some discussion please review the thread on MultiWii forums and consult the documenation.
  45
  46 http://www.multiwii.com/forum/viewtopic.php?f=23&t=5149
  47
  48 ## Installation
  49
  50 See: https://github.com/cleanflight/cleanflight/blob/master/docs/Installation.md
  51
  52 ## Documentation
  53
  54 There is lots of documentation here: https://github.com/cleanflight/cleanflight/tree/master/docs
  55
  56 If what you need is not covered then refer to the baseflight documentation. If you still can't find what you need then visit the #cleanflight on the Freenode IRC network
  57
  58 ## IRC Support and Developers Channel
  59
  60 There's a dedicated IRC channel here:
  61
  62 irc://irc.freenode.net/#cleanflight
  63
  64 If you are using windows and don't have an IRC client installed then take a look at HydraIRC - here: http://hydrairc.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 ## Videos
  69
  70 There is a dedicated Cleanflight youtube channel which has progress update videos, flight demonstrations, instrutions and other related videos.
  71
  72 https://www.youtube.com/playlist?list=PL6H1fAj_XUNVBEcp8vbMH2DrllZAGWkt8
  73
  74 Please subscribe and '+1' the videos if you find them useful.
  75
  76 ## Configuration Tool
  77
  78 To configure Cleanflight you should use the Cleanlight-configurator GUI tool (Windows/OSX/Linux) that can be found here:
  79
  80 https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb
  81
  82 The source for it is here:
  83
  84 https://github.com/cleanflight/cleanflight-configurator
  85
  86 ## Contributing
  87
  88 Contributions are welcome and encouraged.  You can contribute in many ways:
  89
  90 * Documentation updates and corrections.
  91 * How-To guides - received help?  help others!
  92 * Bug fixes.
  93 * New features.
  94 * Telling us your ideas and suggestions.
  95
  96 The best place to start is the IRC channel on freenode (see above), drop in, say hi. Next place is the github issue tracker:
  97
  98 https://github.com/cleanflight/cleanflight/issues
  99 https://github.com/cleanflight/cleanflight-configurator/issues
 100
 101 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!
 102
 103 ## Developers
 104
 105 There is a developers section in the `docs/development` folder.
 106
 107 Before making any code contributions, take a note of the https://github.com/multiwii/baseflight/wiki/CodingStyle
 108
 109 For this fork it is also advised to read about clean code, here are some useful links:
 110
 111 * http://cleancoders.com/
 112 * http://en.wikipedia.org/wiki/SOLID_%28object-oriented_design%29
 113 * http://en.wikipedia.org/wiki/Code_smell
 114 * http://en.wikipedia.org/wiki/Code_refactoring
 115 * http://www.amazon.co.uk/Working-Effectively-Legacy-Robert-Martin/dp/0131177052
 116
 117 TravisCI is also used to run automatic builds
 118
 119 https://travis-ci.org/cleanflight/cleanflight
 120
 121 [![Build Status](https://travis-ci.org/cleanflight/cleanflight.svg?branch=master)](https://travis-ci.org/cleanflight/cleanflight)
 122
 123 ## Cleanflight Releases
 124 https://github.com/cleanflight/cleanflight/releases
 125
 126