Python-yeelight 项目启动与配置教程

Python-yeelight 项目启动与配置教程

python-yeelight A Python library for controlling YeeLight WiFi RGB bulbs (mirror of https://gitlab.com/stavros/python-yeelight). 项目地址: https://gitcode.com/gh_mirrors/py/python-yeelight

一、项目目录结构及介绍

Python-yeelight 项目是一个用于控制 YeeLight WiFi RGB LED 灯泡的 Python 库。项目的目录结构如下：

python-yeelight/
├── docs/                   # 项目文档
├── yeelight/               # 核心代码模块
├── .editorconfig            # 编辑器配置文件
├── .gitchangelog.rc         # Git 日志配置文件
├── .gitignore              # Git 忽略文件
├── .gitlab-ci.yml          # GitLab CI/CD 配置文件
├── .pre-commit-config.yaml # pre-commit 配置文件
├── CHANGELOG               # 更改日志
├── LICENSE                 # 许可证文件
├── MANIFEST.in             # 打包文件列表
├── README.rst              # 项目介绍文档
├── flit.ini                # flit 打包配置文件
├── requirements_dev.txt    # 开发环境依赖文件
├── setup.cfg               # setuptools 配置文件
├── setup.py                # setuptools 打包脚本
└── tox.ini                 # tox 测试配置文件

• docs/：存放项目的文档资料。
• yeelight/：包含项目的核心代码，如灯泡控制逻辑等。
• .editorconfig：用于定义项目的编辑器配置，以确保不同开发者的编辑器设置保持一致。
• .gitchangelog.rc：配置 Git 日志的格式。
• .gitignore：指定 Git 忽略的文件和目录，以防止敏感信息或不必要的文件被提交。
• .gitlab-ci.yml：定义 GitLab CI/CD 的流程。
• .pre-commit-config.yaml：pre-commit 配置文件，用于在提交前自动运行一些固定的脚本，如代码格式化、检查等。
• CHANGELOG：记录项目的历史更新和更改。
• LICENSE：项目的许可证信息，本项目采用 BSD 许可证。
• MANIFEST.in：指定打包时需要包含的文件。
• README.rst：项目的介绍文档。
• flit.ini：flit 打包工具的配置文件。
• requirements_dev.txt：列出项目开发所需的依赖。
• setup.cfg：setuptools 的配置文件。
• setup.py：setuptools 的打包脚本。
• tox.ini：tox 测试工具的配置文件。

二、项目的启动文件介绍

项目的启动主要依赖于 yeelight 模块中的 Bulb 类。以下是一个简单的启动示例：

from yeelight import Bulb

# 实例化一个灯泡对象，IP 地址替换为实际灯泡的 IP
bulb = Bulb("192.168.0.5")

# 开启灯泡
bulb.turn_on()

要运行上述代码，你需要确保灯泡处于开发模式，通常这可以通过 YeeLight 应用程序来完成。

三、项目的配置文件介绍

项目的配置主要通过以下文件进行：

• .editorconfig：配置编辑器的代码风格，例如缩进、换行符等。
• .pre-commit-config.yaml：配置 pre-commit 钩子，这些钩子会在代码提交前自动执行，如代码格式化、静态代码分析等。
• requirements_dev.txt：列出项目开发环境所需的依赖库。

确保在开发环境中安装了所有必需的依赖项，可以使用以下命令：

pip install -r requirements_dev.txt

安装完成后，可以运行 pre-commit 钩子以确保代码风格符合项目要求：

pre-commit install

之后，每次提交代码前，pre-commit 钩子都会自动运行。如果需要手动运行钩子，可以使用以下命令：

pre-commit run -a

以上是关于 Python-yeelight 项目的启动和配置的基本介绍。按照这些步骤，你就可以开始使用这个库来控制你的 YeeLight 灯泡了。

python-yeelight A Python library for controlling YeeLight WiFi RGB bulbs (mirror of https://gitlab.com/stavros/python-yeelight). 项目地址: https://gitcode.com/gh_mirrors/py/python-yeelight