Home Assistant Floor Plan 项目教程

Home Assistant Floor Plan 项目教程

home-assistant-floor-planHome Assistant Floor Plan Generator Plugin For Sweet Home 3D项目地址:https://gitcode.com/gh_mirrors/ho/home-assistant-floor-plan

1. 项目的目录结构及介绍

home-assistant-floor-plan/
├── README.md
├── floorplan.py
├── config/
│   ├── example_config.yaml
│   └── custom_components/
│       └── floorplan/
│           ├── __init__.py
│           └── manifest.json
└── static/
    └── images/
        └── example_floorplan.png

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• floorplan.py: 项目的主启动文件，负责加载和运行地板图界面。
• config/: 配置文件目录，包含示例配置文件和自定义组件。
  • example_config.yaml: 示例配置文件，展示了如何配置地板图。
  • custom_components/floorplan/: 自定义组件目录，包含地板图组件的实现。
    • init.py: 自定义组件的初始化文件。
    • manifest.json: 自定义组件的清单文件，包含组件的元数据。
• static/images/: 静态资源目录，包含地板图的图片文件。
  • example_floorplan.png: 示例地板图图片。

2. 项目的启动文件介绍

floorplan.py 是项目的启动文件，负责初始化和运行地板图界面。该文件主要包含以下功能：

• 加载配置文件。
• 初始化地板图界面。
• 监听Home Assistant的状态变化，并更新地板图。

3. 项目的配置文件介绍

config/example_config.yaml 是项目的示例配置文件，展示了如何配置地板图。主要包含以下配置项：

• floorplan_image: 地板图的图片路径。
• entities: 需要显示在地板图上的实体列表，每个实体包含以下属性：
  • entity_id: 实体的ID。
  • x: 实体在地板图上的X坐标。
  • y: 实体在地板图上的Y坐标。
  • icon: 实体在地板图上显示的图标。

示例配置文件内容如下：

floorplan_image: /local/floorplan.png
entities:
  - entity_id: light.living_room
    x: 100
    y: 200
    icon: mdi:lightbulb
  - entity_id: switch.kitchen
    x: 300
    y: 400
    icon: mdi:switch

通过以上配置，可以在地板图上显示指定位置的实体，并根据实体的状态更新图标。

home-assistant-floor-planHome Assistant Floor Plan Generator Plugin For Sweet Home 3D项目地址:https://gitcode.com/gh_mirrors/ho/home-assistant-floor-plan