Understanding the Installation Folder Requirement

Oct 13, 2025 by talynt.org 126 views

After Installing HA-Floorplan via HACS: Understanding the Installation Folder Requirement

As a Home Assistant (HA) user, you may have encountered the need to use the installation folder for your HA-Floorplan files after installing it via HACS. In this article, we will delve into the reasons behind this requirement and provide a step-by-step guide on how to configure HA-Floorplan correctly.

What is HA-Floorplan?

HA-Floorplan is a custom component for Home Assistant that allows you to create interactive floor plans with various features, such as text elements, entities, and onclick behaviors. It is a powerful tool for visualizing your home's layout and interacting with your smart devices.

Installing HA-Floorplan via HACS

To install HA-Floorplan via HACS, follow these steps:

Open the HACS repository in your Home Assistant instance.
Search for "HA-Floorplan" and click on the result.
Click on the "Install" button to install the component.

Understanding the Installation Folder Requirement

After installing HA-Floorplan via HACS, the component is installed in the /config/www/community/ha-floorplan directory. This directory contains the necessary files for HA-Floorplan, including the floorplan.js and floorplan.js.gz files.

Configuring HA-Floorplan

To configure HA-Floorplan, you need to create a home.yaml file in the installation folder. This file contains the configuration settings for HA-Floorplan, including the image, stylesheet, and cache settings.

Creating a Dashboard

To create a dashboard for HA-Floorplan, follow these steps:

Open the settings menu in your Home Assistant instance.
Click on "Dashboards" and then "Add Dashboard".
Select the "Default Dashboard" template and click on "Create".
Click on the pencil icon in the header and select "Take Control".
In the popup, select "Start with an empty dashboard" and click on "Take Control".
Open the raw configuration editor and replace the content with the following code:

views:
  - title: Home
    config:
      show_side_bar: false
      show_app_header: false
    type: sidebar
    cards:
      - type: custom:floorplan-card
        full_height: true
        config: /local/community/ha-floorplan/home.yaml

Why Use the Installation Folder?

As mentioned earlier, the installation folder is required for HA-Floorplan to work correctly. This is because the component uses the floorplan.js and floorplan.js.gz files, which are located in the installation folder.

Troubleshooting

If you encounter issues with HA-Floorplan, make sure to check the following:

The home.yaml file is located in the installation folder.
The floorplan.js and floorplan.js.gz files are present in the installation folder.
The dashboard configuration is correct.

Conclusion

In conclusion, using the installation folder for HA-Floorplan is a requirement for the component to work correctly. By following the steps outlined in this article, you should be able to configure HA-Floorplan and create a dashboard for your interactive floor plan.

Future Improvements

As a beginner-friendly community, we encourage you to contribute to the documentation and provide feedback on how to improve the installation and configuration process for HA-Floorplan. Some suggested improvements include:

Creating a step-by-step guide for installing HA-Floorplan via HACS.
Providing a simple example of how to create a dashboard for HA-Floorplan.
Documenting how to use text elements, entities, and onclick behaviors in HA-Floorplan.
Explaining how to style text in the SVG file using Inkscape.
Providing a guide on how to draw the floor plan and add features such as lights, open doors, and open windows.

We hope this article has been helpful in understanding the installation folder requirement for HA-Floorplan. If you have any further questions or need assistance, please don't hesitate to ask.
HA-Floorplan Q&A: Frequently Asked Questions and Answers

As a Home Assistant (HA) user, you may have questions about HA-Floorplan, a custom component for creating interactive floor plans. In this article, we will address some of the most frequently asked questions about HA-Floorplan.

Q: What is HA-Floorplan?

A: HA-Floorplan is a custom component for Home Assistant that allows you to create interactive floor plans with various features, such as text elements, entities, and onclick behaviors.

Q: How do I install HA-Floorplan?

A: To install HA-Floorplan, follow these steps:

Open the HACS repository in your Home Assistant instance.
Search for "HA-Floorplan" and click on the result.
Click on the "Install" button to install the component.

Q: Where are the HA-Floorplan files located?

A: After installing HA-Floorplan via HACS, the component is installed in the /config/www/community/ha-floorplan directory. This directory contains the necessary files for HA-Floorplan, including the floorplan.js and floorplan.js.gz files.

Q: Why do I need to use the installation folder for my HA-Floorplan files?

A: You need to use the installation folder because the component uses the floorplan.js and floorplan.js.gz files, which are located in the installation folder.

Q: How do I configure HA-Floorplan?

A: To configure HA-Floorplan, you need to create a home.yaml file in the installation folder. This file contains the configuration settings for HA-Floorplan, including the image, stylesheet, and cache settings.

Q: How do I create a dashboard for HA-Floorplan?

A: To create a dashboard for HA-Floorplan, follow these steps:

Open the settings menu in your Home Assistant instance.
Click on "Dashboards" and then "Add Dashboard".
Select the "Default Dashboard" template and click on "Create".
Click on the pencil icon in the header and select "Take Control".
In the popup, select "Start with an empty dashboard" and click on "Take Control".
Open the raw configuration editor and replace the content with the following code:

views:
  - title: Home
    config:
      show_side_bar: false
      show_app_header: false
    type: sidebar
    cards:
      - type: custom:floorplan-card
        full_height: true
        config: /local/community/ha-floorplan/home.yaml

Q: What is the difference between /config/www/community/ha-floorplan and /local/community/ha-floorplan?

A: /config/www/community/ha-floorplan is the installation folder, while /local/community/ha-floorplan is a symbolic link to the installation folder. You need to use the symbolic link to reference the installation folder in your configuration files.

Q: How do I troubleshoot issues with HA-Floorplan?

A: To troubleshoot issues with HA-Floorplan, make sure to check the following:

The home.yaml file is located in the installation folder.
The floorplan.js and floorplan.js.gz files are present in the installation folder.
The dashboard configuration is correct.

Q: Can I use HA-Floorplan with other custom components?

A: Yes, you can use HA-Floorplan with other custom components. However, you need to ensure that the components are compatible with each other and with HA-Floorplan.

Q: How do I update HA-Floorplan?

A: To update HA-Floorplan, follow these steps:

Open the HACS repository in your Home Assistant instance.
Search for "HA-Floorplan" and click on the result.
Click on the "Update" button to update the component.

We hope this Q&A article has been helpful in addressing some of the most frequently asked questions about HA-Floorplan. If you have any further questions or need assistance, please don't hesitate to ask.