README.md 3.84 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

Albert Kravcov's avatar
Albert Kravcov committed
3
![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
4
![Travis CI status](https://travis-ci.org/iNavFlight/inav.svg?branch=master)
Paweł Spychalski's avatar
Paweł Spychalski committed
5

Paweł Spychalski's avatar
Paweł Spychalski committed
6
## Features
Dominic Clifton's avatar
Dominic Clifton committed
7

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
8
9
10
11
12
13
* Outstanding navigation performance out of the box
* Position Hold, Altitude Hold, Return To Home and Missions
* Excellent support for fixed wing UAVs: airplanes, flying wings 
* Pitot tube support
* Rangefinder support (sonar and laser)
* Oneshot and Multishot ESC support.
14
* Blackbox flight recorder logging (to onboard flash or external SD card).
15
16
* Lux's new PID (uses float values internally, resistant to looptime variation).
* Simultaneous Bluetooth configuration and OSD.
17
* LTM Telemetry.
18
* Smartport Telemetry.
19
20
21
22
* RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II and X8R.
* OLED Displays - Display information on: Battery voltage, profile, rate profile, version, sensors, RC, etc.
* In-flight manual PID tuning and rate adjustment.
* Rate profiles and in-flight selection of them.
23
* Multiple simultaneous telemetry providers.
24
* Configurable serial ports for Serial RX, Telemetry, MSP, GPS - Use most devices on any port, softserial too.
Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
25
26
* Multi-color RGB LED Strip support (each LED can be a different color using variable length WS2811 Addressable RGB strips - use for Orientation Indicators, Low Battery Warning, Flight Mode Status, etc)
* PIDs from CF/BF can be used in INAV, no need to retune for INAV
giacomo892's avatar
giacomo892 committed
27
* And many more!
Dominic Clifton's avatar
Dominic Clifton committed
28

29
For a list of features, changes and some discussion please review the thread on RCGroups forums and consult the documentation.
Dominic Clifton's avatar
Dominic Clifton committed
30

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

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

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
35
Official too 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
36

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

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

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

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
43
Users of FrSky Taranis X9 and Q X7 can use INAV Lua Telemetry screen created by @teckel12 . Software and installation instruction are available here: [https://github.com/iNavFlight/LuaTelemetry](https://github.com/iNavFlight/LuaTelemetry)
Dominic Clifton's avatar
Dominic Clifton committed
44

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

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

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
49
## Documentation, support and learning resources
Paweł Spychalski's avatar
Paweł Spychalski committed
50

Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
51
52
* [Official documentation](https://github.com/iNavFlight/inav/tree/master/docs)
* [Official Wiki](https://github.com/iNavFlight/inav/wiki)
giacomo892's avatar
giacomo892 committed
53
54
55
* [INAV Official on Telegram](https://t.me/INAVFlight)
* [INAV Official on Facebook](https://www.facebook.com/groups/INAVOfficial)
* [INAV Official on Slack](https://publicslack.com/slacks/inavflight/invites/new)
Pawel Spychalski (DzikuVx)'s avatar
Pawel Spychalski (DzikuVx) committed
56
57
58
* [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)
59

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

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

* Documentation updates and corrections.
* How-To guides - received help?  help others!
* Bug fixes.
* New features.
* Telling us your ideas and suggestions.

The best place to start is the IRC channel on freenode (see above), drop in, say hi. Next place is the github issue tracker:

oleost's avatar
oleost committed
72
https://github.com/iNavFlight/inav/issues
oleost's avatar
oleost committed
73

oleost's avatar
oleost committed
74
https://github.com/iNavFlight/inav-configurator/issues
Dominic Clifton's avatar
Dominic Clifton committed
75
76
77
78
79

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
80
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
81
82


83
## INAV Releases
84
https://github.com/iNavFlight/inav/releases