← All articlesGETTING STARTED · 5 STEPS

Getting Started with HAFloorplan

HAFloorplan turns the devices you place on your floor plan into a native Home Assistant picture-elements card. You do not need to hand-write the YAML. This guide takes you from the editor to a working dashboard card using the current Light/Switch MVP.

1. Open the HAFloorplan editor

Choose Open Editor and work in the visual floor-plan editor. Your rooms define the floor plan, and devices are placed where you want their Home Assistant controls to appear.

Current HAFloorplan editor showing the floor-plan canvas, device controls, and inspector
The current HAFloorplan editor. Build or import the floor plan, then add or select the Light or Power Plug you want to configure.

2. Enter the Title and Home Assistant Entity ID

Select the Light or Power Plug on the floor plan. In the device inspector, enter a friendly Title and the exact Entity ID you identified before starting. These are the two required values for the current MVP.

HAFloorplan device inspector showing the Title and Home Assistant Entity ID fields
Configure the selected device using the Title and Home Assistant Entity ID fields shown in the current inspector.

The Entity ID is the critical connection to Home Assistant. HAFloorplan handles the normal Picture Elements control structure for you, so you do not need to write the Lovelace action YAML yourself.

3. Export for Home Assistant and copy the YAML

Open the editor Actions menu and choose Export for Home Assistant. HAFloorplan checks the project and opens the export screen with the generated Picture Elements configuration.

HAFloorplan Actions menu with Export for Home Assistant available
Use Actions → Export for Home Assistant after the device has a Title and Entity ID.

On the export screen, click Copy YAML to Clipboard. Copy the complete generated configuration; there is no need to select individual YAML sections.

HAFloorplan Home Assistant export screen with generated YAML and Copy YAML to Clipboard control
The Home Assistant export screen is the handoff point: copy the complete generated YAML to the clipboard.

4. Create a Panel view and paste the YAML in Home Assistant

In Home Assistant, edit the dashboard where you want the floor plan and create a view configured as Panel. A Panel view lets one card use the dashboard view as its primary full-width surface, which is the intended layout for this floor-plan workflow.

Home Assistant dashboard view configuration showing the Panel layout option
Configure the Home Assistant dashboard view as Panel before adding the HAFloorplan card.

Add any card as a temporary starting card. Open that card's menu, choose Show code editor, replace the card configuration with the complete YAML copied from HAFloorplan, and save.

Home Assistant card editor showing Show code editor and the YAML editing area
Switch the temporary card to Show code editor, paste the complete HAFloorplan YAML, then save the card.

Treat the generated YAML as the complete card configuration for this MVP path. You should not need to understand or edit the generated Picture Elements structure.

5. Verify the rendered floor plan

After saving, Home Assistant should render the floor plan as a Picture Elements card. The Light or Switch appears at the location you placed it in HAFloorplan. Tap the entity control and verify that it operates the Home Assistant entity you mapped.

Home Assistant dashboard showing the completed HAFloorplan Picture Elements floor-plan card
Success: the generated floor plan is rendered in Home Assistant with the mapped device controls positioned on the floor plan.

You are done

Your Home Assistant dashboard now contains a native Picture Elements floor-plan card generated by HAFloorplan. The important connection is the Entity ID: HAFloorplan handles the YAML structure and places the Home Assistant control at the position you selected.