Homebridge-Dafang 项目使用教程

Homebridge-Dafang 项目使用教程

homebridge-dafang Homebridge Plugin for Xiaomi Dafang / Wyze Cam IP Camera => Hey Siri, Start Video Recording 项目地址: https://gitcode.com/gh_mirrors/ho/homebridge-dafang

1. 项目目录结构及介绍

Homebridge-Dafang 项目是一个用于Homebridge平台的插件，它允许用户将小米Dafang或Wyze Cam IP摄像头集成到HomeKit生态系统中。以下是项目的目录结构及文件介绍：

homebridge-dafang/
├── .circleci/              # CircleCI 持续集成配置文件
├── .github/                # GitHub 工作流和模板文件
├── assets/                 # 资源文件，如图片等
├── src/                    # 源代码目录
├── videos/                 # 视频示例文件
├── .eslintrc.json          # ESLint 配置文件
├── .gitignore              # Git 忽略文件
├── .npmignore              # npm 忽略文件
├── CODE_OF_CONDUCT.md      # 项目行为准则
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目说明文件
├── Setup_MQTT.md           # MQTT 配置指南
├── config-sample.json      # 配置文件示例
├── demo-advanced.gif       # 高级功能演示 GIF
├── demo-rich-not.gif       # 丰富通知演示 GIF
├── demo-simple.gif         # 简单演示 GIF
├── index.js                # 项目入口文件
├── package-lock.json       # npm 包锁定文件
└── package.json            # npm 包配置文件

2. 项目的启动文件介绍

项目的启动文件是 index.js。该文件负责初始化Homebridge插件，并注册相关的设备配件。以下是启动文件的简要说明：

// 引入必要的Node.js模块和Homebridge相关模块
const { hap } = require('homebridge');
const fetch = require('node-fetch');

// 定义Homebridge平台的配件
class DafangPlatformAccessory {
  constructor(log, config) {
    this.log = log;
    this.config = config;
    // 初始化配件的其他属性
  }

  // Homebridge 生命周期钩子，用于启动时执行的操作
  accessories(callback) {
    // 添加配件到Homebridge
    callback();
  }
}

// 注册Homebridge平台
module.exports = (homebridge) => {
  homebridge.registerPlatform('homebridge-dafang', 'Dafang', DafangPlatformAccessory);
};

3. 项目的配置文件介绍

项目的配置文件是 config-sample.json，该文件提供了如何配置Homebridge-Dafang插件的示例。以下是配置文件的简要说明：

{
  "platform": "Dafang",
  "mqtt": {
    "hostBroker": true,
    "port": 1883,
    "host": "localhost",
    "debug": true,
    "mongoUrl": "mongodb://localhost:27017/mqtt"
  },
  "cameras": [
    {
      "cameraName": "My Dafang",
      "cameraRTSPStreamUrl": "rtsp://192.168.1.12:8554/unicast",
      "mqttTopic": "myhome/dafang/#",
      "folder": "/Users/sahilchaddha/Sahil/Recordings/",
      // 其他相机配置项
      "accessories": [
        // 配置配件，如运动传感器、夜视传感器等
      ]
    }
  ]
}

配置文件中包括MQTT设置、摄像头列表及其相关配置，如RTSP流URL、MQTT主题、保存录制的目录等。用户需要根据自己的实际情况修改示例配置文件，并重命名为 config.json 以供Homebridge使用。

homebridge-dafang Homebridge Plugin for Xiaomi Dafang / Wyze Cam IP Camera => Hey Siri, Start Video Recording 项目地址: https://gitcode.com/gh_mirrors/ho/homebridge-dafang