Mushroom项目技术文档

Mushroom项目技术文档

lovelace-mushroom Mushroom Cards - Build a beautiful dashboard easily 🍄 项目地址: https://gitcode.com/gh_mirrors/lo/lovelace-mushroom

---

安装指南

使用HACS安装

1. 若您的Home Assistant环境中尚未集成HACS（Home Assistant Community Store），请先完成HACS的安装。
2. 进入Home Assistant界面后，打开HACS应用。
3. 导航至“前端”分类。
4. 点击加号图标进行搜索。
5. 输入“Mushroom”，找到对应插件并选择安装。

手动安装

1. 访问Mushroom项目的[最新发布页面][release-url]下载mushroom.js文件。
2. 将下载的mushroom.js上传到您Home Assistant配置目录下的www文件夹内。
3. 配置您的仪表板以引入此文件。有两种方法：
   • 通过UI界面: 进入仪表板设置 → 更多选项 → 资源 → 添加资源，设定Url为/local/mushroom.js，类型选为JavaScript Module。若未看到资源菜单，需要在您的用户资料中启用“高级模式”。
   • 通过YAML配置: 在您的configuration.yaml文件的lovelace部分添加以下代码：

     resources:
       - url: /local/mushroom.js
         type: module
     

---

项目使用说明

Mushroom插件为Home Assistant的Dashboard提供了一系列易于使用的卡片组件，无须直接编辑YAML文件，支持全图形界面配置。每一张自定义的Mushroom卡都可以通过Home Assistant的Dashboard编辑器来配置：

1. 在Dashboard界面点击右上角的三个点，选择“编辑仪表板”。
2. 点击添加新卡片的加号按钮，在列表中找到各类“Custom: Mushroom”卡片。

可用卡片类型

• 🚨 报警控制面板卡片
• 🔔 芯片显示卡片
• 🌡 气候控制卡片
• 🪟 遮阳帘控制卡片
• 🪄 实体显示卡片
• 💨 风扇控制卡片
• 💧 加湿器控制卡片
• 💡 灯光控制卡片
• 🔒 锁定控制卡片
• 📺 媒体播放器卡片
• 🔢 数值调整卡片
• 🙋 人员状态卡片
• 📑 选项选择卡片
• 🛠 模板卡片
• ✏️ 标题显示卡片
• 📦 更新信息卡片
• 🧹 吸尘器控制卡片

主题定制

Mushroom可无主题使用，但推荐搭配[Mushroom Themes][theme-url]增强视觉体验。欲了解更多主题定制详情，请参考Home Assistant官方文档中的主题部分。

---

API使用文档

Mushroom本身不公开传统意义上的API接口供外部调用，其功能主要通过Home Assistant的前端界面交互实现。对于想要扩展或自动化控制Mushroom卡片的行为，建议利用Home Assistant的自动化系统与模板语言。

---

项目安装方式（重复内容，已包含于安装指南）

安装指引已在上述“安装指南”部分详细说明，包括了通过HACS自动安装以及手动下载配置的步骤。

---

请注意，本文档基于提供的Readme内容编制，具体操作时请确保遵循当时的项目最新指南和版本更新。[theme-url]应替换为实际的主题插件链接，但在Markdown中没有提供该链接的具体URL，因此保留了变量形式。

lovelace-mushroom Mushroom Cards - Build a beautiful dashboard easily 🍄 项目地址: https://gitcode.com/gh_mirrors/lo/lovelace-mushroom