NinjaFlight
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NinjaFlight Documentation

![Build Status](https://travis-ci.org/mkschreder/ninjaflight.svg?branch=master) ![Coverage Status](https://coveralls.io/repos/github/mkschreder/ninjaflight/badge.svg?branch=master)

An even cleaner version of cleanflight flight-controller. Flight controllers are used to fly multi-rotor craft and fixed wing aircraft.

IMPORTANT NOTE: currently "master" git branch (which you are probably looking at) is undergoing many major changes so it is not going to work.

Latest release: 1.16.10 (Codename: "Panic In The Sewers")

This fork differs from cleanflight in that it introduces SITL (software in the loop) support that is able to simulate the flight controller in a simulated physics environment powered by Bullet physics. It also adds support for tilted motor quads and uses modern development practices to simplify maintainability and improve quality of the firmware.

This is done by:

  • Using code coverage to write better unit tests (aiming at 100% coverage for all code).
  • Using object oriented design in C with minimal use of static/global data
  • Separating modules into as small modules as possible each of which can be unit tested separately.
  • Testing on SITL, through unit tests and on real hardware in parallel to achieve greater robustness.

UPDATE: new changes will be published into master branch. This means that most of the time master branch contains potentially untested code. For stable firmware use tagged version releases.

SITL

Simulator is an integral part of the development cycle. It is however located in a separate repo and requires some data files to work (notably pak0.pk3 from quake3). Main makefile can already download the necessary files for you.

To build and run the sitl on linux you can do the following: 

make start-sitl

Features

  • 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.).
  • Oneshot ESC support.
  • Blackbox flight recorder logging (to onboard flash or external SD card).
  • Support for additional targets that use the STM32F3 processors (baseflight only supports STM32F1).
  • 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).
  • 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.
  • LTM Telemetry.
  • Smartport Telemetry.
  • 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.
  • Multiple simultaneous telemetry providers.
  • Configurable serial ports for Serial RX, Telemetry, MSP, GPS - Use most devices on any port, softserial too.
  • And many more minor bug fixes.

Ninjaflight also supports:

  • SITL simulation support
  • Tilted propeller racing drones with dynamic and static tilting. Throttle compensation and yaw/roll compensation is also supported.

Most popular supported boards

NAZE

NAZE

CJMCU

CJMCU

CC3D

CC3D

Dodo

DODO

Sparky

Sparky

SPRacingEVO

SPRacingEVO

SPRacingF3

SPRacingF3

Colibri

Colibri Race

Lux-Race

Lux Race

Olimexino

Olimexino

Installation

See: Installation.md

Documentation

See: docs folder

If what you need is not covered, check the Cleanflight documentation.

In many ways currently ninjaflight works exactly like cleanflight so a lot of things are already covered by cleanflight documentation (although this may change as the project evolves).

Configuration Tool

To configure Ninjaflight you can use the Cleanflight-configurator GUI tool (Windows/OSX/Linux).

The source for it is here:

https://github.com/cleanflight/cleanflight-configurator

Contributing

Contributions are welcome and encouraged. You can contribute in many ways:

  • 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:

https://github.com/mkschreder/ninjaflight/issues

And also:

https://github.com/mkschreder/ninjaflight/issues https://github.com/cleanflight/cleanflight-configurator/issues

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!

See CONTRIBUTING.md

Acknowlegements

Every single person who has contributed to this project over time (see AUTHORS file).