Merge remote-tracking branch 'origin/master' into mmosca-update-github-actions
[inav.git] / readme.md
blobfac247ef9ab9c86a108913f439a3aff7045ff82b
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 # ICM426xx IMUs PSA
11 > The filtering settings for the ICM426xx has changed to match what is used by Ardupilot and Betaflight in INAV 7.1. When upgrading from older versions you may need to recalibrate the Accelerometer and if you are not using INAV's default tune you may also want to check if the tune is still good.
13 ![INAV](http://static.rcgroups.net/forums/attachments/6/1/0/3/7/6/a9088858-102-inav.png)
15 # PosHold, Navigation and RTH without compass PSA
17 Attention all drone pilots and enthusiasts,
19 Are you ready to take your flights to new heights with INAV 7.1? We've got some important information to share with you.
21 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.
23 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:
25 🛰️ Better Flight Precision: A compass provides essential data for accurate navigation, ensuring smoother and more precise flight paths.
27 🌐 Enhanced Reliability: With a compass onboard, your drone can maintain stability even in challenging environments, low speeds and strong wind.
29 🚀 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.
31 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.
33 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.
35 Fly safe, fly smart with INAV 7.1 and a compass by your side!
37 # INAV Community
39 * [INAV Discord Server](https://discord.gg/peg2hhbYwN)
40 * [INAV Official on Facebook](https://www.facebook.com/groups/INAVOfficial)
42 ## Features
44 * Runs on the most popular F4, AT32, F7 and H7 flight controllers
45 * On Screen Display (OSD) - both character and pixel style
46 * DJI OSD integration: all elements, system messages and warnings
47 * Outstanding performance out of the box
48 * Position Hold, Altitude Hold, Return To Home and Waypoint Missions
49 * Excellent support for fixed wing UAVs: airplanes, flying wings
50 * Blackbox flight recorder logging
51 * Advanced gyro filtering
52 * Fully configurable mixer that allows to run any hardware you want: multirotor, fixed wing, rovers, boats and other experimental devices
53 * Multiple sensor support: GPS, Pitot tube, sonar, lidar, temperature, ESC with BlHeli_32 telemetry
54 * Logic Conditions, Global Functions and Global Variables: you can program INAV with a GUI
55 * SmartAudio and IRC Tramp VTX support
56 * Telemetry: SmartPort, FPort, MAVlink, LTM, CRSF
57 * Multi-color RGB LED Strip support
58 * And many more!
60 For a list of features, changes and some discussion please review consult the releases [page](https://github.com/iNavFlight/inav/releases) and the documentation.
62 ## Tools
64 ### INAV Configurator
66 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.
68 ### INAV Blackbox Explorer
70 Tool for Blackbox logs analysis is available [here](https://github.com/iNavFlight/blackbox-log-viewer/releases)
72 ### INAV Blackbox Tools
74 Command line tools (`blackbox_decode`, `blackbox_render`) for Blackbox log conversion and analysis [here](https://github.com/iNavFlight/blackbox-tools).
76 ### Telemetry screen for EdgeTX and OpenTX
78 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)
80 ### OSD layout Copy, Move, or Replace helper tool
82 [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.
84 ## Installation
86 See: https://github.com/iNavFlight/inav/blob/master/docs/Installation.md
88 ## Documentation, support and learning resources
89 * [INAV 5 on a flying wing full tutorial](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLkZlulvqsX_vRMfXd5zM7Ha)
90 * [INAV on a multirotor drone tutorial](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLkfcKsWobDLtBNIBzwlwRC8)
91 * [Fixed Wing Guide](docs/INAV_Fixed_Wing_Setup_Guide.pdf)
92 * [Autolaunch Guide](docs/INAV_Autolaunch.pdf)
93 * [Modes Guide](docs/INAV_Modes.pdf)
94 * [Wing Tuning Masterclass](docs/INAV_Wing_Tuning_Masterclass.pdf)
95 * [Official documentation](https://github.com/iNavFlight/inav/tree/master/docs)
96 * [Official Wiki](https://github.com/iNavFlight/inav/wiki)
97 * [Video series by Paweł Spychalski](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLloACrA6f1_daCjhqY2x0fB)
98 * [Target documentation](https://github.com/iNavFlight/inav/tree/master/docs/boards)
100 ## Contributing
102 Contributions are welcome and encouraged.  You can contribute in many ways:
104 * Documentation updates and corrections.
105 * How-To guides - received help?  help others!
106 * Bug fixes.
107 * New features.
108 * Telling us your ideas and suggestions.
109 * Buying your hardware from this [link](https://inavflight.com/shop/u/bg/)
111 A good place to start is the Discord channel, Telegram channel or Facebook group. Drop in, say hi.
113 Github issue tracker is a good place to search for existing issues or report a new bug/feature request:
115 https://github.com/iNavFlight/inav/issues
117 https://github.com/iNavFlight/inav-configurator/issues
119 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!
121 ## Developers
123 Please refer to the development section in the [docs/development](https://github.com/iNavFlight/inav/tree/master/docs/development) folder.
125 ## INAV Releases
126 https://github.com/iNavFlight/inav/releases