ha-floorplan 开源项目指南

项目介绍

欢迎来到 ha-floorplan 的官方指导文档，这个项目专为Home Assistant设计，旨在通过SVG文件的强大功能扩展你的家庭自动化想象边界。通过YAML、CSS和JavaScript的结合，或从丰富的示例中汲取灵感，你可以创造几乎无限的自定义家庭布局体验。无论是作为Lovelace卡片还是面板集成，ha-floorplan让你通过可视化状态、触发服务调用等，将平面图带入生活。项目基于Apache-2.0许可协议，鼓励社区参与，共同探索个性化智能家居的新维度。

快速启动

要快速启动并运行ha-floorplan，首先确保你已经配置好了Home Assistant环境。接下来，遵循以下步骤：

安装及配置

1. 访问GitHub仓库:https://github.com/ExperienceLovelace/ha-floorplan，点击“Releases”页面以获取最新版本。

2. 下载最新的发布包，或者直接在HACS（Home Assistant Community Store）中添加此组件（如果你已设置HACS）。

3. 将下载的资源文件放置于Home Assistant指定的定制化资源目录下，如custom_components 或按照特定配置路径。

4. 编辑Home Assistant的配置文件，加入以下代码以启用作为面板的ha-floorplan:

   panel_custom:
     - name: floorplan
       sidebar_title: 地板计划
       sidebar_icon: mdi:home
       url_path: floorplan
       config: include floorplan.yaml
   

5. 创建或更新floorplan.yaml配置文件，指明实体显示和样式规则，例如:

   # 示例配置
   name: 我的家庭布局
   entities:
     - entity: light.living_room_light
       icon: mdi:lightbulb-on
       styles:
         on:
           color: "#FFFFFF"
         off:
           color: "#AAAAAA"
   

6. 保存配置后，重启Home Assistant以使更改生效。

应用案例和最佳实践

• 远程控制界面: 利用ha-floorplan，可以创建一个直观的界面来集中控制家居照明、安防系统等。
• 现代布局风格: 实现现代感十足的地板布局，通过JavaScript动态交互提升用户体验。
• 场景模拟: 设定不同的场景模式（如“回家”、“离家”），一键管理多个设备状态。

典型生态项目

虽然ha-floorplan本身是作为一个独立的项目存在，但它紧密融入Home Assistant生态系统，可以与众多自定义组件和插件协同工作。比如，与automation配合实现基于位置的变化自动调整布局显示，或是结合scene组件让家庭状态一键切换，充分展示家居自动化的力量。

此简要指南旨在快速引导您入门ha-floorplan，深入探索和高级定制请参考官方GitHub仓库中的详细文档和示例。快乐地自动化您的家居吧！