Cleanflight Configurator

基于谷歌 chrome/chromium 的 cleanflight 固件配置工具。「Google chrome/chromium based configuration tool for the cleanflight firmware.」

Github stars Tracking Chart

Cleanflight Configurator

这是一个 Cleanflight 飞行控制系统的跨平台配置工具。

该工具和 Cleanflight 支持各种类型的飞机,如四旋翼飞机、六旋翼飞机、八旋翼飞机和固定翼飞机。

现在也有一个独立的版本。旧版的 Google Chrome Apps 将被 Google 在 Chrome OS 以外的平台上删除。

在 GitHub 上的发布页面可以下载。

项目历史

这个配置器最初是 Baseflight 配置器的一个分支,支持 Cleanflight 而不是 Baseflight。

这个配置器是唯一支持Cleanflight特定功能的配置器。它可能需要您在飞行控制器上运行最新的固件。如果您遇到任何问题,请确保您运行的是最新的固件版本

安装方法

单机

发行 下载安装程序。这是默认的安装方法,在未来的某一天,这将成为大多数平台的唯一可用方式。请尽可能使用这种方法

MacOS X 用户须知

MacOS X 10.14(Mojave)和 10.15(Catalina)最新版本中使用的安全模型的变化意味着,当试图安装应用程序时,操作系统将显示错误信息('"Cleanflight Configurator.app "已损坏,无法打开。你应该把它移到垃圾桶。')时。要解决这个问题,安装后在终端中运行以下命令:sudo xattr -rd com.apple.quarantine /Applications/Cleanflight/Configurator.app。

通过 Chrome Web 商店(适用于 ChromeOS)

  1. 访问 web 商店中的 Cleanflight Configurator 页面
  2. 点击 + 添加到 Chrome 浏览器

请注意 -- 当新版本发布时,应用程序会自动更新。请确保您维护 Cleanflight 文档中描述的配置备份。

不稳定的测试版本

大多数平台的配置器最新版本的不稳定测试版本可以从这里下载。

请注意,这些版本仅用于测试/反馈,可能会出现错误或损坏,并可能导致飞行控制器设置损坏。建议在使用这些版本时要谨慎。

您可以在您的应用程序标签 "应用程序" 中找到 Cleanflight Configurator 图标。

通过 NW.js 构建原生应用

开发

安装node.js(需要10版本)
安装yarn:npm install yarn -g
更改项目文件夹并运行yarn安装。
运行yarn start。

运行测试

yarn test

应用程序的构建和发布

这些任务在 gulpfile.js 中定义,可以通过 yarn 运行。

yarn gulp <taskname> [[platform] [platform] ...]
<pre>
<ul>
<li><strong>dist</strong> 拷贝 <code>./dist</code> 文件夹中的所有JS和CSS文件。</li>
<li><strong>apps</strong> 构建 <code>./apps</code> 文件夹[1]中构建应用程序的调试版本。</li>
<li><strong>debug</strong> 在 <code>./debug</code> 文件夹[1]中构建应用程序的调试版本。</li>
<li><strong>release</strong> 将应用程序压缩到 <code>./release</code> 文件夹[1]中的单个存档中。</li>
</ul>
<p>1] 在 macOS 或 Linux 上运行这个任务需要 Wine,因为需要设置 Windows 应用的图标(为特定平台构建以避免错误)。
</p>
<h3>为一个特定平台构建或发布应用
</h3>
<p>如果要只为一个特定的平台进行构建或发布,可以在任务名称后面添加 plaform。如果没有提供平台,所有的平台将按顺序进行:
</p>
<ul>
<li><strong>MacOS X</strong> 使用 <code>yarn gulp <task-name> --osx64</code></li>
<li><strong>Linux</strong> 使用 <code>yarn gulp <task-name> --linux64</code></li>
<li><strong>Windows</strong> 使用 <code>yarn gulp <task-name> --win32</code></li>
<li><strong>ChromeOS</strong> 使用 <code>yarn gulp <task-name> --chromeos</code></li>
</ul>
<p>你也可以使用多个平台,例如 yarn gulp <taskname> --osx64 --linux64。
</p>
<h2>语种
</h2>
<p>Cleanflight Configurator 已经被翻译成多种语言。如果有翻译成您的系统语言,该应用程序将尝试检测并使用您的系统语言。您可以帮助<a href="https://github.com/cleanflight/cleanflight/tree/master/README.md#Translators">将应用程序翻译成您的语言</a>。
</p>
<p>如果您希望应用程序使用英语或任何其他语言,您可以在应用程序的第一个屏幕中选择您想要的语言。
</p>
<h2>注意事项
</h2>
<h3>图形问题
</h3>
<p>如果您在配置器中遇到图形显示问题或模糊/抖动字体显示问题,请尝试使用 --disable-gpu 命令行开关调用 cleanflight-configurator 可执行文件。这将关闭硬件图形加速。同样,将显卡抗锯齿选项设置为关闭(例如NVidia显卡的FXAA参数)也可能是一个补救措施。
</p>
<h3>Linux 用户
</h3>
<p>在大多数 Linux 发行版中,你的用户默认情况下没有访问串行接口的权限。要添加这个访问权,请在终端中键入以下命令,注销你的用户并重新登录。

