Skip to content
This repository was archived by the owner on Apr 19, 2023. It is now read-only.

Commit

Permalink
Merge remote-tracking branch 'betaflight/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
hydra committed Mar 4, 2018
2 parents 4792439 + cd04c1e commit 8ebfd22
Show file tree
Hide file tree
Showing 390 changed files with 59,912 additions and 3,171 deletions.
13 changes: 13 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
.DS_store
nbproject/
.idea
.project
.settings/
node_modules/
npm-debug.log
cache/
apps/
dist/
debug/
release/

# artefacts for Eclipse
/.settings/

# artefacts for Visual Studio Code
/.vscode/
12 changes: 12 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
language: node_js

before_install:
- npm install gulp -g

script:
- npm install
- gulp release

cache:
directories:
- node_modules
69 changes: 60 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@

Cleanflight Configurator is a crossplatform configuration tool for the [Cleanflight](http://cleanflight.com/) flight control system.

It runs as an app within Google Chrome and allows you to configure the Cleanflight software running on any [supported Cleanflight target](https://github.com/cleanflight/cleanflight/blob/master/docs/Boards.md).
It allows you to configure the Cleanflight software running on any [supported Cleanflight target](https://github.com/cleanflight/cleanflight/blob/master/docs/Boards.md).

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

[![available in the Chrome web store](https://developer.chrome.com/webstore/images/ChromeWebStore_Badge_v2_206x58.png)](https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb)
There is also now a standalone version available. The old Google Chrome Apps version of this software will be removed by Google on platforms other than Chrome OS.

[Downloads are available in Releases page on GitHub.](https://github.com/cleanflight/cleanflight-configurator/releases)

## Project History

Expand All @@ -17,21 +19,27 @@ If you are experiencing any problems please make sure you are running the [lates

## Installation

### Via chrome webstore
### Standalone

Download the installer from [Releases.](https://github.com/betaflight/betaflight-configurator/releases)

### Via Chrome Web Store

[![available in the Chrome web store](https://developer.chrome.com/webstore/images/ChromeWebStore_Badge_v2_206x58.png)](https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb)

1. Visit [Chrome web store](https://chrome.google.com/webstore/detail/cleanflight-configurator/enacoimjcgeinfnnnpajinjgmkahmfgb)
2. Click **+ Free**
2. Click **+ Add to Chrome**

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

### Alternative way
### Alternative way, Chrome app:

1. Clone the configurator repository (from Github) to any local directory or download it as zip.
2. Extract to a folder and not the folder.
3. Start Google Chrome.
4. Click the 3-dots on the far right of the URL bar.
5. Select Settings
6. On the left of the screen select Extensions.
5. Select "More Tools"
6. Select "Extensions"
7. Check the Developer Mode checkbox.
8. Click on load unpacked extension.
9. Point it to the folder you extracted the zip to.
Expand All @@ -40,6 +48,47 @@ Please note - the application will automatically update itself when new versions

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

## Native app build via NW.js

Linux build is disabled currently because of unmet dependecies with some distros, it can be enabled in the `gulpfile.js`.

### Development

1. Install node.js
2. Change to project folder and run `npm install`.
3. Run `npm start`.

### App build and release

The tasks are defined in `gulpfile.js` and can be run either via `gulp <task-name>` (if the command is in PATH or via `../node_modules/gulp/bin/gulp.js <task-name>`:

1. Optional, install gulp `npm install --global gulp-cli`.
2. Run `gulp <taskname> [[platform] [platform] ...]`.

List of possible values of `<task-name>`:
* **dist** copies all the JS and CSS files in the `./dist` folder.
* **apps** builds the apps in the `./apps` folder [1].
* **debug** builds debug version of the apps in the `./debug` folder [1].
* **release** zips up the apps into individual archives in the `./release` folder [1].

[1] Running this task on macOS or Linux requires Wine, since it's needed to set the icon for the Windows app (build for specific platform to avoid errors).

#### Build or release app for one specific platform
To build or release only for one specific platform you can append the plaform after the `task-name`.
If no platform is provided, all the platforms will be done in sequence.

* **MacOS** use `gulp <task-name> --osx64`
* **Linux** use `gulp <task-name> --linux64`
* **Windows** use `gulp <task-name> --win32`

You can also use multiple platforms e.g. `gulp <taskname> --osx64 --linux64`.

## Languages

Betaflight Configurator has been translated into several languages. The application will try to detect and use your system language if a translation into this language is available. You can help [translating the application into your language](https://crowdin.com/project/betaflight-configurator).

If you prefer to have the application in English or any other language, you can select your desired language in the options menu of the application.

## Notes

### WebGL
Expand All @@ -60,7 +109,7 @@ If you have 3D model animation problems, enable "Override software rendering lis

## 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.
If you need help please reach out on the [betaflightgroup](https://betaflightgroup.slack.com) slack channel before raising issues on github. Register and [request slack access here](http://www.betaflight.tk).

### Issue trackers

Expand Down Expand Up @@ -89,3 +138,5 @@ We accept clean and reasonable patches, submit them!
Dominic Clifton/hydra - maintainer of the Cleanflight firmware and configurator.
ctn - primary author and maintainer of Baseflight Configurator from which Cleanflight Configurator project was forked.


[![Crowdin](https://d322cqt584bo4o.cloudfront.net/betaflight-configurator/localized.svg)](https://crowdin.com/project/betaflight-configurator)
7 changes: 7 additions & 0 deletions assets/linux/betaflight-configurator.desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[Desktop Entry]
Name=Cleanflight Configurator
Comment=Crossplatform configuration tool for the Cleanflight flight control system
Exec=/opt/cleanflight/cleanflight-configurator/cleanflight-configurator
Icon=/opt/cleanflight/cleanflight-configurator/icon/cf_icon_128.png
Terminal=false
Type=Application
4 changes: 4 additions & 0 deletions assets/linux/copyright
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
This package was created by the Cleanflight open source flight controller firmware project (https://github.com/cleanflight/cleanflight).

All of the code is covered under the terms of the GPL version 3. See the
file /usr/share/common-licenses/GPL-3 for more information.
File renamed without changes
Binary file added assets/linux/icon/bf_icon_english_128.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added assets/linux/icon/cf_icon_english_128.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/osx/dmg-background.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/osx/dmg-background.psd
Binary file not shown.
Binary file added assets/osx/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 8ebfd22

Please sign in to comment.