hass-node-red 项目教程

hass-node-red 项目教程

hass-node-red Companion Component for node-red-contrib-home-assistant-websocket to help integrate Node-RED with Home Assistant Core 项目地址: https://gitcode.com/gh_mirrors/ha/hass-node-red

1. 项目目录结构及介绍

hass-node-red 项目的目录结构如下：

hass-node-red/
├── devcontainer/
├── github/
├── vscode/
├── config/
│   ├── custom_components/
│   │   └── nodered/
│   └── ...
├── scripts/
├── tests/
├── .gitattributes
├── .gitignore
├── pre-commit-config.yaml
├── prettierignore
├── release-please-manifest.json
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── hacs.json
├── info.md
├── release-please-config.json
├── requirements.txt
├── requirements_test.txt
└── setup.cfg

目录结构介绍

• devcontainer/: 包含开发容器的配置文件。
• github/: 包含 GitHub 相关的配置文件。
• vscode/: 包含 Visual Studio Code 的配置文件。
• config/: 包含项目的配置文件，其中 custom_components/nodered/ 是主要的配置目录。
• scripts/: 包含项目的脚本文件。
• tests/: 包含项目的测试文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• pre-commit-config.yaml: 预提交钩子配置文件。
• prettierignore: Prettier 忽略文件配置。
• release-please-manifest.json: 发布相关配置文件。
• CHANGELOG.md: 项目变更日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• hacs.json: HACS（Home Assistant Community Store）配置文件。
• info.md: 项目信息文件。
• release-please-config.json: 发布配置文件。
• requirements.txt: 项目依赖文件。
• requirements_test.txt: 测试依赖文件。
• setup.cfg: 项目配置文件。

2. 项目启动文件介绍

hass-node-red 项目的启动文件主要是通过 Home Assistant 的集成机制来启动。具体步骤如下：

1. 安装依赖: 确保安装了 node-red-contrib-home-assistant-websocket 插件。
2. 配置 Home Assistant: 在 Home Assistant 的配置文件中添加 nodered 集成。
3. 启动 Home Assistant: 启动 Home Assistant 后，nodered 集成会自动加载并启动 Node-RED。

3. 项目配置文件介绍

hass-node-red 项目的主要配置文件位于 config/custom_components/nodered/ 目录下。以下是一些关键配置文件的介绍：

config/custom_components/nodered/manifest.json

该文件包含了 nodered 集成的元数据，如名称、版本、依赖等信息。

config/custom_components/nodered/services.yaml

该文件定义了 nodered 集成提供的服务，如创建和更新 Home Assistant 实体等。

config/custom_components/nodered/translations/en.json

该文件包含了 nodered 集成的翻译文件，支持多语言配置。

config/custom_components/nodered/config_flow.py

该文件定义了 nodered 集成的配置流程，用户可以通过 Home Assistant 的 UI 进行配置。

config/custom_components/nodered/const.py

该文件定义了 nodered 集成中使用的常量。

config/custom_components/nodered/entity_component.py

该文件定义了 nodered 集成的实体组件，用于管理 Home Assistant 中的实体。

config/custom_components/nodered/webhook.py

该文件定义了 nodered 集成的 Webhook 处理逻辑，用于处理来自 Node-RED 的请求。

通过以上配置文件，hass-node-red 项目可以与 Home Assistant 无缝集成，实现智能家居的自动化控制。

hass-node-red Companion Component for node-red-contrib-home-assistant-websocket to help integrate Node-RED with Home Assistant Core 项目地址: https://gitcode.com/gh_mirrors/ha/hass-node-red