Skip to content

Commit

Permalink
MORE WORDS
Browse files Browse the repository at this point in the history
1712
  • Loading branch information
maybenikhil committed Feb 27, 2024
1 parent 7f58fc4 commit bf43cf4
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 15 deletions.
44 changes: 43 additions & 1 deletion .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,6 @@ iNav
configurator
Blackbox
SDG
MAVLINK
lua
IPEX
SMA
Expand Down Expand Up @@ -325,3 +324,46 @@ crc
https
HD
dodecatillion
StefaΕ„ski
MAVLink
AirPort
Freestylers
DVDA
FreqCorrection
LinkStatistics
LinkStats
spammy
params
BLHeli
RTTTL
youtube
Rox
uncomment
downlink
BetaflightPassthrough
uninversion
md
PuTTY
comms
GCS
RXs
TXs
repurposes
Microbeast
SRXL
SUMD
flybarless
Flybarless
dropdown
ModelMatch
Uplink
fullres
LNAs
octocat
unstaged
MacOS
Repo
repo
VSCode's
SmartPort
LQI
8 changes: 4 additions & 4 deletions docs/software/airport.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: ExpressLRS can be configured as a bi-directional transparent serial
## Description

AirPort provides a firmware option that allows you to turn a regular ExpressLRS transmitter and receiver pair into a bi-directional transparent serial data link, over the air.
The TX module is intended to connect via USB to a laptop, and the RX connects to a free UART on your FC, as per usual. This then allows serial data comms between the peers, in any protocol you wish to use, for example, MAVLINK (Ardupilot), MSP (Betaflight and INAV), or any other telemetry protocol you might wish to use. This may also be useful for wireless ground comms, for example: transmitting CRSF from your handset to an antenna tracker.
The TX module is intended to connect via USB to a laptop, and the RX connects to a free UART on your FC, as per usual. This then allows serial data comms between the peers, in any protocol you wish to use, for example, MAVLink (ArduPilot), MSP (Betaflight and INAV), or any other telemetry protocol you might wish to use. This may also be useful for wireless ground comms, for example: transmitting CRSF from your handset to an antenna tracker.

!!! warning "Warning"
The AirPort option completely replaces the RC link, and repurposes it as a data link. If you intend to retain RC control via ELRS, you will need to run 2x TXs and 2x RXs on the ground and air, respectively. One TX+RX pair sends your normal RC link data, just as it does now, and the other TX+RX pair sends the serial data.
Expand Down Expand Up @@ -109,10 +109,10 @@ Connect the RX to a spare UART on your flight controller, as per normal:
<figcaption>Example AirPort Receiver Wiring</figcaption>
</figure>

Using the appropriate Configurator tool for your FC firmware, configure your selected UART with your desired telemetry protocol. For example, if using AirPort for MAVLINK in Ardupilot, you would set:
Using the appropriate Configurator tool for your FC firmware, configure your selected UART with your desired telemetry protocol. For example, if using AirPort for MAVLink in ArduPilot, you would set:

* `SERIALN_BAUD` to the baud you entered in the section above,
* `SERIALN_OPTIONS` to `0`,
* `SERIALN_PROTOCOL` to `1` or `2` (for MAVLINKv1 or MAVLINKv2).
* `SERIALN_PROTOCOL` to `1` or `2` (for MAVLink v1 or MAVLink v2).

Connect the TX to a computer via USB, open the program that you intend to view the telemetry in, then connect to the COM port for your TX module at the baud you entered above. For example, if using AirPort for MAVLINK in Ardupilot, you would open Mission Planner / QGC etc. and select the TX COM port, enter the baud, then click Connect.
Connect the TX to a computer via USB, open the program that you intend to view the telemetry in, then connect to the COM port for your TX module at the baud you entered above. For example, if using AirPort for MAVLink in ArduPilot, you would open Mission Planner / QGC etc. and select the TX COM port, enter the baud, then click Connect.
2 changes: 1 addition & 1 deletion docs/software/dynamic-transmit-power.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Another important setting is to make sure your craft is **armed** on AUX1=`high`

### Starting Power

On module powerup with Dynamic Power enabled, transmit power is set to the minimum supported power.
On module power up with Dynamic Power enabled, transmit power is set to the minimum supported power.

### Lowering Power

Expand Down
6 changes: 3 additions & 3 deletions docs/software/gemini.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ Flying at events with 6 to 8 up racers, plus who knows how many handsets left po

A Gemini TX has the advantage of not only sending simultaneous packets, but also receiving simultaneous packets. Or when used in single antenna mode (or switch mode) both antennas will listen for the same TLM packet, in the same way a diversity RX listens for RC packets. So your TLM link becomes stronger with fewer missed packets, even when not used in Gemini mode and with single antenna receivers.

