README.md

   1 # INAV - navigation capable flight controller
   2
   3 ## F3 based flight controllers
   4
   5 > STM32 F3 flight controllers like Omnibus F3 or SP Racing F3 are deprecated and soon they will reach the end of support in INAV. If you are still using F3 boards, please migrate to F4 or F7.
   6
   7 ![INAV](http://static.rcgroups.net/forums/attachments/6/1/0/3/7/6/a9088858-102-inav.png)
   8 ![Travis CI status](https://travis-ci.org/iNavFlight/inav.svg?branch=master)
   9
  10 ## Features
  11
  12 * Outstanding navigation performance out of the box
  13 * Position Hold, Altitude Hold, Return To Home and Missions
  14 * Excellent support for fixed wing UAVs: airplanes, flying wings
  15 * Pitot tube support
  16 * Rangefinder support (sonar and laser)
  17 * Oneshot and Multishot ESC support.
  18 * Blackbox flight recorder logging (to onboard flash or external SD card).
  19 * Lux's new PID (uses float values internally, resistant to looptime variation).
  20 * Simultaneous Bluetooth configuration and OSD.
  21 * LTM Telemetry.
  22 * Smartport Telemetry.
  23 * RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II and X8R.
  24 * OLED Displays - Display information on: Battery voltage, profile, rate profile, version, sensors, RC, etc.
  25 * In-flight manual PID tuning and rate adjustment.
  26 * Rate profiles and in-flight selection of them.
  27 * Multiple simultaneous telemetry providers.
  28 * Configurable serial ports for Serial RX, Telemetry, MSP, GPS - Use most devices on any port, softserial too.
  29 * 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)
  30 * PIDs from CF/BF can be used in INAV, no need to retune for INAV
  31 * And many more!
  32
  33 For a list of features, changes and some discussion please review consult the releases [page](https://github.com/iNavFlight/inav/releases) and the documentation.
  34
  35 ## Tools
  36
  37 ### INAV Configurator
  38
  39 Official tool for INAV can be downloaded [here](https://github.com/iNavFlight/inav-configurator/releases). It can be run on Windows, MacOS and Linux machines and standalone application.
  40
  41 ### INAV Blackbox Explorer
  42
  43 Tool for Blackbox logs analysis is available [here](https://github.com/iNavFlight/blackbox-log-viewer/releases)
  44
  45 ### Telemetry screen for OpenTX
  46
  47 Users of FrSky Taranis X9 and Q X7 can use INAV Lua Telemetry screen created by @teckel12 . Software and installation instruction are available here: [https://github.com/iNavFlight/LuaTelemetry](https://github.com/iNavFlight/LuaTelemetry)
  48
  49 ## Installation
  50
  51 See: https://github.com/iNavFlight/inav/blob/master/docs/Installation.md
  52
  53 ## Documentation, support and learning resources
  54 * [Fixed Wing Guide](docs/INAV_Fixed_Wing_Setup_Guide.pdf)
  55 * [Autolaunch Guide](docs/INAV_Autolaunch.pdf)
  56 * [Modes Guide](docs/INAV_Modes.pdf)
  57 * [Wing Tuning Masterclass](docs/INAV_Wing_Tuning_Masterclass.pdf)
  58 * [Official documentation](https://github.com/iNavFlight/inav/tree/master/docs)
  59 * [Official Wiki](https://github.com/iNavFlight/inav/wiki)
  60 * [INAV Official on Telegram](https://t.me/INAVFlight)
  61 * [INAV Official on Facebook](https://www.facebook.com/groups/INAVOfficial)
  62 * [RC Groups Support](https://www.rcgroups.com/forums/showthread.php?2495732-Cleanflight-iNav-(navigation-rewrite)-project)
  63 * [Video series by Painless360](https://www.youtube.com/playlist?list=PLYsWjANuAm4qdXEGFSeUhOZ10-H8YTSnH)
  64 * [Video series by Paweł Spychalski](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLloACrA6f1_daCjhqY2x0fB)
  65
  66 ## Contributing
  67
  68 Contributions are welcome and encouraged.  You can contribute in many ways:
  69
  70 * Documentation updates and corrections.
  71 * How-To guides - received help?  help others!
  72 * Bug fixes.
  73 * New features.
  74 * Telling us your ideas and suggestions.
  75 * Buying your hardware from this [link](https://inavflight.com/shop/u/bg/)
  76
  77 A good place to start is Telegram channel or Facebook group. Drop in, say hi.
  78
  79 Github issue tracker is a good place to search for existing issues or report a new bug/feature request:
  80
  81 https://github.com/iNavFlight/inav/issues
  82
  83 https://github.com/iNavFlight/inav-configurator/issues
  84
  85 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!
  86
  87 ## Developers
  88
  89 Please refer to the development section in the [docs/development](https://github.com/iNavFlight/inav/tree/master/docs/development) folder.
  90
  91
  92 ## INAV Releases
  93 https://github.com/iNavFlight/inav/releases