TinyUPnP 项目教程

TinyUPnP 项目教程

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

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

TinyUPnP 项目的目录结构如下：

TinyUPnP/
├── examples/
│   └── ...
├── src/
│   └── TinyUPnP.h
│   └── TinyUPnP.cpp
├── .gitignore
├── LICENSE
├── README.md
└── library.properties

目录结构介绍

• examples/: 包含示例代码，展示了如何使用 TinyUPnP 库进行自动端口转发。
• src/: 包含 TinyUPnP 库的核心源文件，包括 TinyUPnP.h 和 TinyUPnP.cpp。
• .gitignore: Git 忽略文件，指定哪些文件和目录不需要被 Git 管理。
• LICENSE: 项目的许可证文件，本项目使用 LGPL-2.1 许可证。
• README.md: 项目的说明文件，包含项目的安装、使用方法等信息。
• library.properties: Arduino 库的属性文件，包含库的基本信息。

2. 项目的启动文件介绍

TinyUPnP 项目的启动文件是 src/TinyUPnP.h 和 src/TinyUPnP.cpp。这两个文件是 TinyUPnP 库的核心实现部分。

TinyUPnP.h

TinyUPnP.h 文件包含了 TinyUPnP 类的定义，提供了以下主要功能：

• TinyUPnP 类的构造函数和析构函数。
• addPortMappingConfig 方法：用于配置端口映射。
• commitPortMappings 方法：提交端口映射配置。
• updatePortMappings 方法：更新端口映射。
• printPortMappingConfig 方法：打印端口映射配置。
• printAllPortMappings 方法：打印所有端口映射。

TinyUPnP.cpp

TinyUPnP.cpp 文件包含了 TinyUPnP 类的实现，具体实现了 TinyUPnP.h 中定义的方法。

3. 项目的配置文件介绍

TinyUPnP 项目的主要配置文件是 library.properties。

library.properties

library.properties 文件包含了 Arduino 库的基本信息，内容如下：

name=TinyUPnP
version=1.0.0
author=Ofek Pearl
maintainer=Ofek Pearl
sentence=A very small UPnP IGD implementation for ESP8266 and ESP32.
paragraph=This library allows you to add automatic port mappings (port forwarding) to your router using UPnP.
category=Communication
url=https://github.com/ofekp/TinyUPnP
architectures=esp8266,esp32

配置文件介绍

• name: 库的名称，即 TinyUPnP。
• version: 库的版本号，当前版本为 1.0.0。
• author: 库的作者，即 Ofek Pearl。
• maintainer: 库的维护者，也是 Ofek Pearl。
• sentence: 库的简短描述，说明这是一个用于 ESP8266 和 ESP32 的小型 UPnP IGD 实现。
• paragraph: 库的详细描述，说明该库允许通过 UPnP 自动添加端口映射。
• category: 库的分类，属于 Communication 类别。
• url: 库的 GitHub 仓库地址。
• architectures: 库支持的架构，包括 esp8266 和 esp32。

通过以上内容，您可以了解 TinyUPnP 项目的目录结构、启动文件和配置文件的基本信息。

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