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 * Runs on the most popular F4 and F7 flight controllers
  13 * Outstanding performance out of the box
  14 * Position Hold, Altitude Hold, Return To Home and Missions
  15 * Excellent support for fixed wing UAVs: airplanes, flying wings
  16 * Fully configurable mixer that allows to run any hardware you want: multirotor, fixed wing, rovers, boats and other experimental devices
  17 * Multiple sensor support: GPS, Pitot tube, sonar, lidar, temperature, ESC with BlHeli_32 telemetry
  18 * SmartAudio and IRC Tramp VTX support
  19 * DSHOT and Multishot ESCs
  20 * Blackbox flight recorder logging
  21 * On Screen Display (OSD) - both character and pixel style
  22 * Telemetry: SmartPort, FPort, MAVlink, LTM
  23 * Multi-color RGB LED Strip support
  24 * Advanced gyro filtering: Matrix Filter and RPM filter
  25 * Logic Conditions, Global Functions and Global Variables: you can program INAV with a GUI
  26 * And many more!
  27
  28 For a list of features, changes and some discussion please review consult the releases [page](https://github.com/iNavFlight/inav/releases) and the documentation.
  29
  30 ## Tools
  31
  32 ### INAV Configurator
  33
  34 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.
  35
  36 ### INAV Blackbox Explorer
  37
  38 Tool for Blackbox logs analysis is available [here](https://github.com/iNavFlight/blackbox-log-viewer/releases)
  39
  40 ### Telemetry screen for OpenTX
  41
  42 Users of OpenTX radios (Taranis, Horus, Jumper, Radiomaster, Nirvana) can use INAV OpenTX Telemetry Widget screen. Software and installation instruction are available here: [https://github.com/iNavFlight/OpenTX-Telemetry-Widget](https://github.com/iNavFlight/OpenTX-Telemetry-Widget)
  43
  44 ## Installation
  45
  46 See: https://github.com/iNavFlight/inav/blob/master/docs/Installation.md
  47
  48 ## Documentation, support and learning resources
  49 * [Fixed Wing Guide](docs/INAV_Fixed_Wing_Setup_Guide.pdf)
  50 * [Autolaunch Guide](docs/INAV_Autolaunch.pdf)
  51 * [Modes Guide](docs/INAV_Modes.pdf)
  52 * [Wing Tuning Masterclass](docs/INAV_Wing_Tuning_Masterclass.pdf)
  53 * [Official documentation](https://github.com/iNavFlight/inav/tree/master/docs)
  54 * [Official Wiki](https://github.com/iNavFlight/inav/wiki)
  55 * [INAV Official on Telegram](https://t.me/INAVFlight)
  56 * [INAV Official on Facebook](https://www.facebook.com/groups/INAVOfficial)
  57 * [RC Groups Support](https://www.rcgroups.com/forums/showthread.php?2495732-Cleanflight-iNav-(navigation-rewrite)-project)
  58 * [Video series by Painless360](https://www.youtube.com/playlist?list=PLYsWjANuAm4qdXEGFSeUhOZ10-H8YTSnH)
  59 * [Video series by Paweł Spychalski](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLloACrA6f1_daCjhqY2x0fB)
  60
  61 ## Contributing
  62
  63 Contributions are welcome and encouraged.  You can contribute in many ways:
  64
  65 * Documentation updates and corrections.
  66 * How-To guides - received help?  help others!
  67 * Bug fixes.
  68 * New features.
  69 * Telling us your ideas and suggestions.
  70 * Buying your hardware from this [link](https://inavflight.com/shop/u/bg/)
  71
  72 A good place to start is Telegram channel or Facebook group. Drop in, say hi.
  73
  74 Github issue tracker is a good place to search for existing issues or report a new bug/feature request:
  75
  76 https://github.com/iNavFlight/inav/issues
  77
  78 https://github.com/iNavFlight/inav-configurator/issues
  79
  80 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!
  81
  82 ## Developers
  83
  84 Please refer to the development section in the [docs/development](https://github.com/iNavFlight/inav/tree/master/docs/development) folder.
  85
  86
  87 ## INAV Releases
  88 https://github.com/iNavFlight/inav/releases