Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Axisflying
BETAFPV
BLE
BLHeli
Bayck
Bardwell
Baudrate
BetaFPV
Expand Down Expand Up @@ -46,6 +47,7 @@ CrazyF
Crossband
CubeProgrammer
Cura
DBR
DFU
DIY
DJI
Expand Down Expand Up @@ -93,6 +95,7 @@ FW
Failsafe
Flite
FlySky
FlySky's
Flybarless
Flywoo
Foxeer
Expand All @@ -108,6 +111,7 @@ GND
GPIO
GSoD
Graupner
GX
HD
HDZero
HGLRC
Expand Down Expand Up @@ -143,6 +147,7 @@ LQI
LiPo
LinkStatistics
LinkStats
LinkFlow
LoRa
Lua
MAVLink
Expand Down Expand Up @@ -225,12 +230,14 @@ Remarketing
Repartitioner
Repo
Rox
Runcam
SBUS
SD
SDG
SDR
SG
SIYI
Sirius
SMA
SMD
SNR
Expand All @@ -247,6 +254,8 @@ SWCLK
SWDIO
SX
SYS
sync
sync'd
Saad
Schottky
Seba
Expand Down Expand Up @@ -305,13 +314,16 @@ Vantac
Vergara
Voigt
V16
V14
Walksnail
WebSocket
Webflasher
WebUI
Wifi
Wirelessly
XO
XT
XR
Yagin
Yarillo
YeOldePirate
Expand Down Expand Up @@ -533,4 +545,5 @@ README
USPTO
Squadding
UAV
UAVfutures
UAVfutures
X-Band
3 changes: 2 additions & 1 deletion docs/quick-start/installing-configurator.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ description: The ExpressLRS Configurator has made improvements on ExpressLRS acc
There are two ways to build and flash ExpressLRS:

