开源项目 homebridge-mi-acpartner 使用教程

开源项目 homebridge-mi-acpartner 使用教程

homebridge-mi-acpartnerXiaoMi AC Partner plugins for HomeBridge(https://github.com/nfarina/homebridge).项目地址:https://gitcode.com/gh_mirrors/ho/homebridge-mi-acpartner

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

homebridge-mi-acpartner/
├── LICENSE
├── README.md
├── config-sample.json
├── index.js
├── package.json
└── lib/
    ├── miio/
    │   ├── device.js
    │   ├── miio-device.js
    │   └── miio-manager.js
    └── plugin.js

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• config-sample.json: 配置文件示例。
• index.js: 项目入口文件。
• package.json: 项目依赖和元数据。
• lib/: 项目库文件夹。
  • miio/: 小米设备通信库。
    • device.js: 设备抽象类。
    • miio-device.js: 小米设备类。
    • miio-manager.js: 设备管理类。
  • plugin.js: 插件主逻辑文件。

2. 项目的启动文件介绍

index.js 是项目的入口文件，负责初始化和启动插件。主要功能包括：

• 导入必要的模块。
• 读取配置文件。
• 初始化小米设备管理器。
• 注册Homebridge插件。

const HomebridgePluginUiServer = require('@homebridge/plugin-ui-utils').PluginUiServer;
const MiioManager = require('./lib/miio/miio-manager');
const Plugin = require('./lib/plugin');

let miioManager = new MiioManager();
let plugin = new Plugin(miioManager);

module.exports = (homebridge) => {
  homebridge.registerPlatform('homebridge-mi-acpartner', 'MiAcPartner', plugin, true);
};

3. 项目的配置文件介绍

config-sample.json 是配置文件的示例，用户需要根据实际情况进行修改。主要配置项包括：

• platform: 插件平台名称。
• name: 插件名称。
• devices: 设备列表，每个设备包含以下信息：
  • name: 设备名称。
  • ip: 设备IP地址。
  • token: 设备访问令牌。

{
  "platform": "homebridge-mi-acpartner",
  "name": "MiAcPartner",
  "devices": [
    {
      "name": "卧室空调伴侣",
      "ip": "192.168.1.100",
      "token": "1234567890abcdef1234567890abcdef"
    }
  ]
}

用户需要将此文件复制为 config.json 并放置在 Homebridge 的配置目录中，根据实际设备信息进行修改。

homebridge-mi-acpartnerXiaoMi AC Partner plugins for HomeBridge(https://github.com/nfarina/homebridge).项目地址:https://gitcode.com/gh_mirrors/ho/homebridge-mi-acpartner