betaflight-configurator/README.md

2.5 KiB

Cleanflight Configurator

Cleanflight Configurator is a fork of Baseflight Configurator to support Cleanflight instead of Baseflight.

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

Cleanflight is available here:

https://github.com/cleanflight/cleanflight

Authors

Dominic Clifton/hydra - maintainer of the Cleanflight firmware and configurator.

This configurator is the only configurator 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 version of firmware.

Installation

    • Click + Free

Alternative way

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

How to use

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

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

For non-Cleanflight specific issues please raise them here so that the get fixed in the primary codebase:

https://github.com/multiwii/baseflight-configurator/issues

For Cleanflight specific issues raise them here:

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

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

Support for Baseflight Configurator can also be found on IRC, here: irc://irc.freenode.net/#multiwii

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!

Credits

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