ShellyForHASS 开源项目安装与使用指南

ShellyForHASS 开源项目安装与使用指南

ShellyForHASS Shelly smart home platform for Home Assistant 项目地址: https://gitcode.com/gh_mirrors/sh/ShellyForHASS

项目目录结构及介绍

本项目位于 GitHub 上，为一个旨在集成Shelly智能家庭设备到Home Assistant平台的插件。以下是其基本目录结构及其简介：

.
├── custom_components      # 自定义组件目录，存放所有Shelly相关组件代码。
│   └── shelly             # Shelly组件的核心代码，包括设备发现、控制逻辑等。
│       ├── __init__.py    # 初始化文件，导入组件的关键部分。
│       ├── ...            # 其他Python脚本，如各设备类型的支持模块。
│       ├── examples       # 示例配置和自动化脚本。
│       ├── images         # 文档或示例中使用的图像。
│       ├── scripts        # 可能包含的自定义脚本。
│       ├── tests           # 测试文件夹（如果存在）。
│       └── util           # 辅助工具或函数。
├── .gitattributes          # Git属性文件，用于指定文件处理方式。
├── .gitignore              # 忽略的文件列表。
├── travis.yml              # CI/CD配置文件，用于自动构建和测试。
├── LICENSE                 # 许可证文件，说明软件的使用权限。
├── README.md               # 主要的文档，介绍项目概述和快速入门。
└── hacs.json               # 针对HACS(Home Assistant Community Store)的元数据文件。

项目启动文件介绍

对于此项目来说，并没有传统意义上的“启动文件”，因为它是作为Home Assistant的一个插件设计的。安装完成后，通过Home Assistant的系统管理界面进行启用。然而，如果你手动安装，主要关注点是custom_components/shelly这个目录，特别是__init__.py文件，它负责初始化Shelly组件。

项目的配置文件介绍

基础配置

在不使用HA的图形界面配置时，你需要在Home Assistant的configuration.yaml中添加以下简化配置来启动Shelly插件的发现功能：

shelly:

高级配置示例

为了更细粒度的控制，可以加入更多配置选项，例如，从Shelly云获取设备名称：

shelly:
  cloud_auth_key: "你的认证密钥"
  cloud_server: "你的服务器地址"

或者，如果你想禁用发现功能并手动指定设置，你可能需要更详细的配置块。

MQTT配置（可选）

若选择MQTT支持，配置将包括在configuration.yaml中指定MQTT服务器信息：

shelly:
  mqtt_server_host: "192.168.1.100"
  mqtt_server_port: "1883"
  mqtt_server_username: "your_username"
  mqtt_server_password: "your_password"

请注意，具体配置需根据实际环境调整。一旦配置完成，重启Home Assistant以应用更改。通过这种方式，Home Assistant就能识别并集成所有的Shelly设备，无需手动干预每个设备的配置。

ShellyForHASS Shelly smart home platform for Home Assistant 项目地址: https://gitcode.com/gh_mirrors/sh/ShellyForHASS