TinyUPnP 开源项目使用手册

TinyUPnP 开源项目使用手册

TinyUPnPA very small UPnP IGD implementation for your ESP8266 for automatic port forwarding项目地址:https://gitcode.com/gh_mirrors/ti/TinyUPnP

1. 目录结构及介绍

TinyUPnP 是一个专为嵌入式应用设计的轻量级UPnP（Universal Plug and Play）实现，特别适用于ESP8266和ESP32平台，以实现自动端口转发功能。以下是该仓库的基本目录结构概述：

• 根目录

  • 包含了README.md，提供了项目快速概览。
  • src — 存放核心源代码，包括TinyUPnP的主要实现。
  • examples — 示例应用程序，如PWM_LEDServer，展示了如何在实际项目中使用TinyUPnP进行端口映射。
  • docs — 可能包含了额外的文档或指南，虽然在提供的引用中没有明确展示这个目录。
  • library.properties — Arduino IDE识别库的属性文件，定义库的元数据。

• TinyUPnP库文件

  • TinyUPnP.h — 主头文件，导入它即可使用TinyUPnP库的功能。

• 示例说明
  在examples目录下，每个.ino文件通常代表一个独立的运行案例，例如PWM_LEDServer.ino结合了端口映射和简单的LED控制，演示了如何通过UPnP与网络交互。

2. 项目的启动文件介绍

项目的启动文件通常是位于examples目录下的.ino文件。以PWM_LEDServer.ino为例，这是一个启动文件的简要说明：

• 初始化设置 (setup(void)): 这部分代码负责初始化必要的硬件资源（比如设置串行通信速率、LED引脚模式），连接到WiFi网络，并尝试添加端口映射。
• 主要逻辑 (loop(void)): 程序执行循环中的操作，这可能包括更新DDNS服务、维持端口映射的最新状态以及处理任何客户端请求。

具体来说，它首先确保串行通讯正常工作，接着尝试建立WiFi连接，并通过tinyUPnP.addPortMappingConfig()添加端口映射规则至路由器。之后，进入主循环，定期检查并更新DDNS记录，保持端口映射的有效性，并监听HTTP服务器的客户端请求。

3. 项目的配置文件介绍

尽管TinyUPnP本身作为一个库可能不直接包含一个单独的“配置文件”，但其功能的使用高度依赖于硬编码的配置参数，这些通常是在示例或用户程序中定义的。重要配置项一般包括：

• WiFi设置：SSID、密码。
• 端口映射配置：监听端口(LISTEN_PORT)、协议类型(TCP或UDP)、租期(LEASE_DURATION)、友好的服务名(FRIENDLY_NAME)。
• DDNS配置（如果安装了EasyDDNS库作为补充）：用户名、密码、域名。

这些配置项分散在.ino文件或者初始化代码块中，如使用前需要填写的占位符 <FILL THIS> 显示的地方，表明用户需根据实际情况填充相应的值。

为了使TinyUPnP功能生效，用户需按照实例代码中注释的指示，正确填充这些配置项，确保设备能够成功连接到WiFi，完成端口映射设置，从而允许外部访问内部服务。

TinyUPnPA very small UPnP IGD implementation for your ESP8266 for automatic port forwarding项目地址:https://gitcode.com/gh_mirrors/ti/TinyUPnP