neonplan3d README

The project's README from github.com/Mastershort/neonplan3d. As one markdown file: README.md.

NeonPlan 3D

Spenden mit PayPal

by Mastershort – draw your home right inside Home Assistant and control it in a neon 3D view: lights glow in their colours, blinds move, doors and windows open, cameras watch, and the TV shows what is playing. No external tools, no cloud, made for wall tablets.

▶️ Try the online demo – right in your browser, with invented demo data: turn the house, switch lights, open the editor. Nothing to install.

Open your Home Assistant instance and open the NeonPlan 3D repository inside HACS.

NeonPlan 3D: the house turns, the view flies into the ground floor, lights go off and on, then the kitchen with its room panel

📖 Manual: English · Deutsch (also in this repository: manual.md, anleitung.md)

What it does
Editor Plan editor in Home Assistant – floors, rooms as rectangles or free shapes, automatic walls and free-standing partitions, doors, windows, garage doors, stairs and floor openings, outdoor areas and a roof. The 3D view runs next to the plan while you draw.
Room Live 3D view – tap a lamp to switch it, swipe to dim, long press for colours; blinds follow their position, windows tilt and open, doors swing. A room panel lists everything of the room's area.
Library Furniture and lamps – 40 built-in models plus furniture packs. Lamps light their room in their own colour, TVs, washing machines and radiators glow while they run.
Camera Cameras – mounted on walls or ceilings with their field of view on the floor, red while they see motion; a tap shows the snapshot.
Alerts Wall tablet ready – warnings for smoke, gas, water, alarm and windows open in the rain, a kiosk mode with idle return and night dimming, scene buttons, and a Tablet quality level for Fire tablets.
Card Dashboard card – custom:neonplan3d-card with a visual editor, loaded automatically.

Also included: parking spots with vehicles that appear while a car is home, a heatmap for temperature, humidity and CO₂, sunlight through the windows from sun.sun, three looks (Neon, Blueprint, Day), a search, restore points, and a full backup of plan, pictures and packs.

Free, packs and Pro add-ons

The integration and everything above are free and open source (MIT). Optional extras are sold at mastershort.de and install from the Extensions tab:

Bought packs are signed for your installation and update by themselves once a day. Everything installed keeps working without the shop.

Installation

HACS

Open your Home Assistant instance and open the NeonPlan 3D repository inside HACS.

  1. Click the button above, or in HACS: ⋮ → Custom repositories → add https://github.com/Mastershort/neonplan3d as Integration.

  2. Install NeonPlan 3D and restart Home Assistant.

  3. Add the integration:

    Open your Home Assistant instance and start setting up NeonPlan 3D.

    or Settings → Devices & services → Add integration → NeonPlan 3D.

  4. Open NeonPlan 3D in the sidebar, switch to Editor and draw your first floor.

Manual

Copy custom_components/neonplan3d into config/custom_components/ and restart Home Assistant.

Requires Home Assistant 2025.1 or newer.

Dashboard card

All options can be set in the card's visual editor; in YAML:

type: custom:neonplan3d-card
floor: floor_ab12cd34   # optional: show a single floor (id from the editor)
height: 420             # optional: height in pixels
fill: false             # optional: fill the screen below the dashboard header instead of a height
walls: auto             # optional: auto | cut
explode: true           # optional: pull floors apart in the house view
floor_stack: dim        # optional: floors below an opened floor: dim | stacked | single
quality: auto           # optional: auto | low | high
theme: neon             # optional: neon | blueprint | day
markers: important      # optional: none | important | all
heatmap: none           # optional: none | temperature | humidity | co2
room_panel: true        # optional: tapping a room opens its details
room_names: true        # optional: room names in 3D
controls: true          # optional: switches in the card, or a list of walls, floors, temperature, humidity, co2
floor_thumbs: true      # optional: floor pictures to switch floors
fullscreen_button: false
stats: false            # optional: performance display
alerts: true            # optional: smoke, gas, CO, water, alarm and windows open in the rain pulse
alert_jump: false       # optional: jump to the room of a new warning
scenes: true            # optional: scene and script buttons of the selected room
motion_trail: false     # optional: motion of the last 30 minutes (Pro: camera cockpit)
weather: true           # optional: weather outside (Pro: weather)
weather_entity: weather.home   # optional: which weather entity (default: as set in the plan)
idle_return: 0          # optional: kiosk – seconds without a touch until the start view returns
night: "off"            # optional: kiosk – dim at night: off | sun | "22:00-06:00"
idle_orbit: false       # optional: kiosk – slow camera turn after the idle return

