hub / github.com/ExperienceLovelace/ha-floorplan

github.com/ExperienceLovelace/ha-floorplan @v1.1.6

Chat with this repo

repository ↗ · DeepWiki ↗ · release v1.1.6 ↗ · + Follow

528 symbols 892 edges 64 files 9 documented · 2%

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

ha-floorplan

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

<a href="https://github.com/ExperienceLovelace/ha-floorplan/commits/master" target="_blank">
<img src="https://github.com/ExperienceLovelace/ha-floorplan/actions/workflows/merge-to-master.yaml/badge.svg?branch=master&style=flat-square&logo=github&logoColor=white"
     alt="GitHub Build & Test on Master">
     </a>
<a href="https://github.com/ExperienceLovelace/ha-floorplan/issues" target="_blank">
<img src="https://img.shields.io/github/issues-raw/ExperienceLovelace/ha-floorplan.svg?style=flat-square&logo=github&logoColor=white"
     alt="GitHub Issues">
     </a>
<a href="https://github.com/ExperienceLovelace/ha-floorplan/pulls" target="_blank">
<img src="https://img.shields.io/github/issues-pr-raw/ExperienceLovelace/ha-floorplan.svg?style=flat-square&logo=github&logoColor=white"
     alt="GitHub Pull Requests">
     </a>
<a href="https://github.com/ExperienceLovelace/ha-floorplan/releases" target="_blank">
<img src="https://img.shields.io/github/stars/ExperienceLovelace/ha-floorplan?style=flat-square"
     alt="GitHub Stars">
     </a>
<a href="https://github.com/ExperienceLovelace/ha-floorplan/releases" target="_blank">
<img src="https://img.shields.io/github/v/release/ExperienceLovelace/ha-floorplan.svg?style=flat-square&logo=github&logoColor=white"
     alt="Current version">
     </a>
<a href="https://experiencelovelace.github.io/ha-floorplan/docs/quick-start/#hacs" target="_blank">
<img src="https://img.shields.io/badge/HACS-Default-orange.svg?style=flat-square&logoColor=white"
     alt="HACS Default repository - Go to Quick Start in Docs">
     </a>







•

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.

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](https://github.com/ExperienceLovelace/ha-floorplan/blob/master/package.json). Use `npm run start` to serve our example-suite. Testing can be done with `npm run test`.

Extension points exported contracts — how you extend this code

LovelaceCard (Interface)

(no doc) [4 implementers]

src/lib/homeassistant/panels/lovelace/types.ts

FloorplanExample (Interface)

(no doc)

src/components/floorplan-examples/types.ts

LovelaceViewElement (Interface)

(no doc) [2 implementers]

src/lib/homeassistant/data/lovelace.ts

HassSimulatorConfig (Interface)

(no doc)

src/components/floorplan-examples/types.ts

LovelaceBadge (Interface)

(no doc) [2 implementers]

src/lib/homeassistant/panels/lovelace/types.ts

HassSimulation (Interface)

(no doc)

src/components/floorplan-examples/types.ts

LovelaceHeaderFooter (Interface)

(no doc) [2 implementers]

src/lib/homeassistant/panels/lovelace/types.ts

TimedHassEntity (Interface)

(no doc)

src/components/floorplan-examples/types.ts

Core symbols most depended-on inside this repo

retry

called by 53

tests/jest/jest-common-utils.ts

createFloorplanExampleElement

called by 42

tests/jest/jest-floorplan-utils.ts

getFloorplanElement

called by 31

tests/jest/jest-floorplan-utils.ts

getFloorplanSvg

called by 28

tests/jest/jest-floorplan-utils.ts

logError

called by 18

src/components/floorplan/floorplan-element.ts

callWS

called by 18

src/lib/homeassistant/types.ts

log

called by 17

src/components/floorplan/lib/logger.ts

evaluate

called by 11

src/components/floorplan/floorplan-element.ts

Shape

Method 194

Interface 190

Class 78

Function 65

Enum 1

Languages

TypeScript100%

Modules by API surface

src/components/floorplan/floorplan-element.ts79 symbols

src/lib/homeassistant/lovelace/types.ts45 symbols

src/lib/homeassistant/data/lovelace.ts45 symbols

src/lib/homeassistant/panels/lovelace/cards/types.ts36 symbols

src/lib/homeassistant/types.ts29 symbols

src/lib/utils.ts26 symbols

src/components/floorplan/lib/floorplan-config.ts22 symbols

src/lib/homeassistant/panels/lovelace/types.ts21 symbols

src/lib/homeassistant/panels/lovelace/entity-rows/types.ts15 symbols

src/components/floorplan/lib/floorplan-info.ts15 symbols

src/lib/homeassistant/panels/lovelace/editor/types.ts13 symbols

src/components/floorplan/lib/oui-dom-events.js13 symbols

For agents

$ claude mcp add ha-floorplan \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact