ZHA Quirks 项目使用教程

ZHA Quirks 项目使用教程

zha_quirksAll quirks in one place项目地址:https://gitcode.com/gh_mirrors/zh/zha_quirks

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

zha_quirks/
├── README.md
├── setup.py
├── zha_quirks/
│   ├── __init__.py
│   ├── quirk.py
│   ├── device_registry.py
│   ├── clusters/
│   │   ├── __init__.py
│   │   ├── basic.py
│   │   ├── on_off.py
│   │   └── ...
│   └── devices/
│       ├── __init__.py
│       ├── smart_plug.py
│       ├── light.py
│       └── ...
└── tests/
    ├── __init__.py
    ├── test_quirk.py
    └── ...

• README.md: 项目介绍和使用说明。
• setup.py: 项目安装脚本。
• zha_quirks/: 核心代码目录。
  • __init__.py: 模块初始化文件。
  • quirk.py: 定义Quirk类的文件。
  • device_registry.py: 设备注册表文件。
  • clusters/: 集群定义目录。
    • __init__.py: 集群模块初始化文件。
    • basic.py: 基本集群定义。
    • on_off.py: 开关集群定义。
    • ...
  • devices/: 设备定义目录。
    • __init__.py: 设备模块初始化文件。
    • smart_plug.py: 智能插座设备定义。
    • light.py: 灯光设备定义。
    • ...
• tests/: 测试代码目录。
  • __init__.py: 测试模块初始化文件。
  • test_quirk.py: Quirk测试文件。
  • ...

2. 项目的启动文件介绍

项目的启动文件是 zha_quirks/__init__.py，该文件负责初始化整个模块，并导入必要的子模块和类。

# zha_quirks/__init__.py

from .quirk import Quirk
from .device_registry import DeviceRegistry
from .clusters import *
from .devices import *

__all__ = ['Quirk', 'DeviceRegistry']

3. 项目的配置文件介绍

项目的配置文件通常是 setup.py，该文件定义了项目的元数据和依赖项，用于安装和分发项目。

# setup.py

from setuptools import setup, find_packages

setup(
    name='zha_quirks',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        'zigpy>=0.1.0',
        'homeassistant>=0.110.0'
    ],
    author='Jacek',
    author_email='jacek@example.com',
    description='ZHA Quirks for Home Assistant',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    url='https://github.com/jacekk015/zha_quirks',
    classifiers=[
        'Programming Language :: Python :: 3',
        'License :: OSI Approved :: MIT License',
        'Operating System :: OS Independent',
    ],
    python_requires='>=3.6',
)

以上是 zha_quirks 项目的基本使用教程，包括项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

zha_quirksAll quirks in one place项目地址:https://gitcode.com/gh_mirrors/zh/zha_quirks