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