Skip to content

Commit

Permalink
more words
Browse files Browse the repository at this point in the history
10536 before this
  • Loading branch information
maybenikhil committed Feb 27, 2024
1 parent 72f1cfa commit 93cab40
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 15 deletions.
53 changes: 51 additions & 2 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ SuperD
TCXO
UART
DIY
CRSFshot
CRSFShot
EdgeTX
OpenTX
FPV
Expand All @@ -37,7 +37,7 @@ deadbyte
maybenikhil
BETAFPV
Happymodel
Radiomaster
RadioMaster
Multicopters
facebook
fontawesome
Expand Down Expand Up @@ -70,3 +70,52 @@ PWM
CRSF
Heli
SBUS
pre
Init
Graupner
HoTT
UARTs
Tlm
bluetooth
BluetoothLE
TXes
BLE
Headtracking
VRX
mW
dBm
LQ
jitter
FAILSAFE
desync
Configs
Repartitioner
Nano
SYS
RTN
MDL
INAV
Aion
NamimnoRC
OLED
TLite
Vantac
iFlight
Taranis
FrSky
ACCST
QX
DFU
Baudrate
barcode
GND
VBAT
VCC
UI
CubeProgrammer
PlatformIO
CLI
RDP
SIYI
VM
exe
6 changes: 3 additions & 3 deletions docs/gsod.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ hide:

