Moonraker Home Assistant 项目教程

Moonraker Home Assistant 项目教程

moonraker-home-assistantHome Assistant integration for Moonraker, Klipper and Mainsail项目地址:https://gitcode.com/gh_mirrors/mo/moonraker-home-assistant

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

moonraker-home-assistant/
├── .github/
│   └── workflows/
├── custom_components/
│   └── moonraker/
│       ├── __init__.py
│       ├── config_flow.py
│       ├── const.py
│       ├── manifest.json
│       ├── sensor.py
│       ├── services.yaml
│       └── translations/
├── docs/
│   └── index.md
├── .gitignore
├── LICENSE
├── README.md
└── requirements.txt

• .github/workflows/: 包含GitHub Actions的工作流配置文件。
• custom_components/moonraker/: 核心代码目录，包含所有与Moonraker Home Assistant集成相关的文件。
  • init.py: 初始化文件。
  • config_flow.py: 配置流程处理文件。
  • const.py: 常量定义文件。
  • manifest.json: 项目元数据文件。
  • sensor.py: 传感器相关处理文件。
  • services.yaml: 服务定义文件。
  • translations/: 多语言支持文件夹。
• docs/: 文档目录，包含项目的文档文件。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• requirements.txt: 项目依赖文件。

2. 项目的启动文件介绍

项目的启动文件主要是custom_components/moonraker/__init__.py。这个文件负责初始化集成，并注册必要的组件和服务。

# custom_components/moonraker/__init__.py

import logging
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant

_LOGGER = logging.getLogger(__name__)

async def async_setup(hass: HomeAssistant, config: dict):
    """Set up the Moonraker component."""
    hass.data.setdefault("moonraker", {})
    return True

async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
    """Set up Moonraker from a config entry."""
    hass.data["moonraker"][entry.entry_id] = entry.data
    hass.async_create_task(
        hass.config_entries.async_forward_entry_setup(entry, "sensor")
    )
    return True

async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry):
    """Unload a config entry."""
    unload_ok = await hass.config_entries.async_forward_entry_unload(entry, "sensor")
    if unload_ok:
        hass.data["moonraker"].pop(entry.entry_id)
    return unload_ok

3. 项目的配置文件介绍

项目的配置文件主要是custom_components/moonraker/manifest.json。这个文件包含了项目的基本信息和依赖项。

{
  "domain": "moonraker",
  "name": "Moonraker Home Assistant",
  "documentation": "https://github.com/marcolivierarsenault/moonraker-home-assistant",
  "dependencies": [],
  "codeowners": ["@marcolivierarsenault"],
  "requirements": ["moonraker-api==0.1.0"],
  "version": "1.3.3"
}

• domain: 集成的域名。
• name: 集成的名称。
• documentation: 项目文档的链接。
• dependencies: 依赖的其他集成。
• codeowners: 项目的维护者。
• requirements: 项目所需的Python包。
• version: 项目的版本号。

以上是Moonraker Home Assistant项目的目录结构、启动文件和配置文件的介绍。希望这份文档能帮助你更好地理解和使用该项目。

moonraker-home-assistantHome Assistant integration for Moonraker, Klipper and Mainsail项目地址:https://gitcode.com/gh_mirrors/mo/moonraker-home-assistant