Privacy

NeonPlan 3D stores the plan, its pictures and the packs in Home Assistant's .storage. It talks to the internet only when you enter a licence key in Extensions: then it asks mastershort.de once a day for updates of your packs, sending the key and an anonymous installation fingerprint (a hash).

Development

cd frontend
npm install
npm test            # pure logic
npm run typecheck
npm run build       # writes the bundles to custom_components/neonplan3d/frontend (committed)
npm run screenshot  # renders preview/index.html (invented demo data) with a local Chrome or Edge

Ideas, questions and bugs

Licence

MIT – see LICENSE. Furniture packs and Pro add-ons sold in the shop are not part of this repository.

Unterstützen / Support

NeonPlan 3D ist kostenlos. Wenn es dir gefällt, freue ich mich über einen Kaffee ☕ – oder schau dir die Möbel-Packs im Shop an: https://mastershort.de/neonplan3d/ NeonPlan 3D is free. If you like it, you can buy me a coffee or check out the furniture packs.

PayPal

neonplan3d (Mastershort/neonplan3d)

Searching Database…

792 ·GitHub
Neonplan3d
What is this?NeonPlan 3D lets you draw your home as rooms, walls, doors, windows and furniture right inside Home Assistant, then control your lights, covers, climate, media and cameras live in a neon-styled 3D view.
Is this a standalone app or a Home Assistant add-on?It is a Home Assistant custom integration plus a Lovelace dashboard card (custom:neonplan3d-card), installed through HACS - not a separate standalone app.
Which Home Assistant version do I need?You need Home Assistant 2025.1 or newer; HACS is the recommended way to install it.
Is everything free, or do some features cost extra?The core integration and dashboard card are free and MIT-licensed; furniture packs and Pro add-ons like the camera cockpit, weather effects and live screens are optional paid extras sold separately at mastershort.de.
Does it send my home data to the cloud?No - the plan, pictures and packs stay stored locally in Home Assistant's .storage; it only reaches the internet once a day if you've entered a licence key, to check for pack updates, sending the key and an anonymous installation fingerprint.
Can I try it without installing Home Assistant?Yes, there's an online demo in the browser with invented demo data where you can turn the house, switch lights and open the editor - nothing to install.
What can I actually control in the 3D view?You can tap lights to switch them (swipe to dim, long-press for colour), move blinds, open doors and windows, watch camera fields of view turn red on motion, and see what's playing on TVs - plus climate and media devices.
Is it suited for a wall-mounted tablet?Yes - it includes a kiosk mode with idle return and night dimming, scene buttons, warnings for smoke, gas, water, alarm and open windows in the rain, plus a tablet quality setting tuned for Fire tablets.
How much furniture is included by default?40 built-in furniture and lamp models ship with the integration, with extra themed furniture packs available as paid add-ons.
What are similar projects?espectre, EchoMuse, ha_xiaomi_home, Tasmota, glasshouse, techo5, zigbee2mqtt, core
Which topics is it in?sensors, smart-home, home-assistant, home-automation, threejs, iot, visualization, editor, 3d, customization, dashboard, local-first
Creator
Mastershort
Size
43.1 MB
Stars
792
Updated
CommitOct 18Releasev1.20.0Oct 17
Age
20d
Commits · 90 Days