7.7 KiB
7.7 KiB
Quick Start Guide
Welcome to NowYouSeeMe! This guide will get you up and running with the holodeck environment in under 10 minutes.
🎯 What You'll Learn
- Install NowYouSeeMe on your system
- Configure your camera and WiFi hardware
- Run your first holodeck session
- Understand the basic interface
- Troubleshoot common issues
📋 Prerequisites
Before starting, ensure you have:
Hardware Requirements
- Camera: USB camera (720p+ recommended)
- WiFi Card: Intel 5300 or compatible with Nexmon support
- GPU: CUDA-capable GPU (NVIDIA GTX 1060+)
- RAM: 8GB+ recommended
- Storage: 10GB+ free space
Software Requirements
- OS: Ubuntu 20.04+ or Windows 10+
- Python: 3.8 or higher
- Git: For cloning the repository
🚀 Installation Options
Option 1: Docker (Recommended)
# Clone the repository
git clone https://github.com/your-org/NowYouSeeMe.git
cd NowYouSeeMe
# Start with Docker Compose
docker-compose up -d
# Access the application
# Open your browser to http://localhost:8080
Option 2: PyPI Package
# Install from PyPI
pip install nowyouseeme[gpu,azure]
# Run the application
nowyouseeme
Option 3: Manual Installation
# Clone the repository
git clone https://github.com/your-org/NowYouSeeMe.git
cd NowYouSeeMe
# Create virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install dependencies
pip install -e .[dev]
# Build C++ components
./tools/build.sh
🔧 Hardware Setup
Camera Configuration
-
Connect your camera to a USB port
-
Verify detection:
ls /dev/video* # Should show /dev/video0 or similar -
Test camera:
# Test with OpenCV python -c "import cv2; cap = cv2.VideoCapture(0); print('Camera working:', cap.isOpened())"
WiFi CSI Setup
-
Check WiFi card compatibility:
lspci | grep -i network # Look for Intel 5300 or compatible card -
Install Nexmon (if needed):
# Follow Nexmon installation guide # https://github.com/seemoo-lab/nexmon -
Configure CSI capture:
# Edit config/csi_config.json # Set your WiFi interface and parameters
🎮 First Run
Starting the Application
# From the project directory
python -m src.ui.holodeck_ui
# Or if installed via PyPI
nowyouseeme
Initial Setup Wizard
When you first run NowYouSeeMe, you'll see a setup wizard:
- Welcome Screen - Click "Next"
- Hardware Detection - Verify camera and WiFi are detected
- Calibration - Follow the calibration process
- Configuration - Set your preferences
- Finish - Start your first session
Calibration Process
-
Camera Calibration:
- Print the calibration pattern
- Hold it at different angles
- Follow the on-screen instructions
-
RF Calibration:
- Move around the room slowly
- Let the system learn the environment
- Complete the RF mapping
🖥️ Interface Overview
Main Window
┌─────────────────────────────────────────────────────────────┐
│ NowYouSeeMe Holodeck Environment │
├─────────────────────────────────────────────────────────────┤
│ 📷 Camera View │ 📡 RF Map │ 🎯 3D Scene │
│ │ │ │
│ [Live Camera] │ [RF Coverage] │ [3D Rendering] │
│ │ │ │
├─────────────────────────────────────────────────────────────┤
│ 📊 Status Panel │ ⚙️ Controls │ 📈 Performance │
│ Latency: 18ms │ [Start/Stop] │ FPS: 45 │
│ Accuracy: 8cm │ [Calibrate] │ CSI: 120 pkt/s │
└─────────────────────────────────────────────────────────────┘
Key Controls
- 🎬 Start/Stop: Begin or pause tracking
- 🎯 Calibrate: Re-run calibration
- 📊 Settings: Configure parameters
- 💾 Save: Save current session
- 📤 Export: Export to Unity/Unreal
View Modes
- 3D Scene: Real-time 3D visualization
- RF Map: WiFi CSI coverage map
- Camera Feed: Raw camera input
- Fusion View: Combined sensor data
🎯 Basic Usage
Starting a Session
- Launch the application
- Wait for hardware detection
- Click "Start Tracking"
- Move around slowly to let the system learn
- Observe the 3D scene updating in real-time
Understanding the Display
- Green dots: Confident tracking points
- Yellow dots: Uncertain measurements
- Red areas: RF coverage gaps
- Blue lines: Trajectory path
Performance Monitoring
Watch the status panel for:
- Latency: Should be <20ms
- Accuracy: Should be <10cm
- Frame Rate: Should be 30-60 FPS
- CSI Rate: Should be ≥100 packets/second
🔧 Configuration
Camera Settings
Edit config/camera_config.json:
{
"camera": {
"device_id": 0,
"width": 1280,
"height": 720,
"fps": 30,
"exposure": "auto"
}
}
CSI Settings
Edit config/csi_config.json:
{
"csi": {
"interface": "wlan0",
"channel": 6,
"bandwidth": 20,
"packet_rate": 100
}
}
🐛 Troubleshooting
Common Issues
Camera Not Detected
# Check camera permissions
sudo usermod -a -G video $USER
# Verify camera device
ls -la /dev/video*
# Test with OpenCV
python -c "import cv2; print(cv2.__version__)"
WiFi CSI Not Working
# Check WiFi card
lspci | grep -i network
# Verify Nexmon installation
lsmod | grep nexmon
# Test CSI capture
sudo ./tools/test_csi.sh
Low Performance
# Check GPU
nvidia-smi
# Monitor system resources
htop
# Reduce quality settings
# Edit config files to lower resolution/FPS
Application Crashes
# Check logs
tail -f logs/nowyouseeme.log
# Run in debug mode
python -m src.ui.holodeck_ui --debug
# Check dependencies
pip list | grep -E "(opencv|numpy|PyQt6)"
Getting Help
- Check the logs:
tail -f logs/nowyouseeme.log - Run in debug mode: Add
--debugflag - Search issues: GitHub Issues
- Ask community: Discord Server
- Email support: support@nowyouseeme.dev
🎉 Next Steps
Congratulations! You've successfully set up NowYouSeeMe. Here's what to explore next:
Advanced Features
- Neural Rendering - NeRF integration
- Sensor Fusion - Advanced algorithms
- Azure Integration - Cloud GPU support
- Unity Export - VR/AR integration
Development
- API Reference - Complete API documentation
- Contributing - How to contribute
- Architecture - System design
Community
- Discord - Join the community
- GitHub Discussions - Share ideas
- Blog - Latest updates
Need help? Check our Troubleshooting Guide or ask the community!