About

Story

The first version of Floorplan for Home Assistant dates back to 2017. The project was developed by Petar Kožul based on earlier work done using SVG files for home automation. With the ermergence of Lovelace in HA, Petar added support for running ha-floorplan as a Lovelace card. The old Lovelace version was called lovelace-floorplan. Tobias Nordahl Kristensen joined the ha-floorplan project during a period where not much development was taking place on the project. After contributing a huge pull request, lovelace-floorplan was finally able to support HACS. What Tobias didn’t know, was that Petar had already commenced a complete rewrite of the code, this time using TypeScript. The intention was to improve performance, add new features, and bring Floorplan to a whole new level.

We (Petar and Tobias) moved lovelace-floorplan to a new team called ExperienceLovelace. After a few weeks of testing and improvements to the new code base, we finally released the first version of the new ha-floorplan (Yep, that’s the current one).

Your imagination (almost) defines the limits

With ha-floorplan, we finally have a module which allows you to create tons of things. Create an SVG, and map entities to it.

The primary usage is floorplans, but you’re able to create whatever you need. You’re able to import a normal image to an SVG file, so it’s possible to do many things with it. Therefore, kindly head over to our examples area if you’re ready to see ha-floorplan in action.

Get help along the way

If you’re struggling to get started, please check our examples, Quick Start guide and more. After reading the docs, we’d like to introduce you to our discussion area on GitHub. Here you’re more than welcome to ask for help. If you’d like to contribute to the project, feel free to create pull requests and issues in the main repo. If you like the Home Assistant Community, come join us, too.

About the docs

Our docs are generated by Jekyll, and powered by the Minimal Mistakes (GitHub) theme. There’s plenty of ways of doing formatting (GitHub), and the helpers, layouts and utility classes are all awesome. Minimal Mistakes can be used free of charge, and can be posted with GitHub Pages - like our docs. We’d just like to give a big shout-out to Michael Rose, for a great Jekyll theme. Thanks!

Not sponsored - disclaimer

There are no sponsors for ha-floorplan, and that’s totally fine with us. We’d just like to point that we may be recommending software which will require a few bucks, if you’re searching for the best result. Recommendations towards paid or freemium services are done, cause we like those. All links to services like these, are marked with a Not sponsored disclaimer.