</p>
<pre>sudo usermod -aG dialout ${USER}

Linux/MacOS X 用户

如果你有 3D 模型动画的问题,请在 Chrome 的 flags 中启用 "覆盖软件渲染列表" chrome://flags/#ignore-gpu-blacklist。

支持

如果您需要帮助,请在github上提出问题之前,先到 cleanflight slack 频道联系。请注册并在这里申请 slack 访问

问题跟踪器

对于 Cleanflight 配置器的问题,请在这里提出。

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

对于Cleanflight的固件问题,请在这里提出。

https://github.com/cleanflight/cleanflight/issues

技术细节

配置器基于 chrome.serial API,运行在 Google Chrome/Chromium core 上。

开发者

我们接受干净合理的补丁,请提交补丁!

作者

Dominic Clifton/hydra - Cleanflight 固件和配置器的维护者。 ctn - Baseflight 配置器的主要作者和维护者,Cleanflight 配置器项目就是从这个配置器分叉出来的。


(The first version translated by vz on 2020.12.19)

Main metrics

Overview
Name With Ownercleanflight/cleanflight-configurator
Primary LanguageJavaScript
Program languageHTML (Language Count: 5)
PlatformChrome OS, Linux, Mac, Windows
License:GNU General Public License v3.0
所有者活动
Created At2013-12-08 00:39:15
Pushed At2021-06-18 01:12:51
Last Commit At2020-07-01 15:41:53
Release Count82
Last Release NameCLFL_v2.6.0 (Posted on 2020-06-22 17:51:30)
First Release Namev0.24 (Posted on 2014-01-17 10:42:59)
用户参与
Stargazers Count335
Watchers Count80
Fork Count249
Commits Count5.3k
Has Issues Enabled
Issues Count303
Issue Open Count0
Pull Requests Count137
Pull Requests Open Count0
Pull Requests Close Count109
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private

Cleanflight Configurator

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

It allows you to configure the Cleanflight software running on any supported Cleanflight target.

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

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.

Project History

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

This configurator is the only configurator with support for Cleanflight 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

Standalone

Download the installer from Releases.

Via Chrome Web Store

available in the Chrome web store

  1. Visit Chrome web store
  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, Chrome app:

  1. Clone the repo to any local directory or download it as zip.
  2. If downloaded as a zip, extract it into a new directory.
  3. Start Google Chrome.
  4. Click the 3-dots on the far right of the URL bar.
  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.

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

Native app build via NW.js

Development

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

Running tests

npm test

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

Cleanflight 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.

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

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

Linux users

If connecting Cleanflight Configurator to your flight controller's USB port does not work out-of-the box, follow this check-list:

  1. After connecting, sudo dmesg should print a message similar to usb 2-1.1: new full-speed USB device number 17 using ehci-pci. If not, there may be a problem with your cable/FC.
  2. FCs with USB Virtual Com Port (VCP) usually use USB CDC (Communications Device Class) ACM (Abstract Control Model) protocol. The driver cdc_acm (kernel option CONFIG_USB_ACM) should pick up the device, cdc_acm 2-1.1:1.0: ttyACM0: USB ACM device should appear in sudo dmesg.
  3. The device file (usually /dev/ttyACM0) needs to be writeable by your user account. This is best achieved by creating a udev rule /etc/udev/rules.d/90-ttyACM-group-plugdev.rules that contains KERNEL=="ttyACM[0-9]", GROUP="plugdev" and ensuring you are in the plugdev group using sudo usermod -aG plugdev YOUR_USERNAME. Re-plug the device / logout & login for changes to take effect.

Linux / MacOSX users

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 please reach out on the cleanflight slack channel before raising issues on github. Register and request slack access here.

Issue trackers

For Cleanflight configurator issues raise them here

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

For Cleanflight firmware issues raise them here

https://github.com/cleanflight/cleanflight/issues

IRC Channel

There is an IRC channel for Cleanflight, here: irc://irc.freenode.net/#cleanflight

Technical details

The configurator is based on chrome.serial API running on Google Chrome/Chromium core.

Developers

We accept clean and reasonable patches, submit them!

Authors

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