PyLoxone 项目使用教程

PyLoxone 项目使用教程

PyLoxone Python Loxone binding 项目地址: https://gitcode.com/gh_mirrors/py/PyLoxone

1. 项目目录结构及介绍

PyLoxone 项目的目录结构如下：

PyLoxone/
├── custom_components/
│   └── loxone/
│       ├── __init__.py
│       ├── api.py
│       ├── config_flow.py
│       ├── const.py
│       ├── entity.py
│       ├── helpers.py
│       ├── __pycache__/
│       └── services.py
├── images/
│   └── loxone_logo.png
├── .gitignore
├── LICENSE
├── README.md
└── hacs.json

目录结构介绍

• custom_components/loxone/: 包含与 Loxone 集成的核心代码文件。

  • __init__.py: 初始化文件。
  • api.py: 与 Loxone API 交互的代码。
  • config_flow.py: 配置流程处理文件。
  • const.py: 常量定义文件。
  • entity.py: 实体类定义文件。
  • helpers.py: 辅助函数文件。
  • services.py: 服务定义文件。
  • __pycache__/: Python 编译后的缓存文件。

• images/: 包含项目相关的图片文件。

  • loxone_logo.png: Loxone 的标志图片。

• .gitignore: Git 忽略文件配置。

• LICENSE: 项目许可证文件。

• README.md: 项目说明文件。

• hacs.json: HACS (Home Assistant Community Store) 配置文件。

2. 项目启动文件介绍

PyLoxone 项目的主要启动文件是 custom_components/loxone/__init__.py。该文件负责初始化 Loxone 集成，并注册相关的服务和实体。

__init__.py 文件介绍

• 初始化集成: 该文件首先导入必要的模块和常量，然后定义了 Loxone 集成的初始化逻辑。
• 注册服务: 文件中还定义了与 Loxone 相关的服务，如 event_websocket_command，用于通过 WebSocket 发送命令到 Loxone 系统。
• 实体注册: 该文件还负责注册 Loxone 相关的实体，如传感器、开关等。

3. 项目的配置文件介绍

PyLoxone 项目的配置文件主要包括 hacs.json 和 custom_components/loxone/const.py。

hacs.json 文件介绍

hacs.json 文件是 HACS 的配置文件，用于定义项目的元数据和安装信息。

{
  "name": "PyLoxone",
  "render_readme": true,
  "homeassistant": "2024.1.0"
}

• name: 项目名称。
• render_readme: 是否渲染 README.md 文件。
• homeassistant: 支持的 Home Assistant 版本。

const.py 文件介绍

const.py 文件定义了项目中使用的常量。

DOMAIN = "loxone"
CONF_UUID = "uuid"
CONF_USERNAME = "username"
CONF_PASSWORD = "password"

• DOMAIN: 定义了 Loxone 集成的域名。
• CONF_UUID: 定义了 UUID 配置项。
• CONF_USERNAME: 定义了用户名配置项。
• CONF_PASSWORD: 定义了密码配置项。

这些配置项在项目的其他部分（如 config_flow.py 和 api.py）中被引用，用于配置和连接 Loxone 系统。

PyLoxone Python Loxone binding 项目地址: https://gitcode.com/gh_mirrors/py/PyLoxone