Skip to content

Commit 2e5bf60

Browse files
authoredApr 27, 2022
update readme (emuflight#801)
* update readme * update readme * update readme
1 parent 97ae2c7 commit 2e5bf60

File tree

4 files changed

+56
-58
lines changed

4 files changed

+56
-58
lines changed
 

‎README.md

+56-58
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,88 @@
1-
![EmuFlight](docs/assets/images/EmuFlight.png)
1+
![EmuFlight](docs/assets/images/EMUFlightLogo-2022_Trans.png)
22

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

76
## WARNING
87

9-
**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.**
10-
11-
## News
12-
13-
To get the latest updates as well as support from us, you can join our discord at <https://discord.gg/BWqgBg3>.
8+
* **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.**
149

15-
## Features
10+
## EmuFlight Releases
1611

17-
EmuFlight has some of the following features:
18-
19-
* 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)
20-
* DShot (150, 300, 600, 1200, 2400, 4800), Multishot, and Oneshot (125 and 42) motor protocol support
21-
* Blackbox flight recorder logging (to onboard flash or external microSD card where equipped)
22-
* Support for targets that use the STM32 F7 and F4 processors. F3 Support removed after version 0.1.0
23-
* PWM, PPM, and Serial (SBus, SumH, SumD, Spektrum 1024/2048, XBus, etc) RX connection with failsafe detection
24-
* Multiple telemetry protocols (CSRF, FrSky, HoTT smart-port, MSP, etc)
25-
* RSSI via ADC - Uses ADC to read PWM RSSI signals, tested with FrSky D4R-II, X8R, X4R-SB, & XSR
26-
* OSD support & configuration without needing third-party OSD software/firmware/comm devices
27-
* OLED Displays - Display information on: Battery voltage/current/mAh, profile, rate profile, mode, version, sensors, etc
28-
* In-flight manual PID tuning and rate adjustment
29-
* Rate profiles and in-flight selection of them
30-
* Configurable serial ports for Serial RX, Telemetry, ESC telemetry, MSP, GPS, OSD, Sonar, etc - Use most devices on any port, softserial included
31-
* VTX support for Unify Pro and IRC Tramp
32-
* Latest IMUF filtering technology
33-
* and MUCH, MUCH more.
12+
* [![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)
13+
* https://github.com/emuflight/EmuConfigurator/releases
14+
* https://github.com/emuflight/EmuFlight/releases
3415

35-
## Installation & Documentation
16+
## Support and Developers Channel
3617

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

39-
## Support and Developers Channel
21+
## Features
4022

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

43-
https://discord.gg/BWqgBg3
50+
## Installation & Documentation
4451

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

4754
## Configuration Tool
4855

49-
To configure EmuFlight you should use the EmuFlight-configurator GUI tool (Windows/OSX/Linux) which can be found here:
50-
51-
https://github.com/emuflight/EmuConfigurator
56+
* To configure EmuFlight you should use the EmuFlight-Configurator GUI tool (Windows/OSX/Linux) which can be found here:
57+
* https://github.com/emuflight/EmuConfigurator
5258

5359
## DJI OSD [In]Compatibility
5460

55-
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.
61+
* 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.
5662

5763
## Contributing
5864

59-
Contributions are welcome and encouraged. You can contribute in many ways:
60-
61-
* Documentation updates and corrections.
62-
* How-To guides - received help? Help others!
63-
* Bug reporting & fixes.
64-
* New feature ideas & suggestions.
65-
* Coding and Pull Requests.
66-
67-
The best place to start is the EmuFlight Discord (https://discord.gg/BWqgBg3). Next place is the github issue tracker:
65+
* Contributions are welcome and encouraged. You can contribute in many ways:
6866

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

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

73-
Before creating new issues please check to see if there is an existing one.
77+
* Before creating new issues please check to see if there is an existing one.
7478

75-
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).
79+
* If you want to contribute financially on an ongoing basis, please consider becoming a Patreon member (https://www.patreon.com/EmuFlight).
7680

7781
## Developers
7882

79-
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.
83+
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.
8084
Before starting to write code, please read our [development guidelines](docs/development/Development.md ) and [coding style definition](docs/development/CodingStyle.md).
8185

82-
## EmuFlight Releases
83-
84-
[![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)
85-
86-
https://github.com/emuflight/EmuFlight/releases
87-
8886
## Open Source / Contributors
8987

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

127-
And many many others who haven't been mentioned....
125+
And many many others either mentioned in release notes, GitHub history, or possibly haven't been mentioned.... Thank you!
Loading
Loading

‎docs/assets/images/EmuFlight.png

-90.9 KB
Binary file not shown.

0 commit comments

Comments
 (0)
Please sign in to comment.