XiaomiGateway3 项目使用教程

XiaomiGateway3 项目使用教程

XiaomiGateway3 Control Zigbee, BLE and Mesh devices from Home Assistant with Xiaomi Gateway 3 on original firmware 项目地址: https://gitcode.com/gh_mirrors/xia/XiaomiGateway3

1. 项目目录结构及介绍

XiaomiGateway3 项目的目录结构如下：

XiaomiGateway3/
├── assets/
├── custom_components/
│   └── xiaomi_gateway3/
├── tests/
├── .gitignore
├── LICENSE.md
├── README.md
├── hacs.json
└── print_models.py

目录结构介绍

• assets/: 存放项目相关的静态资源文件。
• custom_components/xiaomi_gateway3/: 包含 Home Assistant 自定义组件的核心代码。
• tests/: 存放项目的测试代码。
• .gitignore: Git 忽略文件配置。
• LICENSE.md: 项目的开源许可证文件。
• README.md: 项目的主文档，包含项目的介绍、安装和使用说明。
• hacs.json: HACS (Home Assistant Community Store) 配置文件。
• print_models.py: 用于打印设备型号的脚本。

2. 项目的启动文件介绍

XiaomiGateway3 项目的主要启动文件位于 custom_components/xiaomi_gateway3/ 目录下。以下是一些关键文件的介绍：

• init.py: 项目的初始化文件，包含 Home Assistant 组件的入口点。
• manifest.json: 组件的元数据文件，包含组件的名称、版本、依赖等信息。
• config_flow.py: 配置流程文件，用于在 Home Assistant 中配置组件。
• gateway3.py: 核心逻辑文件，处理与小米多模网关的通信和控制。

3. 项目的配置文件介绍

XiaomiGateway3 项目的配置文件主要包括 manifest.json 和 configuration.yaml。

manifest.json

manifest.json 文件位于 custom_components/xiaomi_gateway3/ 目录下，包含组件的元数据信息：

{
  "domain": "xiaomi_gateway3",
  "name": "Xiaomi Gateway 3",
  "version": "1.0.0",
  "documentation": "https://github.com/AlexxIT/XiaomiGateway3",
  "dependencies": [],
  "codeowners": ["@AlexxIT"],
  "requirements": []
}

configuration.yaml

在 Home Assistant 中，XiaomiGateway3 组件的配置通常通过 Home Assistant 的 UI 进行，但也可以通过 configuration.yaml 文件进行手动配置。以下是一个简单的配置示例：

xiaomi_gateway3:
  gateways:
    - host: 192.168.1.100
      token: "your_gateway_token"
      key: "your_gateway_key"

• host: 小米多模网关的 IP 地址。
• token: 网关的访问令牌。
• key: 网关的加密密钥（仅在特定固件版本需要）。

通过以上配置，您可以在 Home Assistant 中成功添加并控制小米多模网关及其连接的设备。

XiaomiGateway3 Control Zigbee, BLE and Mesh devices from Home Assistant with Xiaomi Gateway 3 on original firmware 项目地址: https://gitcode.com/gh_mirrors/xia/XiaomiGateway3