Zigbee2mqtt Home Assistant Add-on 使用教程

Zigbee2mqtt Home Assistant Add-on 使用教程

hassio-zigbee2mqtt Hass.io add-on for zigbee2mqtt 项目地址: https://gitcode.com/gh_mirrors/has/hassio-zigbee2mqtt

1. 项目目录结构及介绍

Zigbee2mqtt Home Assistant Add-on 的目录结构如下：

.
├── .github
│   └── repository.json
├── zigbee2mqtt-edge
├── zigbee2mqtt
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── README.md
└── repository.json

• .github/repository.json：存储关于仓库的元数据。
• zigbee2mqtt-edge：可能包含边缘计算相关的代码或配置。
• zigbee2mqtt：主程序文件夹，包含项目的核心代码。
• .gitignore：定义了 Git 忽略的文件和文件夹。
• CONTRIBUTING.md：提供了关于如何贡献项目的指南。
• LICENSE：项目的许可证文件，本项目采用 Apache-2.0 许可。
• README.md：项目的自述文件，介绍了项目的相关信息。
• repository.json：存储关于仓库的配置信息。

2. 项目的启动文件介绍

在 zigbee2mqtt 文件夹中，通常会有一个启动脚本或者配置文件来初始化和运行项目。具体的启动文件可能因项目具体实现而异，但通常会包含以下内容：

• start.sh 或 run.py：这是启动项目的脚本文件，用户可以通过运行这个脚本来启动服务。
• Dockerfile：如果项目支持 Docker，这个文件定义了如何构建 Docker 容器。
• config.yaml：这是一个示例配置文件，用户可以根据自己的需求修改配置。

3. 项目的配置文件介绍

配置文件通常是 config.yaml，它定义了项目的运行参数和设置。以下是一个基本的配置文件介绍：

# Zigbee2mqtt 配置文件示例

# MQTT 服务器设置
mqtt:
  base_topic: zigbee2mqtt
  server: 'mqtt://localhost:1883'
  user: yourmqttuser
  password: yourmqttuserpassword

# 设备配置
devices:
  - name: "设备名称"
    model: "设备型号"
    manufacturername: "制造商名称"
    description: "设备描述"

# 其他设置
advanced:
  # 设定Zigbee协调器的网络密钥
  network_key: 'your-zigbee-network-key'
  # 其他高级设置...

# 设备发现设置
device一趟covery:
  # 是否启用设备自动发现
  enabled: true
  # 自动发现相关设置...

# 日志设置
logging:
  level: info
  # 日志相关设置...

在配置文件中，用户需要根据自己的实际情况填写 MQTT 服务器的信息、设备信息以及任何高级设置。这些配置将直接影响项目的运行和设备的管理。在修改配置文件后，重新启动项目以应用新的设置。

hassio-zigbee2mqtt Hass.io add-on for zigbee2mqtt 项目地址: https://gitcode.com/gh_mirrors/has/hassio-zigbee2mqtt