Spoolman Home Assistant 集成安装与配置指南

Spoolman Home Assistant 集成安装与配置指南

1. 项目基础介绍

Spoolman Home Assistant 集成是一个开源项目，它可以将 Spoolman 服务集成到 Home Assistant 家庭自动化系统中。通过这个集成，用户可以监控和管理他们的 3D 打印丝材卷，例如追踪消耗量以及在丝材快要用完时接收通知。该项目主要使用 Python 编程语言。

2. 关键技术和框架

该项目使用了以下关键技术和框架：

• Home Assistant: 一个流行的开源家庭自动化平台，用于控制和监控家中的智能设备。
• Spoolman: 一个用于追踪和管理 3D 打印丝材卷的 API 服务。
• REST API: 项目通过 REST API 与 Spoolman 服务进行通信。
• Python: 作为主要的编程语言，用于编写集成代码和处理数据。

3. 安装和配置准备工作

在开始安装之前，请确保您已经满足了以下先决条件：

• Home Assistant 系统已安装并运行。
• HACS (Home Assistant Community Store) 已在 Home Assistant 中安装。
• 您有一个运行中的 Spoolman 实例，并知道其 URL。

安装步骤

以下是详细的安装步骤：

步骤 1: 添加自定义存储库

1. 打开 Home Assistant 的 HACS 面板。
2. 导航到 “存储库” 部分。
3. 点击 “添加存储库” 按钮并选择 “通过 URL 添加”。
4. 输入以下 URL 并点击 “添加”：

   https://github.com/Disane87/spoolman-homeassistant
   

步骤 2: 安装集成

1. 在 HACS 面板中，找到刚才添加的 Spoolman Home Assistant 集成。
2. 点击集成的安装按钮。
3. 安装完成后，刷新页面，您应该能够在 Home Assistant 的集成列表中看到 Spoolman。

步骤 3: 配置集成

1. 在 Home Assistant 的配置文件中，添加 Spoolman 集成的配置。您需要提供 Spoolman 实例的 URL，如下所示：

   spoolman:
     url: 'http://your_spoolman_instance_url:port'
   

2. 保存配置并重新加载 Home Assistant。

步骤 4: 添加和配置传感器

1. 在 Home Assistant 中添加一个新的自动化或使用现有的自动化，以根据 Spoolman 数据创建传感器。
2. 使用以下模板配置传感器，将 your_spoolman_instance_url:port 替换为您的 Spoolman 实例的 URL：

   - platform: http
     name: "Spoolman Spool #1"
     url: http://your_spoolman_instance_url:port/spool/1
     state_topic: state topic
     availability_topic: availability topic
     json_attributes_topic: attributes topic
   

3. 根据需要调整传感器的名称、URL 以及主题。

完成以上步骤后，您应该能够在 Home Assistant 中看到 Spoolman 集成，并且可以开始监控您的 3D 打印丝材卷了。