iPhoneDetect 项目使用教程

iPhoneDetect 项目使用教程

iphonedetectA custom component for Home Assistant to detect iPhones connected to local LAN, even if the phone is in deep sleep.项目地址:https://gitcode.com/gh_mirrors/ip/iphonedetect

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

iPhoneDetect 是一个用于 Home Assistant 的自定义组件，用于检测连接到本地局域网的 iPhone，即使在深度睡眠状态下也能检测到。以下是项目的目录结构及其介绍：

iphonedetect/
├── custom_components/
│   └── iphonedetect/
│       ├── __init__.py
│       ├── device_tracker.py
│       └── manifest.json
├── .github/
│   └── workflows/
│       └── ...
├── .gitignore
├── LICENSE
├── README.md
├── hacs.json
└── info.md

• custom_components/iphonedetect/: 包含 iPhoneDetect 组件的核心文件。
  • __init__.py: 组件的初始化文件。
  • device_tracker.py: 设备追踪的主要逻辑文件。
  • manifest.json: 组件的元数据文件。
• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的许可证文件。
• README.md: 项目的主文档文件。
• hacs.json: HACS（Home Assistant Community Store）的配置文件。
• info.md: 项目的额外信息文件。

2. 项目的启动文件介绍

iPhoneDetect 组件的启动文件是 custom_components/iphonedetect/__init__.py。这个文件负责初始化组件并加载必要的配置。以下是该文件的主要功能：

• 导入必要的模块和库。
• 定义组件的配置和初始化逻辑。
• 注册设备追踪服务。

3. 项目的配置文件介绍

iPhoneDetect 组件的配置文件是 custom_components/iphonedetect/manifest.json。这个文件包含了组件的元数据，如名称、版本、依赖等。以下是一个示例配置文件的内容：

{
  "domain": "iphonedetect",
  "name": "iPhone Detect",
  "documentation": "https://github.com/mudape/iphonedetect",
  "dependencies": [],
  "codeowners": ["@mudape"],
  "requirements": [],
  "version": "1.0.0"
}

• domain: 组件的域名。
• name: 组件的名称。
• documentation: 组件的文档链接。
• dependencies: 组件的依赖项。
• codeowners: 组件的代码维护者。
• requirements: 组件的依赖库。
• version: 组件的版本号。

此外，用户需要在 Home Assistant 的 configuration.yaml 文件中添加以下配置来启用 iPhoneDetect 组件：

device_tracker:
  - platform: iphonedetect
    consider_home: 60
    scan_interval: 12
    new_device_defaults:
      track_new_devices: true
    hosts:
      hostname1: 192.168.0.17
      hostname2: 192.168.0.24

• platform: 指定使用的设备追踪平台。
• consider_home: 设备被标记为离家的延迟时间。
• scan_interval: 扫描间隔时间。
• new_device_defaults: 新设备的默认设置。
• hosts: 要追踪的设备及其 IP 地址。

以上是 iPhoneDetect 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助您更好地理解和使用该项目。

iphonedetectA custom component for Home Assistant to detect iPhones connected to local LAN, even if the phone is in deep sleep.项目地址:https://gitcode.com/gh_mirrors/ip/iphonedetect