Home Assistant Minimalistic Area Card 使用与安装指南
1. 项目目录结构及介绍
本项目位于 GitHub 上,提供了一个简洁风格的区域卡片用于Home Assistant的仪表板。下面是对项目主要目录结构的概述:
devcontainer
: 这个目录包含了VS Code的开发容器配置,用于设置一个标准化的开发环境。docs
: 文档相关的资料存放位置,虽然在这个引用中没有详细列出内部文件,通常会包括教程或API参考。elements
,rollup-plugins
,src
: 这些目录分别用于存放自定义元素、Rollup插件和源代码,是实现卡片功能的核心部分。.eslintrc.js
,.gitignore
,.prettierrc.js
,LICENSE
,README.md
,hacs.json
,package.json
,rollup.config.{dev,js}
,tsconfig.json
,yarn.lock
: 这些文件涵盖了项目的基本配置、依赖管理、代码规范检查、打包配置等,对于开发者而言是关键的。
2. 项目的启动文件介绍
虽然此项目主要是为Home Assistant设计的一个定制卡片,其本身并不直接运行一个独立的应用程序,因此没有传统意义上的“启动文件”。然而,开发这个卡片时,主要关注点在于src
目录下的 TypeScript 或 JavaScript 文件,这些是卡片逻辑的实现。要“启动”或测试这个卡片,您需要在Home Assistant环境中集成它,并通过HACS(Home Assistant Community Store)或者手动方式添加到您的配置中。
3. 项目的配置文件介绍
集成到Home Assistant的配置
为了在Home Assistant中使用这个卡片,你需要在你的配置中的某个仪表盘yaml文件内添加以下示例配置:
type: custom:minimalistic-area-card
title: 客厅
image: /local/img/living-room.jpg # 可选,图像路径或URL
area: living_room # 区域ID,按需设置
entities:
- entity: switch.fireplace_on_off
tap_action: action: toggle
- entity: cover.window_covering
tap_action: {action: toggle}
- entity: media_player.speaker
- entity: light.living_room_lamp
- entity: sensor.hallway_humidity
- entity: sensor.hallway_temperature
注意事项:
custom:minimalistic-area-card
指定了卡片类型,这是一个自定义卡片,需要先确保已通过HACS或手动方式安装。- 实体列表 (
entities
) 中每个实体都可以根据需要配置tap_action来决定点击行为。 - 图像路径可以是本地路径(如
/local/img/living-room.jpg
)或绝对URL。
通过以上步骤和配置,您可以成功地将这个简洁的区域卡片添加至您的Home Assistant界面,以美观且直观的方式展示家中的不同区域状态。