Skip to content

balkrishan99/scanbuddy-pro

Repository files navigation

ScanBuddy(OpenScan3D)

Platform Build Cost Accuracy License

Low-cost, high-precision 3D laser scanner ecosystem for makers, researchers, and fabrication labs.

Hero Scan Animation

Live Demo Β· Quick Start Β· Roadmap


πŸ“š Table of Contents

  1. Overview
  2. Feature Highlights
  3. Quick Specs
  4. Hardware & Assembly
  5. Software Walkthrough
  6. Architecture
  7. Validation & QA
  8. Professional Documentation
  9. Quick Start
  10. Project Structure
  11. Roadmap
  12. Contributing
  13. License

πŸš€ Overview

ScanBuddy Pro packages mechanical CAD, electronics, calibration routines, automation software, and compliance guidance into a single workspace. The goal is to make laser triangulation scanning accessible without sacrificing metrology-grade accuracy.


✨ Feature Highlights

  • πŸ”΄ Laser Triangulation Engine with < 0.5 mm plane error
  • πŸ€– AI Noise Reduction for clean point clouds
  • πŸ”„ 360Β° Automated Turntable and batch queueing
  • 🧠 Calibration Wizard with repeatability scoring
  • πŸ“€ Multi-format Export: STL, OBJ, PLY, GLB presets
  • πŸ”Œ Plugin Architecture supporting Python and C++ extensions
  • πŸ›‘οΈ Security & Safety Guidance covering Class II laser compliance

πŸ“ Quick Specs

Metric Value
Scan Volume 200 Γ— 200 Γ— 200 mm
Accuracy Β±0.1 mm
Capture Time < 60 seconds
Hardware Cost ~USD 150
Exports STL, OBJ, PLY, GLB
Control Modes Desktop UI, REST API

πŸ› οΈ Hardware & Assembly

Exploded View Placeholder

πŸ“‹ Bill of Materials (Click to expand)
Component Qty Est. Cost
650 nm Laser Module (Class II) 1 $12.99
5 MP CMOS Camera 1 $15.99
Stepper Motor (NEMA 17) 1 $14.50
Arduino Microcontroller 1 $8.99
Bearings, Mounts, Fasteners - $21.00
Turntable Plate 1 $18.00
Total β‰ˆ $91.47
🧰 Assembly Highlights
  • Modular frame with printable brackets and laser safety shrouds
  • Tool-less camera alignment jig with thumbscrews
  • Integrated cable routing and EMI shielding recommendations

πŸ–₯️ Software Walkthrough

sequenceDiagram
participant Laser
participant Object
participant Camera
participant Pipeline
participant User
Laser->>Object: Projects calibrated line
Object->>Camera: Reflects deformation profile
Camera->>Pipeline: Streams frames @ 60 fps
Pipeline->>Pipeline: Triangulation + AI denoise
Pipeline->>User: Mesh + validation metrics
Loading
flowchart LR
Start([Start Scan]) --> Calibrate[Laser & Camera Calibration]
Calibrate --> Capture[Capture Sweep]
Capture --> Process[Noise Reduction + Meshing]
Process --> Inspect[Quality Dashboard]
Inspect --> Export{Export Format?}
Export -->|STL/OBJ| CAD
Export -->|Point Cloud| PLY
Export -->|Automation| API
Loading

πŸ—οΈ Architecture

Architecture Diagram Placeholder

πŸ”¬ Laser Plane Calibration
  • Structured-light baseline fitting with SVD
  • RMS error < 0.5 mm across the capture volume
$$ax + by + cz + d = 0$$
🧠 AI Processing Stack
  • U-Net denoiser trained on synthetic artifacts
  • Outlier rejection via statistical trimming
  • Mesh repair using Poisson reconstruction heuristics

βœ… Validation & QA

Test Result
Laser Plane RMS 0.42 mm
Reprojection Error 0.48 px
Repeatability (10 scans) Β±0.12 mm
Turntable Angular Error < 0.3Β°

Calibration samples, target models, and QA scripts live in src/components/ValidationTesting.tsx and supporting assets.


πŸ“˜ Professional Documentation Suite

The landing page aggregates production-ready appendices:

  • System Requirements – hardware tiers, throughput guidance
  • Error Diagnostics – live telemetry and troubleshooting matrices
  • Data Management – project folder schema, metadata contracts
  • Export Interoperability – presets for Blender, Fusion 360, MeshLab
  • Security & Safety – laser classifications, permissions, encryption
  • Plugin Architecture – scripting APIs (Python/C++) and marketplace roadmap
  • Validation Testing – benchmark artefacts and accuracy charts
  • Project Roadmap – v1.0–v3.0 milestones
  • Licensing & Deployment – Community / Pro / Enterprise models
  • Glossary & References – terminology, citations, standards bodies

⚑ Quick Start

Prerequisites

  • Node.js 18+
  • npm 9+
git clone https://github.com/balkrishan99/scanbuddy-pro.git
cd scanbuddy-pro
npm install
npm run dev

The development server defaults to http://localhost:8080. Press Ctrl+C to exit.

Useful Scripts

  • npm run dev – hot reload development environment
  • npm run build – generate production bundle
  • npm run preview – serve the built bundle locally
  • npm run lint – run ESLint/TypeScript checks

πŸ—‚οΈ Project Structure

src/
	components/
		...feature modules and professional sections
	pages/
		Index.tsx          # Main landing page composition
	lib/
		utils.ts           # Shared helpers
public/
	favicon.svg          # Updated project badge
	robots.txt

πŸ›£οΈ Roadmap

gantt
		title OpenScan3D Roadmap
		dateFormat  YYYY-MM
		section Core Platform
		v1_0 Scanning Engine          :done,    2025-01, 2m
		Calibration Enhancements      :active,  2025-03, 3m
		section AI & Automation
		Mesh Repair Toolkit           :planned, 2025-06, 3m
		Adaptive Noise Models         :planned, 2025-09, 3m
		section Ecosystem
		Plugin Marketplace            :planned, 2025-10, 4m
		Enterprise Compliance Suite   :planned, 2026-02, 4m
Loading

🀝 Contributing

  1. Fork the repository
  2. Create a branch: git checkout -b feature/<name>
  3. Implement changes and run npm run lint
  4. Commit with a conventional message
  5. Open a pull request with context, screenshots, or benchmark results

We welcome hardware tweaks, firmware updates, UX polish, and documentation improvements.


πŸ“œ License

  • Software: MIT
  • Hardware CAD / BOM: CERN OHL v2
  • Documentation: CC BY-SA 4.0

Please review LICENSE files for the exact terms before commercial deployments.


⭐ Support the Mission

If you believe precision 3D scanning should be accessible, star this repository and share builds with the community.

Releases

No releases published

Packages

 
 
 

Contributors

Languages