StreamDeck Home Assistant 插件使用教程

StreamDeck Home Assistant 插件使用教程

项目地址:https://gitcode.com/gh_mirrors/st/streamdeck-homeassistant

项目目录结构及介绍

StreamDeck Home Assistant 插件的目录结构如下：

streamdeck-homeassistant/
├── README.md
├── LICENSE
├── src/
│   ├── main.js
│   ├── config.js
│   ├── entities/
│   │   ├── switches.js
│   │   ├── lights.js
│   │   ├── input_boolean.js
│   │   ├── binary_sensors.js
│   │   ├── plugs.js
│   │   ├── temperature.js
│   │   ├── humidity.js
│   │   ├── pressure.js
│   │   ├── power.js
│   │   ├── voltage.js
│   │   ├── battery_level.js
│   │   ├── weather.js
│   │   ├── vacuum_robots.js
│   └── utils/
│       ├── helpers.js
│       ├── constants.js
├── package.json
├── package-lock.json
└── streamdeck-plugin.sdplugin

目录结构说明

• README.md: 项目说明文档。
• LICENSE: 项目许可证文件。
• src/: 源代码目录。
  • main.js: 项目启动文件。
  • config.js: 配置文件。
  • entities/: 实体处理相关文件。
  • utils/: 工具函数和常量定义。
• package.json: 项目依赖和脚本配置。
• package-lock.json: 依赖锁定文件。
• streamdeck-plugin.sdplugin: 插件安装文件。

项目的启动文件介绍

main.js

main.js 是 StreamDeck Home Assistant 插件的启动文件，负责初始化插件并连接到 Home Assistant 服务器。主要功能包括：

• 读取配置文件。
• 建立与 Home Assistant 的 WebSocket 连接。
• 处理实体状态更新和按钮事件。

项目的配置文件介绍

config.js

config.js 是 StreamDeck Home Assistant 插件的配置文件，包含全局设置和实体设置。主要配置项包括：

• Home Assistant Settings:

  • Server URL: Home Assistant 服务器的 URL，例如 ws://192.126.0.5:8123/api/websocket。
  • Access Token: 从 Home Assistant 获取的长效访问令牌。

• Entity Settings:

  • 每个按钮的特定设置，包括实体 ID、显示模板和触发服务等。

通过这些配置，用户可以自定义每个按钮的行为和显示内容，实现对 Home Assistant 设备的控制。

---

以上是 StreamDeck Home Assistant 插件的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

streamdeck-homeassistant Control your Home Assistant devices from StreamDeck 项目地址: https://gitcode.com/gh_mirrors/st/streamdeck-homeassistant