jlpoole/LilyGo-LoRa-Series
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Update docs

Browse source
This commit is contained in:
lewisxhe 2025-07-07 17:38:16 +08:00
commit 7cd63af7ed
13 changed files with 645 additions and 791 deletions
Download patch file Download diff file Expand all files Collapse all files

429
README.MD
View file

@ -1,53 +1,33 @@
<h1 align = "center">🌟LilyGo LoRa Series🌟</h1>
<div align="center" markdown="1">
<img src=".github/LilyGo_logo.png" alt="LilyGo logo" width="100"/>
</div>
## **[中文](./README_CN.MD) | English**
<h1 align = "center">🌟LilyGo LoRa Series🌟</h1>
## News
- This warehouse currently only maintains the version of LilyGo that is on sale , For the LilyGo discontinued version of the LoRa board, please jump to [Archive package](https://github.com/Xinyuan-LilyGO/LilyGo-LoRa-Series/releases/tag/v0.0.1) to download
- Arduino IDE users need to configure the board to be used in the <utilities.h> file in the sketch directory before using the example. The <utilities.h> file contains the pin definitions of the board. If you do not select it, an error will occur during compilation.
- Arduino IDE 用户需要在 Sketch 目录下的 <utilities.h> 文件的最上方配置要使用的开发板，然后才能使用该示例。<utilities.h> 文件包含开发板的引脚定义。如果您未选择该文件，编译时将出现错误。
## 1️⃣Product
### `1` Get Started
| Product | SOC | Flash | PSRAM |
| ---------------------------------- | ---------------------- | -------------- | -------------- |
| [T-Beam S3 Supreme L76K][1] | ESP32-S3FN8 | 8MB(Quad-SPI) | 8MB(Quad-SPI) |
| [T-Beam S3 Supreme Ublox][2] | ESP32-S3FN8 | 8MB(Quad-SPI) | 8MB(Quad-SPI) |
| [T-Beam Meshtastic][3] | ESP32-D0WDQ6-V3 | 4MB(Quad-SPI) | 8MB(Quad-SPI) |
| [T-Beam SoftRF][4] | ESP32-D0WDQ6-V3 | 4MB(Quad-SPI) | 8MB(Quad-SPI) |
| [T3-S3 SX1280 2.4G With out PA][5] | ESP32-S3FH4R2 | 4MB(Quad-SPI) | 2MB(Quad-SPI) |
| [T3-S3 SX1280 2.4G With PA][6] | ESP32-S3FH4R2 | 4MB(Quad-SPI) | 2MB(Quad-SPI) |
| [T3-S3 SX1276][7] | ESP32-S3FH4R2 | 4MB(Quad-SPI) | 2MB(Quad-SPI) |
| [T3-S3 SX1262][8] | ESP32-S3FH4R2 | 4MB(Quad-SPI) | 2MB(Quad-SPI) |
| [LoRa32 V1.3][8] | ESP32-D0WDQ6-V3 | 4MB(Quad-SPI) | ❌ |
| [LoRa32 V1.6.1][11] | ESP32-PICO-D4 | 4MB(Quad-SPI) | ❌ |
| [T-Motion][9] | STM32L073RZ | 192 Kbyte | (20-Kbyte RAM) |
| [T-Lora C6][10] | ESP32-C6-MINI-1U | 4MB(Quad-SPI) | ❌ |
| [T-Beam BPF][12] | ESP32-S3-WROOM-1-N16R8 | 16MB(Quad-SPI) | 8MB(OPI) |
| [T-3 TCXO][13] | ESP32-PICO-D4 | 4MB(Quad-SPI) | ❌ |
| [T-Beam 2W][15] | ESP32-S3-WROOM-1-N16R8 | 16MB(Quad-SPI) | 8MB(OPI) |
- 🔧 **[T-Beam Quick Start](./docs/en/t_beam/t_beam_hw.md)**
- 🔧 **[T-Beam Supreme Quick Start](./docs/en/t_beam_supreme/t_beam_supreme_hw.md)**
- 🔧 **[T-Beam BPF Quick Start](./docs/en/t_beam_bpf/t_beam_bpf_hw.md)**
- 🔧 **[T-Beam 2W Quick Start](./docs/en/t_beam_2w/t_beam_2w_hw.md)**
- 🔧 **[LoRa32 V1.3 Quick Start](./docs/en/t3_v13_sx1276/t3_v13_sx1276.md)**
- 🔧 **[LoRa32 V1.6.1 Quick Start](./docs/en/t3_v161_sx1276/t3_v161_sx1276_hw.md)**
- 🔧 **[LoRa32 TCXO Quick Start](./docs/en/t3_tcxo_sx1276/t3_tcxo_sx1276_hw.md)**
- 🔧 **[T3-C6 Quick Start](./docs/en/t3_c6_sx1262/t3_c6_sx1262_hw.md)**
- 🔧 **[T3-S3-SX1262 Quick Start](./docs/en/t3_s3_sx1262/t3_s3_sx1262_hw.md)**
- 🔧 **[T3-S3-SX1280 Quick Start](./docs/en/t3_s3_sx1280/t3_s3_sx1280_hw.md)**
- 🔧 **[T3-S3-SX1280PA Quick Start](./docs/en/t3_s3_sx1280pa/t3_s3_sx1280pa.md)**
[1]: https://www.lilygo.cc/products/softrf-t-beamsupreme?variant=42880905052341 "T-Beam S3 Supreme L76K"
[2]: https://www.lilygo.cc/products/softrf-t-beamsupreme?variant=42880905281717 "T-Beam S3 Supreme Ublox"
[3]: https://www.lilygo.cc/products/t-beam-v1-1-esp32-lora-module "T-Beam Meshtastic"
[4]: https://www.lilygo.cc/products/t-beam-softrf "T-Beam SoftRF"
[5]: https://www.lilygo.cc/products/t3s3-v1-0?variant=42586879656117 "T3-S3 SX1280 2.4G With out PA"
[6]: https://www.lilygo.cc/products/t3s3-v1-0?variant=43043715678389 "T3-S3 SX1280 2.4G With PA"
[7]: https://www.lilygo.cc/products/t3s3-v1-0?variant=42586879688885 "T3-S3 SX1276"
[8]: https://www.lilygo.cc/products/lora-v1-3 "LoRa V1.3"
[9]: https://www.lilygo.cc/products/t-motion-s76g-stm32-lora "T-Motion"
[10]: https://www.lilygo.cc/products/t-lora-c6 "T-Lora C6"
[11]: https://lilygo.cc/products/lora3 "LoRa32 V1.6.1"
[12]: https://www.lilygo.cc/products "T-Beam BPF"
[13]: https://lilygo.cc/products/t3-tcxo "T-3 TCXO"
[15]: https://lilygo.cc/ "T-Beam 2W"
## 2️⃣Example description
## `2` Example description
```bash
./examples/
├── ArduinoLoRa # Only support SX1276/SX1278 radio module
├── ArduinoLoRa # Only support SX1276/SX1278 radio module (仅支持 SX1276/SX1278 无线电模块)
│ ├── LoRaReceiver
│ └── LoRaSender
├── Display # Only supports TBeam TFT Shield
@ -102,380 +82,13 @@
└── Factory # T-Beam & T-Beam S3 and BPF factory test examples
```
## 3️⃣Use reference
## `3` Use reference
| Product | Youtube link | explanation | Status |
| :-----------: | :---------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: | :----: |
| T -BEAM | [Youtube link](https://www.youtube.com/watch?v=Xf1Wf-aTSmc) | How do I drive the T-Beam display How to use T-Beam for positioning,How to use T-Beams for communication test | ✅ |
| LilyGo device | [Youtube link](https://www.youtube.com/watch?v=f3BybP3L7ls) | How to enter boot mode to download the firmware | ✅ |
## 4️⃣ PlatformIO Quick Start (Recommended)
1. For users using the ESP32 version (non ESP32S3 version), please install the **CH9102 USB bridge** driver for the first time.
- [Windows](https://www.wch-ic.com/downloads/CH343SER_ZIP.html)
- [Mac OS](https://www.wch-ic.com/downloads/CH34XSER_MAC_ZIP.html)
2. Install [Visual Studio Code](https://code.visualstudio.com/) and [Python](https://www.python.org/)
3. Search for the `PlatformIO` plugin in the `VisualStudioCode` extension and install it.
4. After the installation is complete, you need to restart `VisualStudioCode`
5. After restarting `VisualStudioCode`, select `File` in the upper left corner of `VisualStudioCode` -> `Open Folder` -> select the `LilyGo-LoRa-Series` directory
6. Wait for the installation of third-party dependent libraries to complete
7. Click on the `platformio.ini` file, and in the `platformio` column
8. Select the board name you want to use in `default_envs` and uncomment it.
9. Uncomment one of the lines `src_dir = xxxx` to make sure only one line works , Please note the example comments, indicating what works and what does not.
10. Click the (✔) symbol in the lower left corner to compile
11. Connect the board to the computer USB-C , Micro-USB is used for module firmware upgrade
12. Click (→) to upload firmware
13. Click (plug symbol) to monitor serial output
14. If it cannot be written, or the USB device keeps flashing, please check the **FAQ** below
## 5️⃣ Arduino IDE quick start
1. Install [Arduino IDE](https://www.arduino.cc/en/software)
2. Install [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/)
3. Copy all folders in the `lib` directory to the `Sketchbook location` directory. How to find the location of your own libraries, [please see here](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer)
- Windows: `C:\Users\{username}\Documents\Arduino`
- macOS: `/Users/{username}/Documents/Arduino`
- Linux: `/home/{username}/Arduino`
4. Open the corresponding example
- Open the downloaded `LilyGo-LoRa-Series`
- Open `examples`
- Select the sample file and open the file ending with `ino`
5. On Arduino ISelect the corresponding board in the DE tool project and click on the corresponding option in the list below to select
<details>
<summary>Click to view T-Beam S3 Supreme Arduino IDE options</summary>
| T-Beam S3 Supreme | Value |
| ------------------------------------ | --------------------------------- |
| Board | **ESP32S3 Dev Module** |
| Port | Your port |
| USB CDC On Boot | Enable |
| CPU Frequency | 240MHZ(WiFi) |
| Core Debug Level | None |
| USB DFU On Boot | Disable |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Flash Mode | QIO 80MHZ |
| Flash Size | **8MB(64Mb)** |
| Arduino Runs On | Core1 |
| USB Firmware MSC On Boot | Disable |
| Partition Scheme | **8M Flash(3M APP/1.5MB SPIFFS)** |
| PSRAM | **QSPI PSRAM** |
| Upload Mode | **UART0/Hardware CDC** |
| Upload Speed | 921600 |
| USB Mode | **CDC and JTAG** |
| Programmer | **Esptool** |
</details>
<details>
<summary>Click to view T-Beam-V1.X Arduino IDE options</summary>
| T-Beam-V1.X | Value |
| ------------------------------------ | ------------------------------------ |
| Board | **ESP32 Dev Module** |
| Port | Your port |
| CPU Frequency | 240MHZ(WiFi/BT) |
| Core Debug Level | None |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Flash Frequency | 80MHZ |
| Flash Mode | QIO |
| Flash Size | **4MB(32Mb)** |
| JTAG Adapter | Disabled |
| Arduino Runs On | Core1 |
| Partition Scheme | **Huge APP (3MB No OTA/1MB SPIFFS)** |
| PSRAM | **Enable** |
| Upload Speed | 921600 |
| Programmer | **Esptool** |
</details>
<details>
<summary>Click to view LoRa32 V1.x or T3 TCXO Arduino IDE options</summary>
| LoRa32 V1.x or T3 TCXO | Value |
| ------------------------------------ | ------------------------------------ |
| Board | **ESP32 Dev Module** |
| Port | Your port |
| CPU Frequency | 240MHZ(WiFi/BT) |
| Core Debug Level | None |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Flash Frequency | 80MHZ |
| Flash Mode | QIO |
| Flash Size | **4MB(32Mb)** |
| JTAG Adapter | Disabled |
| Arduino Runs On | Core1 |
| Partition Scheme | **Huge APP (3MB No OTA/1MB SPIFFS)** |
| PSRAM | **Disable** |
| Upload Speed | 921600 |
| Programmer | **Esptool** |
</details>
<details>
<summary>Click to view T3-S3 V.1x (V1.1~V1.3) Arduino IDE options</summary>
| T3-S3 V.1x | Value |
| ------------------------------------ | ------------------------------------ |
| Board | **ESP32S3 Dev Module** |
| Port | Your port |
| USB CDC On Boot | Enable |
| CPU Frequency | 240MHZ(WiFi) |
| Core Debug Level | None |
| USB DFU On Boot | Disable |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Flash Mode | QIO 80MHZ |
| Flash Size | **4MB(32Mb)** |
| Arduino Runs On | Core1 |
| USB Firmware MSC On Boot | Disable |
| Partition Scheme | **Huge APP (3MB No OTA/1MB SPIFFS)** |
| PSRAM | **QSPI PSRAM** |
| Upload Mode | **UART0/Hardware CDC** |
| Upload Speed | 921600 |
| USB Mode | **CDC and JTAG** |
| Programmer | **Esptool** |
</details>
<details>
<summary>Click to view T-Motion Arduino IDE options</summary>
| T-Motion | Value |
| --------------------------- | ---------------------------------------- |
| Board | **Nucleo-64** |
| Port | Your port |
| Debug symbols and core logs | None |
| Optimize | Smallest (-Os default) |
| Board part number | Nucleo L073RZ |
| C Runtime Library | Newlib Nano (default) |
| Upload method | STM32CubeProgrammer (DFU) |
| USB support (if available) | CDC (generic 'Serial' supersede U(S)ART) |
| U(S)ART support | Enabled (generic 'Serial') |
| USB speed (if available) | Low/Full Speed |
- To upload a sketch, you need to hold down the BOOT button on the board and then plug in the USB. At this time, it will enter the DFU mode to allow program writing.
</details>
<details>
<summary>Click to view T3-C6 Arduino IDE options</summary>
| T3-C6 | Value |
| ------------------------------------ | ------------------------------------------------------- |
| Board | **ESP32C6 Dev Module** |
| Port | Your port |
| USB CDC On Boot | Enable |
| CPU Frequency | 160MHZ(WiFi) |
| Core Debug Level | None |
| USB DFU On Boot | Disable |
| Erase All Flash Before Sketch Upload | Disable |
| Flash Mode | DIO |
| Flash Size | **4MB(32Mb)** |
| Arduino Runs On | Core1 |
| USB Firmware MSC On Boot | Disable |
| Partition Scheme | **Default 4M Flash with spiffs(1.2M APP/1.5MB SPIFFS)** |
| Upload Speed | 921600 |
| Programmer | **Esptool** |
</details>
<details>
<summary>Click to view T-Beam PBF or T-Beam 2W Arduino IDE options</summary>
| T-Beam PBF | Value |
| ------------------------------------ | ----------------------------------- |
| Board | **ESP32S3 Dev Module** |
| Port | Your port |
| USB CDC On Boot | Enable |
| CPU Frequency | 240MHZ(WiFi) |
| Core Debug Level | None |
| USB DFU On Boot | Disable |
| Erase All Flash Before Sketch Upload | Disable |
| Flash Mode | QIO 80Mhz |
| Flash Size | **16MB(128Mb)** |
| Arduino Runs On | Core1 |
| USB Firmware MSC On Boot | Disable |
| Partition Scheme | **16M Flash (3MB APP/9.9MB FATFS)** |
| PSRAM | **OPI PSRAM** |
| Upload Speed | 921600 |
| Programmer | **Esptool** |
- T3-S3 SX1280/PA Version QWIIC GPIO10,GPIO21 Unavailable, already used as SX1280 RX TX antenna switching function
</details>
6. Please uncomment the `utilities.h` file of each sketch according to your board model, otherwise the compilation will report an error.
7. Upload sketch
## 6️⃣ TTN
## `4` TTN
To access TTN (The Things Network), please refer to [LilyGo_LoRa_Series_Quick_Start](./docs/zh/LilyGo_LoRa_Series_Quick_Start_On_TTN_zh.md)
## 7️⃣ Application
- [T-Beam SoftRF](https://github.com/lyusupov/SoftRF)
- [T-Beam Paxcounter](https://github.com/cyberman54/ESP32-Paxcounter)
- [T-Beam Meshtastic](https://github.com/meshtastic/Meshtastic-device)
# 8️⃣ Datasheet
##### T-Beam S3 Supreme datasheet
- [T-Beam Supreme schematic](schematic/LilyGo_T-BeamS3Supreme.pdf)
- [AXP2101 datasheet](./lib/XPowersLib/datasheet/AXP2101_Datasheet_V1.0_en.pdf)
- [SX1262 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262)
- [LR1121 datasheet](https://www.semtech.com/products/wireless-rf/lora-connect/lr1121)
- [GSP MAX-M10 datasheet](https://www.u-blox.com/zh/product/max-m10-series)
- [PCF8563 datasheet](./lib/SensorsLib/datasheet/PCF8563%20Datasheet%20Rev.11.pdf)
- [QMI8658 datasheet](./lib/SensorsLib/datasheet/QMI8658A%20Datasheet%20Rev1.0.pdf)
- [QMC6310 datasheet](./lib/SensorsLib/datasheet/QMC6310%20Datasheet%20Rev.C.pdf)
- [BME280 datasheet](https://www.bosch-sensortec.com/products/environmental-sensors/humidity-sensors-bme280/)
- [Quectel_L76K_GNSS_Protocol_Specification_V1.2](./docs/datasheet/Quectel_L76KL26K_GNSS_协议规范_V1.2.pdf)
- [CASIC_ProtocolSpecification](./docs/datasheet/CASIC_ProtocolSpecification.pdf)
##### T-Beam ESP32 datasheet
- [T-Beam_V1.2 schematic](schematic/LilyGo_TBeam_V1.2.pdf)
- [AXP192 datasheet](http://www.x-powers.com/en.php/Info/product_detail/article_id/29)
- [SX1262 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262)
- [GSP NEO-6/NEO-8 datasheet](https://www.u-blox.com/en/product/neo-6-series)
##### T3-S3 (ESP32S3) datasheet
- [T3_S3_V1.2 schematic](schematic/T3_S3_V1.2.pdf)
- [T3_S3_V1.3 schematic](schematic/T3_S3_V1.3.pdf)
- [SX1262 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262)
- [SX1278 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1278)
- [SX1276 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1276)
- [LR1121 datasheet](https://www.semtech.com/products/wireless-rf/lora-connect/lr1121)
- [SX1280 datasheet](https://www.semtech.cn/products/wireless-rf/lora-connect/sx1280)
##### LoRa32(ESP32) datasheet
[T3_V1.6.1 schematic](schematic/T3_V1.6.1.pdf)
##### LoRa32(V1.3) datasheet
[T3_V1.3 schematic](schematic/T3_V1.3.pdf)
##### T-Motion datasheet
[T-Motion schematic](schematic/T-Motion.pdf)
##### T3-C6 datasheet
[T3-C6 schematic](schematic/T3-C6_V1.0.pdf)
##### T3-TCXO datasheet
[T3-TCXO schematic](schematic/T3_V3.0.pdf)
##### T-Beam-2W datasheet
[T-Beam-2W schematic](schematic/T-Beam_2W_V1.0.pdf)
# 9️⃣ FAQ
1. T-Beam Supreme GPS backup power comes from 18650 battery. If you remove the 18650 battery, you will not be able to get GPS hot start. If you need to use GPS hot start, please connect the 18650 battery.
2. There is no data output from the GPS. [Refer to GPS factory reset](firmware/GPS_Reset/README.MD)
3. How to find the pin definition?
<details>
<summary>
Click to view detailed
</summary>
- Each sketch contains <utilities.h>, and all board pins are written in this file
</details>
4. Can’t upload sketches?
<details>
<summary>
Click to view detailed
</summary>
1. Connect the board USB to the computer
2. Press the BOOT button and hold (If there is no BOOT button, you need to keep **GPIO0** connected to **GND**.)
3. Press the RST button
4. Release the RST button
5. Finally release the BOOT button(If there is no BOOT button, you need to disconnect GPIO0 from GND.)
6. Click to upload the program
</details>
5. After setting the output power of LoRa, you need to set the minimum current. Set up sx1262 as follows:
<details>
<summary>
Click to view detailed
</summary>
```c
// set output power to 10 dBm (accepted range is -17 - 22 dBm)
if (radio.setOutputPower(22) == RADIOLIB_ERR_INVALID_OUTPUT_POWER) {
Serial.println(F("Selected output power is invalid for this module!"));
while (true);
}
// set over current protection limit to 80 mA (accepted range is 45 - 240 mA)
// NOTE: set value to 0 to disable overcurrent protection
if (radio.setCurrentLimit(80) == RADIOLIB_ERR_INVALID_CURRENT_LIMIT) {
Serial.println(F("Selected current limit is invalid for this module!"));
while (true);
}
```
</details>
6. Precautions for using SX1280 PA version
<details>
<summary>
Click to view detailed
</summary>
- When using the SX1280 PA module, it is recommended that the software controls the 1280 chip to output 2~5dbm, so that the entire module will output 20dbm power;
When the output of the 1280 chip is higher than 2dbm, the output power of the entire module is only 20dbm;
When the output of the 1280 chip is higher than 5dbm, the output power of the entire module is only 20dbm, but if 5dbm is given to the FEM, it will damage the FEM chip (the maximum input allowed by the FEM is 5dbm)
If the output of the 1280 chip is lower than 2dbm, the output power of the entire module is within 20dbm.
- T3-S3 PA version SX1280 output power setting cannot be greater than 2~5dbm, otherwise the FEM chip may be damaged. Setting 3dbm already has 20dmb output power
</details>
7. How to identify the LoRa model?
<details>
<summary>
Click to view detailed
</summary>
- To identify the LoRa model, you only need to check the sticker on the board. 433MHz is SX1278, 868MHz is SX1276, and if the label says SX1262, it is SX1262.
</details>
8. Why does Serial not have any output?
- Arduino -> Tools -> USB CDC On Boot -> Enable
9. T-Beam-s3-supreme antenna signal quality
<details>
<summary>
Click to view detailed
</summary>
![t-beams3-supreme-ant-868M](./images/t-beams3-supreme-ant-868M.jpg)
![t-beams3-supreme-ant-915M](./images/t-beams3-supreme-ant-915M.jpg)
</details>
10. T3-S3 Qwiic GPIO10, GPIO21 cannot be used?
<details>
<summary>
Click to view detailed
</summary>
- If you are using the SX1280/SX1280PA version, these two GPIOs are already connected to the Radio TX/RX Pin and cannot be used.
- If you are using the SX1262/SX1276 version, you can use GPIO10,21 by removing the two resistors in the figure below. Otherwise, the GPIO is connected to Radio DIO3,DIO4 by default.
![T3-S3-QWIIC](./images/T3-S3-QWIIC.png)
</details>

380
README_CN.MD
View file

@ -1,380 +0,0 @@
<h1 align = "center">🌟LilyGo LoRa Series🌟</h1>
## **[English](./README.MD) | 中文**
## News
- 本仓库目前仅维护在售版本的LilyGo，对于LilyGo停产版本的LoRa板请跳转[Archive package](https://github.com/Xinyuan-LilyGO/LilyGo-LoRa-Series/releases/tag/v0.0.1) 下载
- Arduino IDE 用户使用示例之前需要先在草图目录<utilities.h>文件中配置需要使用的板子，<utilities.h>文件包含板子的引脚定义，如果不进行选择，那么编译将会发生错误
## 1️⃣产品
| Product | SOC | Flash | PSRAM |
| ---------------------------------- | ---------------- | ------------- | -------------- |
| [T-Beam S3 Supreme L76K][1] | ESP32-S3FN8 | 8MB(Quad-SPI) | 8MB(Quad-SPI) |
| [T-Beam S3 Supreme Ublox][2] | ESP32-S3FN8 | 8MB(Quad-SPI) | 8MB(Quad-SPI) |
| [T-Beam Meshtastic][3] | ESP32-D0WDQ6-V3 | 4MB(Quad-SPI) | 8MB(Quad-SPI) |
| [T-Beam SoftRF][4] | ESP32-D0WDQ6-V3 | 4MB(Quad-SPI) | 8MB(Quad-SPI) |
| [T3-S3 SX1280 2.4G With out PA][5] | ESP32-S3FH4R2 | 4MB(Quad-SPI) | 2MB(Quad-SPI) |
| [T3-S3 SX1280 2.4G With PA][6] | ESP32-S3FH4R2 | 4MB(Quad-SPI) | 2MB(Quad-SPI) |
| [T3-S3 SX1276][7] | ESP32-S3FH4R2 | 4MB(Quad-SPI) | 2MB(Quad-SPI) |
| [T3-S3 SX1262][8] | ESP32-S3FH4R2 | 4MB(Quad-SPI) | 2MB(Quad-SPI) |
| [LoRa32][8] | ESP32-PICO-D4 | 4MB(Quad-SPI) | ❌ |
| [T-Motion][9] | STM32L073RZ | 192 Kbyte | (20-Kbyte RAM) |
| [T3-C6][10] | ESP32-C6-MINI-1U | 4MB(Quad-SPI) | ❌ |
[1]: https://www.lilygo.cc/products/softrf-t-beamsupreme?variant=42880905052341 "T-Beam S3 Supreme L76K"
[2]: https://www.lilygo.cc/products/softrf-t-beamsupreme?variant=42880905281717 "T-Beam S3 Supreme Ublox"
[3]: https://www.lilygo.cc/products/t-beam-v1-1-esp32-lora-module "T-Beam Meshtastic"
[4]: https://www.lilygo.cc/products/t-beam-softrf "T-Beam SoftRF"
[5]: https://www.lilygo.cc/products/t3s3-v1-0?variant=42586879656117 "T3-S3 SX1280 2.4G With out PA"
[6]: https://www.lilygo.cc/products/t3s3-v1-0?variant=43043715678389 "T3-S3 SX1280 2.4G With PA"
[7]: https://www.lilygo.cc/products/t3s3-v1-0?variant=42586879688885 "T3-S3 SX1276"
[8]: https://www.lilygo.cc/products/t3s3-v1-0?variant=42586879721653 "T3-S3 SX1262"
[9]: https://www.lilygo.cc/products/t-motion-s76g-stm32-lora "T-Motion"
[10]: https://www.lilygo.cc/products "T3-C6"
## 2️⃣示例描述
```
./examples/
├── ArduinoLoRa # Only support SX1276/SX1278 radio module
│ ├── LoRaReceiver
│ └── LoRaSender
├── Display # Only supports TBeam TFT Shield
│ ├── Free_Font_Demo
│ ├── TBeam_TFT_Shield
│ ├── TFT_Char_times
│ └── UTFT_demo
├── GPS # T-Beam GPS demo examples
│ ├── TinyGPS_Example
│ ├── TinyGPS_FullExample
│ ├── TinyGPS_KitchenSink
│ ├── UBlox_BasicNMEARead # Only support Ublox GNSS Module
│ ├── UBlox_NMEAParsing # Only support Ublox GNSS Module
│ ├── UBlox_OutputRate # Only support Ublox GNSS Module
│ └── UBlox_Recovery # Only support Ublox GNSS Module
├── LoRaWAN # LoRaWAN examples
│ ├── LMIC_Library_OTTA
│ └── RadioLib_OTAA
├── OLED
│ ├── SH1106FontUsage
│ ├── SH1106GraphicsTest
│ ├── SH1106IconMenu
│ ├── SH1106PrintUTF8
│ ├── SSD1306SimpleDemo
│ └── SSD1306UiDemo
├── PMU # T-Beam & T-Beam S3 PMU demo examples
├── RadioLibExamples # RadioLib examples,Support SX1276/78/62/80...
│ ├── Receive_Interrupt
│ └── Transmit_Interrupt
├── Sensor # Sensor examples,only support t-beams3-supreme
│ ├── BME280_AdvancedsettingsExample
│ ├── BME280_TestExample
│ ├── BME280_UnifiedExample
│ ├── PCF8563_AlarmByUnits
│ ├── PCF8563_SimpleTime
│ ├── PCF8563_TimeLib
│ ├── PCF8563_TimeSynchronization
│ ├── QMC6310_CalibrateExample
│ ├── QMC6310_CompassExample
│ ├── QMC6310_GetDataExample
│ ├── QMC6310_GetPolarExample
│ ├── QMI8658_BlockExample
│ ├── QMI8658_GetDataExample
│ ├── QMI8658_InterruptBlockExample
│ ├── QMI8658_InterruptExample
│ ├── QMI8658_LockingMechanismExample
│ ├── QMI8658_MadgwickAHRS
│ ├── QMI8658_PedometerExample
│ ├── QMI8658_ReadFromFifoExample
│ └── QMI8658_WakeOnMotion
└── T3S3Factory # T3 S3 factory test examples
```
## 3️⃣Arduino IDE 快速开始:
1. 安装 [Arduino IDE](https://www.arduino.cc/en/software)
2. 安装 [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/)
3. 将 `lib` 目录中所有文件夹复制到`Sketchbook location`目录,如何找到自己的libraries 位置,[请看这里](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer)
- Windows: `C:\Users\{username}\Documents\Arduino`
- macOS: `/Users/{username}/Documents/Arduino`
- Linux: `/home/{username}/Arduino`
4. 打开对应的示例
- 打开下载的`LilyGo-LoRa-Series`
- 打开`examples`
- 选择示例文件,打开`ino`结尾的文件
5. 在Arduino IDE 工具项目中选择相应的板子,点击下面列表中对应的选项进行选择
<details>
<summary>点击查看 T-Beam S3 Supreme Arduino IDE 选项</summary>
| T-Beam S3 Supreme | Value |
| ------------------------------------ | --------------------------------- |
| Board | **ESP32S3 Dev Module** |
| Port | Your port |
| USB CDC On Boot | Enable |
| CPU Frequency | 240MHZ(WiFi) |
| Core Debug Level | None |
| USB DFU On Boot | Disable |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Flash Mode | QIO 80MHZ |
| Flash Size | **8MB(64Mb)** |
| Arduino Runs On | Core1 |
| USB Firmware MSC On Boot | Disable |
| Partition Scheme | **8M Flash(3M APP/1.5MB SPIFFS)** |
| PSRAM | **QSPI PSRAM** |
| Upload Mode | **UART0/Hardware CDC** |
| Upload Speed | 921600 |
| USB Mode | **CDC and JTAG** |
| Programmer | **Esptool** |
</details>
<details>
<summary>点击查看 T-Beam-V1.X Arduino IDE 选项</summary>
| T-Beam-V1.X | Value |
| ------------------------------------ | ------------------------------------------------------- |
| Board | **ESP32 Dev Module** |
| Port | Your port |
| CPU Frequency | 240MHZ(WiFi/BT) |
| Core Debug Level | None |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Flash Frequency | 80MHZ |
| Flash Mode | QIO |
| Flash Size | **4MB(32Mb)** |
| JTAG Adapter | Disabled |
| Arduino Runs On | Core1 |
| Partition Scheme | **Default 4M Flash with spiffs(1.2M APP/1.5MB SPIFFS)** |
| PSRAM | **Enable** |
| Upload Speed | 921600 |
| Programmer | **Esptool** |
</details>
<details>
<summary>点击查看 LoRa32 V1.x Arduino IDE 选项</summary>
| T-Beam-V1.X | Value |
| ------------------------------------ | ------------------------------------------------------- |
| Board | **ESP32 Dev Module** |
| Port | Your port |
| CPU Frequency | 240MHZ(WiFi/BT) |
| Core Debug Level | None |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Flash Frequency | 80MHZ |
| Flash Mode | QIO |
| Flash Size | **4MB(32Mb)** |
| JTAG Adapter | Disabled |
| Arduino Runs On | Core1 |
| Partition Scheme | **Default 4M Flash with spiffs(1.2M APP/1.5MB SPIFFS)** |
| PSRAM | **Disable** |
| Upload Speed | 921600 |
| Programmer | **Esptool** |
</details>
<details>
<summary>点击查看 T3-S3 Arduino IDE 选项</summary>
| T3-S3 | Value |
| ------------------------------------ | ------------------------------------------------------- |
| Board | **ESP32S3 Dev Module** |
| Port | Your port |
| USB CDC On Boot | Enable |
| CPU Frequency | 240MHZ(WiFi) |
| Core Debug Level | None |
| USB DFU On Boot | Disable |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Flash Mode | QIO 80MHZ |
| Flash Size | **4MB(32Mb)** |
| Arduino Runs On | Core1 |
| USB Firmware MSC On Boot | Disable |
| Partition Scheme | **Default 4M Flash with spiffs(1.2M APP/1.5MB SPIFFS)** |
| PSRAM | **QSPI PSRAM** |
| Upload Mode | **UART0/Hardware CDC** |
| Upload Speed | 921600 |
| USB Mode | **CDC and JTAG** |
| Programmer | **Esptool** |
</details>
<details>
<summary>点击查看 T-Motion Arduino IDE 选项</summary>
| T-Motion | Value |
| --------------------------- | ---------------------------------------- |
| Board | **Nucleo-64** |
| Port | Your port |
| Debug symbols and core logs | None |
| Optimize | Smallest (-Os default) |
| Board part number | Nucleo L073RZ |
| C Runtime Library | Newlib Nano (default) |
| Upload method | STM32CubeProgrammer (DFU) |
| USB support (if available) | CDC (generic 'Serial' supersede U(S)ART) |
| U(S)ART support | Enabled (generic 'Serial') |
| USB speed (if available) | Low/Full Speed |
- 需要上传草图,需要按住板子BOOT按键，然后插入USB，此时将进入DFU模式,才允许程序写入
</details>
4. 请在每个草图的 `utilities.h` 文件的上方根据你的板子型号取消注释,否则编译将报错误
5. 上传草图
## 4️⃣ TTN
接入TTN(The Things Network)使用请参考 [LilyGo_LoRa_Series_Quick_Start](./docs/zh/LilyGo_LoRa_Series_Quick_Start_On_TTN_zh.md)
## 5️⃣ 应用
- [T-Beam SoftRF](https://github.com/lyusupov/SoftRF)
- [T-Beam Paxcounter](https://github.com/cyberman54/ESP32-Paxcounter)
- [T-Beam Meshtastic](https://github.com/meshtastic/Meshtastic-device)
# 6️⃣ 数据手册
##### T-Beam S3 Supreme datasheet
- [T-Beam Supreme schematic](schematic/LilyGo_T-BeamS3Supreme.pdf)
- [AXP2101 datasheet](./lib/XPowersLib/datasheet/AXP2101_Datasheet_V1.0_en.pdf)
- [SX1262 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262)
- [GSP MAX-M10 datasheet](https://www.u-blox.com/zh/product/max-m10-series)
- [PCF8563 datasheet](./lib/SensorsLib/datasheet/PCF8563%20Datasheet%20Rev.11.pdf)
- [QMI8658 datasheet](./lib/SensorsLib/datasheet/QMI8658A%20Datasheet%20Rev1.0.pdf)
- [QMC6310 datasheet](./lib/SensorsLib/datasheet/QMC6310%20Datasheet%20Rev.C.pdf)
- [BME280 datasheet](https://www.bosch-sensortec.com/products/environmental-sensors/humidity-sensors-bme280/)
##### T-Beam ESP32 datasheet
- [T-Beam_V1.2 schematic](schematic/LilyGo_TBeam_V1.2.pdf)
- [T-Beam_V1.1 schematic](schematic/LilyGo_TBeam_V1.1.pdf)
- [T-Beam_V1.0 schematic](schematic/LilyGo_TBeam_V1.0.pdf)
- [T-Beam_V0.7 schematic](schematic/LilyGo_TBeam_V0.7.pdf)
- [AXP192 datasheet](http://www.x-powers.com/en.php/Info/product_detail/article_id/29)
- [SX1262 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262)
- [GSP NEO-6/NEO-8 datasheet](https://www.u-blox.com/en/product/neo-6-series)
##### T3-S3 (ESP32S3) datasheet
- [T3_S3_V1.2 schematic](schematic/T3_S3_V1.2.pdf)
- [T3_S3_V1.1 schematic](schematic/T3_S3_V1.1.pdf)
- [T3_S3_V1.1 schematic](schematic/T3_S3_V1.0.pdf)
- [SX1262 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262)
- [SX1278 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1278)
- [SX1276 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1276)
- [SX1280 datasheet](https://www.semtech.cn/products/wireless-rf/lora-connect/sx1280)
##### LoRa32(ESP32) datasheet
[T3_V1.6.1 schematic](schematic/T3_V1.6.1.pdf)
##### LoRa32(V1.0) datasheet
N.A
##### T-Motion datasheet
[T-Motion schematic](schematic/T-Motion.pdf)
# 7️⃣ 常见问题
1. T-Beam Supreme GPS备用电源来自于18650电池，如果移除18650电池将无法获得GPS热启动，如果需要使用GPS热启动，请连接18650电池
2. GPS没有数据输出，[参考GPS恢复出厂](firmware/NMEA_Reset/README.MD)
3. 如何找到引脚定义?
<details>
<summary>
Click to view detailed steps
</summary>
- Each sketch contains <utilities.h>, and all board pins are written in this file
</details>
4. 不能上传草图?
<details>
<summary>
Click to view detailed steps
</summary>
1. 连接板子USB到电脑
2. 按压BOOT按键，并且保持按压(如果没有BOOT按键,需要将GPIO0与GND连接)
3. 按压 RST 按键
4. 放开 RST 按键
5. 最后松开BOOT按键(如果没有BOOT按键,需要将GPIO0与GND断开连接)
6. 点击上传程序
</details>
5. LoRa设置输出功率后需要设置最低电流。设置sx1262如下 :
<details>
<summary>
Click to view detailed steps
</summary>
```c
// set output power to 10 dBm (accepted range is -17 - 22 dBm)
if (radio.setOutputPower(22) == RADIOLIB_ERR_INVALID_OUTPUT_POWER) {
Serial.println(F("Selected output power is invalid for this module!"));
while (true);
}
// set over current protection limit to 80 mA (accepted range is 45 - 240 mA)
// NOTE: set value to 0 to disable overcurrent protection
if (radio.setCurrentLimit(80) == RADIOLIB_ERR_INVALID_CURRENT_LIMIT) {
Serial.println(F("Selected current limit is invalid for this module!"));
while (true);
}
```
</details>
6. SX1280 PA版本使用注意事项
<details>
<summary>
Click to view detailed steps
</summary>
- 在使用SX1280 PA模块时，建议软件控制1280芯片输出2~5dbm，这样整个模组会输出20dbm的功率；
当1280芯片输出高于2dbm时，整个模组输出功率也只有20dbm；
当1280芯片输出高于5dbm时，整个模组输出功率也只有20dbm，但5dbm给到FEM，会损坏FEM芯片（FEM允许最大输入是5dbm）
如果1280芯片输出低于2dbm，整个模组输出功率20dbm以内。
- T3-S3 PA版本 SX1280 输出功率设置不能大于2~5dbm，否则可能导致FEM芯片损坏。设置3dbm就已经有20dmb的输出功率
</details>
7. 如何分辨LoRa型号?
<details>
<summary>
Click to view detailed steps
</summary>
- 分辨LoRa的型号只需要查看板子上的贴纸,433MHz则是SX1278，868MHz则是SX1276，如果标签写的是SX1262则是SX1262
</details>
8. 为什么Serial没有任何输出?
- Arduino -> Tools -> USB CDC On Boot -> Enable
9. T-Beam-s3-supreme 天线信号质量
<details>
<summary>
Click to view detailed
</summary>
![t-beams3-supreme-ant-868M](./images/t-beams3-supreme-ant-868M.jpg)
![t-beams3-supreme-ant-915M](./images/t-beams3-supreme-ant-915M.jpg)
</details>

53
docs/en/t3_c6_sx1262/t3_c6_sx1262_hw.md
View file

@ -12,15 +12,64 @@
1. Please be sure to connect the antenna before transmitting, otherwise it is easy to damage the RF module
### Product
| Product | SOC | Flash |
| --------------- | ---------------- | ------------- |
| -------------- | ---------------- | ------------- |
| [T-Lora C6][1] | ESP32-C6-MINI-1U | 4MB(Quad-SPI) |
[1]: https://www.lilygo.cc/products/t-lora-c6 "T-Lora C6"
### PlatformIO Quick Start
1. Install [Visual Studio Code](https://code.visualstudio.com/) and [Python](https://www.python.org/)
2. Search for the `PlatformIO` plugin in the `Visual Studio Code` extension and install it.
3. After the installation is complete, you need to restart `Visual Studio Code`
4. After restarting `Visual Studio Code`, select `File` in the upper left corner of `Visual Studio Code` -> `Open Folder` -> select the `LilyGo-LoRa-Series` directory
5. Wait for the installation of third-party dependent libraries to complete
6. Click on the `platformio.ini` file, and in the `platformio` column
7. Select the board name you want to use in `default_envs` and uncomment it.
8. Uncomment one of the lines `src_dir = xxxx` to make sure only one line works , Please note the example comments, indicating what works and what does not.
9. Click the (✔) symbol in the lower left corner to compile
10. Connect the board to the computer USB-C , Micro-USB is used for module firmware upgrade
11. Click (→) to upload firmware
12. Click (plug symbol) to monitor serial output
13. If it cannot be written, or the USB device keeps flashing, please check the **FAQ** below
### Arduino IDE quick start
1. Install [Arduino IDE](https://www.arduino.cc/en/software)
2. Install [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/)
3. Copy all folders in the `lib` directory to the `Sketchbook location` directory. How to find the location of your own libraries, [please see here](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer)
* Windows: `C:\Users\{username}\Documents\Arduino`
* macOS: `/Users/{username}/Documents/Arduino`
* Linux: `/home/{username}/Arduino`
4. Open the corresponding example
* Open the downloaded `LilyGo-LoRa-Series`
* Open `examples`
* Select the sample file and open the file ending with `ino`
5. On Arduino ISelect the corresponding board in the DE tool project and click on the corresponding option in the list below to select
| T3-C6 | Value |
| ------------------------------------ | ------------------------------------------------------- |
| Board | **ESP32C6 Dev Module** |
| Port | Your port |
| USB CDC On Boot | Enable |
| CPU Frequency | 160MHZ(WiFi) |
| Core Debug Level | None |
| USB DFU On Boot | Disable |
| Erase All Flash Before Sketch Upload | Disable |
| Flash Mode | DIO |
| Flash Size | **4MB(32Mb)** |
| Arduino Runs On | Core1 |
| USB Firmware MSC On Boot | Disable |
| Partition Scheme | **Default 4M Flash with spiffs(1.2M APP/1.5MB SPIFFS)** |
| Upload Speed | 921600 |
| Programmer | **Esptool** |
6. Please uncomment the `utilities.h` file of each sketch according to your board model ,e.g `T3_C6` , otherwise the compilation will report an error.
7. Upload sketch
### 📍 Pins Map
| Name | GPIO NUM | Free |

58
docs/en/t3_s3_sx1262/t3_s3_sx1262_hw.md
View file

@ -21,6 +21,60 @@
[1]: https://www.lilygo.cc/products/t3s3-v1-0?variant=42586879688885 "T3-S3"
## PlatformIO Quick Start
1. Install [Visual Studio Code](https://code.visualstudio.com/) and [Python](https://www.python.org/)
2. Search for the `PlatformIO` plugin in the `Visual Studio Code` extension and install it.
3. After the installation is complete, you need to restart `Visual Studio Code`
4. After restarting `Visual Studio Code`, select `File` in the upper left corner of `Visual Studio Code` -> `Open Folder` -> select the `LilyGo-LoRa-Series` directory
5. Wait for the installation of third-party dependent libraries to complete
6. Click on the `platformio.ini` file, and in the `platformio` column
7. Select the board name you want to use in `default_envs` and uncomment it.
8. Uncomment one of the lines `src_dir = xxxx` to make sure only one line works , Please note the example comments, indicating what works and what does not.
9. Click the (✔) symbol in the lower left corner to compile
10. Connect the board to the computer USB-C , Micro-USB is used for module firmware upgrade
11. Click (→) to upload firmware
12. Click (plug symbol) to monitor serial output
13. If it cannot be written, or the USB device keeps flashing, please check the **FAQ** below
## Arduino IDE quick start
1. Install [Arduino IDE](https://www.arduino.cc/en/software)
2. Install [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/)
3. Copy all folders in the `lib` directory to the `Sketchbook location` directory. How to find the location of your own libraries, [please see here](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer)
* Windows: `C:\Users\{username}\Documents\Arduino`
* macOS: `/Users/{username}/Documents/Arduino`
* Linux: `/home/{username}/Arduino`
4. Open the corresponding example
* Open the downloaded `LilyGo-LoRa-Series`
* Open `examples`
* Select the sample file and open the file ending with `ino`
5. On Arduino ISelect the corresponding board in the DE tool project and click on the corresponding option in the list below to select
| Name | Value |
| ------------------------------------ | ---------------------------------------------------- |
| Board | **LilyGo T3-S3** |
| Port | Your port |
| USB CDC On Boot | Enable |
| CPU Frequency | 240MHZ(WiFi) |
| Core Debug Level | None |
| USB DFU On Boot | Disable |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Arduino Runs On | Core1 |
| USB Firmware MSC On Boot | Disable |
| Partition Scheme | **Default 4MB with spiffs (1.2MB APP/1.5MB SPIFFS)** |
| PSRAM | **QSPI PSRAM** |
| **Board Revision*** | **Radio-SX1262** |
| Upload Mode | **UART0/Hardware CDC** |
| Upload Speed | 921600 |
| USB Mode | **CDC and JTAG** |
| Programmer | **Esptool** |
* **Board revision Select according to actual model**
6. Upload sketch
### 📍 Pins Map
| Name | GPIO NUM | Free |
@ -107,3 +161,7 @@
* [T3_S3_V1.2 schematic](../../../schematic/T3_S3_V1.2.pdf)
* [T3_S3_V1.3 schematic](../../../schematic/T3_S3_V1.3.pdf)
* [SX1262 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262)
### Application
* [T-Beam Meshtastic](https://github.com/meshtastic/Meshtastic-device)

57
docs/en/t3_s3_sx1280/t3_s3_sx1280_hw.md
View file

@ -21,6 +21,60 @@
[1]: https://www.lilygo.cc/products/t3s3-v1-0?variant=42586879688885 "T3-S3"
## PlatformIO Quick Start
1. Install [Visual Studio Code](https://code.visualstudio.com/) and [Python](https://www.python.org/)
2. Search for the `PlatformIO` plugin in the `Visual Studio Code` extension and install it.
3. After the installation is complete, you need to restart `Visual Studio Code`
4. After restarting `Visual Studio Code`, select `File` in the upper left corner of `Visual Studio Code` -> `Open Folder` -> select the `LilyGo-LoRa-Series` directory
5. Wait for the installation of third-party dependent libraries to complete
6. Click on the `platformio.ini` file, and in the `platformio` column
7. Select the board name you want to use in `default_envs` and uncomment it.
8. Uncomment one of the lines `src_dir = xxxx` to make sure only one line works , Please note the example comments, indicating what works and what does not.
9. Click the (✔) symbol in the lower left corner to compile
10. Connect the board to the computer USB-C , Micro-USB is used for module firmware upgrade
11. Click (→) to upload firmware
12. Click (plug symbol) to monitor serial output
13. If it cannot be written, or the USB device keeps flashing, please check the **FAQ** below
## Arduino IDE quick start
1. Install [Arduino IDE](https://www.arduino.cc/en/software)
2. Install [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/)
3. Copy all folders in the `lib` directory to the `Sketchbook location` directory. How to find the location of your own libraries, [please see here](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer)
* Windows: `C:\Users\{username}\Documents\Arduino`
* macOS: `/Users/{username}/Documents/Arduino`
* Linux: `/home/{username}/Arduino`
4. Open the corresponding example
* Open the downloaded `LilyGo-LoRa-Series`
* Open `examples`
* Select the sample file and open the file ending with `ino`
5. On Arduino ISelect the corresponding board in the DE tool project and click on the corresponding option in the list below to select
| Name | Value |
| ------------------------------------ | ---------------------------------------------------- |
| Board | **LilyGo T3-S3** |
| Port | Your port |
| USB CDC On Boot | Enable |
| CPU Frequency | 240MHZ(WiFi) |
| Core Debug Level | None |
| USB DFU On Boot | Disable |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Arduino Runs On | Core1 |
| USB Firmware MSC On Boot | Disable |
| Partition Scheme | **Default 4MB with spiffs (1.2MB APP/1.5MB SPIFFS)** |
| PSRAM | **QSPI PSRAM** |
| **Board Revision*** | **Radio-SX1280** |
| Upload Mode | **UART0/Hardware CDC** |
| Upload Speed | 921600 |
| USB Mode | **CDC and JTAG** |
| Programmer | **Esptool** |
* **Board revision Select according to actual model**
6. Upload sketch
### 📍 Pins Map
| Name | GPIO NUM | Free |
@ -101,3 +155,6 @@
* [T3_S3_V1.3 schematic](../../../schematic/T3_S3_V1.3.pdf)
* [SX1280 datasheet](https://www.semtech.cn/products/wireless-rf/lora-connect/sx1280)
### Application
* [T-Beam Meshtastic](https://github.com/meshtastic/Meshtastic-device)

54
docs/en/t3_s3_sx1280pa/t3_s3_sx1280pa.md
View file

@ -21,6 +21,60 @@
[1]: https://www.lilygo.cc/products/t3s3-v1-0?variant=42586879688885 "T3-S3"
## PlatformIO Quick Start
1. Install [Visual Studio Code](https://code.visualstudio.com/) and [Python](https://www.python.org/)
2. Search for the `PlatformIO` plugin in the `Visual Studio Code` extension and install it.
3. After the installation is complete, you need to restart `Visual Studio Code`
4. After restarting `Visual Studio Code`, select `File` in the upper left corner of `Visual Studio Code` -> `Open Folder` -> select the `LilyGo-LoRa-Series` directory
5. Wait for the installation of third-party dependent libraries to complete
6. Click on the `platformio.ini` file, and in the `platformio` column
7. Select the board name you want to use in `default_envs` and uncomment it.
8. Uncomment one of the lines `src_dir = xxxx` to make sure only one line works , Please note the example comments, indicating what works and what does not.
9. Click the (✔) symbol in the lower left corner to compile
10. Connect the board to the computer USB-C , Micro-USB is used for module firmware upgrade
11. Click (→) to upload firmware
12. Click (plug symbol) to monitor serial output
13. If it cannot be written, or the USB device keeps flashing, please check the **FAQ** below
## Arduino IDE quick start
1. Install [Arduino IDE](https://www.arduino.cc/en/software)
2. Install [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/)
3. Copy all folders in the `lib` directory to the `Sketchbook location` directory. How to find the location of your own libraries, [please see here](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer)
* Windows: `C:\Users\{username}\Documents\Arduino`
* macOS: `/Users/{username}/Documents/Arduino`
* Linux: `/home/{username}/Arduino`
4. Open the corresponding example
* Open the downloaded `LilyGo-LoRa-Series`
* Open `examples`
* Select the sample file and open the file ending with `ino`
5. On Arduino ISelect the corresponding board in the DE tool project and click on the corresponding option in the list below to select
| Name | Value |
| ------------------------------------ | ---------------------------------------------------- |
| Board | **LilyGo T3-S3** |
| Port | Your port |
| USB CDC On Boot | Enable |
| CPU Frequency | 240MHZ(WiFi) |
| Core Debug Level | None |
| USB DFU On Boot | Disable |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Arduino Runs On | Core1 |
| USB Firmware MSC On Boot | Disable |
| Partition Scheme | **Default 4MB with spiffs (1.2MB APP/1.5MB SPIFFS)** |
| PSRAM | **QSPI PSRAM** |
| **Board Revision*** | **Radio-SX1280PA** |
| Upload Mode | **UART0/Hardware CDC** |
| Upload Speed | 921600 |
| USB Mode | **CDC and JTAG** |
| Programmer | **Esptool** |
* **Board revision Select according to actual model**
6. Upload sketch
### 📍 Pins Map
| Name | GPIO NUM | Free |

57
docs/en/t3_tcxo_sx1276/t3_tcxo_sx1276_hw.md
View file

@ -21,6 +21,63 @@
[1]: https://lilygo.cc/products/t3-tcxo "T-3 TCXO"
### PlatformIO Quick Start
1. Install the **CH9102 USB bridge** driver for the first time.
* [Windows](https://www.wch-ic.com/downloads/CH343SER_ZIP.html)
* [Mac OS](https://www.wch-ic.com/downloads/CH34XSER_MAC_ZIP.html)
2. Install [Visual Studio Code](https://code.visualstudio.com/) and [Python](https://www.python.org/)
3. Search for the `PlatformIO` plugin in the `Visual Studio Code` extension and install it.
4. After the installation is complete, you need to restart `Visual Studio Code`
5. After restarting `Visual Studio Code`, select `File` in the upper left corner of `Visual Studio Code` -> `Open Folder` -> select the `LilyGo-LoRa-Series` directory
6. Wait for the installation of third-party dependent libraries to complete
7. Click on the `platformio.ini` file, and in the `platformio` column
8. Select the board name you want to use in `default_envs` and uncomment it.
9. Uncomment one of the lines `src_dir = xxxx` to make sure only one line works , Please note the example comments, indicating what works and what does not.
10. Click the (✔) symbol in the lower left corner to compile
11. Connect the board to the computer USB-C , Micro-USB is used for module firmware upgrade
12. Click (→) to upload firmware
13. Click (plug symbol) to monitor serial output
14. If it cannot be written, or the USB device keeps flashing, please check the **FAQ** below
### Arduino IDE quick start
1. Install the **CH9102 USB bridge** driver for the first time.
* [Windows](https://www.wch-ic.com/downloads/CH343SER_ZIP.html)
* [Mac OS](https://www.wch-ic.com/downloads/CH34XSER_MAC_ZIP.html)
2. Install [Arduino IDE](https://www.arduino.cc/en/software)
3. Install [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/)
4. Copy all folders in the `lib` directory to the `Sketchbook location` directory. How to find the location of your own libraries, [please see here](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer)
* Windows: `C:\Users\{username}\Documents\Arduino`
* macOS: `/Users/{username}/Documents/Arduino`
* Linux: `/home/{username}/Arduino`
5. Open the corresponding example
* Open the downloaded `LilyGo-LoRa-Series`
* Open `examples`
* Select the sample file and open the file ending with `ino`
6. On Arduino ISelect the corresponding board in the DE tool project and click on the corresponding option in the list below to select
| Name | Value |
| ------------------------------------ | ------------------------------------ |
| Board | **ESP32 Dev Module** |
| Port | Your port |
| CPU Frequency | 240MHZ(WiFi/BT) |
| Core Debug Level | None |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Flash Frequency | 80MHZ |
| Flash Mode | QIO |
| Flash Size | **4MB(32Mb)** |
| JTAG Adapter | Disabled |
| Arduino Runs On | Core1 |
| Partition Scheme | **Huge APP (3MB No OTA/1MB SPIFFS)** |
| PSRAM | **Enable** |
| Upload Speed | 921600 |
| Programmer | **Esptool** |
6. Please uncomment the `utilities.h` file of each sketch according to your board model ,e.g `T3_V3_0_SX1276_TCXO`, otherwise the compilation will report an error.
7. Upload sketch
### 📍 Pins Map
| Name | GPIO NUM | Free |

57
docs/en/t3_v13_sx1276/t3_v13_sx1276.md
View file

@ -21,6 +21,63 @@
[1]: https://www.lilygo.cc/products/lora-v1-3 "LoRa V1.3"
### PlatformIO Quick Start
1. Install the **CH9102 USB bridge** driver for the first time.
* [Windows](https://www.wch-ic.com/downloads/CH343SER_ZIP.html)
* [Mac OS](https://www.wch-ic.com/downloads/CH34XSER_MAC_ZIP.html)
2. Install [Visual Studio Code](https://code.visualstudio.com/) and [Python](https://www.python.org/)
3. Search for the `PlatformIO` plugin in the `Visual Studio Code` extension and install it.
4. After the installation is complete, you need to restart `Visual Studio Code`
5. After restarting `Visual Studio Code`, select `File` in the upper left corner of `Visual Studio Code` -> `Open Folder` -> select the `LilyGo-LoRa-Series` directory
6. Wait for the installation of third-party dependent libraries to complete
7. Click on the `platformio.ini` file, and in the `platformio` column
8. Select the board name you want to use in `default_envs` and uncomment it.
9. Uncomment one of the lines `src_dir = xxxx` to make sure only one line works , Please note the example comments, indicating what works and what does not.
10. Click the (✔) symbol in the lower left corner to compile
11. Connect the board to the computer USB-C , Micro-USB is used for module firmware upgrade
12. Click (→) to upload firmware
13. Click (plug symbol) to monitor serial output
14. If it cannot be written, or the USB device keeps flashing, please check the **FAQ** below
### Arduino IDE quick start
1. Install the **CH9102 USB bridge** driver for the first time.
* [Windows](https://www.wch-ic.com/downloads/CH343SER_ZIP.html)
* [Mac OS](https://www.wch-ic.com/downloads/CH34XSER_MAC_ZIP.html)
2. Install [Arduino IDE](https://www.arduino.cc/en/software)
3. Install [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/)
4. Copy all folders in the `lib` directory to the `Sketchbook location` directory. How to find the location of your own libraries, [please see here](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer)
* Windows: `C:\Users\{username}\Documents\Arduino`
* macOS: `/Users/{username}/Documents/Arduino`
* Linux: `/home/{username}/Arduino`
5. Open the corresponding example
* Open the downloaded `LilyGo-LoRa-Series`
* Open `examples`
* Select the sample file and open the file ending with `ino`
6. On Arduino ISelect the corresponding board in the DE tool project and click on the corresponding option in the list below to select
| Name | Value |
| ------------------------------------ | ------------------------------------ |
| Board | **ESP32 Dev Module** |
| Port | Your port |
| CPU Frequency | 240MHZ(WiFi/BT) |
| Core Debug Level | None |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Flash Frequency | 80MHZ |
| Flash Mode | QIO |
| Flash Size | **4MB(32Mb)** |
| JTAG Adapter | Disabled |
| Arduino Runs On | Core1 |
| Partition Scheme | **Huge APP (3MB No OTA/1MB SPIFFS)** |
| PSRAM | **Enable** |
| Upload Speed | 921600 |
| Programmer | **Esptool** |
6. Please uncomment the `utilities.h` file of each sketch according to your board model ,e.g `T3_V1_3_SX1276` or `T3_V1_3_SX1278`, otherwise the compilation will report an error.
7. Upload sketch
### 📍 Pins Map
| Name | GPIO NUM | Free |

62
docs/en/t3_v161_sx1276/t3_v161_sx1276_hw.md
View file

@ -21,6 +21,63 @@
[1]: https://lilygo.cc/products/lora3 "LoRa32 V1.6.1"
### PlatformIO Quick Start
1. Install the **CH9102 USB bridge** driver for the first time.
* [Windows](https://www.wch-ic.com/downloads/CH343SER_ZIP.html)
* [Mac OS](https://www.wch-ic.com/downloads/CH34XSER_MAC_ZIP.html)
2. Install [Visual Studio Code](https://code.visualstudio.com/) and [Python](https://www.python.org/)
3. Search for the `PlatformIO` plugin in the `Visual Studio Code` extension and install it.
4. After the installation is complete, you need to restart `Visual Studio Code`
5. After restarting `Visual Studio Code`, select `File` in the upper left corner of `Visual Studio Code` -> `Open Folder` -> select the `LilyGo-LoRa-Series` directory
6. Wait for the installation of third-party dependent libraries to complete
7. Click on the `platformio.ini` file, and in the `platformio` column
8. Select the board name you want to use in `default_envs` and uncomment it.
9. Uncomment one of the lines `src_dir = xxxx` to make sure only one line works , Please note the example comments, indicating what works and what does not.
10. Click the (✔) symbol in the lower left corner to compile
11. Connect the board to the computer USB-C , Micro-USB is used for module firmware upgrade
12. Click (→) to upload firmware
13. Click (plug symbol) to monitor serial output
14. If it cannot be written, or the USB device keeps flashing, please check the **FAQ** below
### Arduino IDE quick start
1. Install the **CH9102 USB bridge** driver for the first time.
* [Windows](https://www.wch-ic.com/downloads/CH343SER_ZIP.html)
* [Mac OS](https://www.wch-ic.com/downloads/CH34XSER_MAC_ZIP.html)
2. Install [Arduino IDE](https://www.arduino.cc/en/software)
3. Install [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/)
4. Copy all folders in the `lib` directory to the `Sketchbook location` directory. How to find the location of your own libraries, [please see here](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer)
* Windows: `C:\Users\{username}\Documents\Arduino`
* macOS: `/Users/{username}/Documents/Arduino`
* Linux: `/home/{username}/Arduino`
5. Open the corresponding example
* Open the downloaded `LilyGo-LoRa-Series`
* Open `examples`
* Select the sample file and open the file ending with `ino`
6. On Arduino ISelect the corresponding board in the DE tool project and click on the corresponding option in the list below to select
| Name | Value |
| ------------------------------------ | ------------------------------------ |
| Board | **ESP32 Dev Module** |
| Port | Your port |
| CPU Frequency | 240MHZ(WiFi/BT) |
| Core Debug Level | None |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Flash Frequency | 80MHZ |
| Flash Mode | QIO |
| Flash Size | **4MB(32Mb)** |
| JTAG Adapter | Disabled |
| Arduino Runs On | Core1 |
| Partition Scheme | **Huge APP (3MB No OTA/1MB SPIFFS)** |
| PSRAM | **Enable** |
| Upload Speed | 921600 |
| Programmer | **Esptool** |
6. Please uncomment the `utilities.h` file of each sketch according to your board model ,e.g `T3_V1_6_SX1276` or `T3_V1_6_SX1278`, otherwise the compilation will report an error.
7. Upload sketch
### 📍 Pins Map
| Name | GPIO NUM | Free |
@ -94,3 +151,8 @@
* [T3_V1.6.1 schematic](../../../schematic/T3_V1.6.1.pdf)
* [SX1276 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1276)
### Application
* [T-Beam Paxcounter](https://github.com/cyberman54/ESP32-Paxcounter)
* [T-Beam Meshtastic](https://github.com/meshtastic/Meshtastic-device)

65
docs/en/t_beam/t_beam_hw.md
View file

@ -22,6 +22,64 @@
[1]: https://www.lilygo.cc/products/t-beam-v1-1-esp32-lora-module "T-Beam Meshtastic"
[2]: https://www.lilygo.cc/products/t-beam-softrf "T-Beam SoftRF"
### PlatformIO Quick Start
1. Install the **CH9102 USB bridge** driver for the first time.
* [Windows](https://www.wch-ic.com/downloads/CH343SER_ZIP.html)
* [Mac OS](https://www.wch-ic.com/downloads/CH34XSER_MAC_ZIP.html)
2. Install [Visual Studio Code](https://code.visualstudio.com/) and [Python](https://www.python.org/)
3. Search for the `PlatformIO` plugin in the `Visual Studio Code` extension and install it.
4. After the installation is complete, you need to restart `Visual Studio Code`
5. After restarting `Visual Studio Code`, select `File` in the upper left corner of `Visual Studio Code` -> `Open Folder` -> select the `LilyGo-LoRa-Series` directory
6. Wait for the installation of third-party dependent libraries to complete
7. Click on the `platformio.ini` file, and in the `platformio` column
8. Select the board name you want to use in `default_envs` and uncomment it.
9. Uncomment one of the lines `src_dir = xxxx` to make sure only one line works , Please note the example comments, indicating what works and what does not.
10. Click the (✔) symbol in the lower left corner to compile
11. Connect the board to the computer USB-C , Micro-USB is used for module firmware upgrade
12. Click (→) to upload firmware
13. Click (plug symbol) to monitor serial output
14. If it cannot be written, or the USB device keeps flashing, please check the **FAQ** below
### Arduino IDE quick start
1. Install the **CH9102 USB bridge** driver for the first time.
* [Windows](https://www.wch-ic.com/downloads/CH343SER_ZIP.html)
* [Mac OS](https://www.wch-ic.com/downloads/CH34XSER_MAC_ZIP.html)
2. Install [Arduino IDE](https://www.arduino.cc/en/software)
3. Install [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/)
4. Copy all folders in the `lib` directory to the `Sketchbook location` directory. How to find the location of your own libraries, [please see here](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer)
* Windows: `C:\Users\{username}\Documents\Arduino`
* macOS: `/Users/{username}/Documents/Arduino`
* Linux: `/home/{username}/Arduino`
5. Open the corresponding example
* Open the downloaded `LilyGo-LoRa-Series`
* Open `examples`
* Select the sample file and open the file ending with `ino`
6. On Arduino ISelect the corresponding board in the DE tool project and click on the corresponding option in the list below to select
| Name | Value |
| ------------------------------------ | ------------------------------------ |
| Board | **ESP32 Dev Module** |
| Port | Your port |
| CPU Frequency | 240MHZ(WiFi/BT) |
| Core Debug Level | None |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Flash Frequency | 80MHZ |
| Flash Mode | QIO |
| Flash Size | **4MB(32Mb)** |
| JTAG Adapter | Disabled |
| Arduino Runs On | Core1 |
| Partition Scheme | **Huge APP (3MB No OTA/1MB SPIFFS)** |
| PSRAM | **Enable** |
| Upload Speed | 921600 |
| Programmer | **Esptool** |
6. Please uncomment the `utilities.h` file of each sketch according to your board model ,e.g `T_BEAM_SX1262`,`T_BEAM_SX1276`,`T_BEAM_SX1278`, otherwise the compilation will report an error.
7. Upload sketch
### 📍 Pins Map
| Name | GPIO NUM | Free |
@ -121,3 +179,10 @@
* [SX1276 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1276)
* [SX1262 datasheet](https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262)
* [GSP NEO-6/NEO-8 datasheet](https://www.u-blox.com/en/product/neo-6-series)
### Application
* [T-Beam SoftRF](https://github.com/lyusupov/SoftRF)
* [T-Beam Paxcounter](https://github.com/cyberman54/ESP32-Paxcounter)
* [T-Beam Meshtastic](https://github.com/meshtastic/Meshtastic-device)

51
docs/en/t_beam_2w/t_beam_2w_hw.md
View file

@ -15,6 +15,57 @@
3. Please note that the GPIO with * added to the external pin header GPIO name is already connected to the internal module and cannot be used
4. This RF module provides a maximum power output of 32dBm on this board
## PlatformIO Quick Start
1. Install [Visual Studio Code](https://code.visualstudio.com/) and [Python](https://www.python.org/)
2. Search for the `PlatformIO` plugin in the `Visual Studio Code` extension and install it.
3. After the installation is complete, you need to restart `Visual Studio Code`
4. After restarting `Visual Studio Code`, select `File` in the upper left corner of `Visual Studio Code` -> `Open Folder` -> select the `LilyGo-LoRa-Series` directory
5. Wait for the installation of third-party dependent libraries to complete
6. Click on the `platformio.ini` file, and in the `platformio` column
7. Select the board name you want to use in `default_envs` and uncomment it.
8. Uncomment one of the lines `src_dir = xxxx` to make sure only one line works , Please note the example comments, indicating what works and what does not.
9. Click the (✔) symbol in the lower left corner to compile
10. Connect the board to the computer USB-C , Micro-USB is used for module firmware upgrade
11. Click (→) to upload firmware
12. Click (plug symbol) to monitor serial output
13. If it cannot be written, or the USB device keeps flashing, please check the **FAQ** below
## Arduino IDE quick start
1. Install [Arduino IDE](https://www.arduino.cc/en/software)
2. Install [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/)
3. Copy all folders in the `lib` directory to the `Sketchbook location` directory. How to find the location of your own libraries, [please see here](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer)
* Windows: `C:\Users\{username}\Documents\Arduino`
* macOS: `/Users/{username}/Documents/Arduino`
* Linux: `/home/{username}/Arduino`
4. Open the corresponding example
* Open the downloaded `LilyGo-LoRa-Series`
* Open `examples`
* Select the sample file and open the file ending with `ino`
5. On Arduino ISelect the corresponding board in the DE tool project and click on the corresponding option in the list below to select
| Name | Value |
| ------------------------------------ | ----------------------------------- |
| Board | **ESP32S3 Dev Module** |
| Port | Your port |
| USB CDC On Boot | Enable |
| CPU Frequency | 240MHZ(WiFi) |
| Core Debug Level | None |
| USB DFU On Boot | Disable |
| Erase All Flash Before Sketch Upload | Disable |
| Flash Mode | QIO 80Mhz |
| Flash Size | **16MB(128Mb)** |
| Arduino Runs On | Core1 |
| USB Firmware MSC On Boot | Disable |
| Partition Scheme | **16M Flash (3MB APP/9.9MB FATFS)** |
| PSRAM | **OPI PSRAM** |
| Upload Speed | 921600 |
| Programmer | **Esptool** |
1. Please uncomment the `utilities.h` file of each sketch according to your board model e.g `T_BEAM_2W`, otherwise the compilation will report an error.
2. Upload sketch
### 📍 Pins Map
| Name | GPIO NUM | Free |

51
docs/en/t_beam_bpf/t_beam_bpf_hw.md
View file

@ -13,6 +13,57 @@
1. The device will not be powered when the battery is inserted for the first time, because the onboard BMS is in shipping mode at this time. You need to exit shipping mode and insert the USB-C into the board to activate the device power supply. If the battery is removed and re-inserted, you need to repeat the above steps
2. Please be sure to connect the antenna before transmitting, otherwise it is easy to damage the RF module
## PlatformIO Quick Start
1. Install [Visual Studio Code](https://code.visualstudio.com/) and [Python](https://www.python.org/)
2. Search for the `PlatformIO` plugin in the `Visual Studio Code` extension and install it.
3. After the installation is complete, you need to restart `Visual Studio Code`
4. After restarting `Visual Studio Code`, select `File` in the upper left corner of `Visual Studio Code` -> `Open Folder` -> select the `LilyGo-LoRa-Series` directory
5. Wait for the installation of third-party dependent libraries to complete
6. Click on the `platformio.ini` file, and in the `platformio` column
7. Select the board name you want to use in `default_envs` and uncomment it.
8. Uncomment one of the lines `src_dir = xxxx` to make sure only one line works , Please note the example comments, indicating what works and what does not.
9. Click the (✔) symbol in the lower left corner to compile
10. Connect the board to the computer USB-C , Micro-USB is used for module firmware upgrade
11. Click (→) to upload firmware
12. Click (plug symbol) to monitor serial output
13. If it cannot be written, or the USB device keeps flashing, please check the **FAQ** below
## Arduino IDE quick start
1. Install [Arduino IDE](https://www.arduino.cc/en/software)
2. Install [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/)
3. Copy all folders in the `lib` directory to the `Sketchbook location` directory. How to find the location of your own libraries, [please see here](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer)
* Windows: `C:\Users\{username}\Documents\Arduino`
* macOS: `/Users/{username}/Documents/Arduino`
* Linux: `/home/{username}/Arduino`
4. Open the corresponding example
* Open the downloaded `LilyGo-LoRa-Series`
* Open `examples`
* Select the sample file and open the file ending with `ino`
5. On Arduino ISelect the corresponding board in the DE tool project and click on the corresponding option in the list below to select
| Name | Value |
| ------------------------------------ | ----------------------------------- |
| Board | **ESP32S3 Dev Module** |
| Port | Your port |
| USB CDC On Boot | Enable |
| CPU Frequency | 240MHZ(WiFi) |
| Core Debug Level | None |
| USB DFU On Boot | Disable |
| Erase All Flash Before Sketch Upload | Disable |
| Flash Mode | QIO 80Mhz |
| Flash Size | **16MB(128Mb)** |
| Arduino Runs On | Core1 |
| USB Firmware MSC On Boot | Disable |
| Partition Scheme | **16M Flash (3MB APP/9.9MB FATFS)** |
| PSRAM | **OPI PSRAM** |
| Upload Speed | 921600 |
| Programmer | **Esptool** |
1. Please uncomment the `utilities.h` file of each sketch according to your board model e.g `T_BEAM_S3_BPF`, otherwise the compilation will report an error.
2. Upload sketch
### 📍 Pins Map
| Name | GPIO NUM | Free |

60
docs/en/t_beam_supreme/t_beam_supreme_hw.md
View file

@ -23,6 +23,60 @@
[1]: https://www.lilygo.cc/products/softrf-t-beamsupreme?variant=42880905052341 "T-Beam S3 Supreme L76K"
[2]: https://www.lilygo.cc/products/softrf-t-beamsupreme?variant=42880905281717 "T-Beam S3 Supreme Ublox"
## PlatformIO Quick Start
1. Install [Visual Studio Code](https://code.visualstudio.com/) and [Python](https://www.python.org/)
2. Search for the `PlatformIO` plugin in the `Visual Studio Code` extension and install it.
3. After the installation is complete, you need to restart `Visual Studio Code`
4. After restarting `Visual Studio Code`, select `File` in the upper left corner of `Visual Studio Code` -> `Open Folder` -> select the `LilyGo-LoRa-Series` directory
5. Wait for the installation of third-party dependent libraries to complete
6. Click on the `platformio.ini` file, and in the `platformio` column
7. Select the board name you want to use in `default_envs` and uncomment it.
8. Uncomment one of the lines `src_dir = xxxx` to make sure only one line works , Please note the example comments, indicating what works and what does not.
9. Click the (✔) symbol in the lower left corner to compile
10. Connect the board to the computer USB-C , Micro-USB is used for module firmware upgrade
11. Click (→) to upload firmware
12. Click (plug symbol) to monitor serial output
13. If it cannot be written, or the USB device keeps flashing, please check the **FAQ** below
## Arduino IDE quick start
1. Install [Arduino IDE](https://www.arduino.cc/en/software)
2. Install [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/)
3. Copy all folders in the `lib` directory to the `Sketchbook location` directory. How to find the location of your own libraries, [please see here](https://support.arduino.cc/hc/en-us/articles/4415103213714-Find-sketches-libraries-board-cores-and-other-files-on-your-computer)
* Windows: `C:\Users\{username}\Documents\Arduino`
* macOS: `/Users/{username}/Documents/Arduino`
* Linux: `/home/{username}/Arduino`
4. Open the corresponding example
* Open the downloaded `LilyGo-LoRa-Series`
* Open `examples`
* Select the sample file and open the file ending with `ino`
5. On Arduino ISelect the corresponding board in the DE tool project and click on the corresponding option in the list below to select
| Name | Value |
| ------------------------------------ | --------------------------------- |
| Board | **ESP32S3 Dev Module** |
| Port | Your port |
| USB CDC On Boot | Enable |
| CPU Frequency | 240MHZ(WiFi) |
| Core Debug Level | None |
| USB DFU On Boot | Disable |
| Erase All Flash Before Sketch Upload | Disable |
| Events Run On | Core1 |
| Flash Mode | QIO 80MHZ |
| Flash Size | **8MB(64Mb)** |
| Arduino Runs On | Core1 |
| USB Firmware MSC On Boot | Disable |
| Partition Scheme | **8M Flash(3M APP/1.5MB SPIFFS)** |
| PSRAM | **QSPI PSRAM** |
| Upload Mode | **UART0/Hardware CDC** |
| Upload Speed | 921600 |
| USB Mode | **CDC and JTAG** |
| Programmer | **Esptool** |
6. Please uncomment the `utilities.h` file of each sketch according to your board model e.g `T_BEAM_S3_SUPREME_SX1262` or `T_BEAM_S3_SUPREME_LR1121`, otherwise the compilation will report an error.
7. Upload sketch
### 📍 Pins Map
| Name | GPIO NUM | Free |
@ -182,3 +236,9 @@
* [BME280 datasheet](https://www.bosch-sensortec.com/products/environmental-sensors/humidity-sensors-bme280/)
* [Quectel_L76K_GNSS_Protocol_Specification_V1.2](../../../docs/datasheet/Quectel_L76KL26K_GNSS_协议规范_V1.2.pdf)
* [CASIC_ProtocolSpecification](../../../docs/datasheet/CASIC_ProtocolSpecification.pdf)
### Application
* [T-Beam SoftRF](https://github.com/lyusupov/SoftRF)
* [T-Beam Paxcounter](https://github.com/cyberman54/ESP32-Paxcounter)
* [T-Beam Meshtastic](https://github.com/meshtastic/Meshtastic-device)