diff --git a/README.md b/README.md index 0a66d61d998e2614658861d1e1631540169f1241..328c3b90460e99665de61daab76739422428fe3b 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,67 @@ -<<<<<<< HEAD -ESP32-S3-LR1121-XF Product Engineering Sample Program -ESP32-S3-LR1121-XF integrates high-performance Wi-Fi, Bluetooth and LoRa connectivity, supporting Sub-GHz, S-band and 2.4 GHz communication. It enables rapid development of low-power, long-range IoT applications. -![主图](./assets/Product-1.webp) +# ESP32-S3-LR1121-XF 产品工程样例程序 -🔧 Configuration +ESP32-S3-LR1121-XF 是微雪电子推出的高性能无线通信开发板,集成 ESP32-S3 与 LR1121 双芯片,支持 Wi-Fi、蓝牙以及 LoRa 无线通信,可工作在 Sub-GHz、S-band 和 2.4 GHz 频段。该开发板可实现低功耗、长距离的物联网应用快速开发。 -You can find detailed configuration information on the product wiki page +![产品图](./assets/Product-1.webp) +## 功能特点 -🛠️ Contributing +- **多频段支持**:支持 Sub-GHz(433/470/868/915MHz)、S-band(2.4GHz)和 2.4 GHz Wi-Fi/蓝牙频段 +- **双芯片架构**:集成 ESP32-S3 主控与 LR1121 无线收发芯片 +- **丰富示例**:提供 LoRaWAN、CAD、LR-FHSS、Ping-Pong、频谱扫描等多种应用示例 +- **双环境支持**:兼容 Arduino IDE 与 ESP-IDF 两种开发环境 -We welcome contributions! Here’s how you can help: +## 快速开始 -Fork the repository. -Create a new branch for your feature or bug fix. -Commit your changes with clear descriptions. -Submit a pull request for review. +### 硬件要求 +- ESP32-S3-LR1121-XF 开发板 +- USB 数据线 +### 软件环境 -🧩 Issues and Support +#### Arduino IDE -If you encounter any issues: +1. 安装 ESP32 开发板支持(在 Arduino IDE 首选项中添加 ESP32 开发板 URL) +2. 从库管理器安装 `waveshare_lora_1121` 库 +3. 在 `Tools > Board` 中选择 `ESP32S3 Dev Module` +4. 打开示例程序并上传 -Check the Issues section. -Create a new issue with detailed information. -Refer to the documentation for troubleshooting tips. -Contact the Waveshare team and provide the order number to obtain technical support. +#### ESP-IDF +参考 `examples/esp-idf/README.md` 文档进行配置 +## 示例程序 -📜 License +| 示例 | 说明 | +|------|------| +| `lr1121_LoRaWAN` | LoRaWAN 协议示例 | +| `lr1121_cad` | 信道活动检测示例 | +| `lr1121_ping_pong` | Ping-Pong 双向通信测试 | +| `lr1121_lr_fhss` | LR-FHSS 跳频示例 | +| `lr1121_per` | 包误码率测试 | +| `lr1121_spectral_scan` | 频谱扫描示例 | +| `lr1121_tx_cw` | 连续波发射示例 | +| `lr1121_write` | 数据发送示例 | +| `lr1121_read` | 数据接收示例 | +| `lr1121_firmware_update` | 固件升级示例 | -This repository is licensed under the Apache License License. See the LICENSE file for details. +## 配置说明 +详细配置信息请参阅产品 Wiki 页面。 -🙌 Acknowledgments +## 致谢 +- 微雪电子提供的优质硬件平台与技术支持 +- Espressif 团队的持续支持 +- 开源社区的贡献者 -Waveshare for their excellent hardware platforms and software support -The Espressif Team for their continuous support. -Open-source contributors who make these projects possible. +## 技术支持 +如遇问题请提交 Issue 或联系技术支持。 -Thank you for using Waveshare Electronics Products! 🚀 +## 开源许可 + +本项目基于 Apache License 开源许可。详细内容请参阅 LICENSE 文件。 \ No newline at end of file