Skip to content

Commit

Permalink
update readme (emuflight#801)
Browse files Browse the repository at this point in the history
* update readme

* update readme

* update readme
  • Loading branch information
nerdCopter authored Apr 27, 2022
1 parent 97ae2c7 commit 2e5bf60
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 58 deletions.
114 changes: 56 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,90 +1,88 @@
![EmuFlight](docs/assets/images/EmuFlight.png)
![EmuFlight](docs/assets/images/EMUFlightLogo-2022_Trans.png)

EmuFlight is flight controller software (firmware) used to fly multi-rotor craft.

This fork differs from Baseflight, Cleanflight and Betaflight in that it focuses on flight performance, innovative filtering, and leading-edge features.
## EmuFlight is flight controller software (firmware) used to fly multi-rotor aircraft.
* This fork differs from Baseflight, Cleanflight and Betaflight in that it focuses on flight performance, innovative filtering, and leading-edge features.

## WARNING

**DJI components bypass Configurator safety-checks. Do not attempt arming while connected to Configurator with LiPo plugged. Always remove propellers and use a smoke-stopper for extra safety.**

## News

To get the latest updates as well as support from us, you can join our discord at <https://discord.gg/BWqgBg3>.
* **DJI components bypass Configurator safety-checks. Do not attempt arming while connected to Configurator with LiPo plugged. Always remove propellers and use a smoke-stopper for extra safety.**

## Features
## EmuFlight Releases

EmuFlight has some of the following features:

* 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, Initialization Troubleshooting, etc)
* DShot (150, 300, 600, 1200, 2400, 4800), Multishot, and Oneshot (125 and 42) motor protocol support
* Blackbox flight recorder logging (to onboard flash or external microSD card where equipped)
* Support for targets that use the STM32 F7 and F4 processors. F3 Support removed after version 0.1.0
* PWM, PPM, and Serial (SBus, SumH, SumD, Spektrum 1024/2048, XBus, etc) RX connection with failsafe detection
* Multiple telemetry protocols (CSRF, FrSky, HoTT smart-port, MSP, etc)
* RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II, X8R, X4R-SB, & XSR
* OSD support & configuration without needing third-party OSD software/firmware/comm devices
* OLED Displays - Display information on: Battery voltage/current/mAh, profile, rate profile, mode, version, sensors, etc
* In-flight manual PID tuning and rate adjustment
* Rate profiles and in-flight selection of them
* Configurable serial ports for Serial RX, Telemetry, ESC telemetry, MSP, GPS, OSD, Sonar, etc - Use most devices on any port, softserial included
* VTX support for Unify Pro and IRC Tramp
* Latest IMUF filtering technology
* and MUCH, MUCH more.
* [![Codacy Badge](https://api.codacy.com/project/badge/Grade/5422b54319254b6f9b6d01464ae9380c)](https://www.codacy.com/gh/emuflight/EmuFlight?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=emuflight/EmuFlight&amp;utm_campaign=Badge_Grade)
* https://github.com/emuflight/EmuConfigurator/releases
* https://github.com/emuflight/EmuFlight/releases

## Installation & Documentation
## Support and Developers Channel

See: https://github.com/emuflight/EmuFlight/wiki
* ![Discord](https://img.shields.io/discord/547211754845765635?label=EmuFlight%20Discord&style=for-the-badge&logo=discord&logoColor=white&color=00A3E0)
* To get support as well as the latest updates, join our discord at <https://discord.gg/BWqgBg3>.

## Support and Developers Channel
## Features

There's a dedicated Discord chat channel here:
* Support for targets that use the STM32 F7 and F4 processors
* Support for HelioRC Spring FC's
* IMUF (Kalman-based) Filtering for all FC's
* Additional DShot levels: 1200, 2400, 4800
* OSD based configuration without needing third-party OSD software/firmware/comm devices
* Per-Axis Lowpass filters
* Feathered PIDs
* Error-based Boosts for P, I, & D. (EmuBoost/DBoost)
* i-Decay
* Throttle Point Attenuation (TPA) for P, I, & D
* Stick Point Attenuation (SPA)
* Advanced Dynamic Gyro & D-Term Filters
* Smith-Predictor on Gyro
* Optional ABG Filters for Gyro and DTerm
* PT(n) for LPF and RC-Smoothing
* Rate-Dynamics (Stick-feel modifier)
* Angle-mode 2.0
* Dual Axis Steering
* NFE racer mode
* Fixed yaw PIDsum limit
* LPF filter for voltage and current
* Motor output limit
* Motor output smoothing
* Thrust linearization
* Axis Lock
* and MUCH, MUCH more

https://discord.gg/BWqgBg3
## Installation & Documentation

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.
* See: https://github.com/emuflight/EmuFlight/wiki

## Configuration Tool

To configure EmuFlight you should use the EmuFlight-configurator GUI tool (Windows/OSX/Linux) which can be found here:

https://github.com/emuflight/EmuConfigurator
* To configure EmuFlight you should use the EmuFlight-Configurator GUI tool (Windows/OSX/Linux) which can be found here:
* https://github.com/emuflight/EmuConfigurator

## DJI OSD [In]Compatibility

Setting PIDs and Rates (except for Feed Forward) is supported with the DJI OSD. The filtering menus (MISC PP, FILT PP, FILT GLB) are not currently supported and may result in unintended filtering settings.
* Setting PIDs and Rates (except for Feed Forward) is supported with the DJI OSD. The filtering menus (MISC PP, FILT PP, FILT GLB) are not currently supported and may result in unintended problems.

## Contributing

Contributions are welcome and encouraged. You can contribute in many ways:

* Documentation updates and corrections.
* How-To guides - received help? Help others!
* Bug reporting & fixes.
* New feature ideas & suggestions.
* Coding and Pull Requests.

The best place to start is the EmuFlight Discord (https://discord.gg/BWqgBg3). Next place is the github issue tracker:
* Contributions are welcome and encouraged. You can contribute in many ways:

https://github.com/emuflight/EmuFlight/issues
- Documentation updates and corrections.
- How-To guides - received help? Help others!
- Bug reporting & fixes.
- New feature ideas & suggestions.
- Coding and Pull Requests.

https://github.com/emuflight/EmuConfigurator/issues
* The best place to start is the EmuFlight Discord (https://discord.gg/BWqgBg3). Next place is the github issue tracker:
- https://github.com/emuflight/EmuFlight/issues
- https://github.com/emuflight/EmuConfigurator/issues

Before creating new issues please check to see if there is an existing one.
* Before creating new issues please check to see if there is an existing one.

If you want to contribute financially on an ongoing basis, you should consider becoming a patron for us on Patreon (https://www.patreon.com/EmuFlight).
* If you want to contribute financially on an ongoing basis, please consider becoming a Patreon member (https://www.patreon.com/EmuFlight).

## Developers

Contribution of bugfixes and new features is encouraged. Please be aware that we have a thorough review process for pull requests, and be prepared to explain what you want to achieve with your pull request.
Contribution of bugfixes and new features is encouraged. Please be aware that we have a thorough review process for pull requests. Be prepared to explain what you want to achieve with your pull request.
Before starting to write code, please read our [development guidelines](docs/development/Development.md ) and [coding style definition](docs/development/CodingStyle.md).

## EmuFlight Releases

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/5422b54319254b6f9b6d01464ae9380c)](https://www.codacy.com/gh/emuflight/EmuFlight?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=emuflight/EmuFlight&amp;utm_campaign=Badge_Grade)

https://github.com/emuflight/EmuFlight/releases

## Open Source / Contributors

EmuFlight is software that is **open source** and is available free of charge without warranty to all users.
Expand Down Expand Up @@ -124,4 +122,4 @@ Big thanks to current and past contributors:
* Stålheim, Anton (KiteAnton)
* Tim Sweet, Kaylin Doerr, Shawn Loftin - **Filtering improvements, IMUF**

And many many others who haven't been mentioned....
And many many others either mentioned in release notes, GitHub history, or possibly haven't been mentioned.... Thank you!
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 docs/assets/images/EMUFlightLogo-2022_Trans.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 removed docs/assets/images/EmuFlight.png
Binary file not shown.

0 comments on commit 2e5bf60

Please sign in to comment.