README.md

April 12, 2025 · View on GitHub



ha-floorplan

Floorplan for Home Assistant - your imagination (almost) defines the limits

GitHub Build & Test on Master GitHub Issues GitHub Pull Requests GitHub Stars Current version HACS Default repository - Go to Quick Start in Docs

• Floorplan Documentation • Discussion (Ask for help, feedback & support) • Home Assistant Community •

Tip

For the best experience, we highly recommend installing ha-floorplan through HACS. Alternatively, you can download the latest version directly from the Releases page, where the floorplan.js file is also available as an asset.

SVG Preview

Draw it and bring it to life

This tool expands way beyond creating just floorplans. If you can draw it in an SVG file, you can bring it to life with ha-floorplan. Explore endless possibilities and customize your home automation experience to your liking.

Getting started

We'll suggest you to visit our Installation guide.

If you're unsure on where to start in the creation process, we'll suggest you to check our Live Examples.

Find more documentation on how to use each action and functions, by visiting the Usage page.

Features

  • Make Floorplan(s) based on SVG-files
  • Trigger states, visualize states and more
  • Call services and more, for even more options
  • Use as Lovelace-card, or as a panel
  • It's hard to mention everything in a list like this, so give it a try 🥳

Resource template for Home Assistant

resources:
  - url: /hacsfiles/ha-floorplan/floorplan.js
    type: module


Would you like to play around with the code behind HA Floorplan? There's many ways to build HA Floorplan. The question is, what you're going to do?

Just execute npm install to install the dependencies. Use npm run build for the production-env. Are you going to test something, use npm run build:dev instead. For other options, check package.json. Use npm run start to serve our example-suite. Testing can be done with npm run test.