Bring new life to Home Assistant with Floorplan. By mapping entities to SVG images, you’re able to show states, control devices, call services - and much more. Use your own custom styles to visualize whatever you can think of. Your imagination became the new limit.

And remember: Although it’s typically used to represent the floorplan of your home, you can use Floorplan for anything. A music box? No problem. A Ring doorbell? Bring it on. A remote control for your legacy TV with IR control? Yep, that can be done, too.


Quick Start

Are you ready to begin? Check our Quick Start guide now!

Let's start!

Check our examples

It’s always easier to start, with a good amount of examples. So, go get them!

Let's get inspired?

Usage

There’s plenty of options, including long-click, so what are you waiting for?

Let's deep dive!

Please join our Discussion area, if you need any help, feedback or any kind of other support, too. We’re also on the Home Assistant’s Community - but it’s way better to join the discussion on GitHub.

Kindly use it for general usage questions, too. Do you have a good idea for Floorplan, or have you faced an issue with the current solution? Create an issue, and remember to provide as much detail as possible. We’ll do our best to help you out.

First steps

First of all, check out the Quick Start guide guide. You’ll get an idea of what Floorplan can do, and how to use it with a basic setup.

If you’d like to see interactive examples, head on over to the Examples page.

Are you searching for a specific feature? Please take a look at the Usage page. You’ll see how to use triggers, actions, and more advanced stuff. We’ll do our best to keep it up to date.

If you’re not ready to initiate it on your own. What about testing it? Below you’ll find a working example of ha-floorplan.


See it in action

Here's a real world example of how to use ha-floorplan, with a background created with Floorplanner. This is just a simple example of how to get started. Use a combination of YAML, CSS and JavaScript to get the most out of it, or take a look at the examples to get inspired.

Find more details on the Floorplanner Home-example page.


Posts

Here’s the latest posts about ha-floorplan, shared here in our documentation.

Documentation for ha-floorplan!

less than 1 minute read

Wuhuu!🥳 Welcome to the official documentation for ha-floorplan. We hope you’ll find it usefull, while playing around with our custom module for Home Assistan...

We won’t post that often, but sometime it’s fine to see things created in the past. Right?

Feedback

Floorplan has been created for you, but we can’t make everyone happy at once. If you have feedback for Floorplan, please create an issue, or join the discussion. We’ll do our best to assist you.