Merge pull request #1211 from ExpressLRS/master-merge-commit
[ExpressLRS.git] / README.md
blobc0dde95526526fb320295f3e9a6fb3a65d1f0bea
1 ![Banner](https://github.com/ExpressLRS/ExpressLRS-Hardware/blob/master/img/banner.png)
3 ## Need help? Confused? Join the Community!
4  * [<img src="https://camo.githubusercontent.com/79fcdc7c43f1a1d7c175827976ffee8177814a016fb1b9578ff70f1aef759578/68747470733a2f2f6564656e742e6769746875622e696f2f537570657254696e7949636f6e732f696d616765732f7376672f646973636f72642e737667" width="15" height="15"> Community Discord](https://discord.gg/dS6ReFY)
5  * [<img src="https://camo.githubusercontent.com/8f245234577766478eaf3ee72b0615e99bb9ef3eaa56e1c37f75692811181d5c/68747470733a2f2f6564656e742e6769746875622e696f2f537570657254696e7949636f6e732f696d616765732f7376672f66616365626f6f6b2e737667" width="15" height="15"> Facebook Group](https://www.facebook.com/groups/636441730280366)
6  * [<img src="https://camo.githubusercontent.com/b079fe922f00c4b86f1b724fbc2e8141c468794ce8adbc9b7456e5e1ad09c622/68747470733a2f2f6564656e742e6769746875622e696f2f537570657254696e7949636f6e732f696d616765732f7376672f6769746875622e737667" width="15" height="15"> Wiki](https://github.com/ExpressLRS/ExpressLRS/wiki)
8 ## Support ExpressLRS
9 If you would like to support the development of ExpressLRS please feel free to make a small donation. This helps us buy hardware for porting, development and prototyping. Show your support for which new features you want added by leaving a message when you donate<br/><br/>
10 [![Donate](https://img.shields.io/badge/Donate-PayPal-253B80.svg)](https://www.paypal.com/donate?hosted_button_id=FLHGG9DAFYQZU)
12 ## Quick Start Guide
13 If you have hardware that you want to flash, please refer to our guides on the [website](https://www.expresslrs.org/), and our [FAQ](https://www.expresslrs.org/faq/)
15 ## High Performance LoRa Radio Link
17 ![Build Status](https://github.com/ExpressLRS/ExpressLRS/workflows/Build%20ExpressLRS/badge.svg)
18 ![Release](https://img.shields.io/github/v/release/ExpressLRS/ExpressLRS?include_prereleases)
19 ![License](https://img.shields.io/github/license/ExpressLRS/ExpressLRS)
20 ![Stars](https://img.shields.io/github/stars/ExpressLRS/ExpressLRS)
21 ![Chat](https://img.shields.io/discord/596350022191415318)
23 ExpressLRS is an open source RC link for RC applications. It is based on the fantastic semtech **SX127x**/**SX1280** hardware combined with an **ESP8285**, **ESP32** or **STM32**. ExpressLRS supports a wide range of hardware platforms as well as both `900 MHz` and `2.4 GHz` frequency options. ExpressLRS uses **LoRa** modulation as well as reduced packet size to achieve **best in class range and latency** compared to current commercial offerings.
25 ExpressLRS can run at various packet rates, up to `500hz` or down to `25hz` depending on your preference of range or low latency. At `900 MHz` a maximum of `200 Hz` packet rate is supported. At `2.4 GHz` a blistering `500 Hz` is currently supported with a custom openTX binary with future plans to extend this to `1000 Hz`.
27 ExpressLRS supports [telemetry](https://github.com/ExpressLRS/ExpressLRS/wiki/OpenTX-and-Betaflight-Setup#telemetry) as optional feature. Enabling telemetry also adds support for the betaflight lua script.
29 ExpressLRS can be flashed into existing **Frsky R9M hardware (RX and TX)**, **Jumper R900 RXs**, **SiYi FM30 Hardware (Rx and TX)**, **GHOST hardware (RX and TX)** or **Custom PCBs** can be made if you enjoy tinkering. Happy Model released official ExpressLRS hardware (RX and TX) and several other manufacturers are preparing to offer offical ELRS hardware soon so stay tuned.
31 ![LatencyChart](https://github.com/ExpressLRS/ExpressLRS-Hardware/blob/master/img/Average%20Total%20Latency.png)
33 ExpressLRS aims to achieve the best possible link performance for both latency and range. This is achieved with an optimised over the air packet structure. This compromise allows ExpressLRS to achieve simultaneous **better latency AND range** compared to other options in the market. For example, **ExpressLRS 2.4GHz 150Hz** mode offers the same range as **GHST Normal** while delivering near **triple** the packet update rate. Similarly, **ExpressLRS 900MHz 200Hz** will dramatically out-range **Crossfire 150Hz** and **ExpressLRS 50Hz** will out-range **Crossfire 50Hz** watt per watt.
35 **2.4GHz Comparison**
36 ![RangeVsPacketRate](https://github.com/ExpressLRS/ExpressLRS-Hardware/blob/master/img/pktrate_vs_sens.png)
38 More information can be found on the [website](https://www.expresslrs.org/).
41 ## Supported Hardware
43 ### 900 MHz Hardware:
45 <img src="https://github.com/ExpressLRS/ExpressLRS-Hardware/blob/master/img/900Mhardware.jpg" width = "80%">
47 - **TX**
48     - [FrSky R9M (2018)](https://www.frsky-rc.com/product/r9m/) (Full Support, requires resistor mod)
49     - [FrSky R9M (2019)](https://www.frsky-rc.com/product/r9m-2019/) (Full Support, no mod required)
50     - [FrSky R9M Lite](https://www.frsky-rc.com/product/r9m-lite/) (Full Support, power limited)
51     - [TTGO LoRa V1/V2](http://www.lilygo.cn/products.aspx?TypeId=50003&fid=t3:50003:3) (Full Support, V2 recommended w/50 mW power limit)
52     - [Namimno Voyager 900 TX](http://www.namimno.com/product.html) (Full Support off the shelf)
53     - [HappyModel ES915TX](http://www.happymodel.cn/index.php/2021/02/19/expresslrs-module-es915tx-long-range-915mhz-transmitter-and-es915rx-receiver/) (Full Support off the shelf)
54     - [HappyModel ES900TX](http://www.happymodel.cn/index.php/2021/02/19/expresslrs-module-es915tx-long-range-915mhz-transmitter-and-es915rx-receiver/) (Full Support off the shelf)
55     - DIY Module (Full Support, 50mW limit, limited documentation)
56     - [BetaFPV Nano 900Mhz TX](https://betafpv.com/products/elrs-nano-tx-module?variant=39416993415302) (Full Support, 500 mW output power)
57 - **RX**
58     - [FrSky R9mm](https://www.frsky-rc.com/product/r9-mm-ota/) (Full Support, OTA version can be used)
59     - [FrSky R9 Mini](https://www.frsky-rc.com/product/r9-mini-ota/) (Full Support, OTA version can be used)
60     - [FrSky R9mx](https://www.frsky-rc.com/product/r9-mx/) (Full Support)
61     - [FrSky R9 Slim+](https://www.frsky-rc.com/product/r9-slim-ota/) (Full Support, OTA version can be used)
62     - [Jumper R900 mini](https://www.jumper-b2b.com/jumper-r900-mini-receiver-900mhz-long-range-rx-p0083.html) (Full Support, only flashable via STLink, Bad Stock antenna)
63     - [DIY mini RX](https://github.com/ExpressLRS/ExpressLRS-Hardware/tree/master/PCB/900MHz/RX_Mini_v1.1) (Full Support, supports WiFi Updates)
64     - [DIY 20x20 RX](https://github.com/ExpressLRS/ExpressLRS-Hardware/tree/master/PCB/900MHz/RX_20x20_0805_SMD) (Full Support, supports WiFi Updates)
65     - [HappyModel ES915RX](http://www.happymodel.cn/index.php/2021/02/19/expresslrs-module-es915tx-long-range-915mhz-transmitter-and-es915rx-receiver/) (Full Support off the shelf)    
66     - [HappyModel ES900RX](http://www.happymodel.cn/index.php/2021/02/19/expresslrs-module-es915tx-long-range-915mhz-transmitter-and-es915rx-receiver/) (Full Support off the shelf)
67     - [Namimno Voyager 900 RX](http://www.namimno.com/product.html) (Full Support off the shelf)
68     - [BetaFPV Nano 900Mhz RX](https://betafpv.com/products/elrs-nano-receiver?variant=39416095441030) (Full Support, supports WiFi Updates)
70 ### 2.4 GHz Hardware:
72 <img src="https://github.com/ExpressLRS/ExpressLRS-Hardware/blob/master/img/24Ghardware.jpg" width = "80%">
74 - **TX**
75     - [DIY JR Bay](https://github.com/ExpressLRS/ExpressLRS-Hardware/tree/master/PCB/2400MHz/TX_SX1280) (Full Support, ~24dBm measured at 250mw, supports WiFi Updates)
76     - [DIY Slim TX](https://github.com/ExpressLRS/ExpressLRS-Hardware/tree/master/PCB/2400MHz/TX_SX1280_Slim) (Full Support, ~24dBm measured at 250mw, supports Wifi Updates, fits Slim Bay)
77     - [DIY Slimmer TX](https://github.com/ExpressLRS/ExpressLRS-Hardware/tree/master/PCB/2400MHz/TX_SX1280_Slimmer) (Full Support, ~24dBm measured at 250mw, supports Wifi Updates, fits Slim Bay)
78     - [DIY T-Lite](https://github.com/ExpressLRS/ExpressLRS-Hardware/tree/master/PCB/2400MHz/TX_SX1280_TLite) (Full Support, ~24dBm measured at 250mw, supports WiFi Updates)
79     - [GHOST TX](https://www.immersionrc.com/fpv-products/ghost/) (Full Support, 250 mW output power, OLED support in ELRS v1.1)
80     - [GHOST TX Lite](https://www.immersionrc.com/fpv-products/ghost/) (Full Support, 250 mW output power, OLED support in ELRS v1.1)
81     - [HappyModel TX](http://www.happymodel.cn/index.php/2021/04/12/happymodel-2-4g-expresslrs-elrs-micro-tx-module-es24tx/) (Full Support, 250 mW output power)
82     - [BetaFPV Nano 2.4GHz TX](https://betafpv.com/products/elrs-nano-tx-module?variant=39416993382534) (Full Support, 500 mW output power)
83 - **RX**
84     - [GHOST Atto](https://www.immersionrc.com/fpv-products/ghost/) (Full Support, Initial flashing with STLINK then both STLINK and BF passthrough)
85     - [GHOST Zepto](https://www.immersionrc.com/fpv-products/ghost/) (Full Support, Initial flashing with STLINK then both STLINK and BF passthrough)
86     - [DIY 20x20 RX](https://github.com/ExpressLRS/ExpressLRS-Hardware/tree/master/PCB/2400MHz/RX_20x20) (Full Support, easy to build. WiFi Updating)
87     - [DIY Nano RX](https://github.com/ExpressLRS/ExpressLRS-Hardware/tree/master/PCB/2400MHz/RX_Nano) (Full Support, CRSF Nano Footprint, WiFi Updating)
88     - [DIY Nano CCG RX](https://github.com/ExpressLRS/ExpressLRS-Hardware/tree/master/PCB/2400MHz/RX_CCG_Nano) (Full Support, CRSF Nano Pinout, STM32 Based)
89     - [DIY Nano Ceramic RX](https://github.com/ExpressLRS/ExpressLRS-Hardware/tree/master/PCB/2400MHz/RX_Nano_Ceramic) (Full Support, CRSF Nano Footprint, WiFi Updating, Built in antenna)
90     - [HappyModel PP RX](http://www.happymodel.cn/index.php/2021/04/10/happymodel-2-4g-expresslrs-elrs-nano-series-receiver-module-pp-rx-ep1-rx-ep2-rx/) (Full Support, CRSF Nano Pinout, STM32 Based)
91     - [HappyModel EP1/EP2 RX](http://www.happymodel.cn/index.php/2021/04/10/happymodel-2-4g-expresslrs-elrs-nano-series-receiver-module-pp-rx-ep1-rx-ep2-rx/) (Full Support, CRSF Nano Pinout, ESP8285 Based, WiFi Updating)
92     - [BetaFPV Nano 2.4GHz RX](https://betafpv.com/products/elrs-nano-receiver?variant=39416095408262) (Full Support, supports WiFi Updates)
94 ## Long Range Competition
95 One of the most frequently asked questions that gets asked by people who are interested in, but haven't yet tried ELRS is "How far does it go, and at what packet rate?"
97 The following table is a leaderboard of the current record holder for each packet rate, and the longest distance from home. Note that not every flight resulted in a failsafe at max range, so the link may go (much) futher in some cases.
99 ### Rules
100 Anyone can add an entry to the table, and entries should include the:
101 - Max distance from home
102 - RF freq (900 / 2.4)
103 - Packet rate
104 - Power level
105 - If the link failsafed at max range
106 - The pilot name
107 - A link to your DVR on youtube (DVR is essential to compete, sorry, no keyboard claims)
109 ### Current Leaderboard
110 | Max Dist. | Freq | Pkt Rate | TX Power | Failsafe at Max Range? | Pilot Handle | Link to DVR |
111 | ---- | -------- | -------- | --------- | ---------------------- | ------------ | ----------- |
112 | 40Km | 900M | 50HZ | 10mW | No | Snipes | https://www.youtube.com/watch?v=0QWN9qWoSYY |
113 | 35Km | 2.4G | 250HZ | 100mW | No | Snipes | https://youtu.be/dBmTRhgVcyY |
114 | 20Km | 2.4G | 150HZ | 100mW | Yes | Pairan | https://youtu.be/B9-AItJ9WS0 |
115 | 10Km | 2.4G | 500HZ | 10mW | Yes | mrscythe | https://youtu.be/IpiPEZrCGtg |
116 | 10Km | 2.4G | 250HZ | 100mW | No | Snipes | https://youtu.be/dJYfWLtXVg8 |
117 | 10Km | 900M | 50HZ | 100mW | Yes | Taufik | https://youtu.be/Pi2j17T2dSk |
118 | 6Km | 900M | 100HZ | 50mW | No | Snipes | https://youtu.be/kN89mINbmQc?t=58 |
119 | 6Km | 2.4G | 500HZ | 250mW | No | Spec | https://www.youtube.com/watch?v=bVJaiqJq8gY |
120 | 4.77Km | 900M | 200HZ | 250mW | No | DaBit | https://www.youtube.com/watch?v=k0lY0XwB6Ko |
121 | 3Km | 2.4G (ceramic chip antenna RX) | 500HZ | 100mW | No | Spec | https://www.youtube.com/watch?v=kfa6ugX46n8 |
122 | 2.28Km | 900M | 50HZ | 10mW | No | Mike Malagoli | https://www.youtube.com/watch?v=qi4OygUAZxA&t=75s |
125 ## Legal Stuff
126 The use and operation of this type of device may require a license and some countries may forbid its use. It is entirely up to the end user to ensure compliance with local regulations. This is experimental software/hardware and there is no guarantee of stability or reliability. **USE AT YOUR OWN RISK**
128 [![Banner](https://github.com/ExpressLRS/ExpressLRS-Hardware/blob/master/img/footer.png)](https://github.com/ExpressLRS/ExpressLRS/wiki#community)