CapiBridge 开源项目使用教程

CapiBridge 开源项目使用教程

CapiBridge Gateway between WIFI / LoRa / ESPNOW 项目地址: https://gitcode.com/gh_mirrors/ca/CapiBridge

1. 项目的目录结构及介绍

CapiBridge 项目是一个开源的低功耗设备单向网关，支持 LoRa、ESP-NOW 和 WiFi 等多种通信技术。以下是项目的目录结构及其简要介绍：

CapiBridge/
├── code/                      # 存放项目源代码
├── img/                       # 存放项目相关的图像文件
├── lib/                       # 存放项目依赖的库文件
├── .gitattributes             # Git 属性文件，定义一些文件的 Git 行为
├── LICENSE.md                 # 项目的许可证文件
├── README.md                  # 项目的说明文件
└── ...

• code/: 包含了项目的 Arduino 源代码文件，例如 ESP1.ino 和 ESP2.ino。
• img/: 存放项目的示意图、组件布局图等图像文件。
• lib/: 存放项目依赖的 Arduino 库，如 SPI.h、LoRa.h 等。
• .gitattributes: 定义项目中的特定文件应该如何被 Git 处理。
• LICENSE.md: 项目的开源许可证，说明了项目的版权和使用条款。
• README.md: 项目的自述文件，包含项目的基本信息和说明。

2. 项目的启动文件介绍

项目的启动文件是 ESP1.ino 和 ESP2.ino，这两个文件是项目的核心部分。

• ESP1.ino: 是负责 LoRa 和 WiFi 通信的主要程序文件。它配置 WiFi 连接、MQTT 客户端以及 LoRa 模块的参数，并处理来自 LoRa 和 ESP-NOW 节点的数据。
• ESP2.ino: 是负责 ESP-NOW 通信的辅助程序文件。它主要打印 ESP2 的 MAC 地址，用于与 ESP-NOW 节点进行通信。

在开始编写代码之前，需要确保 Arduino IDE 已经安装了 ESP32 开发板和所有必需的库。

3. 项目的配置文件介绍

项目的配置主要通过 config.h 文件进行。以下是 config.h 文件中一些重要的配置项：

// 网关唯一标识符
#define GATEWAY_KEY "xy"

// WiFi 和 MQTT 服务器配置
#define WIFI_SSID "your_wifi_ssid"
#define WIFI_PASSWORD "your_wifi_passwd"
#define MQTT_USERNAME "your_mqtt_user"
#define MQTT_PASSWORD "your_mqtt_passwd"
#define MQTT_SERVER "your_mqtt_broker_address"
#define MQTT_PORT 1883

// LoRa 配置
#define SIGNAL_BANDWITH 125E3    // 信号带宽
#define SPREADING_FACTOR 8      // 稍微因子
#define CODING_RATE 5           // 编码率
#define SYNC_WORD 0xF3          // 同步字
#define PREAMBLE_LENGTH 6       // 前导码长度
#define TX_POWER 20             // 发射功率
#define BAND 433E6              // 频段

这些配置项需要根据实际的网络环境和硬件设备进行调整。例如，WIFI_SSID 和 WIFI_PASSWORD 需要替换为你的 WiFi 网络的名称和密码，MQTT_SERVER 需要设置为 MQTT 服务器的地址等。LoRa 配置部分也需要与你的节点/传感器配置保持一致。

CapiBridge Gateway between WIFI / LoRa / ESPNOW 项目地址: https://gitcode.com/gh_mirrors/ca/CapiBridge