Xiaomi Mi Air Purifier Homebridge 插件项目启动与配置教程

1. 项目目录结构及介绍

Xiaomi Mi Air Purifier Homebridge 插件项目的目录结构如下：

• .github/: 存放与 GitHub 相关的配置文件。
• .husky/: 用于配置 Husky，一个用于在提交代码前执行任务（如测试、构建等）的工具。
• .vscode/: Visual Studio Code 编辑器的配置文件。
• src/: 源代码目录，包含插件的主要逻辑。
• eslintrc: ESLint 配置文件，用于规范 JavaScript 代码风格。
• .eslintignore: ESLint 忽略文件，用于指定不进行代码风格检查的文件或目录。
• .gitignore: Git 忽略文件，用于指定不提交到 Git 仓库的文件或目录。
• .npmignore: npm 忽略文件，用于指定不包含在 npm 包中的文件或目录。
• .prettierrc.json: Prettier 配置文件，用于统一代码格式。
• .prettierignore: Prettier 忽略文件，用于指定不进行格式化的文件或目录。
• config.schema.json: 配置文件架构，用于定义插件的配置选项。
• nodemon.json: nodemon 配置文件，用于指定 nodemon 的启动行为。
• package-lock.json: npm 包锁定文件，用于确保安装的依赖版本保持一致。
• package.json: npm 包配置文件，定义了插件的名称、版本、依赖等。
• tsconfig.json: TypeScript 配置文件，用于指定 TypeScript 编译器的选项。
• LICENSE: Apache-2.0 许可证文件，描述了软件的使用和分发条款。
• README.md: 项目说明文件，包含了项目的介绍、安装、配置和使用指南。

2. 项目的启动文件介绍

项目的启动主要是通过 npm 来执行。在项目根目录下，你可以运行以下命令来安装依赖并启动项目：

npm install
npm start

npm install 命令会根据 package.json 文件中定义的依赖安装所有必要的包。npm start 命令通常指向 package.json 中的 scripts 部分的启动脚本，该脚本会启动 Homebridge 服务，并加载 Xiaomi Mi Air Purifier 插件。

3. 项目的配置文件介绍

项目的配置主要通过 config.json 文件进行。此文件位于 Homebridge 的主配置目录中，通常位于 ~/.homebridge/ 路径下。以下是一个示例配置：

{
  "accessories": [
    {
      "name": "Air Purifier",
      "address": "<YOUR_DEVICE_IP_ADDRESS>",
      "token": "<YOUR_DEVICE_TOKEN>",
      "enableAirQuality": true,
      "enableTemperature": true,
      "enableHumidity": true,
      "filterChangeThreshold": 5,
      "enableFanSpeedControl": true,
      "enableChildLockControl": true,
      "accessory": "XiaomiMiAirPurifier"
    }
  ]
}

在这里，你需要替换 <YOUR_DEVICE_IP_ADDRESS> 和 <YOUR_DEVICE_TOKEN> 为你的小米空气净化器的 IP 地址和从 Xiaomi Cloud Tokens Extractor 获取的令牌。

• name: 设备名称，用于在 HomeKit 中识别。
• address: 设备的 IP 地址。
• token: 用于验证设备身份的令牌。
• enableAirQuality: 是否启用空气质量传感器。
• enableTemperature: 是否启用温度传感器。
• enableHumidity: 是否启用湿度传感器。
• filterChangeThreshold: 过滤器更换阈值。
• enableFanSpeedControl: 是否启用风扇速度控制。
• enableChildLockControl: 是否启用儿童锁控制。
• accessory: 指定使用的小米空气净化器插件。

完成配置后，重启 Homebridge 服务，你的小米空气净化器就应该可以在 HomeKit 中使用了。