### Airport and Mavlink users
### AirPort and MAVLink users

For data links a single missed packet can mean more than 1 missed packet. If a single packet is missed, this means the rest of the data that was received for that Mavlink packet is now wasted. As the Mavlink packet may have been split across multiple OTA packets and will not be complete. The single missed packet can turn into 10 packets missed. Gemini will help with making sure you get the highest Mav packet rate possible!
For data links a single missed packet can mean more than 1 missed packet. If a single packet is missed, this means the rest of the data that was received for that MAVLink packet is now wasted. As the MAVLink packet may have been split across multiple OTA packets and will not be complete. The single missed packet can turn into 10 packets missed. Gemini will help with making sure you get the highest MAVLink packet rate possible!

## Will Gemini increase my range?

Expand All @@ -64,7 +64,7 @@ Yes, there is antenna switching.

## What happens if I use a Gemini TX, in Gemini Mode, with a single Antenna Receiver?

The Gemini TX will function as designed, in Gemini Mode. The Receiver will only get the signal from the TX it has sync'd with. The other TX, will act as a noise generator. Therefore, you should set the TX in either Switch or Single Antenna (Ant1/Ant2) Mode.
The Gemini TX will function as designed, in Gemini Mode. The Receiver will only get the signal from the TX it has synchronized with. The other TX, will act as a noise generator. Therefore, you should set the TX in either Switch or Single Antenna (Ant1/Ant2) Mode.

## What happens if I use a Gemini TX, in Gemini Mode, with Gemini-incapable Diversity Receivers?

Expand Down
10 changes: 5 additions & 5 deletions docs/software/toolchain-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ template: main.html

`ExpressLRS` is written in C++ using the Arduino framework.

* Rather than using the Arduino IDE (which let's face it, πŸ—Ώ is pretty clunky), we use [platformIO](https://platformio.org/)
* Rather than using the Arduino IDE (which let's face it, πŸ—Ώ is pretty clunky), we use [PlatformIO](https://platformio.org/)
* To ease the use of `pio` we recommend using the [extension ](https://platformio.org/install/ide?install=vscode) for `Visual Studio Code`

### PlatformIO

1. πŸ”½ **Download** a copy of [vscode](https://code.visualstudio.com/) for your computer
2. πŸ“‚ **Open** vscode, and click on the "__Extensions__" icon in the toolbar on the right (see [Managing Extensions](https://code.visualstudio.com/docs/editor/extension-gallery) πŸ“˜)
1. πŸ”½ **Download** a copy of [VSCode](https://code.visualstudio.com/) for your computer
2. πŸ“‚ **Open** VSCode, and click on the "__Extensions__" icon in the toolbar on the right (see [Managing Extensions](https://code.visualstudio.com/docs/editor/extension-gallery) πŸ“˜)
3. πŸ”Ž In the search box, enter `platformio`, and **install** the **extension** (see [the `pio install` documentation](https://platformio.org/install/ide?install=vscode) πŸ“š)

### Git Setup
Expand All @@ -28,7 +28,7 @@ We recommend using VSCode's built-in Git client, as it requires the least 3rd pa
2. Install `git`, click **yes** to the default options (there are a **LOT** πŸ’―)

!!! important
Make sure you select this option during installation, it adds git to PATH which is necessary for VScode cloning (the next step).
Make sure you select this option during installation, it adds git to PATH which is necessary for VSCode cloning (the next step).

<figure markdown>
<img class="center-img" src="https://raw.githubusercontent.com/ExpressLRS/ExpressLRS-hardware/master/img/git_path_option.png" width=100%>
Expand Down Expand Up @@ -110,4 +110,4 @@ The advantage this method has over the first method is that all your changes to

3. In the terminal, type: `git pull -f`

This will pull a new revision of the remote repository to your local repository and automatically merge it with your changes.
This will pull a new revision of the remote repository to your local repository and automatically merge it with your changes.
2 changes: 1 addition & 1 deletion docs/software/user-defines.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Disables all TX buzzer beeps at any state
```
USE_TX_BACKPACK
```
Enables code for talking to a connected [ESP8266 backpack](https://github.com/ExpressLRS/Backpack) on the TX module, and associated Lua params. The device target should enable this automatically for devices that come with this built-in, but can be added to any device. The TX backpack allows wireless integration with VRx modules and planned telemetry mirroring over WiFi.
Enables code for talking to a connected [ESP8266 backpack](https://github.com/ExpressLRS/Backpack) on the TX module, and associated Lua params. The device target should enable this automatically for devices that come with this built-in, but can be added to any device. The TX backpack allows wireless integration with VRX modules and planned telemetry mirroring over WiFi.

## Debug Options

Expand Down

0 comments on commit bf43cf4

Please sign in to comment.