KNX Core 项目使用教程

KNX Core 项目使用教程

1. 项目目录结构及介绍

KNX Core 是一个用于 KNX Net/IP 通信的 Java 库。项目的目录结构如下：

knx-core/
├── assets/
├── scripts/
├── src/
│   ├── main/
│   └── test/
├── github/
│   └── workflows/
├── .gitignore
├── LICENSE.txt
├── README.md
└── pom.xml

目录结构说明

• assets/: 存放项目相关的资源文件。
• scripts/: 存放项目相关的脚本文件。
• src/: 项目的源代码目录，包含 main 和 test 两个子目录。
  • main/: 存放主要的 Java 源代码。
  • test/: 存放测试代码。
• github/workflows/: 存放 GitHub Actions 的工作流配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE.txt: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• pom.xml: Maven 项目的配置文件。

2. 项目启动文件介绍

KNX Core 项目的启动文件主要位于 src/main/java 目录下。具体的启动类和方法可以在 README.md 文件中找到相关说明。

启动示例

// 使用默认配置启动 KNX 客户端
DefaultKnxClient.createStarted();

// 使用自定义 IP 地址启动 KNX 客户端
DefaultKnxClient.createStarted("192.168.0.3");

// 使用自定义 IP 地址和端口启动 KNX 客户端
DefaultKnxClient.createStarted("192.168.0.3:1234");

3. 项目配置文件介绍

KNX Core 项目的配置文件主要是 pom.xml 和 README.md 文件中提到的配置项。

pom.xml 配置文件

pom.xml 是 Maven 项目的配置文件，包含了项目的依赖、插件、构建配置等信息。

配置示例

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>knx-core</artifactId>
    <version>1.0.0</version>
    <dependencies>
        <!-- 项目依赖 -->
    </dependencies>
    <build>
        <plugins>
            <!-- 构建插件 -->
        </plugins>
    </build>
</project>

README.md 中的配置项

在 README.md 文件中，详细介绍了如何配置 KNX Core 客户端的通信模式、端口、超时时间等。

配置示例

// 使用 ConfigBuilder 配置 KNX 客户端
var config = ConfigBuilder.tunneling().build();
DefaultKnxClient.createStarted(config);

// 配置 NAT 模式
var config = ConfigBuilder.tunneling(true).build();
DefaultKnxClient.createStarted(config);

通过以上配置，可以灵活地调整 KNX Core 客户端的行为，以适应不同的网络环境和需求。