How dinhducquan/neonplan3d works
NeonPlan 3D is a Home Assistant integration for drawing and maintaining a home plan, then viewing and controlling it in an interactive 3D dashboard. The main user workflow is to create floors, rooms and fixtures in the editor, save the plan and associated assets, and explore the result in the live view or dashboard card. The repository also includes device and environmental overlays, furniture packs, kiosk features, and optional Pro extensions. Several frontend subsystems are represented by their exact paths, but their internal wiring is omitted where the excerpts do not establish it.
Main entry points: model.ts Building model · viewer3d.ts 3D viewer · solar.ts Sunlight model · furniture.ts Furniture rendering
Components 23
Plan creation
- Plan editor
frontend/src/components/editor.ts - Card editor
frontend/src/card-editor.ts - Dashboard card
frontend/src/card.ts
Plan and geometry
- Plan schema
custom_components/neonplan3d/schema.py - Building model
frontend/src/model.ts - Wall geometry
frontend/src/geometry/walls.ts - Roof sections
frontend/src/roof-sections.ts - Sunlight model
frontend/src/solar.ts
3D experience
- 3D viewer
frontend/src/viewer/viewer3d.ts - Furniture rendering
frontend/src/viewer/furniture.ts - 3D geometry buffers
frontend/src/viewer/geo.ts
Home Assistant integration
- Frontend API
frontend/src/api.ts - Plan sync
frontend/src/building-controller.ts - WebSocket handlers
custom_components/neonplan3d/websocket.py - Plan storage
custom_components/neonplan3d/storage.py
Live features
- Entity mapping
frontend/src/devices.ts - Parking model
frontend/src/parking.ts - Weather effects
frontend/src/weather.ts - Sensor heatmap
frontend/src/heatmap.ts - Furniture packs
frontend/src/packs.ts - Extensions
frontend/src/components/extensions.ts
Other components
- Home Assistant user
- Home Assistant
Connections 24
- Home Assistant user → Plan editor: draws plan
README.md - Home Assistant user → Card editor: configures card
README.md - Home Assistant user → Dashboard card: views plan
README.md - Plan editor → Wall geometry: generates walls
frontend/src/components/editor.ts - Plan sync → Frontend API: loads and saves
frontend/src/building-controller.ts - Plan sync → Building model: normalizes plan
frontend/src/building-controller.ts - WebSocket handlers → Plan storage: accesses stores
custom_components/neonplan3d/websocket.py - Plan storage → Plan schema: completes building
custom_components/neonplan3d/storage.py - Building model → Furniture packs: resolves pack items
frontend/src/model.ts - Sunlight model → Building model: reads plan geometry
frontend/src/solar.ts - Sunlight model → Wall geometry: uses wall geometry
frontend/src/solar.ts - Sunlight model → Roof sections: uses roof sections
frontend/src/solar.ts - Furniture rendering → Building model: uses furniture data
frontend/src/viewer/furniture.ts - Furniture rendering → Furniture packs: resolves pack models
frontend/src/viewer/furniture.ts - Furniture rendering → 3D geometry buffers: builds buffers
frontend/src/viewer/furniture.ts - 3D viewer → Furniture rendering: renders furniture
frontend/src/viewer/viewer3d.ts - 3D viewer → Sunlight model: uses sunlight model
frontend/src/viewer/viewer3d.ts - 3D viewer → Parking model: uses parking model
frontend/src/viewer/viewer3d.ts - 3D viewer → Building model: renders building
frontend/src/viewer/viewer3d.ts - Home Assistant → Entity mapping: provides entity states
README.md - Home Assistant → Weather effects: provides weather data
- Home Assistant → Sensor heatmap: provides sensor data
- Home Assistant user → Extensions: manages add-ons
README.md - Extensions → Home Assistant: checks pack updates
README.md