README.md

   1 # INAV
   2
   3 ![INAV](http://static.rcgroups.net/forums/attachments/6/1/0/3/7/6/a9088858-102-inav.png)
   4
   5 Clean-code version of baseflight flight-controller - flight controllers are used to fly multi-rotor craft and fixed wing craft.
   6
   7 ## Important: PID values and scaling
   8
   9 Starting at 22-06-2016 INAV uses the same scaling for PIDs as Cleanflight/Betaflight LuxFloat and MWRewrite PID controllers. That means the following:
  10
  11 * PIDs from CF/BF can be used in INAV, no need to retune for INAV
  12 * INAV uses the same PID defaults that Cleanflight and Betaflight
  13 * Current INAV tunes can be converted to new using [this guide](https://github.com/iNavFlight/inav/wiki/PID-conversion-from-pre-1.2-to-1.2). This applies to all INAV 1.1
  14 * [Conversion spreadsheet](https://docs.google.com/spreadsheets/d/133vfzz6_38W5nUmoRNuP7ZX9V1E-8IG6x0FxuxkBuQg/edit?usp=sharing)
  15
  16 ## Features
  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 Seriously Pro Racing F3 board (STM32F303, I2C sensors, large flash, excellent I/O.)
  23 * Support for the TauLabs Sparky board (STM32F303, I2C sensors, based board with acc/gyro/compass and baro, ~$35)
  24 * Support for the OpenPilot CC3D board. (STM32F103, board, SPI acc/gyro, ~$20)
  25 * Support for the CJMCU nano quadcopter board.
  26 * Support for developer breakout boards: (Port103R, EUSTM32F103RC, Olimexino, STM32F3Discovery).
  27 * Support for more than 8 RC channels - (e.g. 16 Channels via FrSky X4RSB SBus).
  28 * Support for N-Position switches via flexible channel ranges - not just 3 like baseflight or 3/6 in MultiWii
  29 * Lux's new PID (uses float values internally, resistant to looptime variation).
  30 * Simultaneous Bluetooth configuration and OSD.
  31 * Better PWM and PPM input and failsafe detection than baseflight.
  32 * Better FrSky Telemetry than baseflight.
  33 * LTM Telemetry.
  34 * Smartport Telemetry.
  35 * RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II and X8R.
  36 * OLED Displays - Display information on: Battery voltage, profile, rate profile, version, sensors, RC, etc.
  37 * In-flight manual PID tuning and rate adjustment.
  38 * Rate profiles and in-flight selection of them.
  39 * Graupner PPM failsafe.
  40 * Graupner HoTT telemetry.
  41 * Multiple simultaneous telemetry providers.
  42 * Configurable serial ports for Serial RX, Telemetry, MSP, GPS - Use most devices on any port, softserial too.
  43 * And many more minor bug fixes.
  44
  45 For a list of features, changes and some discussion please review the thread on MultiWii forums and consult the documentation.
  46
  47 http://www.multiwii.com/forum/viewtopic.php?f=23&t=5149
  48
  49 ## Installation
  50
  51 See: https://github.com/iNavFlight/inav/blob/master/docs/Installation.md
  52
  53 ## Documentation
  54
  55 There is lots of documentation here: https://github.com/iNavFlight/inav/tree/master/docs
  56
  57 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 #iNavflight on the Freenode IRC network
  58
  59 ## IRC Support and Developers Channel
  60
  61 There's a dedicated IRC channel here:
  62
  63 irc://irc.freenode.net/#iNavflight
  64
  65 If you are using windows and don't have an IRC client installed then take a look at HydraIRC - here: http://hydrairc.com/
  66
  67 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.
  68
  69
  70 ## Configuration Tool
  71
  72 To configure INAV you should use the INAV-configurator GUI tool (Windows/OSX/Linux).
  73 Currently you have to download the sourcecode and load into Chrome manually from the github page
  74
  75 https://github.com/iNavFlight/inav-configurator
  76
  77 If you rather just want to use Cleanflight configurator you can download from here:
  78 https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb
  79
  80
  81 ## Contributing
  82
  83 Contributions are welcome and encouraged.  You can contribute in many ways:
  84
  85 * Documentation updates and corrections.
  86 * How-To guides - received help?  help others!
  87 * Bug fixes.
  88 * New features.
  89 * Telling us your ideas and suggestions.
  90
  91 The best place to start is the IRC channel on freenode (see above), drop in, say hi. Next place is the github issue tracker:
  92
  93 https://github.com/iNavFlight/inav/issues
  94
  95 https://github.com/iNavFlight/inav-configurator/issues
  96
  97 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!
  98
  99 ## Developers
 100
 101 Please refer to the development section in the [docs/development](https://github.com/iNavFlight/inav/tree/master/docs/development) folder.
 102
 103
 104 ## INAV Releases
 105 https://github.com/iNavFlight/inav/releases