Home Assistant 自定义电池状态卡使用手册
欢迎来到 battery-state-card
的使用手册,该项目由 maxwroc 开发,旨在为 Home Assistant 提供一个高级且可定制的电池状态展示卡片。
1. 目录结构及介绍
这个GitHub仓库的结构遵循了简单的布局,便于开发者和用户理解其组件:
battery-state-card/
├── README.md # 主要的说明文档,包含了项目的简介和快速指南。
├── src # 源代码目录,存放核心功能实现的JavaScript文件。
│ ├── battery-state-card.js # 核心自定义卡片代码。
├── dist # 编译后的产出目录,包含可以直接在Home Assistant中使用的文件。
├── package.json # Node.js 项目配置文件,定义依赖和脚本命令。
├── test # 测试文件夹,包含自动化测试代码。
├── .gitignore # Git版本控制忽略文件列表。
└── ... # 可能包括其他配置或辅助文件。
2. 项目的启动文件介绍
主要关注的启动(或核心)文件是位于 src/battery-state-card.js
。这是自定义卡片的核心实现部分,负责处理所有的逻辑,如电池状态的显示、个性化设置的应用等。用户不需要直接操作此文件来使用该卡片;而是通过Home Assistant的Lovelace界面或者配置文件添加引用。
3. 项目的配置文件介绍
集成到Home Assistant
配置此卡片并不直接涉及到修改仓库内的配置文件,而是通过Home Assistant的前端配置完成。以下是基本的集成步骤和示例配置:
在Lovelace UI中手动添加
首先,将编译后的卡片文件添加至Home Assistant的资源:
lovelace:
resources:
- url: http://[你的Home Assistant IP]:5501/dist/battery-state-card.js
type: module
之后,在您的Lovelace视图中添加卡片实例:
type: custom:battery-state-card
title: "电池状态"
entities:
- sensor.battery_example_1
- entity: sensor.battery_example_2
name: "Example Sensor 2"
multiplier: 10
配置选项详解
title
: 卡片的标题。entities
: 列表,每个元素指定一个电池相关的实体,可以附加额外的属性如name
,multiplier
等。bulk_rename
: 允许你按规则批量重命名多个传感器的名称。- 还支持更多的定制选项,如颜色阈值、自动过滤和显示充电状态等,详细配置请参考项目文档或源码中的注释。
通过这种方式,您无需深入项目内部的源码细节,即可享受高度定制化的电池状态显示功能于Home Assistant之中。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考