diff --git a/README.MD b/README.MD index 5d72d08..80b956e 100644 --- a/README.MD +++ b/README.MD @@ -11,13 +11,14 @@ - ⚠️ If using the PA version, please carefully read the PA power setting limits on the corresponding page. Incorrect output power settings may damage the PA. - ⚠️ 如果使用PA版本,请仔细阅读对应页面的PA功率设置限制,错误的设置输出功率很有可能会损坏PA - ### `1` Get Started - 🔧 **[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 1W Quick Start](./docs/en/t_beam_1w/t_beam_1w_hw.md)** +- 🔧 **[T-Beam 1W SX1262 Quick Start](./docs/en/t_beam_1w_sx1262/t_beam_1w_sx1262.md)** +- 🔧 **[T-Beam 1W LR1121 Quick Start](./docs/en/t_beam_1w_lr1121/t_beam_1w_lr1121.md)** +- 🔧 **[T-Beam 1W LR2021 Quick Start](./docs/en/t_beam_1w_lr2021/t_beam_1w_lr2021.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)** diff --git a/docs/en/t_beam_1w_lr1121/images/XY16EXP33.png b/docs/en/t_beam_1w_lr1121/images/XY16EXP33.png new file mode 100644 index 0000000..902a33e Binary files /dev/null and b/docs/en/t_beam_1w_lr1121/images/XY16EXP33.png differ diff --git a/docs/en/t_beam_1w_lr1121/images/currnetA.png b/docs/en/t_beam_1w_lr1121/images/currnetA.png new file mode 100644 index 0000000..c9d4b05 Binary files /dev/null and b/docs/en/t_beam_1w_lr1121/images/currnetA.png differ diff --git a/docs/en/t_beam_1w_lr1121/images/currnetB.png b/docs/en/t_beam_1w_lr1121/images/currnetB.png new file mode 100644 index 0000000..90573cb Binary files /dev/null and b/docs/en/t_beam_1w_lr1121/images/currnetB.png differ diff --git a/docs/en/t_beam_1w_lr1121/t_beam_1w_lr1121.md b/docs/en/t_beam_1w_lr1121/t_beam_1w_lr1121.md new file mode 100644 index 0000000..d01bfdc --- /dev/null +++ b/docs/en/t_beam_1w_lr1121/t_beam_1w_lr1121.md @@ -0,0 +1,176 @@ +
+ LilyGo logo +
+ +

🌟LilyGo T-Beam-1W-LR1121

