Vaillant Component 项目安装与使用教程

Vaillant Component 项目安装与使用教程

vaillant-component Multimatic integration for Home Assistant (also compatible with sensoAPP) 项目地址: https://gitcode.com/gh_mirrors/va/vaillant-component

1. 项目目录结构及介绍

Vaillant Component 项目的目录结构如下：

vaillant-component/
├── custom_components/
│   └── multimatic/
│       ├── __init__.py
│       ├── config_flow.py
│       ├── const.py
│       ├── ...
├── github/
│   └── workflows/
│       ├── ci.yml
│       ├── ...
├── .gitignore
├── LICENSE
├── README.md
├── hacs.json
└── ...

目录结构介绍

• custom_components/multimatic/: 该目录包含了 Home Assistant 集成的核心代码。multimatic 是与 Vaillant 设备集成的组件。

  • __init__.py: 初始化文件，定义了组件的基本信息。
  • config_flow.py: 配置流程文件，用于通过 UI 配置组件。
  • const.py: 常量定义文件，包含组件中使用的常量。
  • 其他文件：包含组件的各种功能实现。

• github/workflows/: 该目录包含了 GitHub Actions 的工作流配置文件。

  • ci.yml: 持续集成配置文件，用于自动化测试和构建。

• .gitignore: Git 忽略文件，定义了哪些文件或目录不需要被 Git 管理。

• LICENSE: 项目许可证文件，通常为 MIT 许可证。

• README.md: 项目说明文件，包含了项目的介绍、安装和使用说明。

• hacs.json: HACS（Home Assistant Community Store）配置文件，用于在 HACS 中管理该组件。

2. 项目的启动文件介绍

Vaillant Component 项目的启动文件主要位于 custom_components/multimatic/ 目录下。其中，__init__.py 是组件的初始化文件，负责加载和初始化组件。

__init__.py 文件介绍

• 导入模块: 该文件导入了组件所需的各种模块和库。
• 定义组件: 通过 async_setup 和 async_setup_entry 函数，定义了组件的初始化和配置流程。
• 注册服务: 注册了组件提供的各种服务，如设置假期模式、快速模式等。

3. 项目的配置文件介绍

Vaillant Component 的配置文件主要通过 Home Assistant 的 UI 进行配置。用户可以通过 Home Assistant 的集成页面添加 Vaillant Component，并输入用户名和密码进行配置。

配置步骤

1. 添加集成: 在 Home Assistant 的集成页面，点击“添加集成”按钮。
2. 搜索 Vaillant Component: 在搜索框中输入“Vaillant”，选择“Vaillant Component”。
3. 输入用户名和密码: 输入与 Vaillant 或 sensoAPP 相同的用户名和密码。
4. 选择设备: 如果有多个设备，可以选择特定的设备进行集成。
5. 完成配置: 点击“提交”按钮，完成配置。

配置文件示例

虽然 Vaillant Component 主要通过 UI 配置，但也可以通过 YAML 文件进行配置。以下是一个简单的 YAML 配置示例：

multimatic:
  username: "your_username"
  password: "your_password"
  serial_number: "your_serial_number"

配置文件参数说明

• username: 用户名，与 Vaillant 或 sensoAPP 相同的用户名。
• password: 密码，与 Vaillant 或 sensoAPP 相同的密码。
• serial_number: 设备的序列号，可选，用于指定特定的设备。

通过以上步骤，您可以成功安装和配置 Vaillant Component，并将其集成到 Home Assistant 中。

vaillant-component Multimatic integration for Home Assistant (also compatible with sensoAPP) 项目地址: https://gitcode.com/gh_mirrors/va/vaillant-component