1. [ExpressLRS Configurator](https://github.com/ExpressLRS/ExpressLRS-Configurator/releases) (**Recommended**)
2. [Development toolchain setup](../software/toolchain-install.md) (For advanced users)
2. [Web Flasher](https://expresslrs.github.io/web-flasher/)
3. [Development toolchain setup](../software/toolchain-install.md) (For advanced users)

## Configurator Setup

Expand Down
24 changes: 24 additions & 0 deletions docs/quick-start/pre-1stflight.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,30 @@ On the 900MHz hardware, a value of -20dBm or thereabouts is a good indication yo
- Most DIY modules require moving the 0-ohm resistor on the E28 from the PCB antenna side towards the UFL side. A solder bridge will work just fine as well, but make sure it is on the correct pads.
- Swap out antennas on the receiver and/or the TX module; Most ExpressLRS receiver antennas use IPEX 1/UFL connectors and as long as the frequency tuning of the antenna is appropriate for the frequency you're in, it should work. You can also use old 2.4GHz WiFi Router antennas for your 2.4GHz modules, but avoid those that are dual-band. Also, make sure that the connector on the antenna is the appropriate one (RP-SMA on R9 modules; SMA on most off-the-shelf ExpressLRS modules)

## RC Link Preset (BETAFLIGHT ONLY)
For flight controllers based on Betaflight, there are 'RC Link Presets' available that configure feedforward smoothing and associated link settings based on your packet rate and usage case.

!!! Warning
Using no link preset, or using the incorrect one for your packet rate, can result in unwanted noise and jitter in feedforward, which can affect setpoint tracking and thus flight characteristics.

To install the correct 'RC Link Preset', follow these steps in **Betaflight Configurator**:

1. Select the **Preset** tab
1. In the preset tab, select **Save Backup** and save a backup to a safe location before applying any preset.
1. Search for 'ExpressLRS' and select the Link Preset that matches your [Packet Rate](../transmitters/lua-howto.md#packet-rate-and-telemetry-ratio). If no direct match is available, choose the closest preset below your packet rate.

![Presets Home](../../assets/images/preset_home.png)

1. Read through the options by selecting the dropdown list. NOTE: These are all optional, if none of them apply to your circumstances, it is OK to leave everything unticked.

1. Select 'Pick' to stage the preset:

![Presets Pick](../../assets/images/preset_pick.png)

1. Select **Save and Reboot** to apply the preset:

![Presets Save](../../assets/images/preset_save.png)

## Blackbox

Blackbox is handy for evaluating the performance of the RF link for a flight. Set your BB to debug mode `RC_SMOOTHING_RATE`, which will capture the rate that Betaflight is receiving RC Packets from the RX.
Expand Down
24 changes: 0 additions & 24 deletions docs/quick-start/receivers/configuring-fc.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,30 +66,6 @@ The CRSF Protocol requires a full UART pair, uninverted and in full-duplex mode.
- `serialrx_halfduplex` should be **OFF**; configure it with `set serialrx_halfduplex = off`.
- Don't forget to use `save` once you're done setting these up.

## RC Link Preset (BETAFLIGHT ONLY)
For flight controllers based on Betaflight, there are 'RC Link Presets' available that configure feedforward smoothing and associated link settings based on your packet rate and usage case.

!!! Warning
Using no link preset, or using the incorrect one for your packet rate, can result in unwanted noise and jitter in feedforward, which can affect setpoint tracking and thus flight characteristics.

To install the correct 'RC Link Preset', follow these steps in **Betaflight Configurator**:

1. Select the **Preset** tab
1. In the preset tab, select **Save Backup** and save a backup to a safe location before applying any preset.
1. Search for 'ExpressLRS' and select the Link Preset that matches your [Packet Rate](../transmitters/lua-howto.md#packet-rate-and-telemetry-ratio). If no direct match is available, choose the closest preset below your packet rate.

![Presets Home](../../assets/images/preset_home.png)

1. Read through the options by selecting the dropdown list. NOTE: These are all optional, if none of them apply to your circumstances, it is OK to leave everything unticked.

1. Select 'Pick' to stage the preset:

![Presets Pick](../../assets/images/preset_pick.png)

1. Select **Save and Reboot** to apply the preset:

![Presets Save](../../assets/images/preset_save.png)

!!! important
Close your Flight Controller Configurator once you've set it up for ExpressLRS. Keeping it open could prevent the next steps from completing properly, particularly flashing via Passthrough. You must also unplug the FC from USB before proceeding to the next steps to refresh the connection.

Expand Down
31 changes: 28 additions & 3 deletions docs/quick-start/transmitters/lua-howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,22 @@ description: Here is a simple ExpressLRS Lua Script guide explaining the differe

## Installing the Lua Script

Download the [ELRS v3 Lua Script](https://github.com/ExpressLRS/ExpressLRS/blob/3.x.x-maintenance/src/lua/elrsV3.lua?raw=true) (you can simply right-click, save-as) into your radio's SD Card under the `Scripts/Tools` folder.
Download the [ExpressLRS Lua Script](https://github.com/ExpressLRS/ExpressLRS/blob/master/src/lua/elrs.lua?raw=true) (you can simply right-click, save-as) into your radio's SD Card under the `Scripts/Tools` folder.

!!! note "ExpressLRS 4.0"
Starting with ExpressLRS 4.0, the ExpressLRS Lua Script will once again go back to just using `elrs.lua` and will no longer be tied to a specific firmware version.

<figure markdown>
![Lua Folder](../../assets/images/LuaFolder.jpg)
</figure>

## Running the Lua Script

Access the script by navigating to your radio's System Menu.

!!! note "EdgeTX 3.0 Update"
EdgeTX 3.0 will bring changes into how colored-screen radios are navigated. Please refer to EdgeTX user manual for these changes.

1. Press the ++"SYS"++ Key on your Radio.
- Older Radios or those with only one Menu Key will need to long-press the ++context-menu++ Key to access the System Menu.
- Consult your Radio User's Manual on how to access the System Menu.
Expand All @@ -39,8 +47,9 @@ Access the script by navigating to your radio's System Menu.

As of 3.3.0:

- 500Hz or faster packet rates require >400K Baudrate.
- 333Hz is the fastest packet rate you can use with 400K Baudrate.
- 333Hz or faster packet rates require >400K Baudrate for external ELRS modules.
- 250Hz is the fastest packet rate you can use with 400K Baudrate on external modules.
- Best to stick to the fastest baudrate your radio can handle. See the [Baud Rate](tx-prep.md#serial-baud-rate) table.

## Understanding and Using the Lua Script

Expand Down Expand Up @@ -114,6 +123,20 @@ Items with `>` before the name is a folder that when selected shows another leve

These items will now show what is currently set for the items within. An example would be on `TX Power`, which will show the current Power set, and if Dynamic Power is enabled, it will show the current set Max Power, followed by the indicator `Dyn`.

### RF Band

This option is only available for RF modules capable of Dual-Band operation.

The following options will be available:

- X-Band

* Gemini X-Band (Crossband) or GemX mode; Simultaneous operation in 900MHz and 2.4GHz Band. Available only to modules with Dual LR1121 RF chips like the Nomad, Internal GX12 GemX module, Bayck Dual-Band Gemini External modules, etc. Will only sync or connect with GemX-capable receivers like the XR4, DBR4, GEPRC Gemini Xrossband, Bayck Dual Band, etc.

- 2.4GHz

- 900MHz

### Packet Rate and Telemetry Ratio

<figure markdown>
Expand Down Expand Up @@ -194,6 +217,7 @@ Available Options:
!!! warning "WARNING"
When using a Gemini TX with a non-Gemini receiver, you should set the TX in either Switch or Single Antenna (Ant1/Ant2) Mode.
The reason is that as the receiver only get the signal from the TX it has synchronized with, the other TX will act as a noise generator and increase both the noise floor and power consumption.
X-Band or X modes will now lock this to Gemini or if it detects the Receiver isn't capable of Gemini Mode, it will be set to `Switch` starting with ExpressLRS 4.0.

### Link Mode

Expand Down Expand Up @@ -366,6 +390,7 @@ The `Protocol` setting controls the output of the connected receiver. The follow
* `Inverted SBUS` - Like the above, but inverted.
* `SUMD` - Lets the receiver output Graupner HoTT SUMD signal for use with devices that don't support CRSF protocol, like Stabilizers, Heli Controllers etc.
* `DJI RS2 Pro` - Mainly used for the RS2 Pro Gimbals
* `DisplayPort` - For controlling (primarily) DJI Air units to take them out of Low Power mode. New in ExpressLRS 4.0.
* `HoTT Telemetry` - Allows to use Graupner HoTT enabled telemetry sensors (Graupner and 3rd party)
* `MAVLINK` - Introduced on ExpressLRS 3.5.0, it allows the receiver to output native MAVLink into a flight controller. See the [MAVLink](../../software/mavlink.md) page for more details.

Expand Down
49 changes: 37 additions & 12 deletions docs/quick-start/transmitters/tx-prep.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@ Insert or attach your External ExpressLRS Transmitter Module into your Radio mod
Make sure you do have an Internal ExpressLRS Module on your shiny new radio. The following handsets come in both ELRS (ExpressLRS) or 4-in-1 variants; with some coming in with a third (CC2500). Only the ELRS variant works with ExpressLRS. The others will not work as they have a different Hardware incompatible with ExpressLRS.

- RadioMaster TX16S Mark II (ELRS, 4-in-1 CC2500) - ExpressLRS variant will have an ELRS sticker on the box.
- RadioMaster TX12 Mark II (ELRS, 4-in-1, CC2500) - ExpressLRS variant will have an ELRS sticker on the box and an ELRS sticker in the JR module bay.
- RadioMaster TX12 Mark II (ELRS, 4-in-1, CC2500) - ExpressLRS variant will have an ELRS sticker on the box and a blue ELRS sticker in the JR module bay.
- RadioMaster Zorro (ELRS, 4-in-1, CC2500) - ExpressLRS variant will have an ELRS sticker on the box.
- RadioMaster Boxer (ELRS, 4-in-1, CC2500) - ExpressLRS variant will have an ELRS sticker on the box and an ELRS sticker in the JR module bay.
- RadioMaster Boxer (ELRS, 4-in-1, CC2500) - ExpressLRS variant will have an ELRS sticker on the box and a blue ELRS sticker inside the battery bay.
- RadioMaster Pocket (ELRS, CC2500) - ExpressLRS variant will have an ELRS sticker on the box and a blue ELRS sticker inside the radio.
- RadioMaster MT12 (ELRS, 4-in-1) - ExpressLRS variant will have an ELRS sticker on the box and a blue ELRS sticker within the battery bay.
- Jumper T-Lite V2 (ELRS, 4-in-1, CC2500)
- Jumper T-Pro V1/V2 (ELRS, 4-in-1)
- BetaFPV Lite Radio 3 Pro (ELRS, CC2500) - A sticker with the barcode at the bottom of the box should tell you it's an ELRS variant or the CC2500 variant.
Expand All @@ -36,10 +38,15 @@ Make sure you do have an Internal ExpressLRS Module on your shiny new radio. The
<figcaption>Example Sticker On RadioMaster Handset/Radios</figcaption>
</figure>

FlySky is also now offering handsets with an ExpressLRS-compatible internal module like the PA01. Early batches of the radio comes with AFHDS3 firmware and can be converted to ExpressLRS via FlySky's [online tool](https://firmwareswitcher.flyskytech.com/en) under the RF Firmware Tab or by just flashing via the ExpressLRS Configurator or Webflasher.

## Radio Operating System

ExpressLRS **requires** CRSFShot or Mixer Sync to ensure full support for high packet rates. You should have [OpenTX 2.3.12](https://www.open-tx.org/2021/06/14/opentx-2.3.12) or newer, or [EdgeTX 2.4.0](https://github.com/EdgeTX/edgetx/releases/tag/v2.4.0) or newer; These versions have full CRSFShot/Mixer Sync support.

!!! note "EdgeTX 3.0 Update"
EdgeTX 3.0 will bring changes into how colored-screen radios are navigated. Please refer to EdgeTX user manual for these changes.

To determine your Radio Operating System Version, load the Version page from the System Menu of your Radio:

1. Press the ++"SYS"++ Key.
Expand Down Expand Up @@ -76,7 +83,7 @@ ExpressLRS highly recommends [EdgeTX](https://github.com/EdgeTX/edgetx/releases)
9. Once Writing is complete, reboot the radio.
10. Check the Radio's Version Page to verify you have the version you need.

Check [this page](https://github.com/EdgeTX/edgetx.github.io/wiki/EdgeTX-Installation-Guide) for the EdgeTX installation instructions if you're coming in from OpenTX.
Check [this page](https://manual.edgetx.org/installing-and-updating-edgetx) for the EdgeTX installation instructions if you're coming in from OpenTX or updating from an earlier EdgeTX version.

## Radio Settings

Expand Down Expand Up @@ -171,14 +178,18 @@ On other Radios, you can set the Baudrate higher than 400K but will highly depen
| RadioMaster Pocket | 5.25M | |
| RadioMaster MT12 | 5.25M | |
| RadioMaster TX12 | 5.25M | |
| RadioMaster GX12 | 5.25M | External at 1.87M |
| RadioMaster TX15 | 5.25M | |
| Jumper T-Lite V2 | 1.87M | Limited by Handset |
| Jumper T-Pro | 1.87M | Limited by Handset |
| Jumper T20 | 1.87M | Limited by Handset |
| Jumper T14 | 5.25M | |
| Jumper T15 | 5.25M | |
| Jumper T15/Pro | 5.25M | |
| Jumper T12 Max | 5.25M | |
| BetaFPV Lite Radio 3 Pro | 1.87M | Limited by Handset |
| HelloRadio V16 | 5.25M | |
| HelloRadio V16/R | 5.25M | |
| HelloRadio V14 | 5.25M | |
| FlySky PA01 | 5.25M | |

| External TX Module | Max Baud Rate | Notes |
| ---- | ---- | ---- |
Expand All @@ -190,20 +201,25 @@ On other Radios, you can set the Baudrate higher than 400K but will highly depen
| BetaFPV SuperG | 5.25M | |
| RadioMaster Ranger (Micro & Nano included) | 5.25M | |
| RadioMaster Bandit (Micro & Nano included) | 5.25M | |
| RadioMaster Nomad | 5.25M | |
| Axisflying Thor | 5.25M | |
| EMAX Aeris OLED & Nano | 5.25M | |
| GEPRC LinkFlow | 5.25M | |
| BAYCK Dual-Band Gemini Micro & Nano | 5.25M | |
| BAYCK Dual-Band Nano | 5.25M | |
| Runcam Sirius | 5.25M | |
| NamimnoRC Flash/Voyager (no OLED) | 3.75M | STM-based |
| NamimnoRC Flash/Voyager OLED | 5.25M | |
| Vantac Lite | 1.87M | |
| Jumper Aion Nano | 1.87M | |
| iFlight Command 8 | 3.75M | wired as external module |
| HGLRC Hermes | 5.25M | |
| HGLRC T ONE OLED | 5.25M | |
| FrSky R9M/R9M Lite/R9M Lite Pro | 1.87M | |
| FrSky R9M 2018 (non-ACCESS) | 115K | [Resistor Mod](../../hardware/inverter-mod.md) for 400K |
| QuadKopters JR & Slim | 5.25M | |
| SIYI FM30 | 1.87M | STM-based |
| ImmersionRC GHOST | 1.87M | STM-based |
| FrSky R9M/R9M Lite/R9M Lite Pro | 1.87M | STM-based; No Longer Supported from ELRS 4.0 onwards |
| FrSky R9M 2018 (non-ACCESS) | 115K | [Resistor Mod](../../hardware/inverter-mod.md) for 400K; <br />STM-based; No Longer Supported from ELRS 4.0 onwards |
| QuadKopters JR & Slim | 5.25M | STM-based; No Longer Supported from ELRS 4.0 onwards |
| SIYI FM30 | 1.87M | STM-based; No Longer Supported from ELRS 4.0 onwards |
| ImmersionRC GHOST | 1.87M | STM-based; No Longer Supported from ELRS 4.0 onwards |

!!! note "Note"
The Max Baud Rate for external modules will still depend on the capabilities of the Radio Handset.
Expand All @@ -217,7 +233,7 @@ On other Radios, you can set the Baudrate higher than 400K but will highly depen

### ADC Filter

The ADC filter is enabled by default in OpenTX and is known to cause issues with RC Command data. This can result in "jagged" RC command responses in black box logs, caused by sequential RC packets that have the same command value (which were "smoothed" by the ADC filter). We recommend turning the ADC filter OFF in [OpenTX/EdgeTX](https://www.youtube.com/watch?v=ESr2H_EZ89Q).
The ADC filter is enabled by default in OpenTX and is known to cause issues with RC Command data. This can result in "jagged" RC command responses in black box logs, caused by sequential RC packets that have the same command value (which were "smoothed" by the ADC filter). We recommend turning the ADC filter OFF in [OpenTX/EdgeTX](https://www.youtube.com/watch?v=ESr2H_EZ89Q) for applications involving a flight controller that can smooth out or filter the channel data (like Betaflight, etc.).

To check and change this setting, follow these steps:

Expand All @@ -241,6 +257,9 @@ To check and change this setting, follow these steps:
5. Use the Scroll wheel to select between Global(uses the setting from the Hardware page in the System Menu), On or Off.
6. Press ++enter++ Key once more to set it.

!!! note "PWM Receivers"
You **MUST** enable `ADC Filter` on models you are using with ExpressLRS PWM receivers (or any PWM Receivers) to help with alleviating jitters from the channel outputs.

## Model Setup

### RF Protocol
Expand Down Expand Up @@ -323,7 +342,7 @@ By default, a fresh model does not have any Aux Channels configured (Aux channel
5. (Optional) You can name this channel however you want to remind you of its purpose.
6. Select Source. Press the ++enter++ Key.
7. Activate or flick the Switch you'd want to use for this channel.
- An example would be for CH5, which will be your Arming switch, you'd want to choose a 2-position switch.
- An example would be for CH5, which can be your Arming switch, you'd want to choose a 2-position switch.
8. Press the ++enter++ Key once more to set the switch.
9. Press ++"RTN"++ Key once to exit the Channel Mix editor.
10. Repeat steps 3-9 until you have configured all the switches you think you will need.
Expand All @@ -347,3 +366,9 @@ By default, a fresh model does not have any Aux Channels configured (Aux channel
<figure markdown>
![mixesAux Color](../../assets/images/txprep-clr-mixAux.jpg)
</figure>

### Channel Mixing

This is important for those using PWM Receivers, and isn't using flight controllers. You would want to configure at least a basic channel mix for your application. Consult the EdgeTX documentation for a few simple mixes or utilize their Model Wizard for basic setup.

Once you have your PWM Receiver sync'd with your TX module or Radio, revisit your mix to confirm your control surfaces work as they should and adjust your mix as necessary, **BEFORE** attempting your first flight.