+ +## Overview + +* This page introduces the hardware parameters related to `LilyGo T-Beam-1W-LR1121` + +### Notes on use + +1. This board will not charge the external 7.4V battery, it is only powered by the battery. +2. Please be sure to connect the antenna before transmitting, otherwise it is easy to damage the RF module. +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 30dBm 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 Select the corresponding board in the IDE 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 | **Default 4MB with spiffs (1.2MB APP/1.5MB SPIFFS)** | + | PSRAM | **QSPI PSRAM** | + | Upload Speed | 921600 | + | Programmer | **Esptool** | + +6. Please uncomment the `utilities.h` file of each sketch according to your board model e.g `T_BEAM_1W_LR1121`, otherwise the compilation will report an error. +7. Upload sketch + +### 📍 Pins Map + +| Name | GPIO NUM | Free | +| ----------------------- | ------------------------------ | ---- | +| Uart1 TX | 43(External QWIIC Socket) | ✅️ | +| Uart1 RX | 44(External QWIIC Socket) | ✅️ | +| SDA | 8 (External QWIIC Socket same) | ❌ | +| SCL | 9 (External QWIIC Socket same) | ❌ | +| SPI MOSI | 11 | ❌ | +| SPI MISO | 12 | ❌ | +| SPI SCK | 13 | ❌ | +| SD CS | 10 | ❌ | +| SD MOSI | Share with SPI bus | ❌ | +| SD MISO | Share with SPI bus | ❌ | +| SD SCK | Share with SPI bus | ❌ | +| GNSS(**L76K**) TX | 6 | ❌ | +| GNSS(**L76K**) RX | 5 | ❌ | +| GNSS(**L76K**) PPS | 7 | ❌ | +| GNSS(**L76K**) Wake-up | 16 | ❌ | +| LoRa(**LR1121**) SCK | Share with SPI bus | ❌ | +| LoRa(**LR1121**) MISO | Share with SPI bus | ❌ | +| LoRa(**LR1121**) MOSI | Share with SPI bus | ❌ | +| LoRa(**LR1121**) RESET | 3 | ❌ | +| LoRa(**LR1121**) DIO10 | 1 | ❌ | +| LoRa(**LR1121**) DIO11 | 21 | ❌ | +| LoRa(**LR1121**) CS | 15 | ❌ | +| LoRa(**LR1121**) LDO EN | 40 | ❌ | +| LoRa(**LR1121**) BUSY | 38 | ❌ | +| Button1 (BOOT) | 0 | ❌ | +| Button2 | 17 | ❌ | +| On Board LED | 18 | ❌ | +| NTC ADC | 14 | ❌ | +| Battery ADC | 4 | ❌ | +| Fan control | 41 | ❌ | + +> \[!IMPORTANT] +> +> LDO EN pin is control pin inside the module: +> +> 1. High level turns on the Radio +> 2. Low level turns off the Radio +> + +### 🧑🏼‍🔧 I2C Devices Address + +| Devices | 7-Bit Address | Share Bus | +| ------------------- | ------------- | --------- | +| OLED Display SH1106 | 0x3C | ✅️ | + +### ⚡ Electrical parameters + +| Features | Details | +| -------------------- | ------- | +| 🔗USB-C Input Voltage | 3.9V-6V | +| ⚡Charge Function | ❌ | +| 🔋Battery Voltage | 7.4V | + +> \[!IMPORTANT] +> +> The battery used must have a discharge capacity of 2A or greater; otherwise, it may trigger battery protection during high-power transmission. +> + +### Button Description + +| Channel | Peripherals | +| ------- | ------------------------------ | +| IO17 | Customizable buttons | +| BOOT | Boot mode button, customizable | +| RST | Reset button | + +### LED Description + +* IO18 LED + 1. Connect to GPIO18, you can turn the LED on or off by writing high or low level. + +* PPS LED + 1. This LED cannot be turned off and is connected to the GPS PPS Pin. This LED flashes to indicate that the PPS pulse has arrived. + +* USB LED + 1. LED On means the USB cable is connected,LED off means the USB cable is disconnected + +### RF parameters + +| Features | 868MHz | +| ------------------------- | ----------------------- | +| RF Module | LR1121 TCXO (XY16E8P33) | +| Frequency range | 840~930MHz | +| Transfer rate(FSK) | 0.6 ~ 300 kbps | +| Transfer rate(LoRa) Sub1G | 0.091 ~ 62.5 kbps | +| Transfer rate(LoRa) 2.4G | 0.476 ~ 101.5 kbps | +| Modulation | FSK, MSK, GMSK, LoRa | + + +### RF Block Diagram + +![RF Block Diagram](./images/XY16EXP33.png) + +### VCC=+5V, 840MHz~930MHz module output power dBm and current + +![currnetA](./images/currnetA.png) + +### VCC=+5V, 2400MHz~2500MHz module output power dBm and current + +![currnetB](./images/currnetB.png) + +### Resource + +* [Schematic](../../../schematic/T-Beam_1W_V1.1.pdf) diff --git a/docs/en/t_beam_1w_lr2021/images/XY16E3AXP33.png b/docs/en/t_beam_1w_lr2021/images/XY16E3AXP33.png new file mode 100644 index 0000000..0bd7b36 Binary files /dev/null and b/docs/en/t_beam_1w_lr2021/images/XY16E3AXP33.png differ diff --git a/docs/en/t_beam_1w_lr2021/images/currentA.png b/docs/en/t_beam_1w_lr2021/images/currentA.png new file mode 100644 index 0000000..29c7f4d Binary files /dev/null and b/docs/en/t_beam_1w_lr2021/images/currentA.png differ diff --git a/docs/en/t_beam_1w_lr2021/images/currentB.png b/docs/en/t_beam_1w_lr2021/images/currentB.png new file mode 100644 index 0000000..c0a405b Binary files /dev/null and b/docs/en/t_beam_1w_lr2021/images/currentB.png differ diff --git a/docs/en/t_beam_1w_lr2021/t_beam_1w_lr2021.md b/docs/en/t_beam_1w_lr2021/t_beam_1w_lr2021.md new file mode 100644 index 0000000..bafb7e7 --- /dev/null +++ b/docs/en/t_beam_1w_lr2021/t_beam_1w_lr2021.md @@ -0,0 +1,208 @@ +
+ LilyGo logo +
+ +

🌟LilyGo T-Beam-1W-LR2021

