小米空调伴侣开源项目使用教程

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

xiaomi_airconditioningcompanion/
├── custom_components/
│   └── xiaomi_miio_airconditioningcompanion/
│       ├── __init__.py
│       ├── climate.py
│       ├── fan.py
│       ├── manifest.json
│       └── services.yaml
├── .gitignore
├── LICENSE
├── README.md
└── requirements.txt

• custom_components/xiaomi_miio_airconditioningcompanion/: 包含项目的核心代码文件。
  • __init__.py: 初始化文件。
  • climate.py: 处理空调相关的逻辑。
  • fan.py: 处理风扇相关的逻辑。
  • manifest.json: 项目的元数据文件。
  • services.yaml: 定义服务配置。
• .gitignore: Git忽略文件列表。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。

2. 项目的启动文件介绍

项目的启动文件主要是 custom_components/xiaomi_miio_airconditioningcompanion/__init__.py。该文件负责初始化组件，并加载其他模块。

# __init__.py 文件内容示例
from homeassistant.const import CONF_HOST, CONF_TOKEN
from homeassistant.helpers.discovery import load_platform

DOMAIN = 'xiaomi_miio_airconditioningcompanion'

def setup(hass, config):
    host = config[DOMAIN][CONF_HOST]
    token = config[DOMAIN][CONF_TOKEN]
    # 加载其他平台
    load_platform(hass, 'climate', DOMAIN, {CONF_HOST: host, CONF_TOKEN: token}, config)
    return True

3. 项目的配置文件介绍

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

manifest.json

{
  "domain": "xiaomi_miio_airconditioningcompanion",
  "name": "Xiaomi Mi and Aqara Air Conditioning Companion",
  "documentation": "https://github.com/syssi/xiaomi_airconditioningcompanion",
  "dependencies": [],
  "codeowners": ["@syssi"],
  "requirements": ["python-miio>=0.5.3"]
}

• domain: 组件的域名。
• name: 组件的名称。
• documentation: 文档链接。
• dependencies: 依赖的其他组件。
• codeowners: 代码维护者。
• requirements: 依赖的Python包。

services.yaml

climate_learn_command:
  description: Capture an infrared command
  fields:
    entity_id:
      description: Only act on a specific Xiaomi miIO fan entity
      example: fan.xiaomi_miio_airconditioningcompanion
    slot:
      description: Storage slot
      default: 30
    timeout:
      description: Capturing timeout
      default: 10

climate_send_command:
  description: Send captured infrared command or device configuration
  fields:
    entity_id:
      description: Only act on a specific Xiaomi miIO fan entity
      example: fan.xiaomi_miio_airconditioningcompanion
    command:
      description: Infrared command
      example: FE01...

• climate_learn_command: 学习红外命令的服务。
• climate_send_command: 发送红外命令的服务。

以上是小米空调伴侣开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。