README.md

   1 # INAV - navigation capable flight controller
   2
   3 ![INAV](http://static.rcgroups.net/forums/attachments/6/1/0/3/7/6/a9088858-102-inav.png)
   4
   5 # INAV Community
   6
   7 * [INAV Discord Server](https://discord.gg/peg2hhbYwN)
   8 * [INAV Official on Facebook](https://www.facebook.com/groups/INAVOfficial)
   9 * [RC Groups Support](https://www.rcgroups.com/forums/showthread.php?2495732-Cleanflight-iNav-(navigation-rewrite)-project)
  10 * [INAV Official on Telegram](https://t.me/INAVFlight)
  11
  12 ## Features
  13
  14 * Runs on the most popular F4 and F7 flight controllers
  15 * Outstanding performance out of the box
  16 * Position Hold, Altitude Hold, Return To Home and Missions
  17 * Excellent support for fixed wing UAVs: airplanes, flying wings
  18 * Fully configurable mixer that allows to run any hardware you want: multirotor, fixed wing, rovers, boats and other experimental devices
  19 * Multiple sensor support: GPS, Pitot tube, sonar, lidar, temperature, ESC with BlHeli_32 telemetry
  20 * SmartAudio and IRC Tramp VTX support
  21 * Blackbox flight recorder logging
  22 * On Screen Display (OSD) - both character and pixel style
  23 * DJI OSD integration: all elements, system messages and warnings
  24 * Telemetry: SmartPort, FPort, MAVlink, LTM
  25 * Multi-color RGB LED Strip support
  26 * Advanced gyro filtering: Matrix Filter and RPM filter
  27 * Logic Conditions, Global Functions and Global Variables: you can program INAV with a GUI
  28 * And many more!
  29
  30 For a list of features, changes and some discussion please review consult the releases [page](https://github.com/iNavFlight/inav/releases) and the documentation.
  31
  32 ## Tools
  33
  34 ### INAV Configurator
  35
  36 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.
  37
  38 ### INAV Blackbox Explorer
  39
  40 Tool for Blackbox logs analysis is available [here](https://github.com/iNavFlight/blackbox-log-viewer/releases)
  41
  42 ### Telemetry screen for OpenTX
  43
  44 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)
  45
  46 ### INAV magnetometer alignment helper
  47
  48 [INAV Magnetometer Alignment helper](https://kernel-machine.github.io/INavMagAlignHelper/) allows to align INAV magnetometer despite position and orientation. This simplifies the process of INAV setup on multirotors with tilted GPS modules.
  49
  50 ### OSD layout Copy, Move, or Replace helper tool
  51
  52 [Easy INAV OSD switcher tool](https://www.mrd-rc.com/tutorials-tools-and-testing/useful-tools/inav-osd-switcher-tool/) allows you to easily switch your OSD layouts around in iNav. Choose the from and to OSD layouts, and the method of transfering the layouts.
  53
  54 ## Installation
  55
  56 See: https://github.com/iNavFlight/inav/blob/master/docs/Installation.md
  57
  58 ## Documentation, support and learning resources
  59 * [Target documentation](https://github.com/iNavFlight/inav/tree/master/docs/boards)
  60 * [Fixed Wing Guide](docs/INAV_Fixed_Wing_Setup_Guide.pdf)
  61 * [Autolaunch Guide](docs/INAV_Autolaunch.pdf)
  62 * [Modes Guide](docs/INAV_Modes.pdf)
  63 * [Wing Tuning Masterclass](docs/INAV_Wing_Tuning_Masterclass.pdf)
  64 * [Official documentation](https://github.com/iNavFlight/inav/tree/master/docs)
  65 * [Official Wiki](https://github.com/iNavFlight/inav/wiki)
  66 * [Video series by Painless360](https://www.youtube.com/playlist?list=PLYsWjANuAm4qdXEGFSeUhOZ10-H8YTSnH)
  67 * [Video series by Paweł Spychalski](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLloACrA6f1_daCjhqY2x0fB)
  68
  69 ## Contributing
  70
  71 Contributions are welcome and encouraged.  You can contribute in many ways:
  72
  73 * Documentation updates and corrections.
  74 * How-To guides - received help?  help others!
  75 * Bug fixes.
  76 * New features.
  77 * Telling us your ideas and suggestions.
  78 * Buying your hardware from this [link](https://inavflight.com/shop/u/bg/)
  79
  80 A good place to start is Telegram channel or Facebook group. Drop in, say hi.
  81
  82 Github issue tracker is a good place to search for existing issues or report a new bug/feature request:
  83
  84 https://github.com/iNavFlight/inav/issues
  85
  86 https://github.com/iNavFlight/inav-configurator/issues
  87
  88 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!
  89
  90 ## Developers
  91
  92 Please refer to the development section in the [docs/development](https://github.com/iNavFlight/inav/tree/master/docs/development) folder.
  93
  94
  95 ## INAV Releases
  96 https://github.com/iNavFlight/inav/releases