+ +## Overview + +* This page introduces the hardware parameters related to `LilyGo T-Beam-1W-LR2021` + +### Notes on use + +1. This board will not charge the external 7.4V battery, it is only powered by the battery. +2. Please be sure to connect the antenna before transmitting, otherwise it is easy to damage the RF module. +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 30dBm 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 Select the corresponding board in the IDE 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 | **Default 4MB with spiffs (1.2MB APP/1.5MB SPIFFS)** | + | PSRAM | **QSPI PSRAM** | + | Upload Speed | 921600 | + | Programmer | **Esptool** | + +6. Please uncomment the `utilities.h` file of each sketch according to your board model e.g `T_BEAM_1W_LR2021`, otherwise the compilation will report an error. +7. Upload sketch + +### 📍 Pins Map + +| Name | GPIO NUM | Free | +| ----------------------- | ------------------------------ | ---- | +| Uart1 TX | 43(External QWIIC Socket) | ✅️ | +| Uart1 RX | 44(External QWIIC Socket) | ✅️ | +| SDA | 8 (External QWIIC Socket same) | ❌ | +| SCL | 9 (External QWIIC Socket same) | ❌ | +| SPI MOSI | 11 | ❌ | +| SPI MISO | 12 | ❌ | +| SPI SCK | 13 | ❌ | +| SD CS | 10 | ❌ | +| SD MOSI | Share with SPI bus | ❌ | +| SD MISO | Share with SPI bus | ❌ | +| SD SCK | Share with SPI bus | ❌ | +| GNSS(**L76K**) TX | 6 | ❌ | +| GNSS(**L76K**) RX | 5 | ❌ | +| GNSS(**L76K**) PPS | 7 | ❌ | +| GNSS(**L76K**) Wake-up | 16 | ❌ | +| LoRa(**LR2021**) SCK | Share with SPI bus | ❌ | +| LoRa(**LR2021**) MISO | Share with SPI bus | ❌ | +| LoRa(**LR2021**) MOSI | Share with SPI bus | ❌ | +| LoRa(**LR2021**) RESET | 3 | ❌ | +| LoRa(**LR2021**) DIO10 | 1 | ❌ | +| LoRa(**LR2021**) DIO11 | 21 | ❌ | +| LoRa(**LR2021**) CS | 15 | ❌ | +| LoRa(**LR2021**) LDO EN | 40 | ❌ | +| LoRa(**LR2021**) BUSY | 38 | ❌ | +| Button1 (BOOT) | 0 | ❌ | +| Button2 | 17 | ❌ | +| On Board LED | 18 | ❌ | +| NTC ADC | 14 | ❌ | +| Battery ADC | 4 | ❌ | +| Fan control | 41 | ❌ | + +> \[!IMPORTANT] +> +> LDO EN pin is control pin inside the module: +> +> 1. High level turns on the Radio +> 2. Low level turns off the Radio +> + +### 🧑🏼‍🔧 I2C Devices Address + +| Devices | 7-Bit Address | Share Bus | +| ------------------- | ------------- | --------- | +| OLED Display SH1106 | 0x3C | ✅️ | + +### ⚡ Electrical parameters + +| Features | Details | +| -------------------- | ------- | +| 🔗USB-C Input Voltage | 3.9V-6V | +| ⚡Charge Function | ❌ | +| 🔋Battery Voltage | 7.4V | + +> \[!IMPORTANT] +> +> The battery used must have a discharge capacity of 2A or greater; otherwise, it may trigger battery protection during high-power transmission. +> + +### Button Description + +| Channel | Peripherals | +| ------- | ------------------------------ | +| IO17 | Customizable buttons | +| BOOT | Boot mode button, customizable | +| RST | Reset button | + +### LED Description + +* IO18 LED + 1. Connect to GPIO18, you can turn the LED on or off by writing high or low level. + +* PPS LED + 1. This LED cannot be turned off and is connected to the GPS PPS Pin. This LED flashes to indicate that the PPS pulse has arrived. + +* USB LED + 1. LED On means the USB cable is connected,LED off means the USB cable is disconnected + +### RF parameters + +| Features | LR2021 (XY16E3AXP33) | +| ------------------------- | ----------------------------- | +| RF Module | LR2021 TCXO | +| Frequency range | 840 ~ 930MHz | +| Transfer rate(FSK) | 0.5 ~ 2000 kbps | +| Transfer rate(LoRa Sub1G) | 0.091 ~ 62.5kbps | +| Transfer rate(FSK 2.4G) | 0.476 ~ 101.5 Kbps | +| Transfer rate(FLRC) | 0.13 ~ 2.6 Mbps | +| Modulation | FSK, MSK, LoRa ,FLRC | + + +### RadioLib RF Setting + +```c +static const uint32_t pa_version_rf_switch_dio_pins[] = { + RADIOLIB_LR2021_DIO5, RADIOLIB_LR2021_DIO6, RADIOLIB_LR2021_DIO7, RADIOLIB_LR2021_DIO8, RADIOLIB_NC +}; + +static const Module::RfSwitchMode_t low_sub1g_switch_table[] = { + // mode DIO5 DIO6 DIO7 DIO8 + { LR2021::MODE_STBY, { LOW, LOW, LOW, LOW} }, + { LR2021::MODE_TX, { LOW, LOW, LOW, HIGH} }, // Sub1G DIO8 SET HIGH + { LR2021::MODE_RX, { LOW, LOW, LOW, LOW} }, // Sub1G ALL DIO SET LOW + { LR2021::MODE_RX_HF, { LOW, LOW, LOW, LOW} }, + { LR2021::MODE_TX_HF, { LOW, LOW, LOW, LOW} }, + END_OF_MODE_TABLE, +}; + +static const Module::RfSwitchMode_t high_2g4_switch_table[] = { + // mode DIO5 DIO6 DIO7 DIO8 + { LR2021::MODE_STBY, { LOW, LOW, LOW, LOW} }, + { LR2021::MODE_TX, { LOW, LOW, LOW, LOW} }, + { LR2021::MODE_RX, { LOW, LOW, LOW, LOW} }, + { LR2021::MODE_RX_HF, { LOW, HIGH, LOW, LOW} }, //2.4G RX DIO6 SET HIGH + { LR2021::MODE_TX_HF, { LOW, LOW, HIGH, LOW} }, //2.4G TX DIO7 SET HIGH + END_OF_MODE_TABLE, +}; + +``` + + + +### RF Block Diagram + +![RF Block Diagram](./images/XY16E3AXP33.png) + +### VCC=+5V, 840MHz~930MHz module output power dBm and current + +![currnetA](./images/currentA.png) + +### VCC=+5V, 2400MHz~2500MHz module output power dBm and current + +![currnetB](./images/currentB.png) + +### Resource + +* [Schematic](../../../schematic/T-Beam_1W_V1.1.pdf) diff --git a/docs/en/t_beam_1w/images/RampTime.jpg b/docs/en/t_beam_1w_sx1262/images/RampTime.jpg similarity index 100% rename from docs/en/t_beam_1w/images/RampTime.jpg rename to docs/en/t_beam_1w_sx1262/images/RampTime.jpg diff --git a/docs/en/t_beam_1w/images/XY16P35.jpg b/docs/en/t_beam_1w_sx1262/images/XY16P35.jpg similarity index 100% rename from docs/en/t_beam_1w/images/XY16P35.jpg rename to docs/en/t_beam_1w_sx1262/images/XY16P35.jpg diff --git a/docs/en/t_beam_1w/images/currnetA.jpg b/docs/en/t_beam_1w_sx1262/images/currnetA.jpg similarity index 100% rename from docs/en/t_beam_1w/images/currnetA.jpg rename to docs/en/t_beam_1w_sx1262/images/currnetA.jpg diff --git a/docs/en/t_beam_1w/images/currnetB.jpg b/docs/en/t_beam_1w_sx1262/images/currnetB.jpg similarity index 100% rename from docs/en/t_beam_1w/images/currnetB.jpg rename to docs/en/t_beam_1w_sx1262/images/currnetB.jpg diff --git a/docs/en/t_beam_1w/t_beam_1w_hw.md b/docs/en/t_beam_1w_sx1262/t_beam_1w_sx1262.md similarity index 98% rename from docs/en/t_beam_1w/t_beam_1w_hw.md rename to docs/en/t_beam_1w_sx1262/t_beam_1w_sx1262.md index 9ae1744..611aaf7 100644 --- a/docs/en/t_beam_1w/t_beam_1w_hw.md +++ b/docs/en/t_beam_1w_sx1262/t_beam_1w_sx1262.md @@ -141,10 +141,6 @@ | BOOT | Boot mode button, customizable | | RST | Reset button | -* The PWR button is connected to the PMU - 1. In shutdown mode, press the PWR button to turn on the power supply - 2. In power-on mode, press the PWR button for 6 seconds (default time) to turn off the power supply - ### LED Description * IO18 LED