Update servos.h to match pwm_mapping.h
[inav.git] / readme.md
blob1c313de35695d48f4819f740b28b33b3b60f3e06
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 # M7, M6 and older UBLOX GPS units PSA
15 > INAV 8.0 will mark those GPS as deprecated and INAV 9.0.0 will require UBLOX units with Protocol version 15.00 or newer. This means that you need a GPS unit based on UBLOX M8 or newer.
17 > If you want to check the protocol version of your unit, it is displayed in INAV's 7.0.0+ status cli command.
18 > INAV 8.0.0 will warn you if your GPS is too old.
19 > ```GPS: HW Version: Unknown Proto: 0.00 Baud: 115200 (UBLOX Proto >= 15.0 required)```
22 > M8, M9 and M10 GPS are the most common units in use today, are readly available and have similar capabilities.
23 >Mantaining and testing GPS changes across this many UBLOX versions is a challenge and takes a lot of time. Removing the support for older devices will simplify code.
25 ![INAV](http://static.rcgroups.net/forums/attachments/6/1/0/3/7/6/a9088858-102-inav.png)
27 # PosHold, Navigation and RTH without compass PSA
29 Attention all drone pilots and enthusiasts,
31 Are you ready to take your flights to new heights with INAV 7.1? We've got some important information to share with you.
33 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.
35 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:
37 🛰️ Better Flight Precision: A compass provides essential data for accurate navigation, ensuring smoother and more precise flight paths.
39 🌐 Enhanced Reliability: With a compass onboard, your drone can maintain stability even in challenging environments, low speeds and strong wind.
41 🚀 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.
43 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.
45 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.
47 Fly safe, fly smart with INAV 7.1 and a compass by your side!
49 # INAV Community
51 * [INAV Discord Server](https://discord.gg/peg2hhbYwN)
52 * [INAV Official on Facebook](https://www.facebook.com/groups/INAVOfficial)
54 ## Features
56 * Runs on the most popular F4, AT32, F7 and H7 flight controllers
57 * On Screen Display (OSD) - both character and pixel style
58 * DJI OSD integration: all elements, system messages and warnings
59 * Outstanding performance out of the box
60 * Position Hold, Altitude Hold, Return To Home and Waypoint Missions
61 * Excellent support for fixed wing UAVs: airplanes, flying wings
62 * Blackbox flight recorder logging
63 * Advanced gyro filtering
64 * Fully configurable mixer that allows to run any hardware you want: multirotor, fixed wing, rovers, boats and other experimental devices
65 * Multiple sensor support: GPS, Pitot tube, sonar, lidar, temperature, ESC with BlHeli_32 telemetry
66 * Logic Conditions, Global Functions and Global Variables: you can program INAV with a GUI
67 * SmartAudio and IRC Tramp VTX support
68 * Telemetry: SmartPort, FPort, MAVlink, LTM, CRSF
69 * Multi-color RGB LED Strip support
70 * And many more!
72 For a list of features, changes and some discussion please review consult the releases [page](https://github.com/iNavFlight/inav/releases) and the documentation.
74 ## Tools
76 ### INAV Configurator
78 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.
80 ### INAV Blackbox Explorer
82 Tool for Blackbox logs analysis is available [here](https://github.com/iNavFlight/blackbox-log-viewer/releases)
84 ### INAV Blackbox Tools
86 Command line tools (`blackbox_decode`, `blackbox_render`) for Blackbox log conversion and analysis [here](https://github.com/iNavFlight/blackbox-tools).
88 ### Telemetry screen for EdgeTX and OpenTX
90 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)
92 ### OSD layout Copy, Move, or Replace helper tool
94 [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.
96 ## Installation
98 See: https://github.com/iNavFlight/inav/blob/master/docs/Installation.md
100 ## Documentation, support and learning resources
101 * [INAV 5 on a flying wing full tutorial](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLkZlulvqsX_vRMfXd5zM7Ha)
102 * [INAV on a multirotor drone tutorial](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLkfcKsWobDLtBNIBzwlwRC8)
103 * [Fixed Wing Guide](docs/INAV_Fixed_Wing_Setup_Guide.pdf)
104 * [Autolaunch Guide](docs/INAV_Autolaunch.pdf)
105 * [Modes Guide](docs/INAV_Modes.pdf)
106 * [Wing Tuning Masterclass](docs/INAV_Wing_Tuning_Masterclass.pdf)
107 * [Official documentation](https://github.com/iNavFlight/inav/tree/master/docs)
108 * [Official Wiki](https://github.com/iNavFlight/inav/wiki)
109 * [Video series by Paweł Spychalski](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLloACrA6f1_daCjhqY2x0fB)
110 * [Target documentation](https://github.com/iNavFlight/inav/tree/master/docs/boards)
112 ## Contributing
114 Contributions are welcome and encouraged.  You can contribute in many ways:
116 * Documentation updates and corrections.
117 * How-To guides - received help?  help others!
118 * Bug fixes.
119 * New features.
120 * Telling us your ideas and suggestions.
121 * Buying your hardware from this [link](https://inavflight.com/shop/u/bg/)
123 A good place to start is the Discord channel, Telegram channel or Facebook group. Drop in, say hi.
125 Github issue tracker is a good place to search for existing issues or report a new bug/feature request:
127 https://github.com/iNavFlight/inav/issues
129 https://github.com/iNavFlight/inav-configurator/issues
131 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!
133 ## Developers
135 Please refer to the development section in the [docs/development](https://github.com/iNavFlight/inav/tree/master/docs/development) folder.
137 Nightly builds are available for testing on the following links:
139 https://github.com/iNavFlight/inav-nightly/releases
141 https://github.com/iNavFlight/inav-configurator-nightly/releases
143 ## INAV Releases
144 https://github.com/iNavFlight/inav/releases