Review and Expand ExpressLRS User Documentation - [expresslrs.org](https://www.expresslrs.org)

## About the organisation
## About the organization

ExpressLRS (ELRS) is an open source project focusing on developing a radio control (RC) link. The link is primarily designed for first-person view (FPV) crafts (e.g Multicopters, Planes). ELRS aims to provide the best completely open source, high refresh radio control link, minimizing latency while maximising range. A vast range of hardware in both 900 MHz and 2.4 GHz frequencies is available.
ExpressLRS (ELRS) is an open source project focusing on developing a radio control (RC) link. The link is primarily designed for first-person view (FPV) crafts (e.g Multicopters, Planes). ELRS aims to provide the best completely open source, high refresh radio control link, minimizing latency while maximizing range. A vast range of hardware in both 900 MHz and 2.4 GHz frequencies is available.

FPV is a community built on top of open source projects such as [flight controller firmware Betaflight](https://github.com/betaflight) and [RC handset firmware EdgeTX](https://github.com/EdgeTX). ELRS fills a void for an open source and high performance RC link with an active development team of about 20 volunteers.

Expand Down Expand Up @@ -129,7 +129,7 @@ Our initial timeline has been heavily delayed through the delivery of hardware t

**Metrics**

A key metric for the success of the project was to address common user issues in the documentation. Another key metric is the project's userbase & growth: at the time of the proposal the Facebook group had 8.4k and Discord 8.1k users. These groups have now grown to 12.4k and 13k respectively!
A key metric for the success of the project was to address common user issues in the documentation. Another key metric is the project's user base & growth: at the time of the proposal the Facebook group had 8.4k and Discord 8.1k users. These groups have now grown to 12.4k and 13k respectively!

Therefore, we can say that we observed significant growth as a project & organization within the months of Google Season of Docs, but have no strong metrics correlating to use of documentation, as compared to the beginning of the project.

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

## Installing the Lua Script

Download the [ELRSv3 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 [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.

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

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

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.
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.
2. You are now in the Tools Menu where Lua Scripts can be found. Scroll down and select `ExpressLRS` Lua Script.

Expand All @@ -30,7 +30,7 @@ Access the script by navigating to your radio's System Menu.
![Lua Script Colored](../../assets/images/lua2.jpg)
</figure>

3. Press ++enter++ to Load it.
3. Press ++`enter`++ to Load it.

??? failure "Stuck at `Loading...` (click/tap to expand)"
Go back to the [Radio Preparation Guide](tx-prep.md) and make sure the current model is configured for ExpressLRS use.
Expand Down Expand Up @@ -199,7 +199,7 @@ The Receiver ID of the active model is shown after the option value.
![Power Settings BW](../../assets/images/lua/power-bw.png)
</figure>

The `TX Power` folder is where you can change your TX Module's Transmission Power settings. Press ++enter++ once to access the settings and Press ++"RTN"++ key to go back to the previous page.
The `TX Power` folder is where you can change your TX Module's Transmission Power settings. Press ++`enter`++ once to access the settings and Press the ++`RTN`++ key to go back to the previous page.

* `Max Power` sets the maximum power level your TX will transmit at. Selecting a power level higher or lower than your TX supports will revert to the closest supported level. The options are `10, 25, 50, 100, 250, 500, 1000 & 2000` mW. If Dynamic Power is set to `Off` this is the power level your TX always uses.

Expand All @@ -226,9 +226,9 @@ VTX Administrator allows you to change your VTX settings directly from your radi

* `Channel` sets the VTX channel, the options are `1, 2, 3, 4, 5, 6, 7 & 8` which are the standard channels in the above bands.

* `Pwr Lvl` sets the VTX power by index, the options are `-, 1, 2, 3, 4, 5, 6, 7, & 8` which are the power levels that your VTX can do. Refer to your VTX table settings on the flight controller for the exact power levels. For example a VTX may have 1 = 25mW, 2 = 100mwW, 3 = 200mW, 4 = 500mW.
* `Pwr Lvl` sets the VTX power by index, the options are `-, 1, 2, 3, 4, 5, 6, 7, & 8` which are the power levels that your VTX can do. Refer to your VTX table settings on the flight controller for the exact power levels. For example a VTX may have 1 = 25mW, 2 = 100mW, 3 = 200mW, 4 = 500mW.

* `Pitmode` the options are `On & Off` which allow you to quickly switch into or out of pitmode
* `Pitmode` the options are `On & Off` which allow you to quickly switch into or out of pit mode

* Finally pressing the `[Send VTX]` button sends the configured settings to the receiver and on to the VTX. These settings are also sent every time a connection is established.

Expand All @@ -248,9 +248,9 @@ This section contains all the WiFi-related functions.

* `Enable RX WiFi` will put the bound and connected receiver into WiFi mode to facilitate updating via WiFi (if the receiver has WiFi capabilities).

* `Enable Backpack WiFi` will put the TX Backpack into WiFi mode (available only to TX modules with backpacks connected and updated to the new [Backpack](https://github.com/ExpressLRS/Backpack) firmwares).
* `Enable Backpack WiFi` will put the TX Backpack into WiFi mode (available only to TX modules with backpacks connected and updated to the new [Backpack](https://github.com/ExpressLRS/Backpack) firmware).

* `Enable VRx WiFi` will put the VRx [Backpack](https://github.com/ExpressLRS/Backpack) that is bound and connected to the onboard TX Backpack into WiFi mode to facilitate updating via WiFi.
* `Enable VRX WiFi` will put the VRX [Backpack](https://github.com/ExpressLRS/Backpack) that is bound and connected to the onboard TX Backpack into WiFi mode to facilitate updating via WiFi.

### Backpack Options

Expand Down Expand Up @@ -334,7 +334,7 @@ The Other Devices folder, if present, allows changing the configuration of other
The `Protocol` setting controls the output of the connected receiver. The following options are available:

* `CRSF` - The regular CRSF Protocol Output. Recommended for most application.
* `Inverted CRSF` - The CRSF Protocol inverted for use in Flight Controllers that doesn't have any other uarts available and the only option is to connect the receiver TX pin into an SBUS pad (Inverted RX). This is the old `Invert TX Pin` option.
* `Inverted CRSF` - The CRSF Protocol inverted for use in Flight Controllers that doesn't have any other UARTs available and the only option is to connect the receiver TX pin into an SBUS pad (Inverted RX). This is the old `Invert TX Pin` option.
* `SBUS` - Let the receiver output SBUS signal for use with devices that doesn't support CRSF protocol, like Stabilizers, Heli Controllers etc.
* `Inverted SBUS` - Like the above, but inverted.
* `SUMD` - Graupner/HoTT
Expand Down

0 comments on commit 93cab40

Please sign in to comment.