mirror of
https://github.com/betaflight/betaflight.git
synced 2025-07-21 15:25:36 +03:00
Update README.md
This commit is contained in:
J Blackman
GitHub
parent
eb87c1c41d
commit
c030ed9d60
1 changed files with 17 additions and 55 deletions
72
README.md
72
README.md
|
|
@ -2,79 +2,41 @@
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Clean-code version of baseflight flight-controller - flight controllers are used to fly multi-rotor craft and fixed wing craft.
|
Betaflight is flight controller software (firmware) used to fly multi-rotor craft and fixed wing craft.
|
||||||
|
|
||||||
This fork differs from baseflight in that it attempts to use modern software development practices which result in:
|
This fork differs from baseflight and cleanflight in that it focuses on flight performance and wide target support.
|
||||||
|
|
||||||
1. greater reliability through code robustness and automated testing.
|
## Features
|
||||||
2. easier maintenance through code cleanliness.
|
|
||||||
3. easier to develop new features.
|
|
||||||
4. easier to re-use code though code de-coupling and modularisation.
|
|
||||||
|
|
||||||
The MultiWii software, from which baseflight originated, violates many good software development best-practices. Hopefully this fork will go some way to address them. If you see any bad code in this fork please immediately raise an issue so it can be fixed, or better yet submit a pull request.
|
Betaflight has the following features:
|
||||||
|
|
||||||
## Additional Features
|
|
||||||
|
|
||||||
Cleanflight also has additional features not found in baseflight.
|
|
||||||
|
|
||||||
* Multi-color RGB LED Strip support (each LED can be a different color using variable length WS2811 Addressable RGB strips - use for Orientation Indicators, Low Battery Warning, Flight Mode Status, etc)
|
* Multi-color RGB LED Strip support (each LED can be a different color using variable length WS2811 Addressable RGB strips - use for Orientation Indicators, Low Battery Warning, Flight Mode Status, etc)
|
||||||
* Oneshot ESC support.
|
* Oneshot ESC support
|
||||||
* Blackbox flight recorder logging (to onboard flash or external SD card).
|
* Blackbox flight recorder logging (to onboard flash or external SD card - where fitted)
|
||||||
* Support for additional targets that use the STM32F3 processors (baseflight only supports STM32F1).
|
* Support for targets that use the STM32 F7, F4, F3 and F1 processors
|
||||||
* Support for the Seriously Pro Racing F3 board (STM32F303, I2C sensors, large flash, excellent I/O.)
|
* Support for more than 8 RC channels - (e.g. 16 Channels via FrSky X4RSB SBus)
|
||||||
* Support for the TauLabs Sparky board (STM32F303, I2C sensors, based board with acc/gyro/compass and baro, ~$35)
|
* Support for N-Position switches via flexible channel ranges
|
||||||
* Support for the OpenPilot CC3D board. (STM32F103, board, SPI acc/gyro, ~$20)
|
* PWM, PPM and serial input with failsafe detection
|
||||||
* Support for the CJMCU nano quadcopter board.
|
* Multiple Telemetry protocols (CRSF, FrSky, HoTT smart-port, MSP etc)
|
||||||
* Support for developer breakout boards: (Port103R, EUSTM32F103RC, Olimexino, STM32F3Discovery).
|
|
||||||
* Support for more than 8 RC channels - (e.g. 16 Channels via FrSky X4RSB SBus).
|
|
||||||
* Support for N-Position switches via flexible channel ranges - not just 3 like baseflight or 3/6 in MultiWii
|
|
||||||
* Lux's new PID (uses float values internally, resistant to looptime variation).
|
|
||||||
* Simultaneous Bluetooth configuration and OSD.
|
|
||||||
* Better PWM and PPM input and failsafe detection than baseflight.
|
|
||||||
* Better FrSky Telemetry than baseflight.
|
|
||||||
* MSP Telemetry.
|
|
||||||
* Smartport Telemetry.
|
|
||||||
* RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II and X8R.
|
* RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II and X8R.
|
||||||
* OLED Displays - Display information on: Battery voltage, profile, rate profile, version, sensors, RC, etc.
|
* OLED Displays - Display information on: Battery voltage, profile, rate profile, version, sensors, RC, etc.
|
||||||
* In-flight manual PID tuning and rate adjustment.
|
* In-flight manual PID tuning and rate adjustment.
|
||||||
* Rate profiles and in-flight selection of them.
|
* Rate profiles and in-flight selection of them.
|
||||||
* Graupner PPM failsafe.
|
|
||||||
* Graupner HoTT telemetry.
|
|
||||||
* Multiple simultaneous telemetry providers.
|
|
||||||
* Configurable serial ports for Serial RX, Telemetry, MSP, GPS - Use most devices on any port, softserial too.
|
* Configurable serial ports for Serial RX, Telemetry, MSP, GPS - Use most devices on any port, softserial too.
|
||||||
* Optional lost buzzer on port 6 for CC3D (set enable_buzzer_p6 = ON)
|
* and much much more.
|
||||||
* And many more minor bug fixes.
|
|
||||||
|
|
||||||
For a list of features, changes and some discussion please review the thread on MultiWii forums and consult the documentation.
|
## Installation & Documentation
|
||||||
|
|
||||||
http://www.multiwii.com/forum/viewtopic.php?f=23&t=5149
|
See: https://github.com/betaflight/betaflight/wiki
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
See: https://github.com/cleanflight/cleanflight/blob/master/docs/Installation.md
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
There is lots of documentation here: https://github.com/cleanflight/cleanflight/tree/master/docs
|
|
||||||
|
|
||||||
If what you need is not covered then refer to the baseflight documentation. If you still can't find what you need then visit the #cleanflight on the Freenode IRC network
|
|
||||||
|
|
||||||
## IRC Support and Developers Channel
|
## IRC Support and Developers Channel
|
||||||
|
|
||||||
There's a dedicated IRCgitter chat channel here:
|
There's a dedicated Slack chat channel here:
|
||||||
|
|
||||||
https://gitter.im/betaflight/betaflight
|
https://betaflight.ch/invite
|
||||||
|
|
||||||
Etiquette: Don't ask to ask and please wait around long enough for a reply - sometimes people are out flying, asleep or at work and can't answer immediately.
|
Etiquette: Don't ask to ask and please wait around long enough for a reply - sometimes people are out flying, asleep or at work and can't answer immediately.
|
||||||
|
|
||||||
## Videos
|
|
||||||
|
|
||||||
There is a dedicated Cleanflight youtube channel which has progress update videos, flight demonstrations, instructions and other related videos.
|
|
||||||
|
|
||||||
https://www.youtube.com/playlist?list=PL6H1fAj_XUNVBEcp8vbMH2DrllZAGWkt8
|
|
||||||
|
|
||||||
Please subscribe and '+1' the videos if you find them useful.
|
|
||||||
|
|
||||||
## Configuration Tool
|
## Configuration Tool
|
||||||
|
|
||||||
To configure Betaflight you should use the Betaflight-configurator GUI tool (Windows/OSX/Linux) that can be found here:
|
To configure Betaflight you should use the Betaflight-configurator GUI tool (Windows/OSX/Linux) that can be found here:
|
||||||
|
|
@ -113,8 +75,8 @@ https://travis-ci.org/betaflight/betaflight
|
||||||
[](https://travis-ci.org/betaflight/betaflight)
|
[](https://travis-ci.org/betaflight/betaflight)
|
||||||
|
|
||||||
## Betaflight Releases
|
## Betaflight Releases
|
||||||
https://github.com/betaflight/betaflight/releases
|
|
||||||
|
|
||||||
|
https://github.com/betaflight/betaflight/releases
|
||||||
|
|
||||||
## Open Source / Contributors
|
## Open Source / Contributors
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue