Home Assistant Flightradar24 项目使用教程

1. 项目目录结构及介绍

home-assistant-flightradar24/
├── custom_components/
│   └── flightradar24/
│       ├── __init__.py
│       ├── manifest.json
│       ├── sensor.py
│       └── services.yaml
├── README.md
└── requirements.txt

目录结构说明

• custom_components/: 该目录包含了自定义组件，用于扩展 Home Assistant 的功能。
  • flightradar24/: 这是 Flightradar24 组件的目录。
    • init.py: 初始化文件，通常用于定义组件的基本信息。
    • manifest.json: 组件的元数据文件，包含组件的名称、版本、依赖等信息。
    • sensor.py: 传感器实现文件，用于从 Flightradar24 API 获取数据并将其显示在 Home Assistant 中。
    • services.yaml: 定义了组件提供的服务。
• README.md: 项目的说明文档，包含项目的介绍、安装步骤、使用方法等。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目启动文件介绍

项目的启动文件主要是 sensor.py，该文件负责从 Flightradar24 API 获取飞行数据，并将其作为传感器数据提供给 Home Assistant。

sensor.py 文件功能

• 数据获取: 通过 Flightradar24 API 获取飞行数据。
• 数据处理: 将获取的数据转换为 Home Assistant 可以识别的传感器数据格式。
• 数据更新: 定期更新传感器数据，确保数据的实时性。

3. 项目配置文件介绍

项目的配置文件主要是 manifest.json 和 services.yaml。

manifest.json

{
  "domain": "flightradar24",
  "name": "Flightradar24",
  "documentation": "https://github.com/AlexandrErohin/home-assistant-flightradar24",
  "dependencies": [],
  "codeowners": ["@AlexandrErohin"],
  "requirements": ["flightradar24==1.0.0"]
}

配置项说明

• domain: 组件的唯一标识符。
• name: 组件的名称。
• documentation: 组件的文档链接。
• dependencies: 组件依赖的其他组件或库。
• codeowners: 组件的维护者。
• requirements: 组件依赖的 Python 包。

services.yaml

flightradar24_update:
  description: 更新 Flightradar24 数据
  fields:
    entity_id:
      description: 要更新的实体 ID
      example: sensor.flightradar24_sensor

配置项说明

• flightradar24_update: 定义了一个服务，用于手动触发 Flightradar24 数据的更新。
  • description: 服务的描述。
  • fields: 服务的参数。
    • entity_id: 要更新的传感器实体 ID。

通过以上配置，用户可以在 Home Assistant 中使用 Flightradar24 组件，获取实时的飞行数据。