README.md

   1 # INAV - navigation capable flight controller
   2
   3 ![INAV](http://static.rcgroups.net/forums/attachments/6/1/0/3/7/6/a9088858-102-inav.png)
   4 ![Travis CI status](https://travis-ci.org/iNavFlight/inav.svg?branch=master)
   5
   6 ## Features
   7
   8 * Outstanding navigation performance out of the box
   9 * Position Hold, Altitude Hold, Return To Home and Missions
  10 * Excellent support for fixed wing UAVs: airplanes, flying wings
  11 * Pitot tube support
  12 * Rangefinder support (sonar and laser)
  13 * Oneshot and Multishot ESC support.
  14 * Blackbox flight recorder logging (to onboard flash or external SD card).
  15 * Support for more than 8 RC channels - (e.g. 16 Channels via FrSky X4RSB SBus).
  16 * Support for N-Position switches via flexible channel ranges - not just 3 like baseflight or 3/6 in MultiWii
  17 * Lux's new PID (uses float values internally, resistant to looptime variation).
  18 * Simultaneous Bluetooth configuration and OSD.
  19 * Better PWM and PPM input and failsafe detection than baseflight.
  20 * Better FrSky Telemetry than baseflight.
  21 * LTM Telemetry.
  22 * Smartport Telemetry.
  23 * RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II and X8R.
  24 * OLED Displays - Display information on: Battery voltage, profile, rate profile, version, sensors, RC, etc.
  25 * In-flight manual PID tuning and rate adjustment.
  26 * Rate profiles and in-flight selection of them.
  27 * Multiple simultaneous telemetry providers.
  28 * Configurable serial ports for Serial RX, Telemetry, MSP, GPS - Use most devices on any port, softserial too.
  29 * 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)
  30 * PIDs from CF/BF can be used in INAV, no need to retune for INAV
  31 * And many more minor bug fixes.
  32
  33 For a list of features, changes and some discussion please review the thread on RCGroups forums and consult the documentation.
  34
  35 ## Tools
  36
  37 ### INAV Configurator
  38
  39 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.
  40
  41 ### INAV Blackbox Explorer
  42
  43 Tool for Blackbox logs analysis is available [here](https://github.com/iNavFlight/blackbox-log-viewer/releases)
  44
  45 ### Telemetry screen for OpenTX
  46
  47 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)
  48
  49 ## Installation
  50
  51 See: https://github.com/iNavFlight/inav/blob/master/docs/Installation.md
  52
  53 ## Documentation, support and learning resources
  54
  55 * [Official documentation](https://github.com/iNavFlight/inav/tree/master/docs)
  56 * [Official Wiki](https://github.com/iNavFlight/inav/wiki)
  57 * [Slack channel](https://inavflight.signup.team/)
  58 * [RC Groups Support](https://www.rcgroups.com/forums/showthread.php?2495732-Cleanflight-iNav-(navigation-rewrite)-project)
  59 * [Video series by Painless360](https://www.youtube.com/playlist?list=PLYsWjANuAm4qdXEGFSeUhOZ10-H8YTSnH)
  60 * [Video series by Paweł Spychalski](https://www.youtube.com/playlist?list=PLOUQ8o2_nCLloACrA6f1_daCjhqY2x0fB)
  61
  62 ## Contributing
  63
  64 Contributions are welcome and encouraged.  You can contribute in many ways:
  65
  66 * Documentation updates and corrections.
  67 * How-To guides - received help?  help others!
  68 * Bug fixes.
  69 * New features.
  70 * Telling us your ideas and suggestions.
  71
  72 The best place to start is the IRC channel on freenode (see above), drop in, say hi. Next place is the github issue tracker:
  73
  74 https://github.com/iNavFlight/inav/issues
  75
  76 https://github.com/iNavFlight/inav-configurator/issues
  77
  78 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!
  79
  80 ## Developers
  81
  82 Please refer to the development section in the [docs/development](https://github.com/iNavFlight/inav/tree/master/docs/development) folder.
  83
  84
  85 ## INAV Releases
  86 https://github.com/iNavFlight/inav/releases