Skip to content

fiam/inav-configurator

 
 

Repository files navigation

INAV Configurator

INAV Configurator is a crossplatform configuration tool for the INAV flight control system.

It runs as an app within Google Chrome and allows you to configure the INAV software running on any supported INAV target.

Various types of aircraft are supported by the tool and by INAV, e.g. quadcopters, hexacopters, octocopters and fixed-wing aircraft.

available in the Chrome web store

Build system

For local development, node.js build system is used.

  1. Install node.js
  2. From project folder run npm install
  3. To build the JS and CSS files and start the configurator:
    • With NW.js: Run npm start.
    • With Chrome: Run ./node_modules/gulp/bin/gulp.js. Then open chrome://extensions, enable the Developer mode, click on the Load unpacked extension... button and select the inav-configurator directory.

Other tasks are also defined in gulpfile.js. To run a task, use ./node_modules/gulp/bin/gulp.js task-name. Available ones are:

  • build: Generate JS and CSS output files used by the configurator from their sources. It must be run whenever changes are made to any .js or .css files in order to have those changes appear in the configurator. If new files are added, they must be included in gulpfile.js. See the comments at the top of gulpfile.js to learn how to do so. See also the watch task.
  • watch: Watch JS and CSS sources for changes and run the build task whenever they're edited.
  • dist: Create a distribution of the app (valid for packaging both as a Chrome app or a NW.js app) in the ./dist/ directory.
  • release: Create NW.js apps for each supported platform (win32, osx64 and linux64) in the ./apps directory. Running this task on macOS or Linux requires Wine, since it's needed to set the icon for the Windows app.

Authors

Konstantin Sharlaimov/DigitalEntity - maintainer of the INAV firmware and configurator.

INAV Configurator was originally a fork of Cleanflight Configurator with support for INAV instead of Cleanflight.

This configurator is the only configurator with support for INAV specific features. It will likely require that you run the latest firmware on the flight controller. If you are experiencing any problems please make sure you are running the latest firmware version.

Installation

Via chrome webstore

  1. Visit Chrome web store
  2. Click + Free

Please note - the application will automatically update itself when new versions are released. Please ensure you maintain configuration backups as described in the INAV documentation.

Alternative way

  1. Clone the repo to any local directory or download it as zip
  2. Start Chromium or Google Chrome and go to tools -> extension
  3. Check the "Developer mode" checkbox
  4. Click on load unpacked extension and point it to the INAV Configurator directory (for example D:/inav-configurator)

How to use

You can find the INAV Configurator icon in your application tab "Apps"

Notes

WebGL

Make sure Settings -> System -> "User hardware acceleration when available" is checked to achieve the best performance

Linux users

  1. Dont forget to add your user into dialout group "sudo usermod -aG dialout YOUR_USERNAME" for serial access
  2. If you have 3D model animation problems, enable "Override software rendering list" in Chrome flags chrome://flags/#ignore-gpu-blacklist

Support

If you need help your please use the multiwii or rcgroups forums or visit the IRC channel before raising issues in the issue trackers.

Issue trackers

For INAV configurator issues raise them here

https://github.com/iNavFlight/inav-configurator/issues

For INAV firmware issues raise them here

https://github.com/iNavFlight/inav/issues

Technical details

This branch uses NW.js to pack Crome app into single package with node.js and chromium

npm install
./node_modules/nw-builder/bin/nwbuild -p win32 ./

Developers

We accept clean and reasonable patches, submit them!

Credits

ctn - primary author and maintainer of Baseflight Configurator. Hydra - author and maintainer of Cleanflight Configurator from which this project was forked.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 59.4%
  • HTML 28.4%
  • CSS 11.3%
  • Other 0.9%