Merge remote-tracking branch 'upstream/master' into abo_fw_alt_vel_control
[inav.git] / readme.md
bloba70c42d4c86eb19c948c99050ee834f8476c8f26
1 # INAV - navigation capable flight controller
3 # F411 PSA
5 > INAV no longer accepts targets based on STM32 F411 MCU.
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.
9 ![INAV](http://static.rcgroups.net/forums/attachments/6/1/0/3/7/6/a9088858-102-inav.png)
11 # PosHold, Navigation and RTH without compass PSA
13 Attention all drone pilots and enthusiasts,
15 Are you ready to take your flights to new heights with INAV 7.1? We've got some important information to share with you.
17 INAV 7.1 brings an exciting update to navigation capabilities. Now, you can soar through the skies, navigate waypoints, and even return to home without relying on a compass. Yes, you heard that right! But before you launch into the air, there's something crucial to consider.
19 While INAV 7.1 may not require a compass for basic navigation functions, we strongly advise you to install one for optimal flight performance. Here's why:
21 🛰️ Better Flight Precision: A compass provides essential data for accurate navigation, ensuring smoother and more precise flight paths.
23 🌐 Enhanced Reliability: With a compass onboard, your drone can maintain stability even in challenging environments, low speeds and strong wind.
25 🚀 Minimize Risks: Although INAV 7.1 can get you where you need to go without a compass, flying without one may result in a bumpier ride and increased risk of drift or inaccurate positioning.
27 Remember, safety and efficiency are paramount when operating drones. By installing a compass, you're not just enhancing your flight experience, but also prioritizing safety for yourself and those around you.
29 So, before you take off on your next adventure, make sure to equip your drone with a compass. It's the smart choice for smoother flights and better navigation.
31 Fly safe, fly smart with INAV 7.1 and a compass by your side!
33 # INAV Community
35 * [INAV Discord Server](https://discord.gg/peg2hhbYwN)
36 * [INAV Official on Facebook](https://www.facebook.com/groups/INAVOfficial)
38 ## Features
40 * Runs on the most popular F4, AT32, F7 and H7 flight controllers
41 * On Screen Display (OSD) - both character and pixel style
42 * DJI OSD integration: all elements, system messages and warnings
43 * Outstanding performance out of the box
44 * Position Hold, Altitude Hold, Return To Home and Waypoint Missions
45 * Excellent support for fixed wing UAVs: airplanes, flying wings
46 * Blackbox flight recorder logging
47 * Advanced gyro filtering
48 * Fully configurable mixer that allows to run any hardware you want: multirotor, fixed wing, rovers, boats and other experimental devices
49 * Multiple sensor support: GPS, Pitot tube, sonar, lidar, temperature, ESC with BlHeli_32 telemetry
50 * Logic Conditions, Global Functions and Global Variables: you can program INAV with a GUI
51 * SmartAudio and IRC Tramp VTX support
52 * Telemetry: SmartPort, FPort, MAVlink, LTM, CRSF
53 * Multi-color RGB LED Strip support
54 * On Screen Display (OSD) - both character and pixel style
55 * And many more!
57 For a list of features, changes and some discussion please review consult the releases [page](https://github.com/iNavFlight/inav/releases) and the documentation.
59 ## Tools
61 ### INAV Configurator
63 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.
65 ### INAV Blackbox Explorer
67 Tool for Blackbox logs analysis is available [here](https://github.com/iNavFlight/blackbox-log-viewer/releases)
69 ### INAV Blackbox Tools
71 Command line tools (`blackbox_decode`, `blackbox_render`) for Blackbox log conversion and analysis [here](https://github.com/iNavFlight/blackbox-tools).
73 ### Telemetry screen for EdgeTX and OpenTX
75 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)
77 ### OSD layout Copy, Move, or Replace helper tool
79 [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.
81 ## Installation
83 See: https://github.com/iNavFlight/inav/blob/master/docs/Installation.md
85 ## Documentation, support and learning resources
86 * [INAV 5 on a flying wing full tutorial](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLkZlulvqsX_vRMfXd5zM7Ha)
87 * [INAV on a multirotor drone tutorial](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLkfcKsWobDLtBNIBzwlwRC8)
88 * [Fixed Wing Guide](docs/INAV_Fixed_Wing_Setup_Guide.pdf)
89 * [Autolaunch Guide](docs/INAV_Autolaunch.pdf)
90 * [Modes Guide](docs/INAV_Modes.pdf)
91 * [Wing Tuning Masterclass](docs/INAV_Wing_Tuning_Masterclass.pdf)
92 * [Official documentation](https://github.com/iNavFlight/inav/tree/master/docs)
93 * [Official Wiki](https://github.com/iNavFlight/inav/wiki)
94 * [Video series by Paweł Spychalski](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLloACrA6f1_daCjhqY2x0fB)
95 * [Target documentation](https://github.com/iNavFlight/inav/tree/master/docs/boards)
97 ## Contributing
99 Contributions are welcome and encouraged.  You can contribute in many ways:
101 * Documentation updates and corrections.
102 * How-To guides - received help?  help others!
103 * Bug fixes.
104 * New features.
105 * Telling us your ideas and suggestions.
106 * Buying your hardware from this [link](https://inavflight.com/shop/u/bg/)
108 A good place to start is the Discord channel, Telegram channel or Facebook group. Drop in, say hi.
110 Github issue tracker is a good place to search for existing issues or report a new bug/feature request:
112 https://github.com/iNavFlight/inav/issues
114 https://github.com/iNavFlight/inav-configurator/issues
116 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!
118 ## Developers
120 Please refer to the development section in the [docs/development](https://github.com/iNavFlight/inav/tree/master/docs/development) folder.
122 ## INAV Releases
123 https://github.com/iNavFlight/inav/releases