README.md 5.66 KB
Newer Older
Albert Kravcov's avatar
Albert Kravcov committed
1
# INAV
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)
Dominic Clifton's avatar
Dominic Clifton committed
4

5
6
[![Join the chat at https://gitter.im/iNavFlight/inav](https://badges.gitter.im/iNavFlight/inav.svg)](https://gitter.im/iNavFlight/inav?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

dan557's avatar
dan557 committed
7
Clean-code version of baseflight flight-controller with improved navigational capabilities - flight controllers are used to fly multi-rotor craft and fixed wing craft.
Dominic Clifton's avatar
Dominic Clifton committed
8

Paweł Spychalski's avatar
Paweł Spychalski committed
9
10
11
12
13
14
## Important: PID values and scaling

Starting at 22-06-2016 INAV uses the same scaling for PIDs as Cleanflight/Betaflight LuxFloat and MWRewrite PID controllers. That means the following:

* PIDs from CF/BF can be used in INAV, no need to retune for INAV
* INAV uses the same PID defaults that Cleanflight and Betaflight
Paweł Spychalski's avatar
Paweł Spychalski committed
15
* Current INAV tunes can be converted to new using [this guide](https://github.com/iNavFlight/inav/wiki/PID-conversion-from-pre-1.2-to-1.2). This applies to all INAV 1.1
16
* [Conversion spreadsheet](https://docs.google.com/spreadsheets/d/133vfzz6_38W5nUmoRNuP7ZX9V1E-8IG6x0FxuxkBuQg/edit?usp=sharing)
Paweł Spychalski's avatar
Paweł Spychalski committed
17

Paweł Spychalski's avatar
Paweł Spychalski committed
18
## Features
Dominic Clifton's avatar
Dominic Clifton committed
19

20
* 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)
21
* Oneshot ESC support.
22
* Blackbox flight recorder logging (to onboard flash or external SD card).
23
* Support for additional targets that use the STM32F3 processors (baseflight only supports STM32F1).
24
25
26
* Support for the Seriously Pro Racing F3 board (STM32F303, I2C sensors, large flash, excellent I/O.)
* Support for the TauLabs Sparky board (STM32F303, I2C sensors, based board with acc/gyro/compass and baro, ~$35)
* Support for the OpenPilot CC3D board. (STM32F103, board, SPI acc/gyro, ~$20)
27
28
29
30
31
32
33
34
* Support for the CJMCU nano quadcopter board.
* Support for developer breakout boards: (Port103R, EUSTM32F103RC, Olimexino, STM32F3Discovery).
* Support for more than 8 RC channels - (e.g. 16 Channels via FrSky X4RSB SBus).
* Support for N-Position switches via flexible channel ranges - not just 3 like baseflight or 3/6 in MultiWii
* Lux's new PID (uses float values internally, resistant to looptime variation).
* Simultaneous Bluetooth configuration and OSD.
* Better PWM and PPM input and failsafe detection than baseflight.
* Better FrSky Telemetry than baseflight.
35
* LTM Telemetry.
36
* Smartport Telemetry.
37
38
39
40
41
42
* 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.
* Graupner PPM failsafe.
* Graupner HoTT telemetry.
43
* Multiple simultaneous telemetry providers.
44
* Configurable serial ports for Serial RX, Telemetry, MSP, GPS - Use most devices on any port, softserial too.
Joe Poser's avatar
Joe Poser committed
45
* And many more minor bug fixes.
Dominic Clifton's avatar
Dominic Clifton committed
46

47
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
48

49
http://www.rcgroups.com/forums/showthread.php?t=2495732
Dominic Clifton's avatar
Dominic Clifton committed
50

51
52
## Installation

oleost's avatar
oleost committed
53
See: https://github.com/iNavFlight/inav/blob/master/docs/Installation.md
54

Dominic Clifton's avatar
Dominic Clifton committed
55
## Documentation
56

oleost's avatar
oleost committed
57
There is lots of documentation here: https://github.com/iNavFlight/inav/tree/master/docs
Dominic Clifton's avatar
Dominic Clifton committed
58

dan557's avatar
dan557 committed
59
If what you need is not covered then refer to the [Cleanflight documentation](https://github.com/cleanflight/cleanflight/tree/master/docs). If you still can't find what you need then visit the Gitter room or the IRC Channel at #inavflight
Dominic Clifton's avatar
Dominic Clifton committed
60

61
## Gitter Support and Developers Channel
Dominic Clifton's avatar
Dominic Clifton committed
62

63
64
There's a dedicated Gitter room here:
https://gitter.im/iNavFlight/inav
Dominic Clifton's avatar
Dominic Clifton committed
65

dan557's avatar
dan557 committed
66
67
68
69
There's a dedicated INAV IRC channel on the Freenode IRC network. Users and some of the developers are there, and it is a helpful and friendly community - but there are two important things to keep in mind: First and most importantly, please go ahead and ask if you have questions, but make sure you wait around long enough for a reply. Next, sometimes people are out flying, asleep or at work and can't answer immediately, even though they are present in the channel. This is how IRC works: Many people stay logged in, even though they are not actively participating in the discussion all the time. Have a seat, grab a drink and hang around if it's a quiet time of day.

irc://irc.freenode.net/#inavflight

Dominic Clifton's avatar
Dominic Clifton committed
70
71
## Configuration Tool

oleost's avatar
oleost committed
72
To configure INAV you should use the INAV-configurator GUI tool (Windows/OSX/Linux).
73
[//]: # (Can be found here: https://chrome.google.com/webstore/detail/inav-configurator/)
oleost's avatar
oleost committed
74
Currently you have to download the sourcecode and load into Chrome manually from the github page 
Dominic Clifton's avatar
Dominic Clifton committed
75

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

oleost's avatar
oleost committed
78
79
If you rather just want to use Cleanflight configurator you can download from here:
https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb
80
81


Dominic Clifton's avatar
Dominic Clifton committed
82
## Contributing
dongie's avatar
dongie committed
83

Dominic Clifton's avatar
Dominic Clifton committed
84
Contributions are welcome and encouraged.  You can contribute in many ways:
Dominic Clifton's avatar
Dominic Clifton committed
85
86
87
88
89
90
91
92
93

* 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
94
https://github.com/iNavFlight/inav/issues
oleost's avatar
oleost committed
95

oleost's avatar
oleost committed
96
https://github.com/iNavFlight/inav-configurator/issues
Dominic Clifton's avatar
Dominic Clifton committed
97
98
99
100
101

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
102
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
103
104


105
## INAV Releases
oleost's avatar
oleost committed
106
https://github.com/iNavFlight/inav/releases