You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
inav-configurator/README.md

104 lines
4.4 KiB
Markdown

8 years ago
# INAV Configurator
8 years ago
INAV Configurator is a crossplatform configuration tool for the [INAV](https://github.com/iNavFlight/inav) flight control system.
8 years ago
It runs as an app within Google Chrome and allows you to configure the INAV software running on any supported INAV target.
10 years ago
8 years ago
Various types of aircraft are supported by the tool and by INAV, e.g. quadcopters, hexacopters, octocopters and fixed-wing aircraft.
10 years ago
8 years ago
[![available in the Chrome web store](https://developer.chrome.com/webstore/images/ChromeWebStore_Badge_v2_206x58.png)](https://chrome.google.com/webstore/detail/inav-configurator/fmaidjmgkdkpafmbnmigkpdnpdhopgel)
10 years ago
8 years ago
## Build system
For local development, **node.js** build system is used.
1. Install node.js
1. From project folder run `npm install`
1. 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.
8 years ago
## Authors
8 years ago
Konstantin Sharlaimov/DigitalEntity - maintainer of the INAV firmware and configurator.
10 years ago
8 years ago
INAV Configurator was originally a [fork](#credits) of Cleanflight Configurator with support for INAV instead of Cleanflight.
8 years ago
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](https://github.com/iNavFlight/inav/releases).
## Installation
### Via chrome webstore
8 years ago
1. Visit [Chrome web store](https://chrome.google.com/webstore/detail/inav-configurator/fmaidjmgkdkpafmbnmigkpdnpdhopgel)
2. Click **+ Free**
8 years ago
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
8 years ago
4. Click on load unpacked extension and point it to the INAV Configurator directory (for example D:/inav-configurator)
## How to use
8 years ago
You can find the INAV Configurator icon in your application tab "Apps"
11 years ago
## 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.
10 years ago
### Issue trackers
10 years ago
8 years ago
For INAV configurator issues raise them here
10 years ago
8 years ago
https://github.com/iNavFlight/inav-configurator/issues
10 years ago
For INAV firmware issues raise them here
8 years ago
https://github.com/iNavFlight/inav/issues
10 years ago
## Technical details
10 years ago
8 years ago
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 ./
8 years ago
```
10 years ago
## Developers
10 years ago
We accept clean and reasonable patches, submit them!
## Credits
8 years ago
ctn - primary author and maintainer of Baseflight Configurator.
Hydra - author and maintainer of Cleanflight Configurator from which this project was forked.