readme.md

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