Hassio-Plejd 开源项目启动与配置教程

1. 项目的目录结构及介绍

Hassio-Plejd 项目目录结构如下所示：

hassio-plejd/
├── .github/              # GitHub 相关配置文件
│   └── workflows/        # GitHub Actions 工作流
├── .gitignore            # Git 忽略文件
├── Dockerfile            # Docker 构建文件
├── README.md             # 项目说明文件
├── requirements.txt      # 项目依赖文件
├── manifest.json         # Hass.io 插件清单文件
├── Plejd.py              # Plejd 设备控制核心逻辑
└── sensors/              # 传感器模块
    ├── binary_sensor.py  # 二进制传感器实现
    ├── sensor.py         # 传感器基础类

目录说明：

• .github/: 包含 GitHub 相关配置文件，如 Actions 工作流。
• .gitignore: 指定 Git 忽略的文件和目录。
• Dockerfile: 用于构建 Docker 容器的文件。
• README.md: 项目的基本介绍和说明。
• requirements.txt: 项目所需的 Python 依赖。
• manifest.json: 定义 Hass.io 插件的元数据和配置。
• Plejd.py: 实现与 Plejd 设备通信的核心逻辑。
• sensors/: 包含传感器相关的模块和类。

2. 项目的启动文件介绍

项目的启动主要通过 Dockerfile 文件实现。以下是 Dockerfile 的主要内容：

# 使用 Python 3.8 官方镜像作为基础镜像
FROM python:3.8

# 设置工作目录
WORKDIR /usr/src/app

# 将项目文件复制到容器中
COPY . .

# 安装项目依赖
RUN pip install --no-cache-dir -r requirements.txt

# 将启动脚本添加到容器中并赋予执行权限
COPY entrypoint.sh /usr/src/app/
RUN chmod +x /usr/src/app/entrypoint.sh

# 暴露 Home Assistant API 使用的端口
EXPOSE 8123

# 启动容器时执行的命令
CMD ["./entrypoint.sh"]

entrypoint.sh 脚本用于启动 Home Assistant 实例。

3. 项目的配置文件介绍

项目的配置主要通过 manifest.json 文件进行。以下是 manifest.json 的主要配置：

{
  "name": "Plejd",
  "version": "0.1.0",
  "description": "A Home Assistant add-on for Plejd.",
  "author": "icanos",
  "url": "https://github.com/icanos/hassio-plejd",
  "type": "integration",
  "repo": "https://github.com/icanos/hassio-plejd",
  "image": "icanos/hassio-plejd",
  " architectures": ["armhf", "aarch64", "i386", "amd64"],
  "container_type": "docker",
  "state": "beta",
  "discovery": {
    "on": ["start", "restart"]
  },
  "config": {
    "options": {
      "token": {
        "name": "Plejd Token",
        "description": "Your Plejd Token to authenticate with Plejd API.",
        "type": "string",
        "required": true
      }
    }
  }
}

配置说明：

• name, version, description, author, url: 插件的基本信息。
• type: 插件的类型，这里是 integration。
• repo: 插件的 GitHub 仓库地址。
• image: 用于创建容器的基础镜像名。
• architectures: 支持的硬件架构。
• container_type: 容器类型，这里是 docker。
• state: 插件的当前状态，这里是 beta。
• discovery: 启动或重启时自动发现的配置。
• config: 插件的配置选项，这里有一个 token 选项，用于认证与 Plejd API 的连接。