Quick Start (Home Edition)

Welcome to Zircon3D Home Edition This guide walks you through the essential steps to get Zircon3D running with your Home Assistant setup and create your first 3D floorplan.

1. Create Your Zircon3D Account

Go to app.zircon3d.com and sign in with your Google account.
After signing in, you can manage your access tokens and licenses.

Continue: Create Your Account

2. Install the Zircon3D Add-on in Home Assistant

1. Open Home Assistant
2. Go to Settings → Add-ons → Add-on Store
3. Click ⋮ → Repositories, add: https://github.com/lichr-inc/ha-zircon3d-repo 
4. Install Zircon3D HA Proxy
5. Start the add-on

Video tutorial: https://youtu.be/3b5FyLn3hFE 

Continue: Install Zircon3D Add-on

3. Activate Your Add-on (Access Token)

1. In the Zircon3D web app, go to Account → Tokens
2. Copy your Access Token
3. Paste it in the add-on UI
4. Click Activate

Continue: Activate Add-on

4. Create Your First Floorplan

Once connected:

1. Open the Designer
2. Create a new Project
3. Draw floors, rooms, and walls
4. Place objects such as sensors, lights, and appliances

Continue: Create First Project

5. Visualize Your Data

• Create dashboards (gauges, trends, device cards)
• Add heatmap layers (temperature, humidity, Wi-Fi)
• View live updates in your 3D floorplan

Continue: Visualize Data

6. Advanced Views & Home Assistant Dashboard

• Try Block View
• Try Replay Mode
• Embed your Zircon3D view into your Home Assistant dashboard using an iframe card

Continue: Advanced Views

You’re all set!
Next, follow each section for a deeper explanation.