Updated the `osd_pan_servo_index` max to 16
[inav.git] / readme.md
blob8382adc1881a3af26a698897548b2b2ae7a6497a
1 # INAV - navigation capable flight controller
3 ![INAV](http://static.rcgroups.net/forums/attachments/6/1/0/3/7/6/a9088858-102-inav.png)
5 # INAV 6 Horizon Hawk feature freeze
7 > INAV 6 feature freeze will happen on 29th of January 2023. No new features for INAV 6 will be accepted after that date. 
9 # INAV Community
11 * [INAV Discord Server](https://discord.gg/peg2hhbYwN)
12 * [INAV Official on Facebook](https://www.facebook.com/groups/INAVOfficial)
13 * [INAV Official on Telegram](https://t.me/INAVFlight)
15 ## Features
17 * Runs on the most popular F4, F7 and H7 flight controllers
18 * On Screen Display (OSD) - both character and pixel style
19 * DJI OSD integration: all elements, system messages and warnings
20 * Outstanding performance out of the box
21 * Position Hold, Altitude Hold, Return To Home and Missions
22 * Excellent support for fixed wing UAVs: airplanes, flying wings 
23 * Fully configurable mixer that allows to run any hardware you want: multirotor, fixed wing, rovers, boats and other experimental devices
24 * Multiple sensor support: GPS, Pitot tube, sonar, lidar, temperature, ESC with BlHeli_32 telemetry
25 * SmartAudio and IRC Tramp VTX support
26 * Blackbox flight recorder logging
27 * Telemetry: SmartPort, FPort, MAVlink, LTM
28 * Multi-color RGB LED Strip support
29 * Advanced gyro filtering
30 * Logic Conditions, Global Functions and Global Variables: you can program INAV with a GUI
31 * And many more!
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.
35 ## Tools
37 ### INAV Configurator
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.  
41 ### INAV Blackbox Explorer
43 Tool for Blackbox logs analysis is available [here](https://github.com/iNavFlight/blackbox-log-viewer/releases)
45 ### Telemetry screen for OpenTX
47 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)
49 ### INAV magnetometer alignment helper
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.
53 ### OSD layout Copy, Move, or Replace helper tool
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.
57 ## Installation
59 See: https://github.com/iNavFlight/inav/blob/master/docs/Installation.md
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)
73 ## Contributing
75 Contributions are welcome and encouraged.  You can contribute in many ways:
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/)
84 A good place to start is Telegram channel or Facebook group. Drop in, say hi.
86 Github issue tracker is a good place to search for existing issues or report a new bug/feature request:
88 https://github.com/iNavFlight/inav/issues
90 https://github.com/iNavFlight/inav-configurator/issues
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!
94 ## Developers
96 Please refer to the development section in the [docs/development](https://github.com/iNavFlight/inav/tree/master/docs/development) folder.
98 ## INAV Releases
99 https://github.com/iNavFlight/inav/releases