README.md 4.01 KB
Newer Older
Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
1
# INAV - navigation capable flight controller
Dominic Clifton's avatar
Dominic Clifton committed
2

3 4 5 6
## F3 based flight controllers

> STM32 F3 flight controllers like Omnibus F3 or SP Racing F3 are deprecated and soon they will reach the end of support in INAV. If you are still using F3 boards, please migrate to F4 or F7.

Albert Kravcov's avatar
Albert Kravcov committed
7
![INAV](http://static.rcgroups.net/forums/attachments/6/1/0/3/7/6/a9088858-102-inav.png)
Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
8
![Travis CI status](https://travis-ci.org/iNavFlight/inav.svg?branch=master)
Paweł Spychalski's avatar
Paweł Spychalski committed
9

Paweł Spychalski's avatar
Paweł Spychalski committed
10
## Features
Dominic Clifton's avatar
Dominic Clifton committed
11

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
12 13
* Runs on the most popular F4 and F7 flight controllers
* Outstanding performance out of the box
Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
14 15
* Position Hold, Altitude Hold, Return To Home and Missions
* Excellent support for fixed wing UAVs: airplanes, flying wings 
Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
16 17 18
* Fully configurable mixer that allows to run any hardware you want: multirotor, fixed wing, rovers, boats and other experimental devices
* Multiple sensor support: GPS, Pitot tube, sonar, lidar, temperature, ESC with BlHeli_32 telemetry
* SmartAudio and IRC Tramp VTX support
giacomo892's avatar
giacomo892 committed
19
* DSHOT and Multishot ESCs
Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
20 21 22 23 24 25
* Blackbox flight recorder logging
* On Screen Display (OSD) - both character and pixel style
* Telemetry: SmartPort, FPort, MAVlink, LTM
* Multi-color RGB LED Strip support
* Advanced gyro filtering: Matrix Filter and RPM filter
* Logic Conditions, Global Functions and Global Variables: you can program INAV with a GUI
giacomo892's avatar
giacomo892 committed
26
* And many more!
Dominic Clifton's avatar
Dominic Clifton committed
27

giacomo892's avatar
giacomo892 committed
28
For a list of features, changes and some discussion please review consult the releases [page](https://github.com/iNavFlight/inav/releases) and the documentation.
Dominic Clifton's avatar
Dominic Clifton committed
29

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
30
## Tools
Dominic Clifton's avatar
Dominic Clifton committed
31

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
32
### INAV Configurator
Dominic Clifton's avatar
Dominic Clifton committed
33

Eric Xu's avatar
Eric Xu committed
34
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.  
Dominic Clifton's avatar
Dominic Clifton committed
35

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
36
### INAV Blackbox Explorer
dan557's avatar
dan557 committed
37

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
38
Tool for Blackbox logs analysis is available [here](https://github.com/iNavFlight/blackbox-log-viewer/releases)
dan557's avatar
dan557 committed
39

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
40
### Telemetry screen for OpenTX
Dominic Clifton's avatar
Dominic Clifton committed
41

42
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)
Dominic Clifton's avatar
Dominic Clifton committed
43

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
44
## Installation
45

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
46
See: https://github.com/iNavFlight/inav/blob/master/docs/Installation.md
47

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
48
## Documentation, support and learning resources
49
* [Fixed Wing Guide](docs/INAV_Fixed_Wing_Setup_Guide.pdf)
50 51 52
* [Autolaunch Guide](docs/INAV_Autolaunch.pdf)
* [Modes Guide](docs/INAV_Modes.pdf)
* [Wing Tuning Masterclass](docs/INAV_Wing_Tuning_Masterclass.pdf)
Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
53 54
* [Official documentation](https://github.com/iNavFlight/inav/tree/master/docs)
* [Official Wiki](https://github.com/iNavFlight/inav/wiki)
giacomo892's avatar
giacomo892 committed
55 56
* [INAV Official on Telegram](https://t.me/INAVFlight)
* [INAV Official on Facebook](https://www.facebook.com/groups/INAVOfficial)
Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
57 58 59
* [RC Groups Support](https://www.rcgroups.com/forums/showthread.php?2495732-Cleanflight-iNav-(navigation-rewrite)-project)
* [Video series by Painless360](https://www.youtube.com/playlist?list=PLYsWjANuAm4qdXEGFSeUhOZ10-H8YTSnH)
* [Video series by Paweł Spychalski](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLloACrA6f1_daCjhqY2x0fB)
60

Dominic Clifton's avatar
Dominic Clifton committed
61
## Contributing
dongie's avatar
dongie committed
62

Dominic Clifton's avatar
Dominic Clifton committed
63
Contributions are welcome and encouraged.  You can contribute in many ways:
Dominic Clifton's avatar
Dominic Clifton committed
64 65 66 67 68 69

* Documentation updates and corrections.
* How-To guides - received help?  help others!
* Bug fixes.
* New features.
* Telling us your ideas and suggestions.
giacomo892's avatar
giacomo892 committed
70
* Buying your hardware from this [link](https://inavflight.com/shop/u/bg/)
Dominic Clifton's avatar
Dominic Clifton committed
71

giacomo892's avatar
giacomo892 committed
72
A good place to start is Telegram channel or Facebook group. Drop in, say hi.
73 74

Github issue tracker is a good place to search for existing issues or report a new bug/feature request:
Dominic Clifton's avatar
Dominic Clifton committed
75

oleost's avatar
oleost committed
76
https://github.com/iNavFlight/inav/issues
oleost's avatar
oleost committed
77

oleost's avatar
oleost committed
78
https://github.com/iNavFlight/inav-configurator/issues
Dominic Clifton's avatar
Dominic Clifton committed
79 80 81 82 83

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!

## Developers

oleost's avatar
oleost committed
84
Please refer to the development section in the [docs/development](https://github.com/iNavFlight/inav/tree/master/docs/development) folder.
Dominic Clifton's avatar
Dominic Clifton committed
85 86


87
## INAV Releases
88
https://github.com/iNavFlight/inav/releases